StressProbe

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

Bases: object

Defines a StressProbe.

Overview

Methods

ExportAnimation	Run the ExportAnimation action.
ClearGeneratedData	Run the ClearGeneratedData action.
DuplicateWithoutResults	Run the DuplicateWithoutResults action.
EvaluateAllResults	Run the EvaluateAllResults action.
SnapToMeshNodes	Snap the coordinates of probe result to the mesh nodes.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.
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.
EquivalentStress	Gets the EquivalentStress.
XCoordinate	Gets the XCoordinate.
YCoordinate	Gets the YCoordinate.
ZCoordinate	Gets the ZCoordinate.
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.
MaximumXYShearStress	Gets the MaximumXYShearStress.
MaximumXZShearStress	Gets the MaximumXZShearStress.
MaximumYZShearStress	Gets the MaximumYZShearStress.
MaximumStressIntensity	Gets the MaximumStressIntensity.
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.
MinimumXYShearStress	Gets the MinimumXYShearStress.
MinimumXZShearStress	Gets the MinimumXZShearStress.
MinimumYZShearStress	Gets the MinimumYZShearStress.
MinimumStressIntensity	Gets the MinimumStressIntensity.
NormalXAxisStress	Gets the NormalXAxisStress.
NormalYAxisStress	Gets the NormalYAxisStress.
NormalZAxisStress	Gets the NormalZAxisStress.
XYShearStress	Gets the XYShearStress.
XZShearStress	Gets the XZShearStress.
YZShearStress	Gets the YZShearStress.
StressIntensity	Gets the StressIntensity.
DataModelObjectCategory	Gets the current DataModelObject’s category.
Summation	Gets or sets the Summation.
LocationMethod	Gets or sets the LocationMethod.
GeometryLocation	Gets or sets the GeometryLocation.
CoordinateSystemSelection	Gets or sets the CoordinateSystemSelection.
BoundaryConditionSelection	Gets or sets the BoundaryConditionSelection. In order to select the option ‘WeakSprings’, please use the property ‘LocationMethod = LocationDefinitionMethod.WeakSprings’.
ContactRegionSelection	Gets or sets the ContactRegionSelection.
RemotePointSelection	Gets or sets the RemotePointSelection.
BeamSelection	Gets or sets the BeamSelection.
MeshConnectionSelection	Gets or sets the MeshConnectionSelection.
SurfaceSelection	Gets or sets the MeshConnectionSelection.
SpringSelection	Gets or sets the SpringSelection.
IsSolved	Gets the IsSolved.
Orientation	Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.
IterationNumber	Gets the IterationNumber.
LoadStep	Gets the LoadStep.
LoadStepNumber	Gets or sets the LoadStepNumber.
Substep	Gets the Substep.
DisplayTime	Gets or sets the DisplayTime.
MaximumTotal	Gets the MaximumTotal.
MaximumXAxis	Gets the MaximumXAxis.
MaximumYAxis	Gets the MaximumYAxis.
MaximumZAxis	Gets the MaximumZAxis.
MinimumTotal	Gets the MinimumTotal.
MinimumXAxis	Gets the MinimumXAxis.
MinimumYAxis	Gets the MinimumYAxis.
MinimumZAxis	Gets the MinimumZAxis.
Time	Gets the Time.
Total	Gets the Total.
XAxis	Gets the XAxis.
YAxis	Gets the YAxis.
ZAxis	Gets the ZAxis.
ResultSelection	Gets or sets the ResultSelection.
SpatialResolution	Gets or sets the SpatialResolution.
Type	Gets the Type.
DpfEvaluation	Gets or sets the DpfEvaluation.
Suppressed	Gets or sets the Suppressed.
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 StressProbe.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None

Gets the internal object. For advanced usage only.

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

Gets the EquivalentStress.

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

Gets the XCoordinate.

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

Gets the YCoordinate.

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

Gets the ZCoordinate.

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.MaximumXYShearStress: Ansys.Core.Units.Quantity | None

Gets the MaximumXYShearStress.

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

Gets the MaximumXZShearStress.

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

Gets the MaximumYZShearStress.

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

Gets the MaximumStressIntensity.

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.MinimumXYShearStress: Ansys.Core.Units.Quantity | None

Gets the MinimumXYShearStress.

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

Gets the MinimumXZShearStress.

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

Gets the MinimumYZShearStress.

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

Gets the MinimumStressIntensity.

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.XYShearStress: Ansys.Core.Units.Quantity | None

Gets the XYShearStress.

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

Gets the XZShearStress.

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

Gets the YZShearStress.

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

Gets the StressIntensity.

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

Gets the current DataModelObject’s category.

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

Gets or sets the Summation.

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

Gets or sets the LocationMethod.

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

Gets or sets the GeometryLocation.

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

Gets or sets the CoordinateSystemSelection.

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.ContactRegionSelection: Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None

Gets or sets the ContactRegionSelection.

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

Gets or sets the RemotePointSelection.

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

Gets or sets the BeamSelection.

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

Gets or sets the MeshConnectionSelection.

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

Gets or sets the MeshConnectionSelection.

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

Gets or sets the SpringSelection.

property StressProbe.IsSolved: System.Boolean | None

Gets the IsSolved.

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.IterationNumber: System.Int32 | None

Gets the IterationNumber.

property StressProbe.LoadStep: System.Int32 | None

Gets the LoadStep.

property StressProbe.LoadStepNumber: System.UInt32 | None

Gets or sets the LoadStepNumber.

property StressProbe.Substep: System.Int32 | None

Gets the Substep.

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

Gets or sets the DisplayTime.

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

Gets the MaximumTotal.

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

Gets the MaximumXAxis.

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

Gets the MaximumYAxis.

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

Gets the MaximumZAxis.

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

Gets the MinimumTotal.

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

Gets the MinimumXAxis.

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

Gets the MinimumYAxis.

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

Gets the MinimumZAxis.

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

Gets the Time.

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

Gets the Total.

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

Gets the XAxis.

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

Gets the YAxis.

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

Gets the ZAxis.

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.Type: Ansys.Mechanical.DataModel.Enums.ProbeResultType | None

Gets the Type.

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

Gets or sets the DpfEvaluation.

property StressProbe.Suppressed: System.Boolean | None

Gets or sets the Suppressed.

property StressProbe.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property StressProbe.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property StressProbe.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property StressProbe.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property StressProbe.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

property StressProbe.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property StressProbe.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail

StressProbe.ExportAnimation(filePath: System.String, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) → System.Void

Run the ExportAnimation action.

StressProbe.ClearGeneratedData() → System.Void

Run the ClearGeneratedData action.

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

Run the DuplicateWithoutResults action.

StressProbe.EvaluateAllResults() → System.Void

Run the EvaluateAllResults action.

StressProbe.SnapToMeshNodes() → System.Void

Snap the coordinates of probe result to the mesh nodes.

StressProbe.RenameBasedOnDefinition() → System.Void

Run the RenameBasedOnDefinition action.

StressProbe.Delete() → System.Void

Run the Delete action.

StressProbe.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]

Gets the list of children, filtered by type.

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

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

StressProbe.Activate() → System.Void

Activate the current object.

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

Copies all visible properties from this object to another.

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

Creates a copy of the current DataModelObject.

StressProbe.GroupAllSimilarChildren() → System.Void

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

Get a property by its unique name.

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

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

Creates a new parameter for a Property.

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

Gets the parameter corresponding to the given property.

StressProbe.RemoveParameter(propName: System.String) → System.Void

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