MomentReaction#

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

Bases: object

Defines a MomentReaction.

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.

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.

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.

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

Gets or sets the Beam.

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

Gets or sets the BeamSelection.

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

Gets or sets the By.

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

Gets the list of children.

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

Gets the list of associated comments.

property MomentReaction.ContactForce: Ansys.Mechanical.DataModel.Enums.ContactForceType | None#

Gets or sets the ContactForce.

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

Gets or sets the ContactRegionSelection.

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

Gets or sets the CoordinateSystemSelection.

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

Gets the current DataModelObject's category.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

property MomentReaction.Extraction: Ansys.Mechanical.DataModel.Enums.ProbeExtractionType | None#

Gets or sets the Extraction.

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

Gets the list of associated figures.

property MomentReaction.Frequency: Ansys.Core.Units.Quantity | None#

Gets or sets the Frequency.

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

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property MomentReaction.IsSolved: bool | None#

Gets the IsSolved.

property MomentReaction.IterationNumber: int | None#

Gets the IterationNumber.

property MomentReaction.LoadStep: int | None#

Gets the LoadStep.

property MomentReaction.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

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

Gets or sets the LocationMethod.

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

Gets the MaximumTotal.

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

Gets the MaximumXAxis.

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

Gets the MaximumYAxis.

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

Gets the MaximumZAxis.

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

Gets or sets the MeshConnectionSelection.

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

Gets the MinimumTotal.

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

Gets the MinimumXAxis.

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

Gets the MinimumYAxis.

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

Gets the MinimumZAxis.

property MomentReaction.Mode: int | None#

Gets or sets the Mode.

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

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

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

Gets or sets the PhaseIncrement.

property MomentReaction.Probability: float | None#

Gets the Probability.

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

Gets the list of properties for this object.

property MomentReaction.Reference: Ansys.Mechanical.DataModel.Enums.ResultRelativityType | None#

Gets the Reference.

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

Gets or sets the RemotePointSelection.

property MomentReaction.RemotePoints: Ansys.ACT.Automation.Mechanical.RemotePoint | None#

Gets or sets the RemotePoints.

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

Gets the ReportedFrequency.

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

Gets or sets the ResultSelection.

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

Gets or sets the ScaleFactor.

property MomentReaction.ScaleFactorValue: float | None#

Gets or sets the ScaleFactorValue.

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

Gets or sets the SpatialResolution.

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

Gets or sets the SpringSelection.

property MomentReaction.Substep: int | None#

Gets the Substep.

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

Gets or sets the Summation.

property MomentReaction.Suppressed: bool | None#

Gets or sets the Suppressed.

property MomentReaction.SurfaceArea: Ansys.Core.Units.Quantity | None#

Gets the SurfaceArea.

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

Gets or sets the MeshConnectionSelection.

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

Gets or sets the SweepingPhase.

property MomentReaction.SymmetryMultiplier: float | None#

Gets or sets the SymmetryMultiplier.

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

Gets the Time.

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

Gets the Total.

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

Gets the Type.

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

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

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

Gets the XAxis.

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

Gets the YAxis.

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

Gets the ZAxis.

Method detail#

MomentReaction.Activate() None#

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

MomentReaction.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.
MomentReaction.ClearGeneratedData() None#

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

MomentReaction.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Run the DuplicateWithoutResults action.

MomentReaction.EvaluateAllResults() None#

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

MomentReaction.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

Get a property by its unique name.

MomentReaction.RemoveParameter(propName: str) None#

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

MomentReaction.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.

MomentReaction.SnapToMeshNodes() None#

Snap the coordinates of probe result to the mesh nodes.