Skip to main content

Mechanical scripting interface

TopoOptAnalysisSettings

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.AnalysisSettings.TopoOptAnalysisSettings

Bases: object

Defines a TopoOptAnalysisSettings.

Overview

Methods

Name Description
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.
CreateParameter Creates a new parameter for a Property.
DeleteAllRestartPoints DeleteAllRestartPoints method.
Duplicate Creates a copy of the current DataModelObject.
GetChildren Gets the list of children, filtered by type.
GetParameter Gets the parameter corresponding to the given property.
GroupAllSimilarChildren Run the GroupAllSimilarChildren action.
GroupSimilarObjects Run the GroupSimilarObjects action.
PropertyByAPIName Get a property by its API name.
PropertyByName Get a property by its unique name.
RemoveParameter Removes the parameter from the parameter set corresponding to the given property.

Properties

Name Description
Algorithm Gets or sets the Algorithm.
Children Gets the list of children.
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.
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.
OptimizationOutputLog Gets or sets the OptimizationOutputLog.
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.
StoreResultsAt Gets or sets the StoreResultsAt.
StoreResultsAtValue Gets or sets the StoreResultsAtValue.
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.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

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.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property TopoOptAnalysisSettings.InternalObject : Ansys.Common.Interop.DSObjectsAuto.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.OptimizationOutputLog : Ansys.Mechanical.DataModel.Enums.TopoOptimizationOutputLog | None

Gets or sets the OptimizationOutputLog.

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.StoreResultsAt : Ansys.Mechanical.DataModel.Enums.IterationOptions | None

Gets or sets the StoreResultsAt.

property TopoOptAnalysisSettings.StoreResultsAtValue : int | None

Gets or sets the StoreResultsAtValue.

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()

Activate the current object.

TopoOptAnalysisSettings.AddComment()

Creates a new child Comment.

TopoOptAnalysisSettings.AddFigure()

Creates a new child Figure.

TopoOptAnalysisSettings.AddImage(filePath: str)

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)

Copies all visible properties from this object to another.

TopoOptAnalysisSettings.CreateParameter(propName: str)

Creates a new parameter for a Property.

TopoOptAnalysisSettings.DeleteAllRestartPoints()

DeleteAllRestartPoints method.

TopoOptAnalysisSettings.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

TopoOptAnalysisSettings.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

TopoOptAnalysisSettings.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

TopoOptAnalysisSettings.GroupSimilarObjects()

Run the GroupSimilarObjects action.

TopoOptAnalysisSettings.PropertyByAPIName(name: str)

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.PropertyByName(name: str)

Get a property by its unique name.

TopoOptAnalysisSettings.RemoveParameter(propName: str)

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