Skip to main content

Mechanical scripting interface

BeamProbe

Last update: 14.01.2025

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

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
AxialForce Gets the AxialForce.
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.
MaximumAxialForce Gets the MaximumAxialForce.
MaximumMomentAtI Gets the MaximumMomentAtI.
MaximumMomentAtJ Gets the MaximumMomentAtJ.
MaximumShearForceAtI Gets the MaximumShearForceAtI.
MaximumShearForceAtJ Gets the MaximumShearForceAtJ.
MaximumTorque Gets the MaximumTorque.
MaximumTotal Gets the MaximumTotal.
MaximumXAxis Gets the MaximumXAxis.
MaximumYAxis Gets the MaximumYAxis.
MaximumZAxis Gets the MaximumZAxis.
MeshConnectionSelection Gets or sets the MeshConnectionSelection.
MinimumAxialForce Gets the MinimumAxialForce.
MinimumMomentAtI Gets the MinimumMomentAtI.
MinimumMomentAtJ Gets the MinimumMomentAtJ.
MinimumShearForceAtI Gets the MinimumShearForceAtI.
MinimumShearForceAtJ Gets the MinimumShearForceAtJ.
MinimumTorque Gets the MinimumTorque.
MinimumTotal Gets the MinimumTotal.
MinimumXAxis Gets the MinimumXAxis.
MinimumYAxis Gets the MinimumYAxis.
MinimumZAxis Gets the MinimumZAxis.
MomentAtI Gets the MomentAtI.
MomentAtJ Gets the MomentAtJ.
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.
ShearForceAtI Gets the ShearForceAtI.
ShearForceAtJ Gets the ShearForceAtJ.
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.
Torque Gets the Torque.
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 BeamProbe.AxialForce : Ansys.Core.Units.Quantity | None

Gets the AxialForce.

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

Gets or sets the BeamSelection.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the ContactRegionSelection.

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

Gets or sets the CoordinateSystemSelection.

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

Gets the current DataModelObject’s category.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

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

Gets the list of associated figures.

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

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property BeamProbe.IsSolved : bool | None

Gets the IsSolved.

property BeamProbe.IterationNumber : int | None

Gets the IterationNumber.

property BeamProbe.LoadStep : int | None

Gets the LoadStep.

property BeamProbe.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the LocationMethod.

property BeamProbe.MaximumAxialForce : Ansys.Core.Units.Quantity | None

Gets the MaximumAxialForce.

property BeamProbe.MaximumMomentAtI : Ansys.Core.Units.Quantity | None

Gets the MaximumMomentAtI.

property BeamProbe.MaximumMomentAtJ : Ansys.Core.Units.Quantity | None

Gets the MaximumMomentAtJ.

property BeamProbe.MaximumShearForceAtI : Ansys.Core.Units.Quantity | None

Gets the MaximumShearForceAtI.

property BeamProbe.MaximumShearForceAtJ : Ansys.Core.Units.Quantity | None

Gets the MaximumShearForceAtJ.

property BeamProbe.MaximumTorque : Ansys.Core.Units.Quantity | None

Gets the MaximumTorque.

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

Gets the MaximumTotal.

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

Gets the MaximumXAxis.

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

Gets the MaximumYAxis.

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

Gets the MaximumZAxis.

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

Gets or sets the MeshConnectionSelection.

property BeamProbe.MinimumAxialForce : Ansys.Core.Units.Quantity | None

Gets the MinimumAxialForce.

property BeamProbe.MinimumMomentAtI : Ansys.Core.Units.Quantity | None

Gets the MinimumMomentAtI.

property BeamProbe.MinimumMomentAtJ : Ansys.Core.Units.Quantity | None

Gets the MinimumMomentAtJ.

property BeamProbe.MinimumShearForceAtI : Ansys.Core.Units.Quantity | None

Gets the MinimumShearForceAtI.

property BeamProbe.MinimumShearForceAtJ : Ansys.Core.Units.Quantity | None

Gets the MinimumShearForceAtJ.

property BeamProbe.MinimumTorque : Ansys.Core.Units.Quantity | None

Gets the MinimumTorque.

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

Gets the MinimumTotal.

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

Gets the MinimumXAxis.

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

Gets the MinimumYAxis.

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

Gets the MinimumZAxis.

property BeamProbe.MomentAtI : Ansys.Core.Units.Quantity | None

Gets the MomentAtI.

property BeamProbe.MomentAtJ : Ansys.Core.Units.Quantity | None

Gets the MomentAtJ.

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

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

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

Gets the list of properties for this object.

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

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

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

Gets or sets the RemotePointSelection.

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

Gets or sets the ResultSelection.

property BeamProbe.ShearForceAtI : Ansys.Core.Units.Quantity | None

Gets the ShearForceAtI.

property BeamProbe.ShearForceAtJ : Ansys.Core.Units.Quantity | None

Gets the ShearForceAtJ.

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

Gets or sets the SpatialResolution.

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

Gets or sets the SpringSelection.

property BeamProbe.Substep : int | None

Gets the Substep.

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

Gets or sets the Summation.

property BeamProbe.Suppressed : bool | None

Gets or sets the Suppressed.

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

Gets or sets the MeshConnectionSelection.

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

Gets the Time.

property BeamProbe.Torque : Ansys.Core.Units.Quantity | None

Gets the Torque.

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

Gets the Total.

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

Gets the Type.

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

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

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

Gets the XAxis.

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

Gets the YAxis.

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

Gets the ZAxis.

Method detail

BeamProbe.Activate()

Activate the current object.

BeamProbe.AddComment()

Creates a new child Comment.

BeamProbe.AddFigure()

Creates a new child Figure.

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

BeamProbe.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

BeamProbe.CreateParameter(propName: str)

Creates a new parameter for a Property.

BeamProbe.Delete()

Run the Delete action.

BeamProbe.Duplicate()

Creates a copy of the current DataModelObject.

BeamProbe.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

BeamProbe.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

BeamProbe.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

BeamProbe.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

BeamProbe.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

BeamProbe.PropertyByName(name: str)

Get a property by its unique name.

BeamProbe.RemoveParameter(propName: str)

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

BeamProbe.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

BeamProbe.SnapToMeshNodes()

Snap the coordinates of probe result to the mesh nodes.