RBDAnalysisSettings

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.AnalysisSettings.RBDAnalysisSettings(internalObject: Any)

Bases: object

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
DeleteAllRestartPoints	DeleteAllRestartPoints method.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetAutomaticTimeStepping	Gets the Automatic Time Stepping at a given solution step.
GetCarryOverTimeStep	Gets the Carry Over Time Step at a given solution step.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetInitialTimeStep	Gets the Initial Time Step at a given solution step.
GetLifetimeService	GetLifetimeService method.
GetMaximumTimeStep	Gets the Maximum Time Step at a given solution step.
GetMinimumTimeStep	Gets the Minimum Time Step at a given solution step.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetStepEndTime	Gets the Step End Time at a given solution step.
GetStoreResultAt	Gets the StoreResultAt setting at a given solution step.
GetStoreResultAtValue	Gets the StoreResultAtValue setting at a given solution step.
GetTimeStep	Gets the (fixed) Time Step at a given solution step.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
SetAutomaticTimeStepping	Sets the Automatic Time Stepping for a given solution step.
SetCarryOverTimeStep	Sets the Carry Over Time Step for a given solution step.
SetInitialTimeStep	Sets the Initial Time Step for a given solution step.
SetMaximumTimeStep	Sets the Maximum Time Step for a given solution step.
SetMinimumTimeStep	Sets the Minimum Time Step for a given solution step.
SetStepEndTime	Sets the Step End Time for a given solution step.
SetStoreResultAt	Sets the StoreResultAt setting for a given solution step.
SetStoreResultAtValue	Sets the StoreResultAtValue setting for a given solution step.
SetTimeStep	Sets the (fixed) Time Step for a given solution step.
ToString	ToString method.

Properties

AssemblyType	Gets or sets the AssemblyType.
AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
ConstraintEquationResidualTolerance	Gets or sets the ConstraintEquationResidualTolerance activity.
ConstraintEquationResidualToleranceValue	Gets or sets the ConstraintEquationResidualToleranceValue.
CorrectionType	Gets or sets the CorrectionType.
CurrentStepNumber	Gets or sets the CurrentStepNumber.
DataModelObjectCategory	Gets the current DataModelObject's category.
DropoffTolerance	Gets or sets the DropoffTolerance.
EnergyAccuracyTolerance	Gets or sets the EnergyAccuracyTolerance activity.
EnergyAccuracyToleranceValue	Gets or sets the EnergyAccuracyToleranceValue.
Figures	Gets the list of associated figures.
ForceResidualTolerance	Gets or sets the ForceResidualTolerance activity.
ForceResidualToleranceValue	Gets or sets the ForceResidualToleranceValue.
Graph	Graph property.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
InternalObject	InternalObject property.
Name	Name property.
NumberOfSteps	Gets or sets the NumberOfSteps.
NumericalDampingTolerance	Gets or sets the NumericalDamping activity.
NumericalDampingValue	Gets or sets the NumericalDampingValue.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
PerformStaticAnalysis	Gets or sets the .
PositionCorrection	Gets or sets the PositionCorrection.
Properties	Gets the list of properties for this object.
RelativeAssemblyTolerance	Gets or sets the RelativeAssemblyTolerance activity.
RelativeAssemblyToleranceValue	Gets or sets the RelativeAssemblyToleranceValue.
ScratchSolverFilesDirectory	Gets the ScratchSolverFilesDirectory.
SolverFilesDirectory	Gets the SolverFilesDirectory.
State	State property.
SurfaceStress	Gets or sets the SurfaceStress.
TimeIntegrationType	Gets or sets the Integration Method.
VelocityConstraintEquationResidualTolerance	Gets or sets the VelocityConstraintEquationResidualTolerance activity.
VelocityConstraintEquationResidualToleranceValue	Gets or sets the ConstraintEquationResidualToleranceValue.
VelocityCorrection	Gets or sets the VelocityCorrection.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property RBDAnalysisSettings.AssemblyType: Ansys.Mechanical.DataModel.Enums.RBDCorrectionType | None

Gets or sets the AssemblyType.

property RBDAnalysisSettings.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property RBDAnalysisSettings.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

property RBDAnalysisSettings.ConstraintEquationResidualTolerance: Ansys.Mechanical.DataModel.Enums.RBDProgramControlType | None

Gets or sets the ConstraintEquationResidualTolerance activity.

property RBDAnalysisSettings.ConstraintEquationResidualToleranceValue: Ansys.Core.Units.Quantity | None

Gets or sets the ConstraintEquationResidualToleranceValue.

