BearingProbe#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.ProbeResults.BearingProbe#

Bases: object

Defines a BoltPretensionProbe.

Overview#

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.

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.

DampingForce1

Gets the DampingForce1.

DampingForce2

Gets the DampingForce2.

DataModelObjectCategory

Gets the current DataModelObject's category.

DisplayTime

Gets or sets the DisplayTime.

DpfEvaluation

Gets or sets the DpfEvaluation.

ElasticForce1

Gets the ElasticForce1.

ElasticForce2

Gets the ElasticForce2.

Elongation1

Gets the Elongation1.

Elongation2

Gets the Elongation2.

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.

MaximumDampingForce1

Gets the MaximumDampingForce1.

MaximumDampingForce2

Gets the MaximumDampingForce2.

MaximumElasticForce1

Gets the MaximumElasticForce1.

MaximumElasticForce2

Gets the MaximumElasticForce2.

MaximumElongation1

Gets the MaximumElongation1.

MaximumElongation2

Gets the MaximumElongation2.

MaximumTotal

Gets the MaximumTotal.

MaximumVelocity1

Gets the MaximumVelocity1.

MaximumVelocity2

Gets the MaximumVelocity2.

MaximumXAxis

Gets the MaximumXAxis.

MaximumYAxis

Gets the MaximumYAxis.

MaximumZAxis

Gets the MaximumZAxis.

MeshConnectionSelection

Gets or sets the MeshConnectionSelection.

MinimumDampingForce1

Gets the MinimumDampingForce1.

MinimumDampingForce2

Gets the MinimumDampingForce2.

MinimumElasticForce1

Gets the MinimumElasticForce1.

MinimumElasticForce2

Gets the MinimumElasticForce2.

MinimumElongation1

Gets the MinimumElongation1.

MinimumElongation2

Gets the MinimumElongation2.

MinimumTotal

Gets the MinimumTotal.

MinimumVelocity1

Gets the MinimumVelocity1.

MinimumVelocity2

Gets the MinimumVelocity2.

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.

PhaseIncrement

Gets or sets the PhaseIncrement.

Properties

Gets the list of properties for this object.

RemotePointSelection

Gets or sets the RemotePointSelection.

ReportedFrequency

Gets the ReportedFrequency.

ResultSelection

Gets or sets the ResultSelection.

ScaleFactor

Gets or sets the ScaleFactor.

ScaleFactorValue

Gets or sets the ScaleFactorValue.

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.

SweepingPhase

Gets or sets the SweepingPhase.

Time

Gets the Time.

Total

Gets the Total.

Type

Gets the Type.

Velocity1

Gets the Velocity1.

Velocity2

Gets the Velocity2.

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 BearingProbe.BeamSelection: Ansys.ACT.Automation.Mechanical.Connections.Beam | None#

Gets or sets the BeamSelection.

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

Gets or sets the By.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the ContactRegionSelection.

property BearingProbe.CoordinateSystemSelection: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the CoordinateSystemSelection.

property BearingProbe.DampingForce1: Ansys.Core.Units.Quantity | None#

Gets the DampingForce1.

property BearingProbe.DampingForce2: Ansys.Core.Units.Quantity | None#

Gets the DampingForce2.

property BearingProbe.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property BearingProbe.DisplayTime: Ansys.Core.Units.Quantity | None#

Gets or sets the DisplayTime.

property BearingProbe.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None#

Gets or sets the DpfEvaluation.

property BearingProbe.ElasticForce1: Ansys.Core.Units.Quantity | None#

Gets the ElasticForce1.

property BearingProbe.ElasticForce2: Ansys.Core.Units.Quantity | None#

Gets the ElasticForce2.

property BearingProbe.Elongation1: Ansys.Core.Units.Quantity | None#

Gets the Elongation1.

property BearingProbe.Elongation2: Ansys.Core.Units.Quantity | None#

Gets the Elongation2.

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

Gets the list of associated figures.

property BearingProbe.GeometryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

property BearingProbe.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None#

Gets the internal object. For advanced usage only.

property BearingProbe.IsSolved: bool | None#

Gets the IsSolved.

property BearingProbe.IterationNumber: int | None#

Gets the IterationNumber.

property BearingProbe.LoadStep: int | None#

Gets the LoadStep.

property BearingProbe.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

property BearingProbe.LocationMethod: Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None#

Gets or sets the LocationMethod.

property BearingProbe.MaximumDampingForce1: Ansys.Core.Units.Quantity | None#

Gets the MaximumDampingForce1.

property BearingProbe.MaximumDampingForce2: Ansys.Core.Units.Quantity | None#

Gets the MaximumDampingForce2.

property BearingProbe.MaximumElasticForce1: Ansys.Core.Units.Quantity | None#

Gets the MaximumElasticForce1.

property BearingProbe.MaximumElasticForce2: Ansys.Core.Units.Quantity | None#

Gets the MaximumElasticForce2.

property BearingProbe.MaximumElongation1: Ansys.Core.Units.Quantity | None#

Gets the MaximumElongation1.

property BearingProbe.MaximumElongation2: Ansys.Core.Units.Quantity | None#

Gets the MaximumElongation2.

property BearingProbe.MaximumTotal: Ansys.Core.Units.Quantity | None#

