`RBDAnalysisSettings`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.AnalysisSettings.RBDAnalysisSettings#

Bases: object

RBDAnalysisSettings class.

Overview#

Methods

`GetStepEndTime`	Gets the Step End Time at a given solution step.
`SetStepEndTime`	Sets the Step End Time for a given solution step.
`GetAutomaticTimeStepping`	Gets the Automatic Time Stepping at a given solution step.
`SetAutomaticTimeStepping`	Sets the Automatic Time Stepping for a given solution step.
`GetCarryOverTimeStep`	Gets the Carry Over Time Step at a given solution step.
`SetCarryOverTimeStep`	Sets the Carry Over Time Step for a given solution step.
`GetInitialTimeStep`	Gets the Initial Time Step at a given solution step.
`SetInitialTimeStep`	Sets the Initial Time Step for a given solution step.
`GetMinimumTimeStep`	Gets the Minimum Time Step at a given solution step.
`SetMinimumTimeStep`	Sets the Minimum Time Step for a given solution step.
`GetMaximumTimeStep`	Gets the Maximum Time Step at a given solution step.
`SetMaximumTimeStep`	Sets the Maximum Time Step for a given solution step.
`GetTimeStep`	Gets the (fixed) Time Step at a given solution step.
`SetTimeStep`	Sets the (fixed) Time Step for a given solution step.
`GetStoreResultAt`	Gets the StoreResultAt setting at a given solution step.
`SetStoreResultAt`	Sets the StoreResultAt setting for a given solution step.
`GetStoreResultAtValue`	Gets the StoreResultAtValue setting at a given solution step.
`SetStoreResultAtValue`	Sets the StoreResultAtValue setting for a given solution step.
`DeleteAllRestartPoints`	DeleteAllRestartPoints method.
`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.

Properties

`InternalObject`	InternalObject property.
`NumberOfSteps`	Gets or sets the NumberOfSteps.
`CurrentStepNumber`	Gets or sets the CurrentStepNumber.
`TimeIntegrationType`	Gets or sets the Integration Method.
`PositionCorrection`	Gets or sets the PositionCorrection.
`VelocityCorrection`	Gets or sets the VelocityCorrection.
`CorrectionType`	Gets or sets the CorrectionType.
`AssemblyType`	Gets or sets the AssemblyType.
`DropoffTolerance`	Gets or sets the DropoffTolerance.
`RelativeAssemblyTolerance`	Gets or sets the RelativeAssemblyTolerance activity.
`RelativeAssemblyToleranceValue`	Gets or sets the RelativeAssemblyToleranceValue.
`EnergyAccuracyTolerance`	Gets or sets the EnergyAccuracyTolerance activity.
`EnergyAccuracyToleranceValue`	Gets or sets the EnergyAccuracyToleranceValue.
`NumericalDampingTolerance`	Gets or sets the NumericalDamping activity.
`NumericalDampingValue`	Gets or sets the NumericalDampingValue.
`ForceResidualTolerance`	Gets or sets the ForceResidualTolerance activity.
`ForceResidualToleranceValue`	Gets or sets the ForceResidualToleranceValue.
`ConstraintEquationResidualTolerance`	Gets or sets the ConstraintEquationResidualTolerance activity.
`ConstraintEquationResidualToleranceValue`	Gets or sets the ConstraintEquationResidualToleranceValue.
`VelocityConstraintEquationResidualTolerance`	Gets or sets the VelocityConstraintEquationResidualTolerance activity.
`VelocityConstraintEquationResidualToleranceValue`	Gets or sets the ConstraintEquationResidualToleranceValue.
`PerformStaticAnalysis`	Gets or sets the .
`Graph`	Graph property.
`InternalObject`	Gets the internal object. For advanced usage only.
`ScratchSolverFilesDirectory`	Gets the ScratchSolverFilesDirectory.
`SolverFilesDirectory`	Gets the SolverFilesDirectory.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`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.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property RBDAnalysisSettings.InternalObject: System.Object | None: InternalObject property.

property RBDAnalysisSettings.NumberOfSteps: System.Int32 | None: Gets or sets the NumberOfSteps.

property RBDAnalysisSettings.CurrentStepNumber: System.Int32 | None: Gets or sets the CurrentStepNumber.

property RBDAnalysisSettings.TimeIntegrationType: Ansys.Mechanical.DataModel.Enums.RBDTimeIntegrationType | None: Gets or sets the Integration Method.

property RBDAnalysisSettings.PositionCorrection: System.Boolean | None: Gets or sets the PositionCorrection.

property RBDAnalysisSettings.VelocityCorrection: System.Boolean | None: Gets or sets the VelocityCorrection.

property RBDAnalysisSettings.CorrectionType: Ansys.Mechanical.DataModel.Enums.RBDCorrectionType | None: Gets or sets the CorrectionType.

property RBDAnalysisSettings.AssemblyType: Ansys.Mechanical.DataModel.Enums.RBDCorrectionType | None: Gets or sets the AssemblyType.

