`StressTool`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.StressToolResults.StressTool#

Bases: object

Defines a StressTool.

Overview#

Methods

`EvaluateAllResults`	Run the EvaluateAllResults action.
`AddStressRatio`	Creates a new StressRatio
`AddSafetyFactor`	Creates a new StressSafetyFactor
`AddSafetyMargin`	Creates a new StressSafetyMargin
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`InternalObject`	Gets the internal object. For advanced usage only.
`LimitFactor`	Gets or sets the LimitFactor.
`CompressiveLimit`	Gets or sets the CompressiveLimit.
`StressLimit`	Gets or sets the StressLimit.
`TensileLimit`	Gets or sets the TensileLimit.
`CompressiveLimitType`	Gets or sets the CompressiveLimitType.
`Theory`	Gets or sets the Theory.
`StressLimitType`	Gets or sets the StressLimitType.
`TensileLimitType`	Gets or sets the TensileLimitType.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`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.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property StressTool.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSStressSafetyToolAuto | None: Gets the internal object. For advanced usage only.

property StressTool.LimitFactor: System.Double | None: Gets or sets the LimitFactor.

property StressTool.CompressiveLimit: Ansys.Core.Units.Quantity | None: Gets or sets the CompressiveLimit.

property StressTool.StressLimit: Ansys.Core.Units.Quantity | None: Gets or sets the StressLimit.

property StressTool.TensileLimit: Ansys.Core.Units.Quantity | None: Gets or sets the TensileLimit.

property StressTool.CompressiveLimitType: Ansys.Mechanical.DataModel.Enums.SafetyLimitType | None: Gets or sets the CompressiveLimitType.

property StressTool.Theory: Ansys.Mechanical.DataModel.Enums.SafetyTheoryType | None: Gets or sets the Theory.

property StressTool.StressLimitType: Ansys.Mechanical.DataModel.Enums.SafetyLimitType | None: Gets or sets the StressLimitType.

property StressTool.TensileLimitType: Ansys.Mechanical.DataModel.Enums.SafetyLimitType | None: Gets or sets the TensileLimitType.

property StressTool.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property StressTool.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property StressTool.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property StressTool.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property StressTool.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property StressTool.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property StressTool.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property StressTool.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

StressTool.EvaluateAllResults() → System.Void: Run the EvaluateAllResults action.

StressTool.AddStressRatio() → Ansys.ACT.Automation.Mechanical.Results.StressToolResults.StressRatio: Creates a new StressRatio

StressTool.AddSafetyFactor() → Ansys.ACT.Automation.Mechanical.Results.StressToolResults.StressSafetyFactor: Creates a new StressSafetyFactor

StressTool.AddSafetyMargin() → Ansys.ACT.Automation.Mechanical.Results.StressToolResults.StressSafetyMargin: Creates a new StressSafetyMargin

StressTool.Delete() → System.Void: Run the Delete action.

StressTool.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

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

StressTool.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

StressTool.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

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

StressTool.Activate() → System.Void: Activate the current object.

StressTool.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

StressTool.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

StressTool.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

StressTool.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

StressTool.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

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

StressTool.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

StressTool.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

StressTool.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.