EnergyContribution#

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Results.FrequencyResponseResults.EnergyContribution(internalObject: Any)#

Bases: object

Defines a EnergyContribution.

Overview#

Activate

Activate the current object.

AddAlert

Creates a new Alert

AddComment

Creates a new child Comment.

AddConvergence

Creates a new Convergence

AddFigure

Creates a new child Figure.

AddImage

Creates a new child Image.

BodyWhereMaximumOccurs

Gets the body that has the maximum result value.

ClearGeneratedData

Run the ClearGeneratedData action.

CopyTo

Copies all visible properties from this object to another.

CreateObjRef

CreateObjRef method.

CreateParameter

CreateParameter method.

CreateResultsAtAllSets

Creates results at all sets for results under a solution.

Delete

Run the Delete action.

Duplicate

Creates a copy of the current DataModelObject.

DuplicateWithoutResults

Run the DuplicateWithoutResults action.

Equals

Equals method.

EvaluateAllResults

Run the EvaluateAllResults action.

ExportAnimation

Run the ExportAnimation action.

ExportToSTLFile

ExportToSTLFile method.

ExportToTextFile

ExportToTextFile method.

FetchRemoteResult

Run the FetchRemoteResult action.

FetchRemoteResults

Run the FetchRemoteResult action.

GetAPIName

GetAPIName method.

GetAllProperties

GetAllProperties method.

GetChildren

Gets the list of children, filtered by type.

GetDetailsView

GetDetailsView method.

GetEnumName

Enum name bound to value

GetHashCode

GetHashCode method.

GetIconFile

GetIconFile method.

GetLifetimeService

GetLifetimeService method.

GetNodalValues

GetNodalValues method.

GetObjectData

GetObjectData method.

GetParameter

Gets the parameter corresponding to the given property.

GetPath

GetPath method.

GetPropertyName

GetPropertyName method.

GetPropertyValue

GetPropertyValue method.

GetQuantityName

GetQuantityName method.

GetType

GetType method.

GetVisibleProperties

GetVisibleProperties method.

GetVisiblePropertyNames

GetVisiblePropertyNames method.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

InitializeLifetimeService

InitializeLifetimeService method.

IsPropertyEditable

IsPropertyEditable method.

IsPropertyVisible

IsPropertyVisible method.

PromoteToNamedSelection

Run the PromoteToNamedSelection action.

PropertyByAPIName

Get a property by its API name.

PropertyById

PropertyById method.

PropertyByName

Get a property by its unique name.

RemoveParameter

Removes the parameter from the parameter set corresponding to the given property.

RenameBasedOnDefinition

Run the RenameBasedOnDefinition action.

RetrieveRemoteDPFResults

RetrieveRemoteDPFResults method.

RetrieveResult

Evaluates the individual result without evaluating all the results in the same solution.

ToString

ToString method.

AttachedRefs

AttachedRefs property.

Average

Gets the Average.

By

Gets or sets the By.

CalculateTimeHistory

Gets or sets the CalculateTimeHistory.

Children

Gets the list of children.

ClsId

ClsId property.

CombinationNumber

Gets or sets the Combination Number for a Solution Combination result.

Comments

Gets the list of associated comments.

CoordinateSystem

Gets or sets the Coordinate System.

CrackFrontNumber

Gets or sets the CrackFrontNumber.

DataModelObjectCategory

Gets the current DataModelObject's category.

DisplayOption

Gets or sets the DisplayOption.

DisplayTime

Gets or sets the DisplayTime.

DpfEvaluation

Gets or sets the DpfEvaluation.

EnergyType

Gets or sets the EnergyType.

Figures

Gets the list of associated figures.

GlobalIDs

Gets or sets the GlobalIDs.

GraphControlsXAxis

Gets or sets the GraphControlsXAxis.

GroupingFolder

GroupingFolder property.

IconName

IconName property.

Identifier

Gets or sets the Identifier.

Images

Gets the list of associated images.

InternalObject

Gets the internal object. For advanced usage only.

IsSolved

Gets the IsSolved.

ItemType

Gets or sets the ItemType.

IterationNumber

Gets the IterationNumber.

LoadStep

Gets the LoadStep.

LoadStepForMaximumOfMaximumValues

Get the Load Step for the maximum of maximum values.

LoadStepForMaximumOfMinimumValues

Get the Load Step for the maximum of minimum values.

LoadStepForMinimumOfMaximumValues

Get the Load Step for the minimum of maximum values.

LoadStepForMinimumOfMinimumValues

