TopoOptAnalysisSettings

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.AnalysisSettings.TopoOptAnalysisSettings(internalObject: Any)

Bases: object

Defines a TopoOptAnalysisSettings.

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.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
DeleteAllRestartPoints	DeleteAllRestartPoints method.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
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.
ToString	ToString method.

Properties

Algorithm	Gets or sets the Algorithm.
AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
ConvergenceAccuracy	Gets or sets the ConvergenceAccuracy.
DataModelObjectCategory	Gets the current DataModelObject's category.
DeleteUnneededFiles	Gets or sets the DeleteUnneededFiles.
ExportDesignProperties	Gets or sets the ExportDesignProperties.
ExportDesignPropertiesFileFormat	Gets or sets the ExportDesignPropertiesFileFormat.
ExportKnockdownFilePath	Gets or sets the ExportKnockdownFilePath.
Figures	Gets the list of associated figures.
Filter	Gets or sets the Filter.
FutureAnalysis	Gets or sets the FutureAnalysis.
Graph	Graph property.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
MaxNumOfIntermediateFiles	Gets or sets the MaxNumOfIntermediateFiles.
MaximumNumberOfIterations	Gets or sets the MaximumNumberOfIterations.
MinimumNormalizedDensity	Gets or sets the MinimumNormalizedDensity.
MultiOptimTypeStrategy	Gets or sets the MultiOptimTypeStrategy.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
OptimizationOutputLog	Gets or sets the OptimizationOutputLog.
Parent	Parent property.
PenaltyFactor	Gets or sets the PenaltyFactor.
Properties	Gets the list of properties for this object.
RegionOfAMOverhangConstraint	Gets or sets the RegionOfAMOverhangConstraint.
RegionOfManufacturingConstraint	Gets or sets the RegionOfManufacturingConstraint.
RegionOfMinMemberSize	Gets or sets the RegionOfMinMemberSize.
SaveMAPDLDB	Gets or sets the SaveMAPDLDB.
ScratchSolverFilesDirectory	Gets the ScratchSolverFilesDirectory.
SolverFilesDirectory	Gets the SolverFilesDirectory.
SolverType	Gets or sets the SolverType.
SolverUnitSystem	Gets or sets the SolverUnitSystem.
SolverUnits	Gets or sets the SolverUnits.
State	State property.
StoreResultsAt	Gets or sets the StoreResultsAt.
StoreResultsAtValue	Gets or sets the StoreResultsAtValue.
SurfaceStress	Gets or sets the SurfaceStress.
TopoOptInitialDensity	Gets or sets the TopoOptInitialDensity.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property TopoOptAnalysisSettings.Algorithm: Ansys.Mechanical.DataModel.Enums.AlgorithmType | None

Gets or sets the Algorithm.

property TopoOptAnalysisSettings.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property TopoOptAnalysisSettings.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

property TopoOptAnalysisSettings.ConvergenceAccuracy: float | None

Gets or sets the ConvergenceAccuracy.

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

Gets the current DataModelObject's category.

property TopoOptAnalysisSettings.DeleteUnneededFiles: bool | None

Gets or sets the DeleteUnneededFiles.

property TopoOptAnalysisSettings.ExportDesignProperties: Ansys.Mechanical.DataModel.Enums.TopoOptimizationExportDesignProperties | None

Gets or sets the ExportDesignProperties.

property TopoOptAnalysisSettings.ExportDesignPropertiesFileFormat: Ansys.Mechanical.DataModel.Enums.TopoOptimizationExportDesignPropertiesFileFormat | None

Gets or sets the ExportDesignPropertiesFileFormat.

property TopoOptAnalysisSettings.ExportKnockdownFilePath: bool | None

Gets or sets the ExportKnockdownFilePath.

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

Gets the list of associated figures.

property TopoOptAnalysisSettings.Filter: Ansys.Mechanical.DataModel.Enums.TopoOptimizationDensityFilter | None

Gets or sets the Filter.

property TopoOptAnalysisSettings.FutureAnalysis: Ansys.Mechanical.DataModel.Enums.FutureIntentType | None

Gets or sets the FutureAnalysis.

property TopoOptAnalysisSettings.Graph: Ansys.Mechanical.Graphics.AnalysisSettingsGraph | None

Graph property.

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

GroupingFolder property.

property TopoOptAnalysisSettings.IconName: str | None

IconName property.

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

Gets the list of associated images.

property TopoOptAnalysisSettings.InternalObject: Ansys.Common.Interop.DSAnalysisSettingsObjects.IDSAnalysisSettings | None

Gets the internal object. For advanced usage only.

