Skip to main content

Mechanical scripting interface

SpringProbe

Last update: 14.01.2025

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

Bases: object

Defines a BoltPretensionProbe.

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’.
By Gets or sets the By.
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.
DampingForce Gets the DampingForce.
DataModelObjectCategory Gets the current DataModelObject’s category.
DisplayTime Gets or sets the DisplayTime.
DpfEvaluation Gets or sets the DpfEvaluation.
ElasticForce Gets the ElasticForce.
Elongation Gets the Elongation.
Figures Gets the list of associated figures.
Frequency Gets or sets the Frequency.
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.
MaximumDampingForce Gets the MaximumDampingForce.
MaximumElasticForce Gets the MaximumElasticForce.
MaximumElongation Gets the MaximumElongation.
MaximumTotal Gets the MaximumTotal.
MaximumVelocity Gets the MaximumVelocity.
MaximumXAxis Gets the MaximumXAxis.
MaximumYAxis Gets the MaximumYAxis.
MaximumZAxis Gets the MaximumZAxis.
MeshConnectionSelection Gets or sets the MeshConnectionSelection.
MinimumDampingForce Gets the MinimumDampingForce.
MinimumElasticForce Gets the MinimumElasticForce.
MinimumElongation Gets the MinimumElongation.
MinimumTotal Gets the MinimumTotal.
MinimumVelocity Gets the MinimumVelocity.
MinimumXAxis Gets the MinimumXAxis.
MinimumYAxis Gets the MinimumYAxis.
MinimumZAxis Gets the MinimumZAxis.
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.
ScaleFactor Gets or sets the ScaleFactor.
ScaleFactorValue Gets or sets the ScaleFactorValue.
SpatialResolution Gets or sets the SpatialResolution.
Spring Gets or sets the Spring.
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.
SweepingPhase Gets or sets the SweepingPhase.
Time Gets the Time.
Total Gets the Total.
Type Gets the Type.
Velocity Gets the Velocity.
VisibleProperties Gets the list of properties that are visible for this object.
XAxis Gets the XAxis.
YAxis Gets the YAxis.
ZAxis Gets the ZAxis.

Property detail

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

Gets or sets the BeamSelection.

property SpringProbe.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 SpringProbe.By : Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None

Gets or sets the By.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the ContactRegionSelection.

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

Gets or sets the CoordinateSystemSelection.

property SpringProbe.DampingForce : Ansys.Core.Units.Quantity | None

Gets the DampingForce.

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

Gets the current DataModelObject’s category.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

property SpringProbe.ElasticForce : Ansys.Core.Units.Quantity | None

Gets the ElasticForce.

property SpringProbe.Elongation : Ansys.Core.Units.Quantity | None

Gets the Elongation.

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

Gets the list of associated figures.

property SpringProbe.Frequency : Ansys.Core.Units.Quantity | None

Gets or sets the Frequency.

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

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property SpringProbe.IsSolved : bool | None

Gets the IsSolved.

property SpringProbe.IterationNumber : int | None

Gets the IterationNumber.

property SpringProbe.LoadStep : int | None

Gets the LoadStep.

property SpringProbe.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the LocationMethod.

property SpringProbe.MaximumDampingForce : Ansys.Core.Units.Quantity | None

Gets the MaximumDampingForce.

property SpringProbe.MaximumElasticForce : Ansys.Core.Units.Quantity | None

Gets the MaximumElasticForce.

property SpringProbe.MaximumElongation : Ansys.Core.Units.Quantity | None

Gets the MaximumElongation.

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

Gets the MaximumTotal.

property SpringProbe.MaximumVelocity : Ansys.Core.Units.Quantity | None

Gets the MaximumVelocity.

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

Gets the MaximumXAxis.

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

Gets the MaximumYAxis.

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

Gets the MaximumZAxis.

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

Gets or sets the MeshConnectionSelection.

property SpringProbe.MinimumDampingForce : Ansys.Core.Units.Quantity | None

Gets the MinimumDampingForce.

property SpringProbe.MinimumElasticForce : Ansys.Core.Units.Quantity | None

Gets the MinimumElasticForce.

property SpringProbe.MinimumElongation : Ansys.Core.Units.Quantity | None

Gets the MinimumElongation.

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

Gets the MinimumTotal.

property SpringProbe.MinimumVelocity : Ansys.Core.Units.Quantity | None

Gets the MinimumVelocity.

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

Gets the MinimumXAxis.

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

Gets the MinimumYAxis.

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

Gets the MinimumZAxis.

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

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

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

Gets the list of properties for this object.

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

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

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

Gets or sets the RemotePointSelection.

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

Gets or sets the ResultSelection.

property SpringProbe.ScaleFactor : Ansys.Mechanical.DataModel.Enums.ScaleFactorType | None

Gets or sets the ScaleFactor.

property SpringProbe.ScaleFactorValue : float | None

Gets or sets the ScaleFactorValue.

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

Gets or sets the SpatialResolution.

property SpringProbe.Spring : Ansys.ACT.Automation.Mechanical.Connections.Spring | None

Gets or sets the Spring.

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

Gets or sets the SpringSelection.

property SpringProbe.Substep : int | None

Gets the Substep.

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

Gets or sets the Summation.

property SpringProbe.Suppressed : bool | None

Gets or sets the Suppressed.

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

Gets or sets the MeshConnectionSelection.

property SpringProbe.SweepingPhase : Ansys.Core.Units.Quantity | None

Gets or sets the SweepingPhase.

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

Gets the Time.

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

Gets the Total.

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

Gets the Type.

property SpringProbe.Velocity : Ansys.Core.Units.Quantity | None

Gets the Velocity.

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

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

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

Gets the XAxis.

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

Gets the YAxis.

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

Gets the ZAxis.

Method detail

SpringProbe.Activate()

Activate the current object.

SpringProbe.AddComment()

Creates a new child Comment.

SpringProbe.AddFigure()

Creates a new child Figure.

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

SpringProbe.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

SpringProbe.CreateParameter(propName: str)

Creates a new parameter for a Property.

SpringProbe.Delete()

Run the Delete action.

SpringProbe.Duplicate()

Creates a copy of the current DataModelObject.

SpringProbe.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

SpringProbe.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

SpringProbe.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

SpringProbe.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

SpringProbe.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

SpringProbe.PropertyByName(name: str)

Get a property by its unique name.

SpringProbe.RemoveParameter(propName: str)

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

SpringProbe.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

SpringProbe.SnapToMeshNodes()

Snap the coordinates of probe result to the mesh nodes.