StressProbe

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Results.ProbeResults.StressProbe

Bases: object

Defines a StressProbe.

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.
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.
DuplicateWithoutResults	Run the DuplicateWithoutResults action.
EvaluateAllResults	Run the EvaluateAllResults action.
ExportAnimation	Run the ExportAnimation 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.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.
SnapToMeshNodes	Snap the coordinates of probe result to the mesh nodes.

Properties

BeamSelection	Gets or sets the BeamSelection.
BoundaryConditionSelection	Gets or sets the BoundaryConditionSelection. In order to select the option 'WeakSprings', please use the property 'LocationMethod = LocationDefinitionMethod.WeakSprings'.
Children	Gets the list of children.
Comments	Gets the list of associated comments.
ContactRegionSelection	Gets or sets the ContactRegionSelection.
CoordinateSystemSelection	Gets or sets the CoordinateSystemSelection.
DataModelObjectCategory	Gets the current DataModelObject's category.
DisplayTime	Gets or sets the DisplayTime.
DpfEvaluation	Gets or sets the DpfEvaluation.
EquivalentStress	Gets the EquivalentStress.
Figures	Gets the list of associated figures.
GeometryLocation	Gets or sets the GeometryLocation.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
IsSolved	Gets the IsSolved.
IterationNumber	Gets the IterationNumber.
LoadStep	Gets the LoadStep.
LoadStepNumber	Gets or sets the LoadStepNumber.
LocationMethod	Gets or sets the LocationMethod.
MaximumEquivalentStress	Gets the MaximumEquivalentStress.
MaximumMaximumPrincipalStress	Gets the MaximumMaximumPrincipalStress.
MaximumMiddlePrincipalStress	Gets the MaximumMiddlePrincipalStress.
MaximumMinimumPrincipalStress	Gets the MaximumMinimumPrincipalStress.
MaximumNormalXAxisStress	Gets the MaximumNormalXAxisStress.
MaximumNormalYAxisStress	Gets the MaximumNormalYAxisStress.
MaximumNormalZAxisStress	Gets the MaximumNormalZAxisStress.
MaximumPrincipalStress	Gets the MaximumPrincipalStress.
MaximumStressIntensity	Gets the MaximumStressIntensity.
MaximumTotal	Gets the MaximumTotal.
MaximumXAxis	Gets the MaximumXAxis.
MaximumXYShearStress	Gets the MaximumXYShearStress.
MaximumXZShearStress	Gets the MaximumXZShearStress.
MaximumYAxis	Gets the MaximumYAxis.
MaximumYZShearStress	Gets the MaximumYZShearStress.
MaximumZAxis	Gets the MaximumZAxis.
MeshConnectionSelection	Gets or sets the MeshConnectionSelection.
MiddlePrincipalStress	Gets the MiddlePrincipalStress.
MinimumEquivalentStress	Gets the MinimumEquivalentStress.
MinimumMaximumPrincipalStress	Gets the MinimumMaximumPrincipalStress.
MinimumMiddlePrincipalStress	Gets the MinimumMiddlePrincipalStress.
MinimumMinimumPrincipalStress	Gets the MinimumMinimumPrincipalStress.
MinimumNormalXAxisStress	Gets the MinimumNormalXAxisStress.
MinimumNormalYAxisStress	Gets the MinimumNormalYAxisStress.
MinimumNormalZAxisStress	Gets the MinimumNormalZAxisStress.
MinimumPrincipalStress	Gets the MinimumPrincipalStress.
MinimumStressIntensity	Gets the MinimumStressIntensity.
MinimumTotal	Gets the MinimumTotal.
MinimumXAxis	Gets the MinimumXAxis.
MinimumXYShearStress	Gets the MinimumXYShearStress.
MinimumXZShearStress	Gets the MinimumXZShearStress.
MinimumYAxis	Gets the MinimumYAxis.
MinimumYZShearStress	Gets the MinimumYZShearStress.
MinimumZAxis	Gets the MinimumZAxis.
NormalXAxisStress	Gets the NormalXAxisStress.
NormalYAxisStress	Gets the NormalYAxisStress.
NormalZAxisStress	Gets the NormalZAxisStress.
Orientation	Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.
Properties	Gets the list of properties for this object.
RemotePointSelection	Gets or sets the RemotePointSelection.
ResultSelection	Gets or sets the ResultSelection.
SpatialResolution	Gets or sets the SpatialResolution.
SpringSelection	Gets or sets the SpringSelection.
StressIntensity	Gets the StressIntensity.
Substep	Gets the Substep.
Summation	Gets or sets the Summation.
Suppressed	Gets or sets the Suppressed.
SurfaceSelection	Gets or sets the MeshConnectionSelection.
Time	Gets the Time.
Total	Gets the Total.
Type	Gets the Type.
VisibleProperties	Gets the list of properties that are visible for this object.
XAxis	Gets the XAxis.
XCoordinate	Gets the XCoordinate.
XYShearStress	Gets the XYShearStress.
XZShearStress	Gets the XZShearStress.
YAxis	Gets the YAxis.
YCoordinate	Gets the YCoordinate.
YZShearStress	Gets the YZShearStress.
ZAxis	Gets the ZAxis.
ZCoordinate	Gets the ZCoordinate.