Get the Load Step for the minimum of minimum values.

LoadStepNumber

Gets or sets the LoadStepNumber.

Location

Gets or sets the Location.

Maximum

Gets the Maximum.

MaximumOccursOn

Gets the MaximumOccursOn.

MaximumOfMaximumOverTime

Gets the MaximumOfMaximumOverTime.

MaximumOfMinimumOverTime

Gets the MaximumOfMinimumOverTime.

Minimum

Gets the Minimum.

MinimumOccursOn

Gets the MinimumOccursOn.

MinimumOfMaximumOverTime

Gets the MinimumOfMaximumOverTime.

MinimumOfMinimumOverTime

Gets the MinimumOfMinimumOverTime.

ModeSelection

Gets or sets the ModeSelection.

MosaicChartLegendMax

Gets or sets the MosaicChartLegendMax.

MosaicChartLegendMin

Gets or sets the MosaicChartLegendMin.

Name

Name property.

NamedSelections

Gets or sets the NamedSelections.

ObjectId

ObjectId property.

ObjectState

ObjectState property.

ObjectTags

ObjectTags property.

Parent

Parent property.

Path

Path property.

PlotData

Gets the result table.

Properties

Gets the list of properties for this object.

RPMSelection

Gets or sets the RPM Selection value at which the results are evaluated.

ResultType

Gets or sets the ResultType.

RpmSetNumber

Gets or sets the RpmSetNumber.

ScopingMethod

Gets or sets the ScopingMethod.

SeparateDataByEntity

Gets or sets the SeparateDataByEntity.

SetNumber

Gets or sets the Set Number.

ShowTextOnMosaic

Gets or sets the ShowTextOnMosaic.

SolutionCombinationDriver

Gets or sets the SolutionCombinationDriver.

SolverComponentIDs

Gets or sets the SolverComponentIDs.

State

State property.

Substep

Gets the Substep.

Suppressed

Gets or sets the Suppressed.

Surface

Surface property.

SurfaceCoating

SurfaceCoating property.

TabularData

Gets the tabular data of the result. Use a to get index to each column of the tabular data.

Time

Gets the Time.

TimeForMaximumOfMaximumValues

Get the Time for the maximum of maximum values.

TimeForMaximumOfMinimumValues

Get the Time for the maximum of minimum values.

TimeForMinimumOfMaximumValues

Get the Time for the minimum of maximum values.

TimeForMinimumOfMinimumValues

Get the Time for the minimum of minimum values.

TopBodiesToDisplay

Gets or sets the TopBodiesToDisplay.

Total

Gets the Total.

VisibleProperties

Gets the list of properties that are visible for this object.

WaterfallDisplayFilterBy

Gets or sets the Filer in Waterfall.

WaterfallDisplayFrequencySelection

Gets or sets the Frequency Selection.

WaterfallDisplayInterpolateData

Gets or sets the Interpolate Data Property.

WaterfallDisplayLowerBand

Gets or sets the Lower Band Value.

WaterfallDisplayMaxRPM

Gets or sets the Display Max RPM.

WaterfallDisplayMinRPM

Gets or sets the Display Min RPM.

WaterfallDisplayModeSelection

Gets or sets the Mode Selection.

WaterfallDisplayOrderSelection

Gets or sets the Order Selection.

WaterfallDisplayRpmSelection

Gets or sets the RPM Selection.

WaterfallDisplayScopeToOrderLines

Gets or sets the Scope to Order Lines Property.

WaterfallDisplayTimeSelection

Gets or sets the Time Selection.

WaterfallDisplayUpperBand

Gets or sets the Upper Band Value.

WaterfallDisplayXAxisMaximum

Gets or sets the Maximum X-Axis Value.

WaterfallDisplayXAxisMinimum

Gets or sets the Minimum X-Axis Value.

WaterfallDisplayYAxisMaximum

Gets or sets the Maximum Y-Axis Value.

WaterfallDisplayYAxisMinimum

Gets or sets the Minimum Y-Axis Value.

WaterfallShowTextOnMosaic

Gets or sets the Waterfall Mosaic Text Property.

Property detail#

property EnergyContribution.AttachedRefs: List[int] | None#

AttachedRefs property.

property EnergyContribution.Average: Ansys.Core.Units.Quantity | None#

Gets the Average.

property EnergyContribution.By: Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None#

Gets or sets the By.

property EnergyContribution.CalculateTimeHistory: bool | None#

Gets or sets the CalculateTimeHistory.

property EnergyContribution.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#

Gets the list of children.

