RASimulatorRun

class ansys.rocky.app.ra_simulator_run.RASimulatorRun

Bases: ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem

Rocky PrePost Scripting wrapper for solver settings.

This wrapper corresponds to the “Solver” item on a project’s data tree. Access it from the RAStudy with:

simulator_run = study.GetSimulatorRun()

Overview

Constructors

GetWrappedClass
GetClassName

Methods

RemoveProcess	It is not possible to remove the item “Solver” from the project. It’s a standard Rocky
SetTimeConfiguration	Shortcut to set both the simulation’s duration and its time interval.
HasFEMForcesEnabled	Whether the simulation is configured to collect forces for FEM analysis.
HasHtcCalculatedData	Whether the “HTC” is being calculated.
EnableHtcCalculator	Enables the “HTC” calculations.
DisableHtcCalculator	Disables the “HTC” calculations.
EnableFEMForces	Enables the “FEM Forces” calculations.
DisableFEMForces	Disables the “FEM Forces” calculations.
HasCompressedFileEnabled
GetTargetGpus	On version 27R1 the local execution mode settings are obtained from RASimulatorRun.GetLocalExecutionSettings()
SetTargetGpus	On version 27R1 the local execution mode settings are obtained from RASimulatorRun.GetLocalExecutionSettings()
GetFluentOutputsMultiplier	Get the value of “Fluent Outputs Multiplier”.
SetFluentOutputsMultiplier	Set the value of “Fluent Outputs Multiplier”.
GetStandardOutputPropertyEnabled	Retrieve enable state of given “Standard Output Property”.
SetStandardOutputPropertyEnabled	Set enable state of given “Standard Output Property”.
GetModulesOutputPropertyEnabled	Retrieve enable state of given “Modules Output Property”.
SetModulesOutputPropertyEnabled	Set enable state of given “Modules Output Property”.
GetStandardOutputPropertiesData	returns: The current value of “Standard Output Properties”.
SetStandardOutputPropertiesData	Set the current value of “Standard Output Properties”.
GetModulesOutputPropertiesData	returns: The current value of “Modules Output Properties”.
SetModulesOutputPropertiesData	Set the current value of “Modules Output Properties”.
RestoreOutputPropertiesDefaults	Restore default values of “Output Properties”.
GetUseDpmBlockingEffectForSinglePhaseSimulations	The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky
SetUseDpmBlockingEffectForSinglePhaseSimulations	The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky
EnableDpmBlockingEffectForSinglePhaseSimulations	The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky
DisableDpmBlockingEffectForSinglePhaseSimulations	The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky
IsDpmBlockingEffectForSinglePhaseSimulationsEnabled	The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky
GetSimulationTarget
SetSimulationTarget
GetResumeDataFrequency	Get the value of “Resume Data Frequency”.
SetResumeDataFrequency	Set the value of “Resume Data Frequency”.
GetLocalExecutionSettings	Get the “Local Execution Settings” element.
GetMpiSettings	Get the “MPI Settings” element.
GetNumberOfProcessors
SetNumberOfProcessors
GetProcessingUnit
SetProcessingUnit
GetValidProcessingUnitValues
GetTargetGpu
SetTargetGpu
GetMultiGpuSlicingDirection
SetMultiGpuSlicingDirection
GetValidMultiGpuSlicingDirectionValues
GetArraysGrowthRate	Get the value of “Arrays Growth Rate”.
SetArraysGrowthRate	Set the value of “Arrays Growth Rate”.
GetBreakageOverlapFactor	Get the value of “Breakage Overlap Factor”.
SetBreakageOverlapFactor	Set the value of “Breakage Overlap Factor”.
GetDisableEdgeVertexFlatContacts	Get the value of “Disable Edge Vertex Flat Contacts”.
SetDisableEdgeVertexFlatContacts	Set the value of “Disable Edge Vertex Flat Contacts”.
GetDisableTrianglesOnPeriodicBoundaries	Get the value of “Disable Triangles On Periodic Boundaries”.
SetDisableTrianglesOnPeriodicBoundaries	Set the value of “Disable Triangles On Periodic Boundaries”.
GetDragLimiterFactor	Get the value of “Drag Limiter Factor”.
SetDragLimiterFactor	Set the value of “Drag Limiter Factor”.
GetMoveCfdCellsWithRockyBoundaries	Get the value of “Move Cfd Cells With Rocky Boundaries”.
SetMoveCfdCellsWithRockyBoundaries	Set the value of “Move Cfd Cells With Rocky Boundaries”.
EnableMoveCfdCellsWithRockyBoundaries	Set the value of “Move Cfd Cells With Rocky Boundaries” to True.
DisableMoveCfdCellsWithRockyBoundaries	Set the value of “Move Cfd Cells With Rocky Boundaries” to False.
IsMoveCfdCellsWithRockyBoundariesEnabled	Check if the “Move Cfd Cells With Rocky Boundaries” is enabled.
GetFixedTimestep	Get the value of “Fixed Timestep”.
SetFixedTimestep	Set the value of “Fixed Timestep”.
GetSuccessiveOverRelaxationTolerance	Get the value of “Successive Over Relaxation Tolerance”.
SetSuccessiveOverRelaxationTolerance	Set the value of “Successive Over Relaxation Tolerance”.
GetJointElasticRatio	Get the value of “Joint Elastic Ratio”.
SetJointElasticRatio	Set the value of “Joint Elastic Ratio”.
GetMinimumLengthDeformationTolerance	Get the value of “Minimum Length Deformation Tolerance”.
SetMinimumLengthDeformationTolerance	Set the value of “Minimum Length Deformation Tolerance”.
GetLinearHystDamp	Get the value of “Linear Hyst Damp”.
SetLinearHystDamp	Set the value of “Linear Hyst Damp”.
GetLoadingNSteps	Get the value of “Loading N Steps”.
SetLoadingNSteps	Set the value of “Loading N Steps”.
GetDeformableMassMatrixType	Get “Deformable Mass Matrix Type” as a string.
SetDeformableMassMatrixType	Set the value of “Deformable Mass Matrix Type”.
GetValidDeformableMassMatrixTypeValues	Get a list of all possible values for “Deformable Mass Matrix Type”.
GetMinimumVolumeTolerance	Get the value of “Minimum Volume Tolerance”.
SetMinimumVolumeTolerance	Set the value of “Minimum Volume Tolerance”.
GetSolverCurvesFrequency	Get the value of “Solver Curves Frequency”.
SetSolverCurvesFrequency	Set the value of “Solver Curves Frequency”.
GetContactNeighboringDistanceBetweenParticles	Get the value of “Contact Neighboring Distance Between Particles”.
SetContactNeighboringDistanceBetweenParticles	Set the value of “Contact Neighboring Distance Between Particles”.
GetContactNeighboringDistanceBetweenParticlesAndTriangles	Get the value of “Contact Neighboring Distance Between Particles And Triangles”.
SetContactNeighboringDistanceBetweenParticlesAndTriangles	Set the value of “Contact Neighboring Distance Between Particles And Triangles”.
GetNegateInitialOverlaps	Get the value of “Negate Initial Overlaps”.
SetNegateInitialOverlaps	Set the value of “Negate Initial Overlaps”.
EnableNegateInitialOverlaps	Set the value of “Negate Initial Overlaps” to True.
DisableNegateInitialOverlaps	Set the value of “Negate Initial Overlaps” to False.
IsNegateInitialOverlapsEnabled	Check if the “Negate Initial Overlaps” is enabled.
GetNeighborSearchModel	Get “Neighbor Search Model” as a string.
SetNeighborSearchModel	Set the value of “Neighbor Search Model”.
GetValidNeighborSearchModelValues	Get a list of all possible values for “Neighbor Search Model”.
GetMaximumNumberOfIterations	Get the value of “Maximum Number of Iterations”.
SetMaximumNumberOfIterations	Set the value of “Maximum Number of Iterations”.
GetOverRelaxationCoefficient	Get the value of “Over Relaxation Coefficient”.
SetOverRelaxationCoefficient	Set the value of “Over Relaxation Coefficient”.
GetRefineConcaveSearch	Get the value of “Refine Concave Search”.
SetRefineConcaveSearch	Set the value of “Refine Concave Search”.
GetParticleSizeLimitForReordering	Get the value of “Particle Size Limit For Reordering”.
SetParticleSizeLimitForReordering	Set the value of “Particle Size Limit For Reordering”.
GetSpecialReorderingForWidePsd	Get the value of “Special Reordering For Wide Psd”.
SetSpecialReorderingForWidePsd	Set the value of “Special Reordering For Wide Psd”.
GetResetOnlyPhysicalContactsData	Get the value of “Reset Only Physical Contacts Data”.
SetResetOnlyPhysicalContactsData	Set the value of “Reset Only Physical Contacts Data”.
GetSortingDistanceFactor	Get the value of “Sorting Distance Factor”.
SetSortingDistanceFactor	Set the value of “Sorting Distance Factor”.
GetTimestepModel	Get “Timestep Model” as a string.
SetTimestepModel	Set the value of “Timestep Model”.
GetValidTimestepModelValues	Get a list of all possible values for “Timestep Model”.
GetUse2023R2SourceTermsApproach	Get the value of “Use 2023 R2 Source Terms Approach”.
SetUse2023R2SourceTermsApproach	Set the value of “Use 2023 R2 Source Terms Approach”.
GetUse2023R2CellVolumeFractionUpdateApproach	Get the value of “Use 2023 R2 Cell Volume Fraction Update Approach”.
SetUse2023R2CellVolumeFractionUpdateApproach	Set the value of “Use 2023 R2 Cell Volume Fraction Update Approach”.
GetUseArraysGrowthRate	Get the value of “Use Arrays Growth Rate”.
SetUseArraysGrowthRate	Set the value of “Use Arrays Growth Rate”.
GetUseBreakageOverlapFactor	Get the value of “Use Breakage Overlap Factor”.
SetUseBreakageOverlapFactor	Set the value of “Use Breakage Overlap Factor”.
GetUse3RdPowerForCfdCgm	Get the value of “Use 3Rd Power For Cfd Cgm”.
SetUse3RdPowerForCfdCgm	Set the value of “Use 3Rd Power For Cfd Cgm”.
EnableUse3RdPowerForCfdCgm	Set the value of “Use 3Rd Power For Cfd Cgm” to True.
DisableUse3RdPowerForCfdCgm	Set the value of “Use 3Rd Power For Cfd Cgm” to False.
IsUse3RdPowerForCfdCgmEnabled	Check if the “Use 3Rd Power For Cfd Cgm” is enabled.
GetUseDragLimiterFactor	Get the value of “Use Drag Limiter Factor”.
SetUseDragLimiterFactor	Set the value of “Use Drag Limiter Factor”.
GetUseFixedTimestep	Get the value of “Use Fixed Timestep”.
SetUseFixedTimestep	Set the value of “Use Fixed Timestep”.
GetUseContactNeighboringDistanceBetweenParticles	Get the value of “Use Contact Neighboring Distance Between Particles”.
SetUseContactNeighboringDistanceBetweenParticles	Set the value of “Use Contact Neighboring Distance Between Particles”.
GetUseContactNeighboringDistanceBetweenParticlesAndTriangles	Get the value of “Use Contact Neighboring Distance Between Particles And Triangles”.
SetUseContactNeighboringDistanceBetweenParticlesAndTriangles	Set the value of “Use Contact Neighboring Distance Between Particles And Triangles”.
GetUseNonRoundTorqueCorrection	Get the value of “Use Non Round Torque Correction”.
SetUseNonRoundTorqueCorrection	Set the value of “Use Non Round Torque Correction”.
GetUseNonRoundTorqueCorrectionForBoundaries	Get the value of “Use Non Round Torque Correction For Boundaries”.
SetUseNonRoundTorqueCorrectionForBoundaries	Set the value of “Use Non Round Torque Correction For Boundaries”.
GetUseSortingDistanceFactor	Get the value of “Use Sorting Distance Factor”.
SetUseSortingDistanceFactor	Set the value of “Use Sorting Distance Factor”.
EnableSortingDistanceFactor	Set the value of “Sorting Distance Factor” to True.
DisableSortingDistanceFactor	Set the value of “Sorting Distance Factor” to False.
IsSortingDistanceFactorEnabled	Check if the “Sorting Distance Factor” is enabled.
GetUseCompressedFiles	Get the value of “Use Compressed Files”.
SetUseCompressedFiles	Set the value of “Use Compressed Files”.
EnableCompressedFile	Set the value of “Compressed File” to True.
DisableCompressedFile	Set the value of “Compressed File” to False.
IsCompressedFileEnabled	Check if the “Compressed File” is enabled.
GetExecutionMode	Get “Execution Mode” as a string.
SetExecutionMode	Set the value of “Execution Mode”.
GetValidExecutionModeValues	Get a list of all possible values for “Execution Mode”.
GetReleaseParticlesWithoutOverlapCheck	Get the value of “Release Particles Without Overlap Check”.
SetReleaseParticlesWithoutOverlapCheck	Set the value of “Release Particles Without Overlap Check”.
GetBreakageDelayAfterRelease	Get the value of “Breakage Delay After Release”.
SetBreakageDelayAfterRelease	Set the value of “Breakage Delay After Release”.
GetBreakageStart	Get the value of “Breakage Start”.
SetBreakageStart	Set the value of “Breakage Start”.
GetTimeInterval	Get the value of “Time Interval”.
SetTimeInterval	Set the value of “Time Interval”.
GetOverlapParticlesDelay	Get the value of “Overlap Particles Delay”.
SetOverlapParticlesDelay	Set the value of “Overlap Particles Delay”.
GetSimulationDuration	Get the value of “Simulation Duration”.
SetSimulationDuration	Set the value of “Simulation Duration”.
GetWearGeometryUpdateInterval	Get the value of “Wear Geometry Update Interval”.
SetWearGeometryUpdateInterval	Set the value of “Wear Geometry Update Interval”.
GetWearStart	Get the value of “Wear Start”.
SetWearStart	Set the value of “Wear Start”.

