Skip to main content

Mechanical scripting interface

StrainProbe

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Results.ProbeResults.StrainProbe

Bases: object

Defines a StrainProbe.

Overview

Methods

Name Description
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

Name Description
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.
EquivalentStrain Gets the EquivalentStrain.
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.
MaximumEquivalentStrain Gets the MaximumEquivalentStrain.
MaximumMaximumPrincipalStrain Gets the MaximumMaximumPrincipalStrain.
MaximumMiddlePrincipalStrain Gets the MaximumMiddlePrincipalStrain.
MaximumMinimumPrincipalStrain Gets the MaximumMinimumPrincipalStrain.
MaximumNormalXAxisStrain Gets the MaximumNormalXAxisStrain.
MaximumNormalYAxisStrain Gets the MaximumNormalYAxisStrain.
MaximumNormalZAxisStrain Gets the MaximumNormalZAxisStrain.
MaximumPrincipalStrain Gets the MaximumPrincipalStrain.
MaximumStrainIntensity Gets the MaximumStrainIntensity.
MaximumTotal Gets the MaximumTotal.
MaximumXAxis Gets the MaximumXAxis.
MaximumXYShearStrain Gets the MaximumXYShearStrain.
MaximumXZShearStrain Gets the MaximumXZShearStrain.
MaximumYAxis Gets the MaximumYAxis.
MaximumYZShearStrain Gets the MaximumYZShearStrain.
MaximumZAxis Gets the MaximumZAxis.
MeshConnectionSelection Gets or sets the MeshConnectionSelection.
MiddlePrincipalStrain Gets the MiddlePrincipalStrain.
MinimumEquivalentStrain Gets the MinimumEquivalentStrain.
MinimumMiddlePrincipalStrain Gets the MinimumMiddlePrincipalStrain.
MinimumMinimumPrincipalStrain Gets the MinimumMinimumPrincipalStrain.
MinimumNormalXAxisStrain Gets the MinimumNormalXAxisStrain.
MinimumNormalYAxisStrain Gets the MinimumNormalYAxisStrain.
MinimumNormalZAxisStrain Gets the MinimumNormalZAxisStrain.
MinimumPrincipalStrain Gets the MinimumPrincipalStrain.
MinimumStrain Gets the MinimumStrain.
MinimumStrainIntensity Gets the MinimumStrainIntensity.
MinimumStrainMaximumPrincipal Gets the MinimumStrainMaximumPrincipal.
MinimumTotal Gets the MinimumTotal.
MinimumXAxis Gets the MinimumXAxis.
MinimumXYShearStrain Gets the MinimumXYShearStrain.
MinimumXZShearStrain Gets the MinimumXZShearStrain.
MinimumYAxis Gets the MinimumYAxis.
MinimumYZShearStrain Gets the MinimumYZShearStrain.
MinimumZAxis Gets the MinimumZAxis.
NormalXAxisStrain Gets the NormalXAxisStrain.
NormalYAxisStrain Gets the NormalYAxisStrain.
NormalZAxisStrain Gets the NormalZAxisStrain.
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.
RPMSelection Gets or sets the RPM Selection value at which the results are evaluated.
RemotePointSelection Gets or sets the RemotePointSelection.
ResultSelection Gets or sets the ResultSelection.
SpatialResolution Gets or sets the SpatialResolution.
SpringSelection Gets or sets the SpringSelection.
Strain Gets the Strain.
StrainIntensity Gets the StrainIntensity.
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.
XYShearStrain Gets the XYShearStrain.
XZShearStrain Gets the XZShearStrain.
YAxis Gets the YAxis.
YZShearStrain Gets the YZShearStrain.
ZAxis Gets the ZAxis.

Property detail

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

Gets or sets the BeamSelection.

property StrainProbe.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 StrainProbe.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the ContactRegionSelection.

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

Gets or sets the CoordinateSystemSelection.

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

Gets the current DataModelObject’s category.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

property StrainProbe.EquivalentStrain : Ansys.Core.Units.Quantity | None

Gets the EquivalentStrain.

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

Gets the list of associated figures.

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

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property StrainProbe.IsSolved : bool | None

Gets the IsSolved.

property StrainProbe.IterationNumber : int | None

Gets the IterationNumber.

property StrainProbe.LoadStep : int | None

Gets the LoadStep.

property StrainProbe.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the LocationMethod.

property StrainProbe.MaximumEquivalentStrain : Ansys.Core.Units.Quantity | None

Gets the MaximumEquivalentStrain.

property StrainProbe.MaximumMaximumPrincipalStrain : Ansys.Core.Units.Quantity | None

Gets the MaximumMaximumPrincipalStrain.

property StrainProbe.MaximumMiddlePrincipalStrain : Ansys.Core.Units.Quantity | None

Gets the MaximumMiddlePrincipalStrain.

property StrainProbe.MaximumMinimumPrincipalStrain : Ansys.Core.Units.Quantity | None

Gets the MaximumMinimumPrincipalStrain.

property StrainProbe.MaximumNormalXAxisStrain : Ansys.Core.Units.Quantity | None

Gets the MaximumNormalXAxisStrain.

property StrainProbe.MaximumNormalYAxisStrain : Ansys.Core.Units.Quantity | None

Gets the MaximumNormalYAxisStrain.

property StrainProbe.MaximumNormalZAxisStrain : Ansys.Core.Units.Quantity | None

Gets the MaximumNormalZAxisStrain.

property StrainProbe.MaximumPrincipalStrain : Ansys.Core.Units.Quantity | None

Gets the MaximumPrincipalStrain.

property StrainProbe.MaximumStrainIntensity : Ansys.Core.Units.Quantity | None

