BearingProbe#

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

Bases: object

Defines a BoltPretensionProbe.

Overview#

ExportAnimation

Run the ExportAnimation action.

ClearGeneratedData

Run the ClearGeneratedData action.

DuplicateWithoutResults

Run the DuplicateWithoutResults action.

EvaluateAllResults

Run the EvaluateAllResults action.

SnapToMeshNodes

Snap the coordinates of probe result to the mesh nodes.

RenameBasedOnDefinition

Run the RenameBasedOnDefinition action.

Delete

Run the Delete action.

GetChildren

Gets the list of children, filtered by type.

GetChildren

Gets the list of children, filtered by type.

AddComment

Creates a new child Comment.

AddFigure

Creates a new child Figure.

AddImage

Creates a new child Image.

Activate

Activate the current object.

CopyTo

Copies all visible properties from this object to another.

Duplicate

Creates a copy of the current DataModelObject.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

PropertyByName

Get a property by its unique name.

PropertyByAPIName

Get a property by its API name.

CreateParameter

Creates a new parameter for a Property.

GetParameter

Gets the parameter corresponding to the given property.

RemoveParameter

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

InternalObject

Gets the internal object. For advanced usage only.

ScaleFactorValue

Gets or sets the ScaleFactorValue.

ReportedFrequency

Gets the ReportedFrequency.

DampingForce1

Gets the DampingForce1.

DampingForce2

Gets the DampingForce2.

Elongation1

Gets the Elongation1.

Elongation2

Gets the Elongation2.

ElasticForce1

Gets the ElasticForce1.

ElasticForce2

Gets the ElasticForce2.

Velocity1

Gets the Velocity1.

Velocity2

Gets the Velocity2.

MaximumDampingForce1

Gets the MaximumDampingForce1.

MaximumDampingForce2

Gets the MaximumDampingForce2.

MaximumElongation1

Gets the MaximumElongation1.

MaximumElongation2

Gets the MaximumElongation2.

MaximumElasticForce1

Gets the MaximumElasticForce1.

MaximumElasticForce2

Gets the MaximumElasticForce2.

MaximumVelocity1

Gets the MaximumVelocity1.

MaximumVelocity2

Gets the MaximumVelocity2.

MinimumDampingForce1

Gets the MinimumDampingForce1.

MinimumDampingForce2

Gets the MinimumDampingForce2.

MinimumElongation1

Gets the MinimumElongation1.

MinimumElongation2

Gets the MinimumElongation2.

MinimumElasticForce1

Gets the MinimumElasticForce1.

MinimumElasticForce2

Gets the MinimumElasticForce2.

MinimumVelocity1

Gets the MinimumVelocity1.

MinimumVelocity2

Gets the MinimumVelocity2.

SweepingPhase

Gets or sets the SweepingPhase.

PhaseIncrement

Gets or sets the PhaseIncrement.

ScaleFactor

Gets or sets the ScaleFactor.

By

Gets or sets the By.

DataModelObjectCategory

Gets the current DataModelObject’s category.

Summation

Gets or sets the Summation.

LocationMethod

Gets or sets the LocationMethod.

GeometryLocation

Gets or sets the GeometryLocation.

CoordinateSystemSelection

Gets or sets the CoordinateSystemSelection.

BoundaryConditionSelection

Gets or sets the BoundaryConditionSelection. In order to select the option ‘WeakSprings’, please use the property ‘LocationMethod = LocationDefinitionMethod.WeakSprings’.

ContactRegionSelection

Gets or sets the ContactRegionSelection.

RemotePointSelection

Gets or sets the RemotePointSelection.

BeamSelection

Gets or sets the BeamSelection.

MeshConnectionSelection

Gets or sets the MeshConnectionSelection.

SurfaceSelection

Gets or sets the MeshConnectionSelection.

SpringSelection

Gets or sets the SpringSelection.

IsSolved

Gets the IsSolved.

Orientation

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

IterationNumber

Gets the IterationNumber.

LoadStep

Gets the LoadStep.

LoadStepNumber

Gets or sets the LoadStepNumber.

Substep

Gets the Substep.

DisplayTime

Gets or sets the DisplayTime.

MaximumTotal

Gets the MaximumTotal.

MaximumXAxis

Gets the MaximumXAxis.

MaximumYAxis

Gets the MaximumYAxis.

MaximumZAxis

Gets the MaximumZAxis.

MinimumTotal

Gets the MinimumTotal.

MinimumXAxis

Gets the MinimumXAxis.

MinimumYAxis

Gets the MinimumYAxis.

MinimumZAxis

Gets the MinimumZAxis.

Time

Gets the Time.

Total

Gets the Total.

XAxis

Gets the XAxis.

YAxis

Gets the YAxis.

ZAxis

Gets the ZAxis.

ResultSelection

Gets or sets the ResultSelection.

