`RASPHSettings`#

class ansys.rocky.app.ra_sph_settings.RASPHSettings(id, model_id=None)#

Bases: ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem

Rocky PrePost Scripting wrapper for SPH Settings properties.

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

sph_settings = study.GetSphSettings()
sph_settings = study.GetElement('SPH')

Overview#

Constructors

`GetWrappedClass`
`GetClassName`

Methods

`SetSolver`	Set the value of “Solver Model”.
`GetSolver`	Get “Solver Model” as a string.
`GetCS`	Get the value of “C S”.
`SetCS`	Set the value of “C S”.
`GetClearyFactor`	Get the value of “Cleary Factor”.
`SetClearyFactor`	Set the value of “Cleary Factor”.
`GetDensityDevMinus`	Get the value of “Density Dev Minus”.
`SetDensityDevMinus`	Set the value of “Density Dev Minus”.
`GetDensityDevPlus`	Get the value of “Density Dev Plus”.
`SetDensityDevPlus`	Set the value of “Density Dev Plus”.
`GetDensityRelativeErrorTolerance`	Get the value of “Density Relative Error Tolerance”.
`SetDensityRelativeErrorTolerance`	Set the value of “Density Relative Error Tolerance”.
`GetDissFactor`	Get the value of “Diss Factor”.
`SetDissFactor`	Set the value of “Diss Factor”.
`GetDistFactorNorm`	Get the value of “Dist Factor Norm”.
`SetDistFactorNorm`	Set the value of “Dist Factor Norm”.
`GetDistFactorTang`	Get the value of “Dist Factor Tang”.
`SetDistFactorTang`	Set the value of “Dist Factor Tang”.
`GetEnabled`	Get the value of “Enabled”.
`SetEnabled`	Set the value of “Enabled”.
`GetEulerianSolutionEnabled`	Get the value of “Eulerian Solution Enabled”.
`SetEulerianSolutionEnabled`	Set the value of “Eulerian Solution Enabled”.
`EnableEulerianSolution`	Set the value of “Eulerian Solution” to True.
`DisableEulerianSolution`	Set the value of “Eulerian Solution” to False.
`IsEulerianSolutionEnabled`	Check if the “Eulerian Solution” is enabled.
`GetFreeSurfaceDivergenceLimit`	Get the value of “Free Surface Divergence Limit”.
`SetFreeSurfaceDivergenceLimit`	Set the value of “Free Surface Divergence Limit”.
`GetIncompressibilityRelaxationFactor`	Get the value of “Incompressibility Relaxation Factor”.
`SetIncompressibilityRelaxationFactor`	Set the value of “Incompressibility Relaxation Factor”.
`GetKernelDistFactor`	Get the value of “Kernel Dist Factor”.
`SetKernelDistFactor`	Set the value of “Kernel Dist Factor”.
`GetKernelType`	Get “Kernel Type” as a string.
`SetKernelType`	Set the value of “Kernel Type”.
`GetValidKernelTypeValues`	Get a list of all possible values for “Kernel Type”.
`GetLimitTurbulentViscosity`	Get the value of “Limit Turbulent Viscosity”.
`SetLimitTurbulentViscosity`	Set the value of “Limit Turbulent Viscosity”.
`GetMaximumExpectedVelocity`	Get the value of “Maximum Expected Velocity”.
`SetMaximumExpectedVelocity`	Set the value of “Maximum Expected Velocity”.
`GetMaximumNumberOfIterations`	Get the value of “Maximum Number of Iterations”.
`SetMaximumNumberOfIterations`	Set the value of “Maximum Number of Iterations”.
`GetMinDistFactor`	Get the value of “Min Dist Factor”.
`SetMinDistFactor`	Set the value of “Min Dist Factor”.
`GetName`	Get the value of “Name”.
`SetName`	Set the value of “Name”.
`GetNegativePressureFactor`	Get the value of “Negative Pressure Factor”.
`SetNegativePressureFactor`	Set the value of “Negative Pressure Factor”.
`GetNumCellSteps`	Get the value of “Num Cell Steps”.
`SetNumCellSteps`	Set the value of “Num Cell Steps”.
`GetNumberOfSteps`	Get the value of “Number of Steps”.
`SetNumberOfSteps`	Set the value of “Number of Steps”.
`GetPosCorrectionType`	Get “Pos Correction Type” as a string.
`SetPosCorrectionType`	Set the value of “Pos Correction Type”.
`GetValidPosCorrectionTypeValues`	Get a list of all possible values for “Pos Correction Type”.
`GetPressureDeg`	Get the value of “Pressure Deg”.
`SetPressureDeg`	Set the value of “Pressure Deg”.
`GetPressureUnderRelaxationFactor`	Get the value of “Pressure Under Relaxation Factor”.
`SetPressureUnderRelaxationFactor`	Set the value of “Pressure Under Relaxation Factor”.
`GetRelaxedIncompressibilityConstraintEnabled`	Get the value of “Relaxed Incompressibility Constraint Enabled”.
`SetRelaxedIncompressibilityConstraintEnabled`	Set the value of “Relaxed Incompressibility Constraint Enabled”.
`EnableRelaxedIncompressibilityConstraint`	Set the value of “Relaxed Incompressibility Constraint” to True.
`DisableRelaxedIncompressibilityConstraint`	Set the value of “Relaxed Incompressibility Constraint” to False.
`IsRelaxedIncompressibilityConstraintEnabled`	Check if the “Relaxed Incompressibility Constraint” is enabled.
`GetShepardFilterOnDensityEnabled`	Get the value of “Shepard Filter On Density Enabled”.
`SetShepardFilterOnDensityEnabled`	Set the value of “Shepard Filter On Density Enabled”.
`EnableShepardFilterOnDensity`	Set the value of “Shepard Filter On Density” to True.
`DisableShepardFilterOnDensity`	Set the value of “Shepard Filter On Density” to False.
`IsShepardFilterOnDensityEnabled`	Check if the “Shepard Filter On Density” is enabled.
`GetShepardFilterOnPressureEnabled`	Get the value of “Shepard Filter On Pressure Enabled”.
`SetShepardFilterOnPressureEnabled`	Set the value of “Shepard Filter On Pressure Enabled”.
`EnableShepardFilterOnPressure`	Set the value of “Shepard Filter On Pressure” to True.
`DisableShepardFilterOnPressure`	Set the value of “Shepard Filter On Pressure” to False.
`IsShepardFilterOnPressureEnabled`	Check if the “Shepard Filter On Pressure” is enabled.
`GetShiftingFactor`	Get the value of “Shifting Factor”.
`SetShiftingFactor`	Set the value of “Shifting Factor”.
`GetSize`	Get the value of “Size”.
`SetSize`	Set the value of “Size”.
`GetSolverModel`	Get “Solver Model” as a string.
`SetSolverModel`	Set the value of “Solver Model”.
`GetValidSolverModelValues`	Get a list of all possible values for “Solver Model”.
`GetSoundSpeed`	Get the value of “Sound Speed”.
`SetSoundSpeed`	Set the value of “Sound Speed”.
`GetStabilityDegree`	Get the value of “Stability Degree”.
`SetStabilityDegree`	Set the value of “Stability Degree”.
`GetStabilityNegFactor`	Get the value of “Stability Neg Factor”.
`SetStabilityNegFactor`	Set the value of “Stability Neg Factor”.
`GetStabilityPosFactor`	Get the value of “Stability Pos Factor”.
`SetStabilityPosFactor`	Set the value of “Stability Pos Factor”.
`GetStiffFactor`	Get the value of “Stiff Factor”.
`SetStiffFactor`	Set the value of “Stiff Factor”.
`GetSurfaceTensionBoundaryAngle`	Get the value of “Surface Tension Boundary Angle”.
`SetSurfaceTensionBoundaryAngle`	Set the value of “Surface Tension Boundary Angle”.
`GetSurfaceTensionBoundaryFraction`	Get the value of “Surface Tension Boundary Fraction”.
`SetSurfaceTensionBoundaryFraction`	Set the value of “Surface Tension Boundary Fraction”.
`GetSurfaceTensionCoefficient`	Get the value of “Surface Tension Coefficient”.
`SetSurfaceTensionCoefficient`	Set the value of “Surface Tension Coefficient”.
`GetSurfaceTensionType`	Get “Surface Tension Type” as a string.
`SetSurfaceTensionType`	Set the value of “Surface Tension Type”.
`GetValidSurfaceTensionTypeValues`	Get a list of all possible values for “Surface Tension Type”.
`GetTimestepFactor`	Get the value of “Timestep Factor”.
`SetTimestepFactor`	Set the value of “Timestep Factor”.
`GetTurbDistanceFraction`	Get the value of “Turb Distance Fraction”.
`SetTurbDistanceFraction`	Set the value of “Turb Distance Fraction”.
`GetTurbulenceType`	Get “Turbulence Type” as a string.
`SetTurbulenceType`	Set the value of “Turbulence Type”.
`GetValidTurbulenceTypeValues`	Get a list of all possible values for “Turbulence Type”.
`GetTurbulentPrandtl`	Get the value of “Turbulent Prandtl”.
`SetTurbulentPrandtl`	Set the value of “Turbulent Prandtl”.
`GetTurbulentViscosityMaximumRatio`	Get the value of “Turbulent Viscosity Maximum Ratio”.
`SetTurbulentViscosityMaximumRatio`	Set the value of “Turbulent Viscosity Maximum Ratio”.
`GetUpdateCoupledDensity`	Get the value of “Update Coupled Density”.
`SetUpdateCoupledDensity`	Set the value of “Update Coupled Density”.
`GetUseParticlesNeighborsList`	Get the value of “Use Particles Neighbors List”.
`SetUseParticlesNeighborsList`	Set the value of “Use Particles Neighbors List”.
`GetViscosityType`	Get “Viscosity Type” as a string.
`SetViscosityType`	Set the value of “Viscosity Type”.
`GetValidViscosityTypeValues`	Get a list of all possible values for “Viscosity Type”.
`GetViscousForceIntegration`	Get “Viscous Force Integration” as a string.
`SetViscousForceIntegration`	Set the value of “Viscous Force Integration”.
`GetValidViscousForceIntegrationValues`	Get a list of all possible values for “Viscous Force Integration”.
`GetViscousForceMaximumNumberOfIterations`	Get the value of “Viscous Force Maximum Number of Iterations”.
`SetViscousForceMaximumNumberOfIterations`	Set the value of “Viscous Force Maximum Number of Iterations”.
`GetViscousForceRelativeErrorTolerance`	Get the value of “Viscous Force Relative Error Tolerance”.
`SetViscousForceRelativeErrorTolerance`	Set the value of “Viscous Force Relative Error Tolerance”.
`GetViscousForceUnderRelaxationFactor`	Get the value of “Viscous Force Under Relaxation Factor”.
`SetViscousForceUnderRelaxationFactor`	Set the value of “Viscous Force Under Relaxation Factor”.
`GetXsphFactor`	Get the value of “Xsph Factor”.
`SetXsphFactor`	Set the value of “Xsph Factor”.
`GetFluidMaterial`	Get the “Fluid Material”.
`SetFluidMaterial`	Set the “Fluid Material”.
`GetAvailableFluidMaterials`	Get all available Fluid Materials.