property RBDAnalysisSettings.CorrectionType: Ansys.Mechanical.DataModel.Enums.RBDCorrectionType | None

Gets or sets the CorrectionType.

property RBDAnalysisSettings.CurrentStepNumber: int | None

Gets or sets the CurrentStepNumber.

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

Gets the current DataModelObject's category.

property RBDAnalysisSettings.DropoffTolerance: Ansys.Core.Units.Quantity | None

Gets or sets the DropoffTolerance.

property RBDAnalysisSettings.EnergyAccuracyTolerance: Ansys.Mechanical.DataModel.Enums.RBDProgramControlType | None

Gets or sets the EnergyAccuracyTolerance activity.

property RBDAnalysisSettings.EnergyAccuracyToleranceValue: Ansys.Core.Units.Quantity | None

Gets or sets the EnergyAccuracyToleranceValue.

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

Gets the list of associated figures.

property RBDAnalysisSettings.ForceResidualTolerance: Ansys.Mechanical.DataModel.Enums.RBDProgramControlType | None

Gets or sets the ForceResidualTolerance activity.

property RBDAnalysisSettings.ForceResidualToleranceValue: Ansys.Core.Units.Quantity | None

Gets or sets the ForceResidualToleranceValue.

property RBDAnalysisSettings.Graph: Ansys.Mechanical.Graphics.AnalysisSettingsGraph | None

Graph property.

property RBDAnalysisSettings.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property RBDAnalysisSettings.IconName: str | None

IconName property.

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

Gets the list of associated images.

property RBDAnalysisSettings.InternalObject: Any | None

InternalObject property.

property RBDAnalysisSettings.Name: str | None

Name property.

property RBDAnalysisSettings.NumberOfSteps: int | None

Gets or sets the NumberOfSteps.

property RBDAnalysisSettings.NumericalDampingTolerance: Ansys.Mechanical.DataModel.Enums.RBDProgramControlType | None

Gets or sets the NumericalDamping activity.

property RBDAnalysisSettings.NumericalDampingValue: Ansys.Core.Units.Quantity | None

Gets or sets the NumericalDampingValue.

property RBDAnalysisSettings.ObjectId: int | None

ObjectId property.

property RBDAnalysisSettings.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property RBDAnalysisSettings.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property RBDAnalysisSettings.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

property RBDAnalysisSettings.PerformStaticAnalysis: Ansys.Mechanical.DataModel.Enums.RBDDoStaticAnalysisType | None

Gets or sets the .

property RBDAnalysisSettings.PositionCorrection: bool | None

Gets or sets the PositionCorrection.

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

Gets the list of properties for this object.

property RBDAnalysisSettings.RelativeAssemblyTolerance: Ansys.Mechanical.DataModel.Enums.RBDProgramControlType | None

Gets or sets the RelativeAssemblyTolerance activity.

property RBDAnalysisSettings.RelativeAssemblyToleranceValue: Ansys.Core.Units.Quantity | None

Gets or sets the RelativeAssemblyToleranceValue.

property RBDAnalysisSettings.ScratchSolverFilesDirectory: str | None

Gets the ScratchSolverFilesDirectory.

property RBDAnalysisSettings.SolverFilesDirectory: str | None

Gets the SolverFilesDirectory.

property RBDAnalysisSettings.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property RBDAnalysisSettings.SurfaceStress: bool | None

Gets or sets the SurfaceStress.

property RBDAnalysisSettings.TimeIntegrationType: Ansys.Mechanical.DataModel.Enums.RBDTimeIntegrationType | None

Gets or sets the Integration Method.

property RBDAnalysisSettings.VelocityConstraintEquationResidualTolerance: Ansys.Mechanical.DataModel.Enums.RBDProgramControlType | None

Gets or sets the VelocityConstraintEquationResidualTolerance activity.

property RBDAnalysisSettings.VelocityConstraintEquationResidualToleranceValue: Ansys.Core.Units.Quantity | None

Gets or sets the ConstraintEquationResidualToleranceValue.

property RBDAnalysisSettings.VelocityCorrection: bool | None

Gets or sets the VelocityCorrection.

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

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

Method detail

RBDAnalysisSettings.Activate() → None

Activate the current object.

RBDAnalysisSettings.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

RBDAnalysisSettings.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

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

RBDAnalysisSettings.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

RBDAnalysisSettings.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

RBDAnalysisSettings.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

RBDAnalysisSettings.DeleteAllRestartPoints() → None

DeleteAllRestartPoints method.

RBDAnalysisSettings.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

RBDAnalysisSettings.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

RBDAnalysisSettings.GetAPIName(dispId: int) → str

