Skip to main content

Mechanical scripting interface

DeformationProbe

Last update: 14.01.2025

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

Bases: object

Defines a DeformationProbe.

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.
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.
MaximumTotal Gets the MaximumTotal.
MaximumTotalDeformation Gets the MaximumTotalDeformation.
MaximumXAxis Gets the MaximumXAxis.
MaximumXAxisDeformation Gets the MaximumXAxisDeformation.
MaximumYAxis Gets the MaximumYAxis.
MaximumYAxisDeformation Gets the MaximumYAxisDeformation.
MaximumZAxis Gets the MaximumZAxis.
MaximumZAxisDeformation Gets the MaximumZAxisDeformation.
MeshConnectionSelection Gets or sets the MeshConnectionSelection.
MinimumTotal Gets the MinimumTotal.
MinimumTotalDeformation Gets the MinimumTotalDeformation.
MinimumXAxis Gets the MinimumXAxis.
MinimumXAxisDeformation Gets the MinimumXAxisDeformation.
MinimumYAxis Gets the MinimumYAxis.
MinimumYAxisDeformation Gets the MinimumYAxisDeformation.
MinimumZAxis Gets the MinimumZAxis.
MinimumZAxisDeformation Gets the MinimumZAxisDeformation.
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.
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.
TotalDeformation Gets the TotalDeformation.
Type Gets the Type.
VisibleProperties Gets the list of properties that are visible for this object.
XAxis Gets the XAxis.
XAxisDeformation Gets the XAxisDeformation.
XCoordinate Gets the XCoordinate.
YAxis Gets the YAxis.
YAxisDeformation Gets the YAxisDeformation.
YCoordinate Gets the YCoordinate.
ZAxis Gets the ZAxis.
ZAxisDeformation Gets the ZAxisDeformation.
ZCoordinate Gets the ZCoordinate.

Property detail

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

Gets or sets the BeamSelection.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the ContactRegionSelection.

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

Gets or sets the CoordinateSystemSelection.

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

Gets the current DataModelObject’s category.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

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

Gets the list of associated figures.

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

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property DeformationProbe.IsSolved : bool | None

Gets the IsSolved.

property DeformationProbe.IterationNumber : int | None

Gets the IterationNumber.

property DeformationProbe.LoadStep : int | None

Gets the LoadStep.

property DeformationProbe.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the LocationMethod.

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

Gets the MaximumTotal.

property DeformationProbe.MaximumTotalDeformation : Ansys.Core.Units.Quantity | None

Gets the MaximumTotalDeformation.

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

Gets the MaximumXAxis.

property DeformationProbe.MaximumXAxisDeformation : Ansys.Core.Units.Quantity | None

Gets the MaximumXAxisDeformation.

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

Gets the MaximumYAxis.

property DeformationProbe.MaximumYAxisDeformation : Ansys.Core.Units.Quantity | None

Gets the MaximumYAxisDeformation.

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

Gets the MaximumZAxis.

property DeformationProbe.MaximumZAxisDeformation : Ansys.Core.Units.Quantity | None

Gets the MaximumZAxisDeformation.

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

Gets or sets the MeshConnectionSelection.

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

Gets the MinimumTotal.

property DeformationProbe.MinimumTotalDeformation : Ansys.Core.Units.Quantity | None

Gets the MinimumTotalDeformation.

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

Gets the MinimumXAxis.

property DeformationProbe.MinimumXAxisDeformation : Ansys.Core.Units.Quantity | None

Gets the MinimumXAxisDeformation.

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

Gets the MinimumYAxis.

property DeformationProbe.MinimumYAxisDeformation : Ansys.Core.Units.Quantity | None

Gets the MinimumYAxisDeformation.

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

Gets the MinimumZAxis.

property DeformationProbe.MinimumZAxisDeformation : Ansys.Core.Units.Quantity | None

Gets the MinimumZAxisDeformation.

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

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

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

Gets the list of properties for this object.

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

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

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

Gets or sets the RemotePointSelection.

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

Gets or sets the ResultSelection.

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

Gets or sets the SpatialResolution.

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

Gets or sets the SpringSelection.

property DeformationProbe.Substep : int | None

Gets the Substep.

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

Gets or sets the Summation.

property DeformationProbe.Suppressed : bool | None

Gets or sets the Suppressed.

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

Gets or sets the MeshConnectionSelection.

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

Gets the Time.

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

Gets the Total.

property DeformationProbe.TotalDeformation : Ansys.Core.Units.Quantity | None

Gets the TotalDeformation.

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

Gets the Type.

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

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

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

Gets the XAxis.

property DeformationProbe.XAxisDeformation : Ansys.Core.Units.Quantity | None

Gets the XAxisDeformation.

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

Gets the XCoordinate.

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

Gets the YAxis.

property DeformationProbe.YAxisDeformation : Ansys.Core.Units.Quantity | None

Gets the YAxisDeformation.

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

Gets the YCoordinate.

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

Gets the ZAxis.

property DeformationProbe.ZAxisDeformation : Ansys.Core.Units.Quantity | None

Gets the ZAxisDeformation.

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

Gets the ZCoordinate.

Method detail

DeformationProbe.Activate()

Activate the current object.

DeformationProbe.AddComment()

Creates a new child Comment.

DeformationProbe.AddFigure()

Creates a new child Figure.

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

DeformationProbe.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

DeformationProbe.CreateParameter(propName: str)

Creates a new parameter for a Property.

DeformationProbe.Delete()

Run the Delete action.

DeformationProbe.Duplicate()

Creates a copy of the current DataModelObject.

DeformationProbe.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

DeformationProbe.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

DeformationProbe.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

DeformationProbe.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

DeformationProbe.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

DeformationProbe.PropertyByName(name: str)

Get a property by its unique name.

DeformationProbe.RemoveParameter(propName: str)

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

DeformationProbe.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

DeformationProbe.SnapToMeshNodes()

Snap the coordinates of probe result to the mesh nodes.