Static methods

GetAvailableStandardOutputProperties	returns: The available “Standard Output Properties”.
GetAvailableModulesOutputProperties	returns: The available “Modules Output Properties”.

Import detail

from ansys.rocky.app.ra_simulator_run import RASimulatorRun

Method detail

classmethod RASimulatorRun.GetWrappedClass() → type[rocky30.models.solver.rocky_simulator_run.RockySimulatorRun]

classmethod RASimulatorRun.GetClassName() → str

RASimulatorRun.RemoveProcess() → None

It is not possible to remove the item “Solver” from the project. It’s a standard Rocky item in project.

RASimulatorRun.SetTimeConfiguration(duration: float, time_interval: float) → None

Shortcut to set both the simulation’s duration and its time interval.

Parameters:

• duration – The simulation duration (in seconds).

• time_interval – The simulation time interval (in seconds).

RASimulatorRun.HasFEMForcesEnabled() → bool

Whether the simulation is configured to collect forces for FEM analysis.

RASimulatorRun.HasHtcCalculatedData() → bool

Whether the “HTC” is being calculated.

RASimulatorRun.EnableHtcCalculator() → None

Enables the “HTC” calculations.

RASimulatorRun.DisableHtcCalculator() → None

Disables the “HTC” calculations.

RASimulatorRun.EnableFEMForces() → None