Import detail#

from ansys.rocky.app.ra_sph_settings import RASPHSettings

Method detail#

classmethod RASPHSettings.GetWrappedClass() → type[rocky30.models.sph.sph_settings.SPHProcess]#

classmethod RASPHSettings.GetClassName() → str#

RASPHSettings.SetSolver(value: str) → None#

Set the value of “Solver Model”.

Parameters:: value – The value to set. Must be one of [‘WCSPH’, ‘IISPH’].
Raises:: RockyApiError – If value is not a valid “Solver Model” option.

RASPHSettings.GetSolver() → str#

Get “Solver Model” as a string.

Returns:: The returned value will be one of [‘WCSPH’, ‘IISPH’].

RASPHSettings.GetCS() → float#: Get the value of “C S”.

RASPHSettings.SetCS(value: str | float) → None#

Set the value of “C S”.

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

RASPHSettings.GetClearyFactor() → float#: Get the value of “Cleary Factor”.

RASPHSettings.SetClearyFactor(value: str | float) → None#

Set the value of “Cleary Factor”.

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

RASPHSettings.GetDensityDevMinus() → float#: Get the value of “Density Dev Minus”.

RASPHSettings.SetDensityDevMinus(value: str | float) → None#

Set the value of “Density Dev Minus”.

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

