AnalysisSettings

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.AnalysisSettings.AnalysisSettings

Bases: object

Defines a AnalysisSettings.

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

Children	Gets the list of children.
Comments	Gets the list of associated comments.
DataModelObjectCategory	Gets the current DataModelObject's category.
Figures	Gets the list of associated figures.
Graph	Graph property.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Properties	Gets the list of properties for this object.
ScratchSolverFilesDirectory	Gets the ScratchSolverFilesDirectory.
SolverFilesDirectory	Gets the SolverFilesDirectory.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

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

Graph property.

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

Gets the list of associated images.

property AnalysisSettings.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSAnalysisSettings | None

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

property AnalysisSettings.ScratchSolverFilesDirectory: str | None

Gets the ScratchSolverFilesDirectory.

property AnalysisSettings.SolverFilesDirectory: str | None

Gets the SolverFilesDirectory.

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

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

Method detail

AnalysisSettings.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

AnalysisSettings.DeleteAllRestartPoints() → None

DeleteAllRestartPoints method.

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

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

AnalysisSettings.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

AnalysisSettings.RemoveParameter(propName: str) → None

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