Enables the “FEM Forces” calculations.

RASimulatorRun.DisableFEMForces() → None

Disables the “FEM Forces” calculations.

RASimulatorRun.HasCompressedFileEnabled() → bool

RASimulatorRun.GetTargetGpus() → list[int]

On version 27R1 the local execution mode settings are obtained from RASimulatorRun.GetLocalExecutionSettings() in contrast with MPI settings that are obtained from RASimulatorSun.GetMpiSettings()

Returns:

A list of IDs of the GPUs currently selected for Multi GPU simulation.

RASimulatorRun.SetTargetGpus(gpus: list[int | str]) → None

On version 27R1 the local execution mode settings are obtained from RASimulatorRun.GetLocalExecutionSettings() in contrast with MPI settings that are obtained from RASimulatorSun.GetMpiSettings()

It will configure the IDs of GPUs that will be used in a local simulation based on the list of IDs or names of GPUs passed.

Parameters:

gpus – List with IDs or names of GPUs to be used in simulation. For example in the name “1 - Geforce GTX 980”, the ID is 1 and the name is “1 - Geforce GTX 980”.

RASimulatorRun.GetFluentOutputsMultiplier() → int

Get the value of “Fluent Outputs Multiplier”.

RASimulatorRun.SetFluentOutputsMultiplier(value: int) → None