property EnergyContribution.ClsId: int | None#

ClsId property.

property EnergyContribution.CombinationNumber: int | None#

Gets or sets the Combination Number for a Solution Combination result.

property EnergyContribution.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#

Gets the list of associated comments.

property EnergyContribution.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the Coordinate System. Accepts/Returns None for Solution Coordinate System in the general case (if applicable). Accepts/Returns None for Fiber Coordinate System for a result that is sub scoped by ply.

property EnergyContribution.CrackFrontNumber: int | None#

Gets or sets the CrackFrontNumber.

property EnergyContribution.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property EnergyContribution.DisplayOption: Ansys.Mechanical.DataModel.Enums.ResultAveragingType | None#

Gets or sets the DisplayOption.

property EnergyContribution.DisplayTime: Ansys.Core.Units.Quantity | None#

Gets or sets the DisplayTime.

property EnergyContribution.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None#

Gets or sets the DpfEvaluation.

property EnergyContribution.EnergyType: Ansys.Mechanical.DataModel.Enums.EnergyContributionEnergyType | None#

Gets or sets the EnergyType.

property EnergyContribution.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#

Gets the list of associated figures.

property EnergyContribution.GlobalIDs: str | None#

Gets or sets the GlobalIDs.

property EnergyContribution.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis | None#

Gets or sets the GraphControlsXAxis.

property EnergyContribution.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#

GroupingFolder property.

property EnergyContribution.IconName: str | None#

IconName property.

property EnergyContribution.Identifier: str | None#

Gets or sets the Identifier.

property EnergyContribution.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#

Gets the list of associated images.

property EnergyContribution.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None#

Gets the internal object. For advanced usage only.

property EnergyContribution.IsSolved: bool | None#

Gets the IsSolved.

property EnergyContribution.ItemType: Ansys.Mechanical.DataModel.Enums.ResultFileItemType | None#

Gets or sets the ItemType.

property EnergyContribution.IterationNumber: int | None#

Gets the IterationNumber.

property EnergyContribution.LoadStep: int | None#

Gets the LoadStep.

property EnergyContribution.LoadStepForMaximumOfMaximumValues: int | None#

Get the Load Step for the maximum of maximum values.

property EnergyContribution.LoadStepForMaximumOfMinimumValues: int | None#

Get the Load Step for the maximum of minimum values.

property EnergyContribution.LoadStepForMinimumOfMaximumValues: int | None#

Get the Load Step for the minimum of maximum values.

property EnergyContribution.LoadStepForMinimumOfMinimumValues: int | None#

Get the Load Step for the minimum of minimum values.

property EnergyContribution.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

property EnergyContribution.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

property EnergyContribution.Maximum: Ansys.Core.Units.Quantity | None#

Gets the Maximum.

property EnergyContribution.MaximumOccursOn: str | None#

Gets the MaximumOccursOn.

property EnergyContribution.MaximumOfMaximumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MaximumOfMaximumOverTime.

property EnergyContribution.MaximumOfMinimumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MaximumOfMinimumOverTime.

property EnergyContribution.Minimum: Ansys.Core.Units.Quantity | None#

Gets the Minimum.

property EnergyContribution.MinimumOccursOn: str | None#

Gets the MinimumOccursOn.

property EnergyContribution.MinimumOfMaximumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MinimumOfMaximumOverTime.

property EnergyContribution.MinimumOfMinimumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MinimumOfMinimumOverTime.

property EnergyContribution.ModeSelection: str | None#

Gets or sets the ModeSelection.

property EnergyContribution.MosaicChartLegendMax: float | None#

Gets or sets the MosaicChartLegendMax.

property EnergyContribution.MosaicChartLegendMin: float | None#

Gets or sets the MosaicChartLegendMin.

property EnergyContribution.Name: str | None#

Name property.

property EnergyContribution.NamedSelections: Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#

Gets or sets the NamedSelections.

property EnergyContribution.ObjectId: int | None#

ObjectId property.

property EnergyContribution.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#

ObjectState property.

property EnergyContribution.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None#

ObjectTags property.

property EnergyContribution.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#

Parent property.

property EnergyContribution.Path: Ansys.ACT.Automation.Mechanical.Path | None#

Path property.

property EnergyContribution.PlotData: Ansys.Mechanical.DataModel.Results.ResultDataTable | None#

Gets the result table.

property EnergyContribution.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

Gets the list of properties for this object.

property EnergyContribution.RPMSelection: Ansys.Core.Units.Quantity | None#

Gets or sets the RPM Selection value at which the results are evaluated.