RASPHSettings.GetDensityDevPlus() → float#: Get the value of “Density Dev Plus”.

RASPHSettings.SetDensityDevPlus(value: str | float) → None#

Set the value of “Density Dev Plus”.

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

RASPHSettings.GetDensityRelativeErrorTolerance() → float#: Get the value of “Density Relative Error Tolerance”.

RASPHSettings.SetDensityRelativeErrorTolerance(value: str | float) → None#

Set the value of “Density Relative Error Tolerance”.

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

RASPHSettings.GetDissFactor() → float#: Get the value of “Diss Factor”.

RASPHSettings.SetDissFactor(value: str | float) → None#

Set the value of “Diss Factor”.

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

RASPHSettings.GetDistFactorNorm() → float#: Get the value of “Dist Factor Norm”.

RASPHSettings.SetDistFactorNorm(value: str | float) → None#

Set the value of “Dist Factor Norm”.

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

RASPHSettings.GetDistFactorTang() → float#: Get the value of “Dist Factor Tang”.

RASPHSettings.SetDistFactorTang(value: str | float) → None#

Set the value of “Dist Factor Tang”.

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

RASPHSettings.GetEnabled() → bool#: Get the value of “Enabled”.

RASPHSettings.SetEnabled(value: bool) → None#

Set the value of “Enabled”.

