TopologyOptimizationResult

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

Bases: object

Defines a TopologyOptimizationResult.

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
ClearGeneratedData	Clears the result.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
EvaluateAllResults	Run the EvaluateAllResults action.
ExportAnimation	Run the ExportAnimation action.
GetAPIName	Property name bound to dispId.
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.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue 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.
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.
RetrieveResult	Evaluates the individual result without evaluating all the results in the same solution.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
CalculateTimeHistory	Gets or sets the CalculateTimeHistory.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
DataModelObjectCategory	Gets the current DataModelObject's category.
ExclusionsParticipation	Gets or sets the ExclusionsParticipation.
Figures	Gets the list of associated figures.
FinalMass	Gets the FinalMass.
FinalVolume	Gets the FinalVolume.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
IterationNumber	Gets the IterationNumber.
IterationStep	Gets or sets the IterationStep.
Location	Gets or sets the Location.
Maximum	Gets the Maximum.
Minimum	Gets the Minimum.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
OriginalMass	Gets the OriginalMass.
OriginalVolume	Gets the OriginalVolume.
Parent	Parent property.
PercentMassOfOriginal	Gets the PercentMassOfOriginal.
PercentVolumeOfOriginal	Gets the PercentVolumeOfOriginal.
Properties	Gets the list of properties for this object.
ScopingMethod	Gets or sets the ScopingMethod.
Selection	Gets or sets the Selection.
ShowOptimizedRegion	Gets or sets the ShowOptimizedRegion.
State	State property.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property TopologyOptimizationResult.AttachedRefs: List[int] | None

AttachedRefs property.

property TopologyOptimizationResult.CalculateTimeHistory: bool | None

Gets or sets the CalculateTimeHistory.

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

Gets the list of children.

property TopologyOptimizationResult.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

property TopologyOptimizationResult.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject's category.

property TopologyOptimizationResult.ExclusionsParticipation: bool | None

Gets or sets the ExclusionsParticipation.

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

Gets the list of associated figures.

property TopologyOptimizationResult.FinalMass: Ansys.Core.Units.Quantity | None

Gets the FinalMass.

property TopologyOptimizationResult.FinalVolume: Ansys.Core.Units.Quantity | None

Gets the FinalVolume.

property TopologyOptimizationResult.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property TopologyOptimizationResult.IconName: str | None

IconName property.

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

Gets the list of associated images.

property TopologyOptimizationResult.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None

Gets the internal object. For advanced usage only.

property TopologyOptimizationResult.IterationNumber: int | None

Gets the IterationNumber.

property TopologyOptimizationResult.IterationStep: int | None

Gets or sets the IterationStep.

property TopologyOptimizationResult.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property TopologyOptimizationResult.Maximum: float | None

Gets the Maximum.

property TopologyOptimizationResult.Minimum: float | None

Gets the Minimum.

property TopologyOptimizationResult.Name: str | None

Name property.

property TopologyOptimizationResult.ObjectId: int | None

ObjectId property.

property TopologyOptimizationResult.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

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

ObjectTags property.

property TopologyOptimizationResult.OriginalMass: Ansys.Core.Units.Quantity | None

Gets the OriginalMass.

property TopologyOptimizationResult.OriginalVolume: Ansys.Core.Units.Quantity | None

Gets the OriginalVolume.

property TopologyOptimizationResult.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

property TopologyOptimizationResult.PercentMassOfOriginal: float | None

Gets the PercentMassOfOriginal.

property TopologyOptimizationResult.PercentVolumeOfOriginal: float | None

Gets the PercentVolumeOfOriginal.

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

Gets the list of properties for this object.

property TopologyOptimizationResult.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property TopologyOptimizationResult.Selection: Ansys.ACT.Automation.Mechanical.OptimizationRegion | None

Gets or sets the Selection.

property TopologyOptimizationResult.ShowOptimizedRegion: Ansys.Mechanical.DataModel.Enums.TopologyOptimizationResultShowType | None

Gets or sets the ShowOptimizedRegion.

property TopologyOptimizationResult.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property TopologyOptimizationResult.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

Method detail

TopologyOptimizationResult.Activate() → None

Activate the current object.

TopologyOptimizationResult.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

TopologyOptimizationResult.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

TopologyOptimizationResult.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.

TopologyOptimizationResult.ClearGeneratedData() → None

Clears the result.

TopologyOptimizationResult.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

TopologyOptimizationResult.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

TopologyOptimizationResult.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

TopologyOptimizationResult.Delete() → None

Run the Delete action.

TopologyOptimizationResult.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

TopologyOptimizationResult.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

TopologyOptimizationResult.EvaluateAllResults() → None

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

TopologyOptimizationResult.GetAPIName(dispId: int) → str

Property name bound to dispId.

TopologyOptimizationResult.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

TopologyOptimizationResult.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]

Gets the list of children, filtered by type.

TopologyOptimizationResult.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

TopologyOptimizationResult.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

TopologyOptimizationResult.GetHashCode() → int

GetHashCode method.

TopologyOptimizationResult.GetIconFile() → System.Byte

GetIconFile method.

TopologyOptimizationResult.GetLifetimeService() → Any

GetLifetimeService method.

TopologyOptimizationResult.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

TopologyOptimizationResult.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

TopologyOptimizationResult.GetPath() → str

GetPath method.

TopologyOptimizationResult.GetPropertyName(dispId: int) → str

GetPropertyName method.

TopologyOptimizationResult.GetPropertyValue(name: str) → Any

GetPropertyValue method.

TopologyOptimizationResult.GetType() → type

GetType method.

TopologyOptimizationResult.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

TopologyOptimizationResult.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

TopologyOptimizationResult.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

TopologyOptimizationResult.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

TopologyOptimizationResult.InitializeLifetimeService() → Any

InitializeLifetimeService method.

TopologyOptimizationResult.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

TopologyOptimizationResult.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

TopologyOptimizationResult.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.

TopologyOptimizationResult.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

TopologyOptimizationResult.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

TopologyOptimizationResult.RemoveParameter(propName: str) → None

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

TopologyOptimizationResult.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

TopologyOptimizationResult.RetrieveResult() → None

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

TopologyOptimizationResult.ToString() → str

ToString method.