Set the value of “Fluent Outputs Multiplier”.

Parameters:

value – The value to set.

RASimulatorRun.GetStandardOutputPropertyEnabled(*output_property: str) → bool

Retrieve enable state of given “Standard Output Property”.

Parameters:

output_property – The output property name.

RASimulatorRun.SetStandardOutputPropertyEnabled(*output_property: str, enabled: bool) → None

Set enable state of given “Standard Output Property”.

Parameters:

• output_property – The output property name.

• enabled – The enable state of given “Standard Output Property”.

RASimulatorRun.GetModulesOutputPropertyEnabled(*output_property: str) → bool

Retrieve enable state of given “Modules Output Property”.

Parameters:

output_property – The output property name.

RASimulatorRun.SetModulesOutputPropertyEnabled(*output_property: str, enabled: bool) → None

Set enable state of given “Modules Output Property”.

Parameters:

• output_property – The output property name.

• enabled – The enable state of given “Modules Output Property”.

static RASimulatorRun.GetAvailableStandardOutputProperties() → dict

Returns:

The available “Standard Output Properties”.

static RASimulatorRun.GetAvailableModulesOutputProperties() → dict

Returns:

The available “Modules Output Properties”.

RASimulatorRun.GetStandardOutputPropertiesData() → dict

Returns:

The current value of “Standard Output Properties”.

RASimulatorRun.SetStandardOutputPropertiesData(data_dict: dict) → None

Set the current value of “Standard Output Properties”.

Parameters:

data_dict – The data dictionary to set.

RASimulatorRun.GetModulesOutputPropertiesData() → dict

Returns:

The current value of “Modules Output Properties”.

RASimulatorRun.SetModulesOutputPropertiesData(data_dict: dict) → None

Set the current value of “Modules Output Properties”.

Parameters:

data_dict – The data dictionary to set.

RASimulatorRun.RestoreOutputPropertiesDefaults() → None

Restore default values of “Output Properties”.

RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations() → bool

The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky since 25R2.

RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations(value: bool) → None

The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky since 25R2.

RASimulatorRun.EnableDpmBlockingEffectForSinglePhaseSimulations() → None

The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky since 25R2.

RASimulatorRun.DisableDpmBlockingEffectForSinglePhaseSimulations() → None

The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky since 25R2.

RASimulatorRun.IsDpmBlockingEffectForSinglePhaseSimulationsEnabled() → bool

The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky since 25R2.

RASimulatorRun.GetSimulationTarget() → str

RASimulatorRun.SetSimulationTarget(value: str) → None

RASimulatorRun.GetResumeDataFrequency() → int

Get the value of “Resume Data Frequency”.