Parameters:: value – The value to set.

RASPHSettings.GetEulerianSolutionEnabled() → bool#: Get the value of “Eulerian Solution Enabled”.

RASPHSettings.SetEulerianSolutionEnabled(value: bool) → None#

Set the value of “Eulerian Solution Enabled”.

Parameters:: value – The value to set.

RASPHSettings.EnableEulerianSolution() → None#: Set the value of “Eulerian Solution” to True.

RASPHSettings.DisableEulerianSolution() → None#: Set the value of “Eulerian Solution” to False.

RASPHSettings.IsEulerianSolutionEnabled() → bool#: Check if the “Eulerian Solution” is enabled.

RASPHSettings.GetFreeSurfaceDivergenceLimit() → float#: Get the value of “Free Surface Divergence Limit”.

RASPHSettings.SetFreeSurfaceDivergenceLimit(value: str | float) → None#

Set the value of “Free Surface Divergence Limit”.

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

RASPHSettings.GetIncompressibilityRelaxationFactor() → float#: Get the value of “Incompressibility Relaxation Factor”.

RASPHSettings.SetIncompressibilityRelaxationFactor(value: str | float) → None#

Set the value of “Incompressibility Relaxation Factor”.

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

RASPHSettings.GetKernelDistFactor() → float#: Get the value of “Kernel Dist Factor”.

RASPHSettings.SetKernelDistFactor(value: str | float) → None#

Set the value of “Kernel Dist Factor”.

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

RASPHSettings.GetKernelType() → str#

Get “Kernel Type” as a string.

Returns:: The returned value will be one of [‘cubic’, ‘quintic’, ‘wendland’].

RASPHSettings.SetKernelType(value: str) → None#

Set the value of “Kernel Type”.

Parameters:: value – The value to set. Must be one of [‘cubic’, ‘quintic’, ‘wendland’].
Raises:: RockyApiError – If value is not a valid “Kernel Type” option.

RASPHSettings.GetValidKernelTypeValues() → list[str]#

Get a list of all possible values for “Kernel Type”.

Returns:: The returned list is [‘cubic’, ‘quintic’, ‘wendland’].

RASPHSettings.GetLimitTurbulentViscosity() → bool#: Get the value of “Limit Turbulent Viscosity”.

RASPHSettings.SetLimitTurbulentViscosity(value: bool) → None#

Set the value of “Limit Turbulent Viscosity”.

Parameters:: value – The value to set.

RASPHSettings.GetMaximumExpectedVelocity(unit: str | None = None) → float#

Get the value of “Maximum Expected Velocity”.

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

RASPHSettings.SetMaximumExpectedVelocity(value: str | float, unit: str | None = None) → None#

Set the value of “Maximum Expected Velocity”.

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/s”.

RASPHSettings.GetMaximumNumberOfIterations() → int#: Get the value of “Maximum Number of Iterations”.

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

RASPHSettings.GetMinDistFactor() → float#: Get the value of “Min Dist Factor”.

RASPHSettings.SetMinDistFactor(value: str | float) → None#

Set the value of “Min Dist Factor”.

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

RASPHSettings.GetName() → str#: Get the value of “Name”.

RASPHSettings.SetName(value: str) → None#

Set the value of “Name”.

Parameters:: value – The value to set.

RASPHSettings.GetNegativePressureFactor() → float#: Get the value of “Negative Pressure Factor”.

RASPHSettings.SetNegativePressureFactor(value: str | float) → None#

