Skip to main content

Mechanical scripting interface

ContactDistanceProbe

Last update: 14.01.2025

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

Bases: object

Defines a ContactDistanceProbe.

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.
MaximumValueOverTime Gets the MaximumValueOverTime.
MaximumXAxis Gets the MaximumXAxis.
MaximumYAxis Gets the MaximumYAxis.
MaximumZAxis Gets the MaximumZAxis.
MeshConnectionSelection Gets or sets the MeshConnectionSelection.
MinimumTotal Gets the MinimumTotal.
MinimumValueOverTime Gets the MinimumValueOverTime.
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.
Results Gets the Results.
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.
Type Gets the Type.
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 ContactDistanceProbe.BeamSelection : Ansys.ACT.Automation.Mechanical.Connections.Beam | None

Gets or sets the BeamSelection.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the ContactRegionSelection.

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

Gets or sets the CoordinateSystemSelection.

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

Gets the current DataModelObject’s category.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

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

Gets the list of associated figures.

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

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property ContactDistanceProbe.IsSolved : bool | None

Gets the IsSolved.

property ContactDistanceProbe.IterationNumber : int | None

Gets the IterationNumber.

property ContactDistanceProbe.LoadStep : int | None

Gets the LoadStep.

property ContactDistanceProbe.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the LocationMethod.

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

Gets the MaximumTotal.

property ContactDistanceProbe.MaximumValueOverTime : Ansys.Core.Units.Quantity | None

Gets the MaximumValueOverTime.

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

Gets the MaximumXAxis.

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

Gets the MaximumYAxis.

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

Gets the MaximumZAxis.

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

Gets or sets the MeshConnectionSelection.

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

Gets the MinimumTotal.

property ContactDistanceProbe.MinimumValueOverTime : Ansys.Core.Units.Quantity | None

Gets the MinimumValueOverTime.

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

Gets the MinimumXAxis.

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

Gets the MinimumYAxis.

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

Gets the MinimumZAxis.

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

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

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

Gets the list of properties for this object.

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

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

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

Gets or sets the RemotePointSelection.

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

Gets or sets the ResultSelection.

property ContactDistanceProbe.Results : Ansys.Core.Units.Quantity | None

Gets the Results.

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

Gets or sets the SpatialResolution.

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

Gets or sets the SpringSelection.

property ContactDistanceProbe.Substep : int | None

Gets the Substep.

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

Gets or sets the Summation.

property ContactDistanceProbe.Suppressed : bool | None

Gets or sets the Suppressed.

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

Gets or sets the MeshConnectionSelection.

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

Gets the Time.

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

Gets the Total.

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

Gets the Type.

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

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

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

Gets the XAxis.

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

Gets the YAxis.

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

Gets the ZAxis.

Method detail

ContactDistanceProbe.Activate()

Activate the current object.

ContactDistanceProbe.AddComment()

Creates a new child Comment.

ContactDistanceProbe.AddFigure()

Creates a new child Figure.

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

ContactDistanceProbe.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

ContactDistanceProbe.CreateParameter(propName: str)

Creates a new parameter for a Property.

ContactDistanceProbe.Delete()

Run the Delete action.

ContactDistanceProbe.Duplicate()

Creates a copy of the current DataModelObject.

ContactDistanceProbe.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

ContactDistanceProbe.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

ContactDistanceProbe.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ContactDistanceProbe.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ContactDistanceProbe.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

ContactDistanceProbe.PropertyByName(name: str)

Get a property by its unique name.

ContactDistanceProbe.RemoveParameter(propName: str)

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

ContactDistanceProbe.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

ContactDistanceProbe.SnapToMeshNodes()

Snap the coordinates of probe result to the mesh nodes.