Gets the MaximumTotal.

property BearingProbe.MaximumVelocity1: Ansys.Core.Units.Quantity | None#

Gets the MaximumVelocity1.

property BearingProbe.MaximumVelocity2: Ansys.Core.Units.Quantity | None#

Gets the MaximumVelocity2.

property BearingProbe.MaximumXAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumXAxis.

property BearingProbe.MaximumYAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumYAxis.

property BearingProbe.MaximumZAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumZAxis.

property BearingProbe.MeshConnectionSelection: Ansys.ACT.Automation.Mechanical.MeshConnection | None#

Gets or sets the MeshConnectionSelection.

property BearingProbe.MinimumDampingForce1: Ansys.Core.Units.Quantity | None#

Gets the MinimumDampingForce1.

property BearingProbe.MinimumDampingForce2: Ansys.Core.Units.Quantity | None#

Gets the MinimumDampingForce2.

property BearingProbe.MinimumElasticForce1: Ansys.Core.Units.Quantity | None#

Gets the MinimumElasticForce1.

property BearingProbe.MinimumElasticForce2: Ansys.Core.Units.Quantity | None#

Gets the MinimumElasticForce2.

property BearingProbe.MinimumElongation1: Ansys.Core.Units.Quantity | None#

Gets the MinimumElongation1.

property BearingProbe.MinimumElongation2: Ansys.Core.Units.Quantity | None#

Gets the MinimumElongation2.

property BearingProbe.MinimumTotal: Ansys.Core.Units.Quantity | None#

Gets the MinimumTotal.

property BearingProbe.MinimumVelocity1: Ansys.Core.Units.Quantity | None#

Gets the MinimumVelocity1.

property BearingProbe.MinimumVelocity2: Ansys.Core.Units.Quantity | None#

Gets the MinimumVelocity2.

property BearingProbe.MinimumXAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumXAxis.

property BearingProbe.MinimumYAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumYAxis.

property BearingProbe.MinimumZAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumZAxis.

property BearingProbe.Orientation: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

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

property BearingProbe.PhaseIncrement: Ansys.Core.Units.Quantity | None#

Gets or sets the PhaseIncrement.

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

Gets the list of properties for this object.

property BearingProbe.RemotePointSelection: Ansys.ACT.Automation.Mechanical.RemotePoint | None#

Gets or sets the RemotePointSelection.

property BearingProbe.ReportedFrequency: Ansys.Core.Units.Quantity | None#

Gets the ReportedFrequency.

property BearingProbe.ResultSelection: Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter | None#

Gets or sets the ResultSelection.

property BearingProbe.ScaleFactor: Ansys.Mechanical.DataModel.Enums.ScaleFactorType | None#

Gets or sets the ScaleFactor.

property BearingProbe.ScaleFactorValue: float | None#

Gets or sets the ScaleFactorValue.

property BearingProbe.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None#

Gets or sets the SpatialResolution.

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

Gets or sets the SpringSelection.

property BearingProbe.Substep: int | None#

Gets the Substep.

property BearingProbe.Summation: Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None#

Gets or sets the Summation.

property BearingProbe.Suppressed: bool | None#

Gets or sets the Suppressed.

property BearingProbe.SurfaceSelection: Ansys.ACT.Automation.Mechanical.Surface | None#

Gets or sets the MeshConnectionSelection.

property BearingProbe.SweepingPhase: Ansys.Core.Units.Quantity | None#

Gets or sets the SweepingPhase.

property BearingProbe.Time: Ansys.Core.Units.Quantity | None#

Gets the Time.

property BearingProbe.Total: Ansys.Core.Units.Quantity | None#

Gets the Total.

property BearingProbe.Type: Ansys.Mechanical.DataModel.Enums.ProbeResultType | None#

Gets the Type.

property BearingProbe.Velocity1: Ansys.Core.Units.Quantity | None#

Gets the Velocity1.

property BearingProbe.Velocity2: Ansys.Core.Units.Quantity | None#

Gets the Velocity2.

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

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

property BearingProbe.XAxis: Ansys.Core.Units.Quantity | None#

Gets the XAxis.

property BearingProbe.YAxis: Ansys.Core.Units.Quantity | None#

Gets the YAxis.

property BearingProbe.ZAxis: Ansys.Core.Units.Quantity | None#

Gets the ZAxis.

Method detail#

BearingProbe.Activate() None#

Activate the current object.

BearingProbe.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

BearingProbe.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

BearingProbe.AddImage(filePath: str) 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.
BearingProbe.ClearGeneratedData() None#

Run the ClearGeneratedData action.

BearingProbe.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

BearingProbe.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

BearingProbe.Delete() None#

Run the Delete action.

BearingProbe.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

BearingProbe.DuplicateWithoutResults() Ansys.ACT.Automation.Mechanical.DataModelObject#

Run the DuplicateWithoutResults action.

BearingProbe.EvaluateAllResults() None#

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

BearingProbe.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

BearingProbe.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

BearingProbe.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

BearingProbe.PropertyByAPIName(name: str) 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.
BearingProbe.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

BearingProbe.RemoveParameter(propName: str) None#

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

BearingProbe.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.

BearingProbe.SnapToMeshNodes() None#

Snap the coordinates of probe result to the mesh nodes.