Skip to main content

Mechanical scripting interface

ExpansionSettings

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ExpansionSettings

Bases: object

Defines a ExpansionSettings.

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.
ClearGeneratedData Run the ClearGeneratedData action.
CopyTo Copies all visible properties from this object to another.
CreateParameter Creates a new parameter for a Property.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
EvaluateAllResults Run the EvaluateAllResults action.
GetChildren Gets the list of children, filtered by type.
GetCompletedExpansionState Gets the completed expansion state of a given Condensed Part
GetExpansionState Gets the requested expansion state of a given Condensed Part
GetParameter Gets the parameter corresponding to the given property.
GroupAllSimilarChildren Run the GroupAllSimilarChildren action.
GroupSimilarObjects Run the GroupSimilarObjects action.
PerformExpansionPass Run the PerformExpansionPass 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.
SetExpansionState Sets the requested expansion state of a given Condensed Part

Properties

Name Description
Children Gets the list of children.
CleanupOptionalFiles Gets or sets the CleanupOptionalFiles.
Comments Gets the list of associated comments.
CondensedPartExpansionType Gets or sets the CondensedPartExpansionType.
DataModelObjectCategory Gets the current DataModelObject’s category.
ExpandAfterUsePassFailure Gets or sets the ExpandAfterUsePassFailure.
Figures Gets the list of associated figures.
GeneralMiscellaneous Gets or sets the GeneralMiscellaneous.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
NodalForces Gets or sets the NodalForces.
Properties Gets the list of properties for this object.
Strain Gets or sets the Strain.
Stress Gets or sets the Stress.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

property ExpansionSettings.CleanupOptionalFiles : bool | None

Gets or sets the CleanupOptionalFiles.

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

Gets the list of associated comments.

property ExpansionSettings.CondensedPartExpansionType : Ansys.Mechanical.DataModel.Enums.CondensedPartExpansionType | None

Gets or sets the CondensedPartExpansionType.

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

Gets the current DataModelObject’s category.

property ExpansionSettings.ExpandAfterUsePassFailure : bool | None

Gets or sets the ExpandAfterUsePassFailure.

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

Gets the list of associated figures.

property ExpansionSettings.GeneralMiscellaneous : bool | None

Gets or sets the GeneralMiscellaneous.

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

Gets the list of associated images.

property ExpansionSettings.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSExpansionSettingsAuto | None

Gets the internal object. For advanced usage only.

property ExpansionSettings.NodalForces : Ansys.Mechanical.DataModel.Enums.OutputControlsNodalForcesType | None

Gets or sets the NodalForces.

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

Gets the list of properties for this object.

property ExpansionSettings.Strain : bool | None

Gets or sets the Strain.

property ExpansionSettings.Stress : bool | None

Gets or sets the Stress.

property ExpansionSettings.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

Method detail

ExpansionSettings.Activate()

Activate the current object.

ExpansionSettings.AddComment()

Creates a new child Comment.

ExpansionSettings.AddFigure()

Creates a new child Figure.

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

ExpansionSettings.ClearGeneratedData()

Run the ClearGeneratedData action.

ExpansionSettings.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

ExpansionSettings.CreateParameter(propName: str)

Creates a new parameter for a Property.

ExpansionSettings.Delete()

Run the Delete action.

ExpansionSettings.Duplicate()

Creates a copy of the current DataModelObject.

ExpansionSettings.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Gets the list of children, filtered by type.

ExpansionSettings.GetCompletedExpansionState(condensedPart: Ansys.ACT.Automation.Mechanical.CondensedPart)

Gets the completed expansion state of a given Condensed Part

ExpansionSettings.GetExpansionState(condensedPart: Ansys.ACT.Automation.Mechanical.CondensedPart)

Gets the requested expansion state of a given Condensed Part

ExpansionSettings.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ExpansionSettings.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ExpansionSettings.GroupSimilarObjects()

Run the GroupSimilarObjects action.

ExpansionSettings.PerformExpansionPass()

Run the PerformExpansionPass action.

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

ExpansionSettings.PropertyByName(name: str)

Get a property by its unique name.

ExpansionSettings.RemoveParameter(propName: str)

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

ExpansionSettings.SetExpansionState(condensedPart: Ansys.ACT.Automation.Mechanical.CondensedPart, state: Ansys.ACT.Automation.Mechanical.CondensedPartExpansionState)

Sets the requested expansion state of a given Condensed Part