Skip to main content

Mechanical scripting interface

ForceReaction

Last update: 14.01.2025

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

Bases: object

Defines a ForceReaction.

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
Beam Gets or sets the Beam.
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.
ContactForce Gets or sets the ContactForce.
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.
Extraction Gets or sets the Extraction.
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.
MaximumTotal Gets the MaximumTotal.
MaximumXAxis Gets the MaximumXAxis.
MaximumYAxis Gets the MaximumYAxis.
MaximumZAxis Gets the MaximumZAxis.
MeshConnectionSelection Gets or sets the MeshConnectionSelection.
MinimumTotal Gets the MinimumTotal.
MinimumXAxis Gets the MinimumXAxis.
MinimumYAxis Gets the MinimumYAxis.
MinimumZAxis Gets the MinimumZAxis.
Mode Gets or sets the Mode.
Orientation Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.
PhaseIncrement Gets or sets the PhaseIncrement.
Probability Gets the Probability.
Properties Gets the list of properties for this object.
RPMSelection Gets or sets the RPM Selection value at which the results are evaluated.
Reference Gets the Reference.
RemotePointSelection Gets or sets the RemotePointSelection.
RemotePoints Gets or sets the RemotePoints.
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.
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.
SurfaceArea Gets the SurfaceArea.
SurfaceSelection Gets or sets the MeshConnectionSelection.
SweepingPhase Gets or sets the SweepingPhase.
SymmetryMultiplier Gets or sets the SymmetryMultiplier.
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 ForceReaction.Beam : Ansys.ACT.Automation.Mechanical.Connections.Beam | None

Gets or sets the Beam.

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

Gets or sets the BeamSelection.

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

Gets or sets the By.

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

Gets the list of children.

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

Gets the list of associated comments.

property ForceReaction.ContactForce : Ansys.Mechanical.DataModel.Enums.ContactForceType | None

Gets or sets the ContactForce.

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

Gets or sets the ContactRegionSelection.

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

Gets or sets the CoordinateSystemSelection.

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

Gets the current DataModelObject’s category.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

property ForceReaction.Extraction : Ansys.Mechanical.DataModel.Enums.ProbeExtractionType | None

Gets or sets the Extraction.

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

Gets the list of associated figures.

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

Gets or sets the Frequency.

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

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property ForceReaction.IsSolved : bool | None

Gets the IsSolved.

property ForceReaction.IterationNumber : int | None

Gets the IterationNumber.

property ForceReaction.LoadStep : int | None

Gets the LoadStep.

property ForceReaction.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the LocationMethod.

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

Gets the MaximumTotal.

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

Gets the MaximumXAxis.

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

Gets the MaximumYAxis.

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

Gets the MaximumZAxis.

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

Gets or sets the MeshConnectionSelection.

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

Gets the MinimumTotal.

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

Gets the MinimumXAxis.

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

Gets the MinimumYAxis.

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

Gets the MinimumZAxis.

property ForceReaction.Mode : int | None

Gets or sets the Mode.

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

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

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

Gets or sets the PhaseIncrement.

property ForceReaction.Probability : float | None

Gets the Probability.

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

Gets the list of properties for this object.

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

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

property ForceReaction.Reference : Ansys.Mechanical.DataModel.Enums.ResultRelativityType | None

Gets the Reference.

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

Gets or sets the RemotePointSelection.

property ForceReaction.RemotePoints : Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets or sets the RemotePoints.

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

Gets the ReportedFrequency.

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

Gets or sets the ResultSelection.

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

Gets or sets the ScaleFactor.

property ForceReaction.ScaleFactorValue : float | None

Gets or sets the ScaleFactorValue.

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

Gets or sets the SpatialResolution.

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

Gets or sets the Spring.

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

Gets or sets the SpringSelection.

property ForceReaction.Substep : int | None

Gets the Substep.

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

Gets or sets the Summation.

property ForceReaction.Suppressed : bool | None

Gets or sets the Suppressed.

property ForceReaction.SurfaceArea : Ansys.Core.Units.Quantity | None

Gets the SurfaceArea.

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

Gets or sets the MeshConnectionSelection.

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

Gets or sets the SweepingPhase.

property ForceReaction.SymmetryMultiplier : float | None

Gets or sets the SymmetryMultiplier.

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

Gets the Time.

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

Gets the Total.

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

Gets the Type.

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

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

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

Gets the XAxis.

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

Gets the YAxis.

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

Gets the ZAxis.

Method detail

ForceReaction.Activate()

Activate the current object.

ForceReaction.AddComment()

Creates a new child Comment.

ForceReaction.AddFigure()

Creates a new child Figure.

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

ForceReaction.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

ForceReaction.CreateParameter(propName: str)

Creates a new parameter for a Property.

ForceReaction.Delete()

Run the Delete action.

ForceReaction.Duplicate()

Creates a copy of the current DataModelObject.

ForceReaction.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

ForceReaction.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

ForceReaction.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ForceReaction.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ForceReaction.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

ForceReaction.PropertyByName(name: str)

Get a property by its unique name.

ForceReaction.RemoveParameter(propName: str)

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

ForceReaction.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

ForceReaction.SnapToMeshNodes()

Snap the coordinates of probe result to the mesh nodes.