RASimulatorRun.SetResumeDataFrequency(value: str | int) → None

Set the value of “Resume Data Frequency”.

Parameters:

value – The value to set. This value can be an expression with input variables or int type.

RASimulatorRun.GetLocalExecutionSettings() → ansys.rocky.app.ra_local_execution_settings.RALocalExecutionSettings

Get the “Local Execution Settings” element.

simulator_run = study.GetSimulatorRun()
local_execution_settings = simulator_run.GetLocalExecutionSettings()
local_execution_settings.GetNumberOfProcessors()

RASimulatorRun.GetMpiSettings() → ansys.rocky.app.ra_local_execution_settings.RALocalExecutionSettings

Get the “MPI Settings” element.

simulator_run = study.GetSimulatorRun()
mpi_settings = simulator_run.GetMpiSettings()
mpi_settings.GetNumberOfProcessors()

RASimulatorRun.GetNumberOfProcessors() → int

RASimulatorRun.SetNumberOfProcessors(value: str | int) → None

RASimulatorRun.GetProcessingUnit() → str

RASimulatorRun.SetProcessingUnit(value: str) → None

RASimulatorRun.GetValidProcessingUnitValues() → list[str]

RASimulatorRun.GetTargetGpu() → int

RASimulatorRun.SetTargetGpu(value: str | int) → None

RASimulatorRun.GetMultiGpuSlicingDirection() → str

RASimulatorRun.SetMultiGpuSlicingDirection(value: str) → None

RASimulatorRun.GetValidMultiGpuSlicingDirectionValues() → list[str]

RASimulatorRun.GetArraysGrowthRate() → float

Get the value of “Arrays Growth Rate”.

RASimulatorRun.SetArraysGrowthRate(value: str | float) → None

Set the value of “Arrays Growth Rate”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RASimulatorRun.GetBreakageOverlapFactor() → float

Get the value of “Breakage Overlap Factor”.

RASimulatorRun.SetBreakageOverlapFactor(value: str | float) → None

Set the value of “Breakage Overlap Factor”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RASimulatorRun.GetDisableEdgeVertexFlatContacts() → bool

Get the value of “Disable Edge Vertex Flat Contacts”.

RASimulatorRun.SetDisableEdgeVertexFlatContacts(value: bool) → None

Set the value of “Disable Edge Vertex Flat Contacts”.

Parameters:

value – The value to set.

RASimulatorRun.GetDisableTrianglesOnPeriodicBoundaries() → bool

Get the value of “Disable Triangles On Periodic Boundaries”.

RASimulatorRun.SetDisableTrianglesOnPeriodicBoundaries(value: bool) → None

Set the value of “Disable Triangles On Periodic Boundaries”.

Parameters:

value – The value to set.

RASimulatorRun.GetDragLimiterFactor() → float

Get the value of “Drag Limiter Factor”.

RASimulatorRun.SetDragLimiterFactor(value: str | float) → None

Set the value of “Drag Limiter Factor”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RASimulatorRun.GetMoveCfdCellsWithRockyBoundaries() → bool

Get the value of “Move Cfd Cells With Rocky Boundaries”.

RASimulatorRun.SetMoveCfdCellsWithRockyBoundaries(value: bool) → None

Set the value of “Move Cfd Cells With Rocky Boundaries”.

Parameters:

value – The value to set.

RASimulatorRun.EnableMoveCfdCellsWithRockyBoundaries() → None

Set the value of “Move Cfd Cells With Rocky Boundaries” to True.

RASimulatorRun.DisableMoveCfdCellsWithRockyBoundaries() → None

Set the value of “Move Cfd Cells With Rocky Boundaries” to False.

RASimulatorRun.IsMoveCfdCellsWithRockyBoundariesEnabled() → bool

Check if the “Move Cfd Cells With Rocky Boundaries” is enabled.

RASimulatorRun.GetFixedTimestep(unit: str | None = None) → float

Get the value of “Fixed Timestep”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “s”.

RASimulatorRun.SetFixedTimestep(value: str | float, unit: str | None = None) → None

Set the value of “Fixed Timestep”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “s”.

RASimulatorRun.GetSuccessiveOverRelaxationTolerance() → float

Get the value of “Successive Over Relaxation Tolerance”.

RASimulatorRun.SetSuccessiveOverRelaxationTolerance(value: str | float) → None

Set the value of “Successive Over Relaxation Tolerance”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RASimulatorRun.GetJointElasticRatio() → float

Get the value of “Joint Elastic Ratio”.

RASimulatorRun.SetJointElasticRatio(value: str | float) → None

Set the value of “Joint Elastic Ratio”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RASimulatorRun.GetMinimumLengthDeformationTolerance() → float

Get the value of “Minimum Length Deformation Tolerance”.

RASimulatorRun.SetMinimumLengthDeformationTolerance(value: str | float) → None

Set the value of “Minimum Length Deformation Tolerance”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RASimulatorRun.GetLinearHystDamp() → float