SpatialResolution

Gets or sets the SpatialResolution.

Type

Gets the Type.

DpfEvaluation

Gets or sets the DpfEvaluation.

Suppressed

Gets or sets the Suppressed.

Children

Gets the list of children.

Comments

Gets the list of associated comments.

Figures

Gets the list of associated figures.

Images

Gets the list of associated images.

InternalObject

Gets the internal object. For advanced usage only.

Properties

Gets the list of properties for this object.

VisibleProperties

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

Property detail#

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

Gets the internal object. For advanced usage only.

property BearingProbe.ScaleFactorValue: System.Double | None

Gets or sets the ScaleFactorValue.

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

Gets the ReportedFrequency.

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

Gets the DampingForce1.

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

Gets the DampingForce2.

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

Gets the Elongation1.

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

Gets the Elongation2.

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

Gets the ElasticForce1.

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

Gets the ElasticForce2.

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

Gets the Velocity1.

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

Gets the Velocity2.

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

Gets the MaximumDampingForce1.

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

Gets the MaximumDampingForce2.

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

Gets the MaximumElongation1.

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

Gets the MaximumElongation2.

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

Gets the MaximumElasticForce1.

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

Gets the MaximumElasticForce2.

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

Gets the MaximumVelocity1.

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

Gets the MaximumVelocity2.

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

Gets the MinimumDampingForce1.

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

Gets the MinimumDampingForce2.

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

Gets the MinimumElongation1.

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

Gets the MinimumElongation2.

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

Gets the MinimumElasticForce1.

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

Gets the MinimumElasticForce2.

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

Gets the MinimumVelocity1.

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

Gets the MinimumVelocity2.

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

Gets or sets the SweepingPhase.

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

Gets or sets the PhaseIncrement.

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

Gets or sets the ScaleFactor.

property BearingProbe.By: Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None

Gets or sets the By.

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

Gets the current DataModelObject’s category.

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

Gets or sets the Summation.

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

Gets or sets the LocationMethod.

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

Gets or sets the GeometryLocation.

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

Gets or sets the CoordinateSystemSelection.

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.ContactRegionSelection: Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None

Gets or sets the ContactRegionSelection.

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

Gets or sets the RemotePointSelection.

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

Gets or sets the BeamSelection.

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

Gets or sets the MeshConnectionSelection.

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

Gets or sets the MeshConnectionSelection.

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

Gets or sets the SpringSelection.

property BearingProbe.IsSolved: System.Boolean | None

Gets the IsSolved.

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.IterationNumber: System.Int32 | None

Gets the IterationNumber.

property BearingProbe.LoadStep: System.Int32 | None

Gets the LoadStep.

property BearingProbe.LoadStepNumber: System.UInt32 | None

Gets or sets the LoadStepNumber.

property BearingProbe.Substep: System.Int32 | None

Gets the Substep.

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

Gets or sets the DisplayTime.

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

Gets the MaximumTotal.

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.MinimumTotal: Ansys.Core.Units.Quantity | None

Gets the MinimumTotal.

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.Time: Ansys.Core.Units.Quantity | None

Gets the Time.

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

Gets the Total.

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.

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

Gets or sets the ResultSelection.

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

Gets or sets the SpatialResolution.

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

Gets the Type.

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

Gets or sets the DpfEvaluation.

property BearingProbe.Suppressed: System.Boolean | None

Gets or sets the Suppressed.

property BearingProbe.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property BearingProbe.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property BearingProbe.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property BearingProbe.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property BearingProbe.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

property BearingProbe.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property BearingProbe.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail#

BearingProbe.ExportAnimation(filePath: System.String, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) System.Void

Run the ExportAnimation action.

BearingProbe.ClearGeneratedData() System.Void

Run the ClearGeneratedData action.

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

Run the DuplicateWithoutResults action.

BearingProbe.EvaluateAllResults() System.Void

Run the EvaluateAllResults action.

BearingProbe.SnapToMeshNodes() System.Void

Snap the coordinates of probe result to the mesh nodes.

BearingProbe.RenameBasedOnDefinition() System.Void

Run the RenameBasedOnDefinition action.

BearingProbe.Delete() System.Void

Run the Delete action.

BearingProbe.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) System.Collections.Generic.IList[ChildrenType]

Gets the list of children, filtered by type.

BearingProbe.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]

Gets the list of children, filtered by type.

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: System.String) 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.Activate() System.Void

Activate the current object.

BearingProbe.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) System.Void

Copies all visible properties from this object to another.

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

Creates a copy of the current DataModelObject.

BearingProbe.GroupAllSimilarChildren() System.Void

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

BearingProbe.PropertyByName(name: System.String) Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

BearingProbe.PropertyByAPIName(name: System.String) 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.CreateParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

BearingProbe.GetParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

BearingProbe.RemoveParameter(propName: System.String) System.Void

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