Set the value of “Negative Pressure Factor”.

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

RASPHSettings.GetNumCellSteps() → int#: Get the value of “Num Cell Steps”.

RASPHSettings.SetNumCellSteps(value: str | int) → None#

Set the value of “Num Cell Steps”.

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

RASPHSettings.GetNumberOfSteps() → int#: Get the value of “Number of Steps”.

RASPHSettings.SetNumberOfSteps(value: str | int) → None#

Set the value of “Number of Steps”.

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

RASPHSettings.GetPosCorrectionType() → str#

Get “Pos Correction Type” as a string.

Returns:: The returned value will be one of [‘none’, ‘xsph’, ‘shift’].

RASPHSettings.SetPosCorrectionType(value: str) → None#

Set the value of “Pos Correction Type”.

Parameters:: value – The value to set. Must be one of [‘none’, ‘xsph’, ‘shift’].
Raises:: RockyApiError – If value is not a valid “Pos Correction Type” option.

RASPHSettings.GetValidPosCorrectionTypeValues() → list[str]#

Get a list of all possible values for “Pos Correction Type”.

Returns:: The returned list is [‘none’, ‘xsph’, ‘shift’].

RASPHSettings.GetPressureDeg() → int#: Get the value of “Pressure Deg”.

RASPHSettings.SetPressureDeg(value: str | int) → None#

Set the value of “Pressure Deg”.

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

RASPHSettings.GetPressureUnderRelaxationFactor() → float#: Get the value of “Pressure Under Relaxation Factor”.

RASPHSettings.SetPressureUnderRelaxationFactor(value: str | float) → None#

Set the value of “Pressure Under Relaxation Factor”.

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

RASPHSettings.GetRelaxedIncompressibilityConstraintEnabled() → bool#: Get the value of “Relaxed Incompressibility Constraint Enabled”.

RASPHSettings.SetRelaxedIncompressibilityConstraintEnabled(value: bool) → None#

Set the value of “Relaxed Incompressibility Constraint Enabled”.

Parameters:: value – The value to set.

RASPHSettings.EnableRelaxedIncompressibilityConstraint() → None#: Set the value of “Relaxed Incompressibility Constraint” to True.

RASPHSettings.DisableRelaxedIncompressibilityConstraint() → None#: Set the value of “Relaxed Incompressibility Constraint” to False.

RASPHSettings.IsRelaxedIncompressibilityConstraintEnabled() → bool#: Check if the “Relaxed Incompressibility Constraint” is enabled.

RASPHSettings.GetShepardFilterOnDensityEnabled() → bool#: Get the value of “Shepard Filter On Density Enabled”.

RASPHSettings.SetShepardFilterOnDensityEnabled(value: bool) → None#

Set the value of “Shepard Filter On Density Enabled”.

Parameters:: value – The value to set.

RASPHSettings.EnableShepardFilterOnDensity() → None#: Set the value of “Shepard Filter On Density” to True.

RASPHSettings.DisableShepardFilterOnDensity() → None#: Set the value of “Shepard Filter On Density” to False.

RASPHSettings.IsShepardFilterOnDensityEnabled() → bool#: Check if the “Shepard Filter On Density” is enabled.

RASPHSettings.GetShepardFilterOnPressureEnabled() → bool#: Get the value of “Shepard Filter On Pressure Enabled”.

RASPHSettings.SetShepardFilterOnPressureEnabled(value: bool) → None#

Set the value of “Shepard Filter On Pressure Enabled”.

Parameters:: value – The value to set.

RASPHSettings.EnableShepardFilterOnPressure() → None#: Set the value of “Shepard Filter On Pressure” to True.

RASPHSettings.DisableShepardFilterOnPressure() → None#: Set the value of “Shepard Filter On Pressure” to False.

RASPHSettings.IsShepardFilterOnPressureEnabled() → bool#: Check if the “Shepard Filter On Pressure” is enabled.

RASPHSettings.GetShiftingFactor() → float#: Get the value of “Shifting Factor”.

RASPHSettings.SetShiftingFactor(value: str | float) → None#

Set the value of “Shifting Factor”.

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

RASPHSettings.GetSize(unit: str | None = None) → float#

Get the value of “Size”.

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

RASPHSettings.SetSize(value: str | float, unit: str | None = None) → None#

Set the value of “Size”.

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

RASPHSettings.GetSolverModel() → str#

Get “Solver Model” as a string.