property TopoOptAnalysisSettings.MaxNumOfIntermediateFiles: int | None

Gets or sets the MaxNumOfIntermediateFiles.

property TopoOptAnalysisSettings.MaximumNumberOfIterations: int | None

Gets or sets the MaximumNumberOfIterations.

property TopoOptAnalysisSettings.MinimumNormalizedDensity: float | None

Gets or sets the MinimumNormalizedDensity.

property TopoOptAnalysisSettings.MultiOptimTypeStrategy: Ansys.Mechanical.DataModel.Enums.MultiOptimTypeStrategyType | None

Gets or sets the MultiOptimTypeStrategy.

property TopoOptAnalysisSettings.Name: str | None

Name property.

property TopoOptAnalysisSettings.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

property TopoOptAnalysisSettings.OptimizationOutputLog: Ansys.Mechanical.DataModel.Enums.TopoOptimizationOutputLog | None

Gets or sets the OptimizationOutputLog.

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

Parent property.

property TopoOptAnalysisSettings.PenaltyFactor: float | None

Gets or sets the PenaltyFactor.

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

Gets the list of properties for this object.

property TopoOptAnalysisSettings.RegionOfAMOverhangConstraint: Ansys.Mechanical.DataModel.Enums.ExclusionParticipantType | None

Gets or sets the RegionOfAMOverhangConstraint.

property TopoOptAnalysisSettings.RegionOfManufacturingConstraint: Ansys.Mechanical.DataModel.Enums.ExclusionParticipantType | None

Gets or sets the RegionOfManufacturingConstraint.

property TopoOptAnalysisSettings.RegionOfMinMemberSize: Ansys.Mechanical.DataModel.Enums.ExclusionParticipantType | None

Gets or sets the RegionOfMinMemberSize.

property TopoOptAnalysisSettings.SaveMAPDLDB: bool | None

Gets or sets the SaveMAPDLDB.

property TopoOptAnalysisSettings.ScratchSolverFilesDirectory: str | None

Gets the ScratchSolverFilesDirectory.

property TopoOptAnalysisSettings.SolverFilesDirectory: str | None

Gets the SolverFilesDirectory.

property TopoOptAnalysisSettings.SolverType: Ansys.Mechanical.DataModel.Enums.OptimizationSolverType | None

Gets or sets the SolverType.

property TopoOptAnalysisSettings.SolverUnitSystem: Ansys.Mechanical.DataModel.Enums.WBUnitSystemType | None

Gets or sets the SolverUnitSystem.

property TopoOptAnalysisSettings.SolverUnits: Ansys.Mechanical.DataModel.Enums.SolverUnitsControlType | None

Gets or sets the SolverUnits.

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

State property.

property TopoOptAnalysisSettings.StoreResultsAt: Ansys.Mechanical.DataModel.Enums.IterationOptions | None

Gets or sets the StoreResultsAt.

property TopoOptAnalysisSettings.StoreResultsAtValue: int | None

Gets or sets the StoreResultsAtValue.

property TopoOptAnalysisSettings.SurfaceStress: bool | None

Gets or sets the SurfaceStress.

property TopoOptAnalysisSettings.TopoOptInitialDensity: float | None

Gets or sets the TopoOptInitialDensity.

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

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

Method detail

TopoOptAnalysisSettings.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

TopoOptAnalysisSettings.DeleteAllRestartPoints() → None

DeleteAllRestartPoints method.

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

Creates a copy of the current DataModelObject.

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

Equals method.

TopoOptAnalysisSettings.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

TopoOptAnalysisSettings.GetHashCode() → int

GetHashCode method.

TopoOptAnalysisSettings.GetIconFile() → System.Byte

GetIconFile method.

TopoOptAnalysisSettings.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

TopoOptAnalysisSettings.GetPath() → str

GetPath method.

TopoOptAnalysisSettings.GetPropertyName(dispId: int) → str

GetPropertyName method.

TopoOptAnalysisSettings.GetPropertyValue(name: str) → Any

GetPropertyValue method.

TopoOptAnalysisSettings.GetType() → type

GetType method.

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

GetVisibleProperties method.

TopoOptAnalysisSettings.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

TopoOptAnalysisSettings.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

TopoOptAnalysisSettings.InitializeLifetimeService() → Any

InitializeLifetimeService method.

TopoOptAnalysisSettings.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

TopoOptAnalysisSettings.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

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

PropertyById method.

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

Get a property by its unique name.

TopoOptAnalysisSettings.RemoveParameter(propName: str) → None

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

TopoOptAnalysisSettings.ToString() → str

ToString method.