Convergence
#
- class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Results.Convergence#
Bases:
object
Defines a Convergence.
Overview#
|
Run the Delete action. |
|
Gets the list of children, filtered by type. |
|
Gets the list of children, filtered by type. |
|
Creates a new child Comment. |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Activate the current object. |
|
Copies all visible properties from this object to another. |
|
Creates a copy of the current DataModelObject. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
Get a property by its unique name. |
|
Get a property by its API name. |
|
Creates a new parameter for a Property. |
|
Gets the parameter corresponding to the given property. |
|
Removes the parameter from the parameter set corresponding to the given property. |
|
Gets the internal object. For advanced usage only. |
|
Gets the LastChange. |
|
Gets or sets the AllowableChange. |
|
Gets or sets the Type. |
|
Gets the IsConverged. |
|
Gets the current DataModelObject’s category. |
|
Gets the list of children. |
|
Gets the list of associated comments. |
|
Gets the list of associated figures. |
|
Gets the list of associated images. |
|
Gets the internal object. For advanced usage only. |
|
Gets the list of properties for this object. |
|
Gets the list of properties that are visible for this object. |
Property detail#
- property Convergence.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSConvergenceAuto | None
Gets the internal object. For advanced usage only.
- property Convergence.LastChange: System.Double | None
Gets the LastChange.
- property Convergence.AllowableChange: System.Double | None
Gets or sets the AllowableChange.
- property Convergence.Type: Ansys.Mechanical.DataModel.Enums.ConvergenceType | None
Gets or sets the Type.
- property Convergence.IsConverged: System.Boolean | None
Gets the IsConverged.
- property Convergence.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
- property Convergence.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
- property Convergence.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
- property Convergence.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
- property Convergence.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
- property Convergence.InternalObject: System.Object | None
Gets the internal object. For advanced usage only.
- property Convergence.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
- property Convergence.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail#
- Convergence.Delete() System.Void
Run the Delete action.
- Convergence.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) System.Collections.Generic.IList[ChildrenType]
Gets the list of children, filtered by type.
- Convergence.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]
Gets the list of children, filtered by type.
- 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: System.String) 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.Activate() System.Void
Activate the current object.
- Convergence.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) System.Void
Copies all visible properties from this object to another.
- Convergence.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject
Creates a copy of the current DataModelObject.
- Convergence.GroupAllSimilarChildren() System.Void
Run the GroupAllSimilarChildren action.
- Convergence.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder
Run the GroupSimilarObjects action.
- Convergence.PropertyByName(name: System.String) Ansys.ACT.Automation.Mechanical.Property
Get a property by its unique name.
- Convergence.PropertyByAPIName(name: System.String) 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.CreateParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter
Creates a new parameter for a Property.
- Convergence.GetParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter
Gets the parameter corresponding to the given property.
- Convergence.RemoveParameter(propName: System.String) System.Void
Removes the parameter from the parameter set corresponding to the given property.