Property name bound to dispId.

RBDAnalysisSettings.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

RBDAnalysisSettings.GetAutomaticTimeStepping(stepNumber: int) → Ansys.Mechanical.DataModel.Enums.AutomaticTimeStepping

Gets the Automatic Time Stepping at a given solution step.

RBDAnalysisSettings.GetCarryOverTimeStep(stepNumber: int) → bool

Gets the Carry Over Time Step at a given solution step.

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

Gets the list of children, filtered by type.

RBDAnalysisSettings.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

RBDAnalysisSettings.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

RBDAnalysisSettings.GetHashCode() → int

GetHashCode method.

RBDAnalysisSettings.GetIconFile() → System.Byte

GetIconFile method.

RBDAnalysisSettings.GetInitialTimeStep(stepNumber: int) → Ansys.Core.Units.Quantity

Gets the Initial Time Step at a given solution step.

RBDAnalysisSettings.GetLifetimeService() → Any

GetLifetimeService method.

RBDAnalysisSettings.GetMaximumTimeStep(stepNumber: int) → Ansys.Core.Units.Quantity

Gets the Maximum Time Step at a given solution step.

RBDAnalysisSettings.GetMinimumTimeStep(stepNumber: int) → Ansys.Core.Units.Quantity

Gets the Minimum Time Step at a given solution step.

RBDAnalysisSettings.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

RBDAnalysisSettings.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

RBDAnalysisSettings.GetPath() → str

GetPath method.

RBDAnalysisSettings.GetPropertyName(dispId: int) → str

GetPropertyName method.

RBDAnalysisSettings.GetPropertyValue(name: str) → Any

GetPropertyValue method.

RBDAnalysisSettings.GetStepEndTime(stepNumber: int) → Ansys.Core.Units.Quantity

Gets the Step End Time at a given solution step.

RBDAnalysisSettings.GetStoreResultAt(stepNumber: int) → Ansys.Mechanical.DataModel.Enums.TimePointsOptions

Gets the StoreResultAt setting at a given solution step.

RBDAnalysisSettings.GetStoreResultAtValue(stepNumber: int) → int

Gets the StoreResultAtValue setting at a given solution step.

RBDAnalysisSettings.GetTimeStep(stepNumber: int) → Ansys.Core.Units.Quantity

Gets the (fixed) Time Step at a given solution step.

RBDAnalysisSettings.GetType() → type

GetType method.

RBDAnalysisSettings.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

RBDAnalysisSettings.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

RBDAnalysisSettings.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

RBDAnalysisSettings.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

RBDAnalysisSettings.InitializeLifetimeService() → Any

InitializeLifetimeService method.

RBDAnalysisSettings.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

RBDAnalysisSettings.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

RBDAnalysisSettings.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

RBDAnalysisSettings.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

RBDAnalysisSettings.RemoveParameter(propName: str) → None

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

RBDAnalysisSettings.SetAutomaticTimeStepping(stepNumber: int, value: Ansys.Mechanical.DataModel.Enums.AutomaticTimeStepping) → None

Sets the Automatic Time Stepping for a given solution step.

RBDAnalysisSettings.SetCarryOverTimeStep(stepNumber: int, value: bool) → None

Sets the Carry Over Time Step for a given solution step.

RBDAnalysisSettings.SetInitialTimeStep(stepNumber: int, value: Ansys.Core.Units.Quantity) → None

Sets the Initial Time Step for a given solution step.

RBDAnalysisSettings.SetMaximumTimeStep(stepNumber: int, value: Ansys.Core.Units.Quantity) → None

Sets the Maximum Time Step for a given solution step.

RBDAnalysisSettings.SetMinimumTimeStep(stepNumber: int, value: Ansys.Core.Units.Quantity) → None

Sets the Minimum Time Step for a given solution step.

RBDAnalysisSettings.SetStepEndTime(stepNumber: int, value: Ansys.Core.Units.Quantity) → None

Sets the Step End Time for a given solution step.

RBDAnalysisSettings.SetStoreResultAt(stepNumber: int, value: Ansys.Mechanical.DataModel.Enums.TimePointsOptions) → None

Sets the StoreResultAt setting for a given solution step.

RBDAnalysisSettings.SetStoreResultAtValue(stepNumber: int, value: int) → None

Sets the StoreResultAtValue setting for a given solution step.

RBDAnalysisSettings.SetTimeStep(stepNumber: int, value: Ansys.Core.Units.Quantity) → None

Sets the (fixed) Time Step for a given solution step.

RBDAnalysisSettings.ToString() → str

ToString method.