Get the value of “Linear Hyst Damp”.

RASimulatorRun.SetLinearHystDamp(value: str | float) → None

Set the value of “Linear Hyst Damp”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RASimulatorRun.GetLoadingNSteps() → int

Get the value of “Loading N Steps”.

RASimulatorRun.SetLoadingNSteps(value: str | int) → None

Set the value of “Loading N Steps”.

Parameters:

value – The value to set. This value can be an expression with input variables or int type.

RASimulatorRun.GetDeformableMassMatrixType() → str

Get “Deformable Mass Matrix Type” as a string.

Returns:

The returned value will be one of [‘lumped’, ‘consistent’].

RASimulatorRun.SetDeformableMassMatrixType(value: str) → None

Set the value of “Deformable Mass Matrix Type”.

Parameters:

value – The value to set. Must be one of [‘lumped’, ‘consistent’].

Raises:

RockyApiError – If value is not a valid “Deformable Mass Matrix Type” option.

RASimulatorRun.GetValidDeformableMassMatrixTypeValues() → list[str]

Get a list of all possible values for “Deformable Mass Matrix Type”.

Returns:

The returned list is [‘lumped’, ‘consistent’].

RASimulatorRun.GetMinimumVolumeTolerance() → float

Get the value of “Minimum Volume Tolerance”.

RASimulatorRun.SetMinimumVolumeTolerance(value: str | float) → None

Set the value of “Minimum Volume Tolerance”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RASimulatorRun.GetSolverCurvesFrequency() → int

Get the value of “Solver Curves Frequency”.

RASimulatorRun.SetSolverCurvesFrequency(value: str | int) → None

Set the value of “Solver Curves Frequency”.

Parameters:

value – The value to set. This value can be an expression with input variables or int type.

RASimulatorRun.GetContactNeighboringDistanceBetweenParticles(unit: str | None = None) → float

Get the value of “Contact Neighboring Distance Between Particles”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.

RASimulatorRun.SetContactNeighboringDistanceBetweenParticles(value: str | float, unit: str | None = None) → None

Set the value of “Contact Neighboring Distance Between Particles”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “m”.

RASimulatorRun.GetContactNeighboringDistanceBetweenParticlesAndTriangles(unit: str | None = None) → float

Get the value of “Contact Neighboring Distance Between Particles And Triangles”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.

RASimulatorRun.SetContactNeighboringDistanceBetweenParticlesAndTriangles(value: str | float, unit: str | None = None) → None

Set the value of “Contact Neighboring Distance Between Particles And Triangles”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “m”.

RASimulatorRun.GetNegateInitialOverlaps() → bool

Get the value of “Negate Initial Overlaps”.

RASimulatorRun.SetNegateInitialOverlaps(value: bool) → None

Set the value of “Negate Initial Overlaps”.

Parameters:

value – The value to set.

RASimulatorRun.EnableNegateInitialOverlaps() → None

Set the value of “Negate Initial Overlaps” to True.

RASimulatorRun.DisableNegateInitialOverlaps() → None

Set the value of “Negate Initial Overlaps” to False.

RASimulatorRun.IsNegateInitialOverlapsEnabled() → bool

Check if the “Negate Initial Overlaps” is enabled.

RASimulatorRun.GetNeighborSearchModel() → str

Get “Neighbor Search Model” as a string.

Returns:

The returned value will be one of [‘BVH’, ‘RegularGrid’, ‘SparseGrid’].

RASimulatorRun.SetNeighborSearchModel(value: str) → None

Set the value of “Neighbor Search Model”.

Parameters:

value – The value to set. Must be one of [‘BVH’, ‘RegularGrid’, ‘SparseGrid’].

Raises:

RockyApiError – If value is not a valid “Neighbor Search Model” option.

RASimulatorRun.GetValidNeighborSearchModelValues() → list[str]

Get a list of all possible values for “Neighbor Search Model”.

Returns:

The returned list is [‘BVH’, ‘RegularGrid’, ‘SparseGrid’].

RASimulatorRun.GetMaximumNumberOfIterations() → int

Get the value of “Maximum Number of Iterations”.

RASimulatorRun.SetMaximumNumberOfIterations(value: str | int) → None

Set the value of “Maximum Number of Iterations”.

Parameters:

value – The value to set. This value can be an expression with input variables or int type.

RASimulatorRun.GetOverRelaxationCoefficient() → float

Get the value of “Over Relaxation Coefficient”.

RASimulatorRun.SetOverRelaxationCoefficient(value: str | float) → None

Set the value of “Over Relaxation Coefficient”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RASimulatorRun.GetRefineConcaveSearch() → bool

Get the value of “Refine Concave Search”.

RASimulatorRun.SetRefineConcaveSearch(value: bool) → None

Set the value of “Refine Concave Search”.

Parameters:

value – The value to set.

RASimulatorRun.GetParticleSizeLimitForReordering(unit: str | None = None) → float

