StressTool

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

Bases: object

Defines a StressTool.

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.
AddSafetyFactor	Creates a new StressSafetyFactor
AddSafetyMargin	Creates a new StressSafetyMargin
AddStressRatio	Creates a new StressRatio
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.
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.
CompressiveLimit	Gets or sets the CompressiveLimit.
CompressiveLimitType	Gets or sets the CompressiveLimitType.
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.
LimitFactor	Gets or sets the LimitFactor.
Properties	Gets the list of properties for this object.
StressLimit	Gets or sets the StressLimit.
StressLimitType	Gets or sets the StressLimitType.
TensileLimit	Gets or sets the TensileLimit.
TensileLimitType	Gets or sets the TensileLimitType.
Theory	Gets or sets the Theory.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

property StressTool.CompressiveLimit: Ansys.Core.Units.Quantity | None

Gets or sets the CompressiveLimit.

property StressTool.CompressiveLimitType: Ansys.Mechanical.DataModel.Enums.SafetyLimitType | None

Gets or sets the CompressiveLimitType.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property StressTool.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSStressSafetyToolAuto | None

Gets the internal object. For advanced usage only.

property StressTool.LimitFactor: float | None

Gets or sets the LimitFactor.

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

Gets the list of properties for this object.

property StressTool.StressLimit: Ansys.Core.Units.Quantity | None

Gets or sets the StressLimit.

property StressTool.StressLimitType: Ansys.Mechanical.DataModel.Enums.SafetyLimitType | None

Gets or sets the StressLimitType.

property StressTool.TensileLimit: Ansys.Core.Units.Quantity | None

Gets or sets the TensileLimit.

property StressTool.TensileLimitType: Ansys.Mechanical.DataModel.Enums.SafetyLimitType | None

Gets or sets the TensileLimitType.

property StressTool.Theory: Ansys.Mechanical.DataModel.Enums.SafetyTheoryType | None

Gets or sets the Theory.

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

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

Method detail

StressTool.Activate() → None

Activate the current object.

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

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.AddStressRatio() → Ansys.ACT.Automation.Mechanical.Results.StressToolResults.StressRatio

Creates a new StressRatio

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

StressTool.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

StressTool.EvaluateAllResults() → None

Run the EvaluateAllResults action.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

StressTool.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

StressTool.RemoveParameter(propName: str) → None

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