`Convergence`

class Ansys.ACT.Automation.Mechanical.Results.Convergence

Bases: object

Defines a Convergence.

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.
Delete	Run the Delete action.
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
AllowableChange	Gets or sets the AllowableChange.
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.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
IsConverged	Gets the IsConverged.
LastChange	Gets the LastChange.
Properties	Gets the list of properties for this object.
Type	Gets or sets the Type.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property Convergence.AllowableChange : float | None

Gets or sets the AllowableChange.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property Convergence.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSConvergenceAuto | None

Gets the internal object. For advanced usage only.

property Convergence.IsConverged : bool | None

Gets the IsConverged.

property Convergence.LastChange : float | None

Gets the LastChange.

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

Gets the list of properties for this object.

property Convergence.Type : Ansys.Mechanical.DataModel.Enums.ConvergenceType | None

Gets or sets the Type.

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

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

Method detail

Convergence.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

Convergence.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

Convergence.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

Convergence.RemoveParameter(propName: str) → None

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