property EnergyContribution.ResultType: Ansys.Mechanical.DataModel.Enums.ResultType | None#

Gets or sets the ResultType.

property EnergyContribution.RpmSetNumber: int | None#

Gets or sets the RpmSetNumber.

property EnergyContribution.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None#

Gets or sets the ScopingMethod.

property EnergyContribution.SeparateDataByEntity: bool | None#

Gets or sets the SeparateDataByEntity.

property EnergyContribution.SetNumber: int | None#

Gets or sets the Set Number.

property EnergyContribution.ShowTextOnMosaic: Ansys.Mechanical.DataModel.Enums.ShowTextOnMosaicMode | None#

Gets or sets the ShowTextOnMosaic.

property EnergyContribution.SolutionCombinationDriver: Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle | None#

Gets or sets the SolutionCombinationDriver.

property EnergyContribution.SolverComponentIDs: str | None#

Gets or sets the SolverComponentIDs.

property EnergyContribution.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None#

State property.

property EnergyContribution.Substep: int | None#

Gets the Substep.

property EnergyContribution.Suppressed: bool | None#

Gets or sets the Suppressed.

property EnergyContribution.Surface: Ansys.ACT.Automation.Mechanical.Surface | None#

Surface property.

property EnergyContribution.SurfaceCoating: Ansys.ACT.Automation.Mechanical.SurfaceCoating | None#

SurfaceCoating property.

property EnergyContribution.TabularData: Ansys.Mechanical.Interfaces.ITable | None#

Gets the tabular data of the result. Use a to get index to each column of the tabular data.

property EnergyContribution.Time: Ansys.Core.Units.Quantity | None#

Gets the Time.

property EnergyContribution.TimeForMaximumOfMaximumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the maximum of maximum values.

property EnergyContribution.TimeForMaximumOfMinimumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the maximum of minimum values.

property EnergyContribution.TimeForMinimumOfMaximumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the minimum of maximum values.

property EnergyContribution.TimeForMinimumOfMinimumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the minimum of minimum values.

property EnergyContribution.TopBodiesToDisplay: int | None#

Gets or sets the TopBodiesToDisplay.

property EnergyContribution.Total: Ansys.Core.Units.Quantity | None#

Gets the Total.

property EnergyContribution.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

Gets the list of properties that are visible for this object.

property EnergyContribution.WaterfallDisplayFilterBy: Ansys.Mechanical.DataModel.Enums.WaterfallDisplayFilterBy | None#

Gets or sets the Filer in Waterfall.

property EnergyContribution.WaterfallDisplayFrequencySelection: str | None#

Gets or sets the Frequency Selection.

property EnergyContribution.WaterfallDisplayInterpolateData: bool | None#

Gets or sets the Interpolate Data Property.

property EnergyContribution.WaterfallDisplayLowerBand: float | None#

Gets or sets the Lower Band Value.

property EnergyContribution.WaterfallDisplayMaxRPM: Ansys.Core.Units.Quantity | None#

Gets or sets the Display Max RPM.

property EnergyContribution.WaterfallDisplayMinRPM: Ansys.Core.Units.Quantity | None#

Gets or sets the Display Min RPM.

property EnergyContribution.WaterfallDisplayModeSelection: str | None#

Gets or sets the Mode Selection.

property EnergyContribution.WaterfallDisplayOrderSelection: str | None#

Gets or sets the Order Selection.

property EnergyContribution.WaterfallDisplayRpmSelection: str | None#

Gets or sets the RPM Selection.

property EnergyContribution.WaterfallDisplayScopeToOrderLines: bool | None#

Gets or sets the Scope to Order Lines Property.

property EnergyContribution.WaterfallDisplayTimeSelection: str | None#

Gets or sets the Time Selection.

property EnergyContribution.WaterfallDisplayUpperBand: float | None#

Gets or sets the Upper Band Value.

property EnergyContribution.WaterfallDisplayXAxisMaximum: float | None#

Gets or sets the Maximum X-Axis Value.

property EnergyContribution.WaterfallDisplayXAxisMinimum: float | None#

Gets or sets the Minimum X-Axis Value.

property EnergyContribution.WaterfallDisplayYAxisMaximum: float | None#

Gets or sets the Maximum Y-Axis Value.

property EnergyContribution.WaterfallDisplayYAxisMinimum: float | None#

Gets or sets the Minimum Y-Axis Value.

property EnergyContribution.WaterfallShowTextOnMosaic: bool | None#

Gets or sets the Waterfall Mosaic Text Property.