Property detail

property StressProbe.BeamSelection: Ansys.ACT.Automation.Mechanical.Connections.Beam | None

Gets or sets the BeamSelection.

property StressProbe.BoundaryConditionSelection: Ansys.ACT.Automation.Mechanical.DataModelObject | None

Gets or sets the BoundaryConditionSelection. In order to select the option 'WeakSprings', please use the property 'LocationMethod = LocationDefinitionMethod.WeakSprings'.

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

Gets the list of children.

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

Gets the list of associated comments.

property StressProbe.ContactRegionSelection: Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None

Gets or sets the ContactRegionSelection.

property StressProbe.CoordinateSystemSelection: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystemSelection.

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

Gets the current DataModelObject's category.

property StressProbe.DisplayTime: Ansys.Core.Units.Quantity | None

Gets or sets the DisplayTime.

property StressProbe.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None

Gets or sets the DpfEvaluation.

property StressProbe.EquivalentStress: Ansys.Core.Units.Quantity | None

Gets the EquivalentStress.

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

Gets the list of associated figures.

property StressProbe.GeometryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

property StressProbe.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None

Gets the internal object. For advanced usage only.

property StressProbe.IsSolved: bool | None

Gets the IsSolved.

property StressProbe.IterationNumber: int | None

Gets the IterationNumber.

property StressProbe.LoadStep: int | None

Gets the LoadStep.

property StressProbe.LoadStepNumber: int | None

Gets or sets the LoadStepNumber.

property StressProbe.LocationMethod: Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None

Gets or sets the LocationMethod.

property StressProbe.MaximumEquivalentStress: Ansys.Core.Units.Quantity | None

Gets the MaximumEquivalentStress.

property StressProbe.MaximumMaximumPrincipalStress: Ansys.Core.Units.Quantity | None

Gets the MaximumMaximumPrincipalStress.

property StressProbe.MaximumMiddlePrincipalStress: Ansys.Core.Units.Quantity | None

Gets the MaximumMiddlePrincipalStress.

property StressProbe.MaximumMinimumPrincipalStress: Ansys.Core.Units.Quantity | None

Gets the MaximumMinimumPrincipalStress.

property StressProbe.MaximumNormalXAxisStress: Ansys.Core.Units.Quantity | None

Gets the MaximumNormalXAxisStress.

property StressProbe.MaximumNormalYAxisStress: Ansys.Core.Units.Quantity | None

Gets the MaximumNormalYAxisStress.

property StressProbe.MaximumNormalZAxisStress: Ansys.Core.Units.Quantity | None

Gets the MaximumNormalZAxisStress.

property StressProbe.MaximumPrincipalStress: Ansys.Core.Units.Quantity | None

Gets the MaximumPrincipalStress.

property StressProbe.MaximumStressIntensity: Ansys.Core.Units.Quantity | None

Gets the MaximumStressIntensity.

property StressProbe.MaximumTotal: Ansys.Core.Units.Quantity | None

Gets the MaximumTotal.

property StressProbe.MaximumXAxis: Ansys.Core.Units.Quantity | None

Gets the MaximumXAxis.

property StressProbe.MaximumXYShearStress: Ansys.Core.Units.Quantity | None

Gets the MaximumXYShearStress.

property StressProbe.MaximumXZShearStress: Ansys.Core.Units.Quantity | None

Gets the MaximumXZShearStress.

property StressProbe.MaximumYAxis: Ansys.Core.Units.Quantity | None

Gets the MaximumYAxis.

property StressProbe.MaximumYZShearStress: Ansys.Core.Units.Quantity | None

Gets the MaximumYZShearStress.

property StressProbe.MaximumZAxis: Ansys.Core.Units.Quantity | None

Gets the MaximumZAxis.

property StressProbe.MeshConnectionSelection: Ansys.ACT.Automation.Mechanical.MeshConnection | None

Gets or sets the MeshConnectionSelection.

property StressProbe.MiddlePrincipalStress: Ansys.Core.Units.Quantity | None

Gets the MiddlePrincipalStress.

property StressProbe.MinimumEquivalentStress: Ansys.Core.Units.Quantity | None

Gets the MinimumEquivalentStress.

property StressProbe.MinimumMaximumPrincipalStress: Ansys.Core.Units.Quantity | None

Gets the MinimumMaximumPrincipalStress.

property StressProbe.MinimumMiddlePrincipalStress: Ansys.Core.Units.Quantity | None

Gets the MinimumMiddlePrincipalStress.