Get the value of “Particle Size Limit For Reordering”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.

RASimulatorRun.SetParticleSizeLimitForReordering(value: str | float, unit: str | None = None) → None

Set the value of “Particle Size Limit For Reordering”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “m”.

RASimulatorRun.GetSpecialReorderingForWidePsd() → bool

Get the value of “Special Reordering For Wide Psd”.

RASimulatorRun.SetSpecialReorderingForWidePsd(value: bool) → None

Set the value of “Special Reordering For Wide Psd”.

Parameters:

value – The value to set.

RASimulatorRun.GetResetOnlyPhysicalContactsData() → bool

Get the value of “Reset Only Physical Contacts Data”.

RASimulatorRun.SetResetOnlyPhysicalContactsData(value: bool) → None

Set the value of “Reset Only Physical Contacts Data”.

Parameters:

value – The value to set.

RASimulatorRun.GetSortingDistanceFactor() → float

Get the value of “Sorting Distance Factor”.

RASimulatorRun.SetSortingDistanceFactor(value: str | float) → None

Set the value of “Sorting Distance Factor”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RASimulatorRun.GetTimestepModel() → str

Get “Timestep Model” as a string.

Returns:

The returned value will be one of [‘constant’, ‘variable’].

RASimulatorRun.SetTimestepModel(value: str) → None

Set the value of “Timestep Model”.

Parameters:

value – The value to set. Must be one of [‘constant’, ‘variable’].

Raises:

RockyApiError – If value is not a valid “Timestep Model” option.

RASimulatorRun.GetValidTimestepModelValues() → list[str]

Get a list of all possible values for “Timestep Model”.

Returns:

The returned list is [‘constant’, ‘variable’].

RASimulatorRun.GetUse2023R2SourceTermsApproach() → bool

Get the value of “Use 2023 R2 Source Terms Approach”.

RASimulatorRun.SetUse2023R2SourceTermsApproach(value: bool) → None

Set the value of “Use 2023 R2 Source Terms Approach”.

Parameters:

value – The value to set.

RASimulatorRun.GetUse2023R2CellVolumeFractionUpdateApproach() → bool

Get the value of “Use 2023 R2 Cell Volume Fraction Update Approach”.

RASimulatorRun.SetUse2023R2CellVolumeFractionUpdateApproach(value: bool) → None

Set the value of “Use 2023 R2 Cell Volume Fraction Update Approach”.

Parameters:

value – The value to set.

RASimulatorRun.GetUseArraysGrowthRate() → bool

Get the value of “Use Arrays Growth Rate”.

RASimulatorRun.SetUseArraysGrowthRate(value: bool) → None

Set the value of “Use Arrays Growth Rate”.

Parameters:

value – The value to set.

RASimulatorRun.GetUseBreakageOverlapFactor() → bool

Get the value of “Use Breakage Overlap Factor”.

RASimulatorRun.SetUseBreakageOverlapFactor(value: bool) → None

Set the value of “Use Breakage Overlap Factor”.

Parameters:

value – The value to set.

RASimulatorRun.GetUse3RdPowerForCfdCgm() → bool

Get the value of “Use 3Rd Power For Cfd Cgm”.

RASimulatorRun.SetUse3RdPowerForCfdCgm(value: bool) → None

Set the value of “Use 3Rd Power For Cfd Cgm”.

Parameters:

value – The value to set.

RASimulatorRun.EnableUse3RdPowerForCfdCgm() → None

Set the value of “Use 3Rd Power For Cfd Cgm” to True.

RASimulatorRun.DisableUse3RdPowerForCfdCgm() → None

Set the value of “Use 3Rd Power For Cfd Cgm” to False.

RASimulatorRun.IsUse3RdPowerForCfdCgmEnabled() → bool

Check if the “Use 3Rd Power For Cfd Cgm” is enabled.

RASimulatorRun.GetUseDragLimiterFactor() → bool

Get the value of “Use Drag Limiter Factor”.

RASimulatorRun.SetUseDragLimiterFactor(value: bool) → None

Set the value of “Use Drag Limiter Factor”.

Parameters:

value – The value to set.

RASimulatorRun.GetUseFixedTimestep() → bool

Get the value of “Use Fixed Timestep”.

RASimulatorRun.SetUseFixedTimestep(value: bool) → None

Set the value of “Use Fixed Timestep”.

Parameters:

value – The value to set.

RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticles() → bool

Get the value of “Use Contact Neighboring Distance Between Particles”.

RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticles(value: bool) → None

Set the value of “Use Contact Neighboring Distance Between Particles”.

Parameters:

value – The value to set.

RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticlesAndTriangles() → bool

Get the value of “Use Contact Neighboring Distance Between Particles And Triangles”.

RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticlesAndTriangles(value: bool) → None

Set the value of “Use Contact Neighboring Distance Between Particles And Triangles”.

Parameters:

value – The value to set.