Gets the MaximumStrainIntensity.

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

Gets the MaximumTotal.

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

Gets the MaximumXAxis.

property StrainProbe.MaximumXYShearStrain : Ansys.Core.Units.Quantity | None

Gets the MaximumXYShearStrain.

property StrainProbe.MaximumXZShearStrain : Ansys.Core.Units.Quantity | None

Gets the MaximumXZShearStrain.

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

Gets the MaximumYAxis.

property StrainProbe.MaximumYZShearStrain : Ansys.Core.Units.Quantity | None

Gets the MaximumYZShearStrain.

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

Gets the MaximumZAxis.

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

Gets or sets the MeshConnectionSelection.

property StrainProbe.MiddlePrincipalStrain : Ansys.Core.Units.Quantity | None

Gets the MiddlePrincipalStrain.

property StrainProbe.MinimumEquivalentStrain : Ansys.Core.Units.Quantity | None

Gets the MinimumEquivalentStrain.

property StrainProbe.MinimumMiddlePrincipalStrain : Ansys.Core.Units.Quantity | None

Gets the MinimumMiddlePrincipalStrain.

property StrainProbe.MinimumMinimumPrincipalStrain : Ansys.Core.Units.Quantity | None

Gets the MinimumMinimumPrincipalStrain.

property StrainProbe.MinimumNormalXAxisStrain : Ansys.Core.Units.Quantity | None

Gets the MinimumNormalXAxisStrain.

property StrainProbe.MinimumNormalYAxisStrain : Ansys.Core.Units.Quantity | None

Gets the MinimumNormalYAxisStrain.

property StrainProbe.MinimumNormalZAxisStrain : Ansys.Core.Units.Quantity | None

Gets the MinimumNormalZAxisStrain.

property StrainProbe.MinimumPrincipalStrain : Ansys.Core.Units.Quantity | None

Gets the MinimumPrincipalStrain.

property StrainProbe.MinimumStrain : Ansys.Core.Units.Quantity | None

Gets the MinimumStrain.

property StrainProbe.MinimumStrainIntensity : Ansys.Core.Units.Quantity | None

Gets the MinimumStrainIntensity.

property StrainProbe.MinimumStrainMaximumPrincipal : Ansys.Core.Units.Quantity | None

Gets the MinimumStrainMaximumPrincipal.

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

Gets the MinimumTotal.

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

Gets the MinimumXAxis.

property StrainProbe.MinimumXYShearStrain : Ansys.Core.Units.Quantity | None

Gets the MinimumXYShearStrain.

property StrainProbe.MinimumXZShearStrain : Ansys.Core.Units.Quantity | None

Gets the MinimumXZShearStrain.

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

Gets the MinimumYAxis.

property StrainProbe.MinimumYZShearStrain : Ansys.Core.Units.Quantity | None

Gets the MinimumYZShearStrain.

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

Gets the MinimumZAxis.

property StrainProbe.NormalXAxisStrain : Ansys.Core.Units.Quantity | None

Gets the NormalXAxisStrain.

property StrainProbe.NormalYAxisStrain : Ansys.Core.Units.Quantity | None

Gets the NormalYAxisStrain.

property StrainProbe.NormalZAxisStrain : Ansys.Core.Units.Quantity | None

Gets the NormalZAxisStrain.

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

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

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

Gets the list of properties for this object.

property StrainProbe.RPMSelection : Ansys.Core.Units.Quantity | None

Gets or sets the RPM Selection value at which the results are evaluated.

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

Gets or sets the RemotePointSelection.

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

Gets or sets the ResultSelection.

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

Gets or sets the SpatialResolution.

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

Gets or sets the SpringSelection.

property StrainProbe.Strain : Ansys.Core.Units.Quantity | None

Gets the Strain.

property StrainProbe.StrainIntensity : Ansys.Core.Units.Quantity | None

Gets the StrainIntensity.

property StrainProbe.Substep : int | None

Gets the Substep.

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

Gets or sets the Summation.

property StrainProbe.Suppressed : bool | None

Gets or sets the Suppressed.

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

Gets or sets the MeshConnectionSelection.

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

Gets the Time.

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

Gets the Total.

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

Gets the Type.

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

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

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

Gets the XAxis.

property StrainProbe.XYShearStrain : Ansys.Core.Units.Quantity | None

Gets the XYShearStrain.

property StrainProbe.XZShearStrain : Ansys.Core.Units.Quantity | None

Gets the XZShearStrain.

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

Gets the YAxis.

property StrainProbe.YZShearStrain : Ansys.Core.Units.Quantity | None

Gets the YZShearStrain.

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

Gets the ZAxis.

Method detail

StrainProbe.Activate()

Activate the current object.

StrainProbe.AddComment()

Creates a new child Comment.

StrainProbe.AddFigure()

Creates a new child Figure.

StrainProbe.AddImage(filePath: str)

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.

StrainProbe.ClearGeneratedData()

Run the ClearGeneratedData action.

StrainProbe.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

StrainProbe.CreateParameter(propName: str)

Creates a new parameter for a Property.

StrainProbe.Delete()

Run the Delete action.

StrainProbe.Duplicate()

Creates a copy of the current DataModelObject.

StrainProbe.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

StrainProbe.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

StrainProbe.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

StrainProbe.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

StrainProbe.GroupSimilarObjects()

Run the GroupSimilarObjects action.

StrainProbe.PropertyByAPIName(name: str)

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.

StrainProbe.PropertyByName(name: str)

Get a property by its unique name.

StrainProbe.RemoveParameter(propName: str)

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

StrainProbe.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

StrainProbe.SnapToMeshNodes()

Snap the coordinates of probe result to the mesh nodes.