property StressProbe.MinimumMinimumPrincipalStress: Ansys.Core.Units.Quantity | None

Gets the MinimumMinimumPrincipalStress.

property StressProbe.MinimumNormalXAxisStress: Ansys.Core.Units.Quantity | None

Gets the MinimumNormalXAxisStress.

property StressProbe.MinimumNormalYAxisStress: Ansys.Core.Units.Quantity | None

Gets the MinimumNormalYAxisStress.

property StressProbe.MinimumNormalZAxisStress: Ansys.Core.Units.Quantity | None

Gets the MinimumNormalZAxisStress.

property StressProbe.MinimumPrincipalStress: Ansys.Core.Units.Quantity | None

Gets the MinimumPrincipalStress.

property StressProbe.MinimumStressIntensity: Ansys.Core.Units.Quantity | None

Gets the MinimumStressIntensity.

property StressProbe.MinimumTotal: Ansys.Core.Units.Quantity | None

Gets the MinimumTotal.

property StressProbe.MinimumXAxis: Ansys.Core.Units.Quantity | None

Gets the MinimumXAxis.

property StressProbe.MinimumXYShearStress: Ansys.Core.Units.Quantity | None

Gets the MinimumXYShearStress.

property StressProbe.MinimumXZShearStress: Ansys.Core.Units.Quantity | None

Gets the MinimumXZShearStress.

property StressProbe.MinimumYAxis: Ansys.Core.Units.Quantity | None

Gets the MinimumYAxis.

property StressProbe.MinimumYZShearStress: Ansys.Core.Units.Quantity | None

Gets the MinimumYZShearStress.

property StressProbe.MinimumZAxis: Ansys.Core.Units.Quantity | None

Gets the MinimumZAxis.

property StressProbe.NormalXAxisStress: Ansys.Core.Units.Quantity | None

Gets the NormalXAxisStress.

property StressProbe.NormalYAxisStress: Ansys.Core.Units.Quantity | None

Gets the NormalYAxisStress.

property StressProbe.NormalZAxisStress: Ansys.Core.Units.Quantity | None

Gets the NormalZAxisStress.

property StressProbe.Orientation: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.

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

Gets the list of properties for this object.

property StressProbe.RemotePointSelection: Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets or sets the RemotePointSelection.

property StressProbe.ResultSelection: Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter | None

Gets or sets the ResultSelection.

property StressProbe.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None

Gets or sets the SpatialResolution.

property StressProbe.SpringSelection: Ansys.ACT.Automation.Mechanical.Connections.Spring | None

Gets or sets the SpringSelection.

property StressProbe.StressIntensity: Ansys.Core.Units.Quantity | None

Gets the StressIntensity.

property StressProbe.Substep: int | None

Gets the Substep.

property StressProbe.Summation: Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None

Gets or sets the Summation.

property StressProbe.Suppressed: bool | None

Gets or sets the Suppressed.

property StressProbe.SurfaceSelection: Ansys.ACT.Automation.Mechanical.Surface | None

Gets or sets the MeshConnectionSelection.

property StressProbe.Time: Ansys.Core.Units.Quantity | None

Gets the Time.

property StressProbe.Total: Ansys.Core.Units.Quantity | None

Gets the Total.

property StressProbe.Type: Ansys.Mechanical.DataModel.Enums.ProbeResultType | None

Gets the Type.

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

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

property StressProbe.XAxis: Ansys.Core.Units.Quantity | None

Gets the XAxis.

property StressProbe.XCoordinate: Ansys.Core.Units.Quantity | None

Gets the XCoordinate.

property StressProbe.XYShearStress: Ansys.Core.Units.Quantity | None

Gets the XYShearStress.

property StressProbe.XZShearStress: Ansys.Core.Units.Quantity | None

Gets the XZShearStress.

property StressProbe.YAxis: Ansys.Core.Units.Quantity | None

Gets the YAxis.

property StressProbe.YCoordinate: Ansys.Core.Units.Quantity | None

Gets the YCoordinate.

property StressProbe.YZShearStress: Ansys.Core.Units.Quantity | None

Gets the YZShearStress.

property StressProbe.ZAxis: Ansys.Core.Units.Quantity | None

Gets the ZAxis.

property StressProbe.ZCoordinate: Ansys.Core.Units.Quantity | None

Gets the ZCoordinate.

Method detail

StressProbe.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

StressProbe.ClearGeneratedData() → None

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

StressProbe.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

StressProbe.DuplicateWithoutResults() → Ansys.ACT.Automation.Mechanical.DataModelObject

Run the DuplicateWithoutResults action.

StressProbe.EvaluateAllResults() → None

Run the EvaluateAllResults action.

StressProbe.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) → None

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

StressProbe.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

StressProbe.RemoveParameter(propName: str) → None

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

StressProbe.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

StressProbe.SnapToMeshNodes() → None

Snap the coordinates of probe result to the mesh nodes.