property RBDAnalysisSettings.DropoffTolerance: Ansys.Core.Units.Quantity | None: Gets or sets the DropoffTolerance.

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.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.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.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.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.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.PerformStaticAnalysis: Ansys.Mechanical.DataModel.Enums.RBDDoStaticAnalysisType | None: Gets or sets the .

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

property RBDAnalysisSettings.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSAnalysisSettings | None: Gets the internal object. For advanced usage only.

property RBDAnalysisSettings.ScratchSolverFilesDirectory: System.String | None: Gets the ScratchSolverFilesDirectory.

property RBDAnalysisSettings.SolverFilesDirectory: System.String | None: Gets the SolverFilesDirectory.

property RBDAnalysisSettings.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property RBDAnalysisSettings.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property RBDAnalysisSettings.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property RBDAnalysisSettings.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property RBDAnalysisSettings.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property RBDAnalysisSettings.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property RBDAnalysisSettings.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

RBDAnalysisSettings.GetStepEndTime(stepNumber: System.Int32) → Ansys.Core.Units.Quantity: Gets the Step End Time at a given solution step.

RBDAnalysisSettings.SetStepEndTime(stepNumber: System.Int32, value: Ansys.Core.Units.Quantity) → System.Void: Sets the Step End Time for a given solution step.

RBDAnalysisSettings.GetAutomaticTimeStepping(stepNumber: System.Int32) → Ansys.Mechanical.DataModel.Enums.AutomaticTimeStepping: Gets the Automatic Time Stepping at a given solution step.

RBDAnalysisSettings.SetAutomaticTimeStepping(stepNumber: System.Int32, value: Ansys.Mechanical.DataModel.Enums.AutomaticTimeStepping) → System.Void: Sets the Automatic Time Stepping for a given solution step.

RBDAnalysisSettings.GetCarryOverTimeStep(stepNumber: System.Int32) → System.Boolean: Gets the Carry Over Time Step at a given solution step.

RBDAnalysisSettings.SetCarryOverTimeStep(stepNumber: System.Int32, value: System.Boolean) → System.Void: Sets the Carry Over Time Step for a given solution step.

RBDAnalysisSettings.GetInitialTimeStep(stepNumber: System.Int32) → Ansys.Core.Units.Quantity: Gets the Initial Time Step at a given solution step.

RBDAnalysisSettings.SetInitialTimeStep(stepNumber: System.Int32, value: Ansys.Core.Units.Quantity) → System.Void: Sets the Initial Time Step for a given solution step.

RBDAnalysisSettings.GetMinimumTimeStep(stepNumber: System.Int32) → Ansys.Core.Units.Quantity: Gets the Minimum Time Step at a given solution step.

RBDAnalysisSettings.SetMinimumTimeStep(stepNumber: System.Int32, value: Ansys.Core.Units.Quantity) → System.Void: Sets the Minimum Time Step for a given solution step.

RBDAnalysisSettings.GetMaximumTimeStep(stepNumber: System.Int32) → Ansys.Core.Units.Quantity: Gets the Maximum Time Step at a given solution step.

RBDAnalysisSettings.SetMaximumTimeStep(stepNumber: System.Int32, value: Ansys.Core.Units.Quantity) → System.Void: Sets the Maximum Time Step for a given solution step.

RBDAnalysisSettings.GetTimeStep(stepNumber: System.Int32) → Ansys.Core.Units.Quantity: Gets the (fixed) Time Step at a given solution step.

RBDAnalysisSettings.SetTimeStep(stepNumber: System.Int32, value: Ansys.Core.Units.Quantity) → System.Void: Sets the (fixed) Time Step for a given solution step.

RBDAnalysisSettings.GetStoreResultAt(stepNumber: System.Int32) → Ansys.Mechanical.DataModel.Enums.TimePointsOptions: Gets the StoreResultAt setting at a given solution step.

RBDAnalysisSettings.SetStoreResultAt(stepNumber: System.Int32, value: Ansys.Mechanical.DataModel.Enums.TimePointsOptions) → System.Void: Sets the StoreResultAt setting for a given solution step.

RBDAnalysisSettings.GetStoreResultAtValue(stepNumber: System.Int32) → System.Int32: Gets the StoreResultAtValue setting at a given solution step.

RBDAnalysisSettings.SetStoreResultAtValue(stepNumber: System.Int32, value: System.Int32) → System.Void: Sets the StoreResultAtValue setting for a given solution step.

RBDAnalysisSettings.DeleteAllRestartPoints() → System.Void: DeleteAllRestartPoints method.

RBDAnalysisSettings.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

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

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

RBDAnalysisSettings.Activate() → System.Void: Activate the current object.

RBDAnalysisSettings.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

RBDAnalysisSettings.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

RBDAnalysisSettings.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

RBDAnalysisSettings.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

RBDAnalysisSettings.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

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

RBDAnalysisSettings.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

RBDAnalysisSettings.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

RBDAnalysisSettings.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.