RASimulatorRun.GetUseNonRoundTorqueCorrection() → bool

Get the value of “Use Non Round Torque Correction”.

RASimulatorRun.SetUseNonRoundTorqueCorrection(value: bool) → None

Set the value of “Use Non Round Torque Correction”.

Parameters:

value – The value to set.

RASimulatorRun.GetUseNonRoundTorqueCorrectionForBoundaries() → bool

Get the value of “Use Non Round Torque Correction For Boundaries”.

RASimulatorRun.SetUseNonRoundTorqueCorrectionForBoundaries(value: bool) → None

Set the value of “Use Non Round Torque Correction For Boundaries”.

Parameters:

value – The value to set.

RASimulatorRun.GetUseSortingDistanceFactor() → bool

Get the value of “Use Sorting Distance Factor”.

RASimulatorRun.SetUseSortingDistanceFactor(value: bool) → None

Set the value of “Use Sorting Distance Factor”.

Parameters:

value – The value to set.

RASimulatorRun.EnableSortingDistanceFactor() → None

Set the value of “Sorting Distance Factor” to True.

RASimulatorRun.DisableSortingDistanceFactor() → None

Set the value of “Sorting Distance Factor” to False.

RASimulatorRun.IsSortingDistanceFactorEnabled() → bool

Check if the “Sorting Distance Factor” is enabled.

RASimulatorRun.GetUseCompressedFiles() → bool

Get the value of “Use Compressed Files”.

RASimulatorRun.SetUseCompressedFiles(value: bool) → None

Set the value of “Use Compressed Files”.

Parameters:

value – The value to set.

RASimulatorRun.EnableCompressedFile() → None

Set the value of “Compressed File” to True.

RASimulatorRun.DisableCompressedFile() → None

Set the value of “Compressed File” to False.

RASimulatorRun.IsCompressedFileEnabled() → bool

Check if the “Compressed File” is enabled.

RASimulatorRun.GetExecutionMode() → str

Get “Execution Mode” as a string.

Returns:

The returned value will be one of [‘local’, ‘single_mpi’, ‘multi_mpi’].

RASimulatorRun.SetExecutionMode(value: str) → None

Set the value of “Execution Mode”.

Parameters:

value – The value to set. Must be one of [‘local’, ‘single_mpi’, ‘multi_mpi’].

Raises:

RockyApiError – If value is not a valid “Execution Mode” option.

RASimulatorRun.GetValidExecutionModeValues() → list[str]

Get a list of all possible values for “Execution Mode”.

Returns:

The returned list is [‘local’, ‘single_mpi’, ‘multi_mpi’].

RASimulatorRun.GetReleaseParticlesWithoutOverlapCheck() → bool

Get the value of “Release Particles Without Overlap Check”.

RASimulatorRun.SetReleaseParticlesWithoutOverlapCheck(value: bool) → None

Set the value of “Release Particles Without Overlap Check”.

Parameters:

value – The value to set.

RASimulatorRun.GetBreakageDelayAfterRelease(unit: str | None = None) → float

Get the value of “Breakage Delay After Release”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “s”.

RASimulatorRun.SetBreakageDelayAfterRelease(value: str | float, unit: str | None = None) → None

Set the value of “Breakage Delay After Release”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “s”.

RASimulatorRun.GetBreakageStart(unit: str | None = None) → float

Get the value of “Breakage Start”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “s”.

RASimulatorRun.SetBreakageStart(value: str | float, unit: str | None = None) → None

Set the value of “Breakage Start”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “s”.

RASimulatorRun.GetTimeInterval(unit: str | None = None) → float

Get the value of “Time Interval”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “s”.

RASimulatorRun.SetTimeInterval(value: str | float, unit: str | None = None) → None

Set the value of “Time Interval”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “s”.

RASimulatorRun.GetOverlapParticlesDelay(unit: str | None = None) → float

Get the value of “Overlap Particles Delay”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “s”.

RASimulatorRun.SetOverlapParticlesDelay(value: str | float, unit: str | None = None) → None

Set the value of “Overlap Particles Delay”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “s”.

RASimulatorRun.GetSimulationDuration(unit: str | None = None) → float

Get the value of “Simulation Duration”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “s”.

RASimulatorRun.SetSimulationDuration(value: str | float, unit: str | None = None) → None

Set the value of “Simulation Duration”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “s”.

RASimulatorRun.GetWearGeometryUpdateInterval(unit: str | None = None) → float

Get the value of “Wear Geometry Update Interval”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “s”.

RASimulatorRun.SetWearGeometryUpdateInterval(value: str | float, unit: str | None = None) → None

Set the value of “Wear Geometry Update Interval”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “s”.

RASimulatorRun.GetWearStart(unit: str | None = None) → float

Get the value of “Wear Start”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “s”.

RASimulatorRun.SetWearStart(value: str | float, unit: str | None = None) → None

Set the value of “Wear Start”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “s”.