Returns:: The returned value will be one of [‘WCSPH’, ‘IISPH’, ‘DFSPH’].

RASPHSettings.SetSolverModel(value: str) → None#

Set the value of “Solver Model”.

Parameters:: value – The value to set. Must be one of [‘WCSPH’, ‘IISPH’, ‘DFSPH’].
Raises:: RockyApiError – If value is not a valid “Solver Model” option.

RASPHSettings.GetValidSolverModelValues() → list[str]#

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

Returns:: The returned list is [‘WCSPH’, ‘IISPH’, ‘DFSPH’].

RASPHSettings.GetSoundSpeed(unit: str | None = None) → float#

Get the value of “Sound Speed”.

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

RASPHSettings.SetSoundSpeed(value: str | float, unit: str | None = None) → None#

Set the value of “Sound Speed”.

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/s”.

RASPHSettings.GetStabilityDegree() → int#: Get the value of “Stability Degree”.

RASPHSettings.SetStabilityDegree(value: str | int) → None#

Set the value of “Stability Degree”.

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

RASPHSettings.GetStabilityNegFactor() → float#: Get the value of “Stability Neg Factor”.

RASPHSettings.SetStabilityNegFactor(value: str | float) → None#

Set the value of “Stability Neg Factor”.

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

RASPHSettings.GetStabilityPosFactor() → float#: Get the value of “Stability Pos Factor”.

RASPHSettings.SetStabilityPosFactor(value: str | float) → None#

Set the value of “Stability Pos Factor”.

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

RASPHSettings.GetStiffFactor() → float#: Get the value of “Stiff Factor”.

RASPHSettings.SetStiffFactor(value: str | float) → None#

Set the value of “Stiff Factor”.

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

RASPHSettings.GetSurfaceTensionBoundaryAngle(unit: str | None = None) → float#

Get the value of “Surface Tension Boundary Angle”.

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

RASPHSettings.SetSurfaceTensionBoundaryAngle(value: str | float, unit: str | None = None) → None#

Set the value of “Surface Tension Boundary Angle”.

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 “dega”.

RASPHSettings.GetSurfaceTensionBoundaryFraction() → float#: Get the value of “Surface Tension Boundary Fraction”.

RASPHSettings.SetSurfaceTensionBoundaryFraction(value: str | float) → None#

Set the value of “Surface Tension Boundary Fraction”.

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

RASPHSettings.GetSurfaceTensionCoefficient(unit: str | None = None) → float#

Get the value of “Surface Tension Coefficient”.

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

RASPHSettings.SetSurfaceTensionCoefficient(value: str | float, unit: str | None = None) → None#

Set the value of “Surface Tension Coefficient”.

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 “N/m”.

RASPHSettings.GetSurfaceTensionType() → str#

Get “Surface Tension Type” as a string.

Returns:: The returned value will be one of [‘none’, ‘CSF’, ‘CSS’, ‘custom’, ‘pairwise_potential’].

RASPHSettings.SetSurfaceTensionType(value: str) → None#

Set the value of “Surface Tension Type”.

Parameters:: value – The value to set. Must be one of [‘none’, ‘CSF’, ‘CSS’, ‘custom’, ‘pairwise_potential’].
Raises:: RockyApiError – If value is not a valid “Surface Tension Type” option.

RASPHSettings.GetValidSurfaceTensionTypeValues() → list[str]#

Get a list of all possible values for “Surface Tension Type”.

Returns:: The returned list is [‘none’, ‘CSF’, ‘CSS’, ‘custom’, ‘pairwise_potential’].

RASPHSettings.GetTimestepFactor() → float#: Get the value of “Timestep Factor”.

RASPHSettings.SetTimestepFactor(value: str | float) → None#

Set the value of “Timestep Factor”.

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

RASPHSettings.GetTurbDistanceFraction() → float#: Get the value of “Turb Distance Fraction”.

RASPHSettings.SetTurbDistanceFraction(value: str | float) → None#

Set the value of “Turb Distance Fraction”.

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

RASPHSettings.GetTurbulenceType() → str#

Get “Turbulence Type” as a string.

Returns:: The returned value will be one of [‘laminar’, ‘les’].

RASPHSettings.SetTurbulenceType(value: str) → None#

Set the value of “Turbulence Type”.

Parameters:: value – The value to set. Must be one of [‘laminar’, ‘les’].
Raises:: RockyApiError – If value is not a valid “Turbulence Type” option.