Method detail#

EnergyContribution.Activate() None#

Activate the current object.

EnergyContribution.AddAlert() Ansys.ACT.Automation.Mechanical.Results.Alert#

Creates a new Alert

EnergyContribution.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

EnergyContribution.AddConvergence() Ansys.ACT.Automation.Mechanical.Results.Convergence#

Creates a new Convergence

EnergyContribution.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

EnergyContribution.AddImage(filePath: str) Ansys.ACT.Automation.Mechanical.Image#
Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.
EnergyContribution.BodyWhereMaximumOccurs() Ansys.ACT.Automation.Mechanical.Body#
Gets the body that has the maximum result value.
Throws an exception if body not found.
EnergyContribution.ClearGeneratedData() None#

Run the ClearGeneratedData action.

EnergyContribution.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

EnergyContribution.CreateObjRef(requestedType: type) System.Runtime.Remoting.ObjRef#

CreateObjRef method.

EnergyContribution.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

CreateParameter method.

EnergyContribution.CreateResultsAtAllSets() List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]#

Creates results at all sets for results under a solution.

EnergyContribution.Delete() None#

Run the Delete action.

EnergyContribution.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

EnergyContribution.DuplicateWithoutResults() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Run the DuplicateWithoutResults action.

EnergyContribution.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) bool#

Equals method.

EnergyContribution.EvaluateAllResults() None#

Run the EvaluateAllResults action.

EnergyContribution.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) None#

Run the ExportAnimation action.

EnergyContribution.ExportToSTLFile(filePath: str) None#

ExportToSTLFile method.

EnergyContribution.ExportToTextFile(bIgnoreExcelPreference: bool, filePath: str) None#

ExportToTextFile method.

EnergyContribution.FetchRemoteResult() None#

Run the FetchRemoteResult action.

EnergyContribution.FetchRemoteResults() None#

Run the FetchRemoteResult action.

EnergyContribution.GetAPIName(dispId: int) str#

GetAPIName method.

EnergyContribution.GetAllProperties() List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#

GetAllProperties method.

EnergyContribution.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#

Gets the list of children, filtered by type.

EnergyContribution.GetDetailsView() Ansys.ACT.Automation.Mechanical.DetailsViewData#

GetDetailsView method.

EnergyContribution.GetEnumName(enumType: type, value: int, dispId: int) str#

Enum name bound to value

EnergyContribution.GetHashCode() int#

GetHashCode method.

EnergyContribution.GetIconFile() System.Byte#

GetIconFile method.

EnergyContribution.GetLifetimeService() Any#

GetLifetimeService method.

EnergyContribution.GetNodalValues(bodyRefId: int) System.Collections.Generic.Dictionary[int, float]#

GetNodalValues method.

EnergyContribution.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) None#

GetObjectData method.

EnergyContribution.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

EnergyContribution.GetPath() str#

GetPath method.

EnergyContribution.GetPropertyName(dispId: int) str#

GetPropertyName method.

EnergyContribution.GetPropertyValue(name: str) Any#

GetPropertyValue method.

EnergyContribution.GetQuantityName(obj: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto) str#

GetQuantityName method.

EnergyContribution.GetType() type#

GetType method.

EnergyContribution.GetVisibleProperties() List[System.Reflection.PropertyInfo]#

GetVisibleProperties method.

EnergyContribution.GetVisiblePropertyNames() List[str]#

GetVisiblePropertyNames method.

EnergyContribution.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

EnergyContribution.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

EnergyContribution.InitializeLifetimeService() Any#

InitializeLifetimeService method.

EnergyContribution.IsPropertyEditable(dispId: int) bool#

IsPropertyEditable method.

EnergyContribution.IsPropertyVisible(dispId: int) bool#

IsPropertyVisible method.

EnergyContribution.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#

Run the PromoteToNamedSelection action.

EnergyContribution.PropertyByAPIName(name: str) Ansys.ACT.Automation.Mechanical.Property#
Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.
EnergyContribution.PropertyById(dispId: int) Ansys.ACT.Automation.Mechanical.Property#

PropertyById method.

EnergyContribution.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

EnergyContribution.RemoveParameter(propName: str) None#

Removes the parameter from the parameter set corresponding to the given property.

EnergyContribution.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.

EnergyContribution.RetrieveRemoteDPFResults() None#

RetrieveRemoteDPFResults method.

EnergyContribution.RetrieveResult() None#

Evaluates the individual result without evaluating all the results in the same solution.

EnergyContribution.ToString() str#

ToString method.