RASPHSettings.GetValidTurbulenceTypeValues() → list[str]#

Get a list of all possible values for “Turbulence Type”.

Returns:: The returned list is [‘laminar’, ‘les’].

RASPHSettings.GetTurbulentPrandtl() → float#: Get the value of “Turbulent Prandtl”.

RASPHSettings.SetTurbulentPrandtl(value: str | float) → None#

Set the value of “Turbulent Prandtl”.

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

RASPHSettings.GetTurbulentViscosityMaximumRatio() → float#: Get the value of “Turbulent Viscosity Maximum Ratio”.

RASPHSettings.SetTurbulentViscosityMaximumRatio(value: str | float) → None#

Set the value of “Turbulent Viscosity Maximum Ratio”.

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

RASPHSettings.GetUpdateCoupledDensity() → bool#: Get the value of “Update Coupled Density”.

RASPHSettings.SetUpdateCoupledDensity(value: bool) → None#

Set the value of “Update Coupled Density”.

Parameters:: value – The value to set.

RASPHSettings.GetUseParticlesNeighborsList() → bool#: Get the value of “Use Particles Neighbors List”.

RASPHSettings.SetUseParticlesNeighborsList(value: bool) → None#

Set the value of “Use Particles Neighbors List”.

Parameters:: value – The value to set.

RASPHSettings.GetViscosityType() → str#

Get “Viscosity Type” as a string.

Returns:: The returned value will be one of [‘cleary’, ‘morris’, ‘custom’].

RASPHSettings.SetViscosityType(value: str) → None#

Set the value of “Viscosity Type”.

Parameters:: value – The value to set. Must be one of [‘cleary’, ‘morris’, ‘custom’].
Raises:: RockyApiError – If value is not a valid “Viscosity Type” option.

RASPHSettings.GetValidViscosityTypeValues() → list[str]#

Get a list of all possible values for “Viscosity Type”.

Returns:: The returned list is [‘cleary’, ‘morris’, ‘custom’].

RASPHSettings.GetViscousForceIntegration() → str#

Get “Viscous Force Integration” as a string.

Returns:: The returned value will be one of [‘explicit’, ‘implicit’].

RASPHSettings.SetViscousForceIntegration(value: str) → None#

Set the value of “Viscous Force Integration”.

Parameters:: value – The value to set. Must be one of [‘explicit’, ‘implicit’].
Raises:: RockyApiError – If value is not a valid “Viscous Force Integration” option.

RASPHSettings.GetValidViscousForceIntegrationValues() → list[str]#

Get a list of all possible values for “Viscous Force Integration”.

Returns:: The returned list is [‘explicit’, ‘implicit’].

RASPHSettings.GetViscousForceMaximumNumberOfIterations() → int#: Get the value of “Viscous Force Maximum Number of Iterations”.

RASPHSettings.SetViscousForceMaximumNumberOfIterations(value: str | int) → None#

Set the value of “Viscous Force Maximum Number of Iterations”.

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

RASPHSettings.GetViscousForceRelativeErrorTolerance() → float#: Get the value of “Viscous Force Relative Error Tolerance”.

RASPHSettings.SetViscousForceRelativeErrorTolerance(value: str | float) → None#

Set the value of “Viscous Force Relative Error Tolerance”.

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

RASPHSettings.GetViscousForceUnderRelaxationFactor() → float#: Get the value of “Viscous Force Under Relaxation Factor”.

RASPHSettings.SetViscousForceUnderRelaxationFactor(value: str | float) → None#

Set the value of “Viscous Force Under Relaxation Factor”.

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

RASPHSettings.GetXsphFactor() → float#: Get the value of “Xsph Factor”.

RASPHSettings.SetXsphFactor(value: str | float) → None#

Set the value of “Xsph Factor”.

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

RASPHSettings.GetFluidMaterial()#

Get the “Fluid Material”.

Return type:: RAFluidMaterial

RASPHSettings.SetFluidMaterial(value) → None#

Set the “Fluid Material”.

:param unicode, RAFluidMaterial value:: Either the API object wrapping the desired entity or its name.

RASPHSettings.GetAvailableFluidMaterials()#

Get all available Fluid Materials.

Return type:: List[RAFluidMaterial] A list of RAFluidMaterial.

RASPHSettings#

Overview#

Import detail#

Method detail#

`RASPHSettings`#