:class:`RASPHSettings` ====================== .. py:class:: ansys.rocky.app.ra_sph_settings.RASPHSettings(id, model_id=None) Bases: :py:obj:`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 :class:`RAStudy` with: .. code-block:: python sph_settings = study.GetSphSettings() sph_settings = study.GetElement('SPH') .. !! processed by numpydoc !! .. py:currentmodule:: RASPHSettings Overview -------- .. tab-set:: .. tab-item:: Constructors .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~GetWrappedClass` - * - :py:attr:`~GetClassName` - .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~SetSolver` - Set the value of "Solver Model". * - :py:attr:`~GetSolver` - Get "Solver Model" as a string. * - :py:attr:`~GetCS` - Get the value of "C S". * - :py:attr:`~SetCS` - Set the value of "C S". * - :py:attr:`~GetClearyFactor` - Get the value of "Cleary Factor". * - :py:attr:`~SetClearyFactor` - Set the value of "Cleary Factor". * - :py:attr:`~GetDensityDevMinus` - Get the value of "Density Dev Minus". * - :py:attr:`~SetDensityDevMinus` - Set the value of "Density Dev Minus". * - :py:attr:`~GetDensityDevPlus` - Get the value of "Density Dev Plus". * - :py:attr:`~SetDensityDevPlus` - Set the value of "Density Dev Plus". * - :py:attr:`~GetDensityRelativeErrorTolerance` - Get the value of "Density Relative Error Tolerance". * - :py:attr:`~SetDensityRelativeErrorTolerance` - Set the value of "Density Relative Error Tolerance". * - :py:attr:`~GetDissFactor` - Get the value of "Diss Factor". * - :py:attr:`~SetDissFactor` - Set the value of "Diss Factor". * - :py:attr:`~GetDistFactorNorm` - Get the value of "Dist Factor Norm". * - :py:attr:`~SetDistFactorNorm` - Set the value of "Dist Factor Norm". * - :py:attr:`~GetDistFactorTang` - Get the value of "Dist Factor Tang". * - :py:attr:`~SetDistFactorTang` - Set the value of "Dist Factor Tang". * - :py:attr:`~GetEnabled` - Get the value of "Enabled". * - :py:attr:`~SetEnabled` - Set the value of "Enabled". * - :py:attr:`~GetEulerianSolutionEnabled` - Get the value of "Eulerian Solution Enabled". * - :py:attr:`~SetEulerianSolutionEnabled` - Set the value of "Eulerian Solution Enabled". * - :py:attr:`~EnableEulerianSolution` - Set the value of "Eulerian Solution" to True. * - :py:attr:`~DisableEulerianSolution` - Set the value of "Eulerian Solution" to False. * - :py:attr:`~IsEulerianSolutionEnabled` - Check if the "Eulerian Solution" is enabled. * - :py:attr:`~GetFreeSurfaceDivergenceLimit` - Get the value of "Free Surface Divergence Limit". * - :py:attr:`~SetFreeSurfaceDivergenceLimit` - Set the value of "Free Surface Divergence Limit". * - :py:attr:`~GetIncompressibilityRelaxationFactor` - Get the value of "Incompressibility Relaxation Factor". * - :py:attr:`~SetIncompressibilityRelaxationFactor` - Set the value of "Incompressibility Relaxation Factor". * - :py:attr:`~GetKernelDistFactor` - Get the value of "Kernel Dist Factor". * - :py:attr:`~SetKernelDistFactor` - Set the value of "Kernel Dist Factor". * - :py:attr:`~GetKernelType` - Get "Kernel Type" as a string. * - :py:attr:`~SetKernelType` - Set the value of "Kernel Type". * - :py:attr:`~GetValidKernelTypeValues` - Get a list of all possible values for "Kernel Type". * - :py:attr:`~GetLimitTurbulentViscosity` - Get the value of "Limit Turbulent Viscosity". * - :py:attr:`~SetLimitTurbulentViscosity` - Set the value of "Limit Turbulent Viscosity". * - :py:attr:`~GetMaximumExpectedVelocity` - Get the value of "Maximum Expected Velocity". * - :py:attr:`~SetMaximumExpectedVelocity` - Set the value of "Maximum Expected Velocity". * - :py:attr:`~GetMaximumNumberOfIterations` - Get the value of "Maximum Number of Iterations". * - :py:attr:`~SetMaximumNumberOfIterations` - Set the value of "Maximum Number of Iterations". * - :py:attr:`~GetMinDistFactor` - Get the value of "Min Dist Factor". * - :py:attr:`~SetMinDistFactor` - Set the value of "Min Dist Factor". * - :py:attr:`~GetName` - Get the value of "Name". * - :py:attr:`~SetName` - Set the value of "Name". * - :py:attr:`~GetNegativePressureFactor` - Get the value of "Negative Pressure Factor". * - :py:attr:`~SetNegativePressureFactor` - Set the value of "Negative Pressure Factor". * - :py:attr:`~GetNumCellSteps` - Get the value of "Num Cell Steps". * - :py:attr:`~SetNumCellSteps` - Set the value of "Num Cell Steps". * - :py:attr:`~GetNumberOfSteps` - Get the value of "Number of Steps". * - :py:attr:`~SetNumberOfSteps` - Set the value of "Number of Steps". * - :py:attr:`~GetPosCorrectionType` - Get "Pos Correction Type" as a string. * - :py:attr:`~SetPosCorrectionType` - Set the value of "Pos Correction Type". * - :py:attr:`~GetValidPosCorrectionTypeValues` - Get a list of all possible values for "Pos Correction Type". * - :py:attr:`~GetPressureDeg` - Get the value of "Pressure Deg". * - :py:attr:`~SetPressureDeg` - Set the value of "Pressure Deg". * - :py:attr:`~GetPressureUnderRelaxationFactor` - Get the value of "Pressure Under Relaxation Factor". * - :py:attr:`~SetPressureUnderRelaxationFactor` - Set the value of "Pressure Under Relaxation Factor". * - :py:attr:`~GetRelaxedIncompressibilityConstraintEnabled` - Get the value of "Relaxed Incompressibility Constraint Enabled". * - :py:attr:`~SetRelaxedIncompressibilityConstraintEnabled` - Set the value of "Relaxed Incompressibility Constraint Enabled". * - :py:attr:`~EnableRelaxedIncompressibilityConstraint` - Set the value of "Relaxed Incompressibility Constraint" to True. * - :py:attr:`~DisableRelaxedIncompressibilityConstraint` - Set the value of "Relaxed Incompressibility Constraint" to False. * - :py:attr:`~IsRelaxedIncompressibilityConstraintEnabled` - Check if the "Relaxed Incompressibility Constraint" is enabled. * - :py:attr:`~GetShepardFilterOnDensityEnabled` - Get the value of "Shepard Filter On Density Enabled". * - :py:attr:`~SetShepardFilterOnDensityEnabled` - Set the value of "Shepard Filter On Density Enabled". * - :py:attr:`~EnableShepardFilterOnDensity` - Set the value of "Shepard Filter On Density" to True. * - :py:attr:`~DisableShepardFilterOnDensity` - Set the value of "Shepard Filter On Density" to False. * - :py:attr:`~IsShepardFilterOnDensityEnabled` - Check if the "Shepard Filter On Density" is enabled. * - :py:attr:`~GetShepardFilterOnPressureEnabled` - Get the value of "Shepard Filter On Pressure Enabled". * - :py:attr:`~SetShepardFilterOnPressureEnabled` - Set the value of "Shepard Filter On Pressure Enabled". * - :py:attr:`~EnableShepardFilterOnPressure` - Set the value of "Shepard Filter On Pressure" to True. * - :py:attr:`~DisableShepardFilterOnPressure` - Set the value of "Shepard Filter On Pressure" to False. * - :py:attr:`~IsShepardFilterOnPressureEnabled` - Check if the "Shepard Filter On Pressure" is enabled. * - :py:attr:`~GetShiftingFactor` - Get the value of "Shifting Factor". * - :py:attr:`~SetShiftingFactor` - Set the value of "Shifting Factor". * - :py:attr:`~GetSize` - Get the value of "Size". * - :py:attr:`~SetSize` - Set the value of "Size". * - :py:attr:`~GetSolverModel` - Get "Solver Model" as a string. * - :py:attr:`~SetSolverModel` - Set the value of "Solver Model". * - :py:attr:`~GetValidSolverModelValues` - Get a list of all possible values for "Solver Model". * - :py:attr:`~GetSoundSpeed` - Get the value of "Sound Speed". * - :py:attr:`~SetSoundSpeed` - Set the value of "Sound Speed". * - :py:attr:`~GetStabilityDegree` - Get the value of "Stability Degree". * - :py:attr:`~SetStabilityDegree` - Set the value of "Stability Degree". * - :py:attr:`~GetStabilityNegFactor` - Get the value of "Stability Neg Factor". * - :py:attr:`~SetStabilityNegFactor` - Set the value of "Stability Neg Factor". * - :py:attr:`~GetStabilityPosFactor` - Get the value of "Stability Pos Factor". * - :py:attr:`~SetStabilityPosFactor` - Set the value of "Stability Pos Factor". * - :py:attr:`~GetStiffFactor` - Get the value of "Stiff Factor". * - :py:attr:`~SetStiffFactor` - Set the value of "Stiff Factor". * - :py:attr:`~GetSurfaceTensionBoundaryAngle` - Get the value of "Surface Tension Boundary Angle". * - :py:attr:`~SetSurfaceTensionBoundaryAngle` - Set the value of "Surface Tension Boundary Angle". * - :py:attr:`~GetSurfaceTensionBoundaryFraction` - Get the value of "Surface Tension Boundary Fraction". * - :py:attr:`~SetSurfaceTensionBoundaryFraction` - Set the value of "Surface Tension Boundary Fraction". * - :py:attr:`~GetSurfaceTensionCoefficient` - Get the value of "Surface Tension Coefficient". * - :py:attr:`~SetSurfaceTensionCoefficient` - Set the value of "Surface Tension Coefficient". * - :py:attr:`~GetSurfaceTensionType` - Get "Surface Tension Type" as a string. * - :py:attr:`~SetSurfaceTensionType` - Set the value of "Surface Tension Type". * - :py:attr:`~GetValidSurfaceTensionTypeValues` - Get a list of all possible values for "Surface Tension Type". * - :py:attr:`~GetTimestepFactor` - Get the value of "Timestep Factor". * - :py:attr:`~SetTimestepFactor` - Set the value of "Timestep Factor". * - :py:attr:`~GetTurbDistanceFraction` - Get the value of "Turb Distance Fraction". * - :py:attr:`~SetTurbDistanceFraction` - Set the value of "Turb Distance Fraction". * - :py:attr:`~GetTurbulenceType` - Get "Turbulence Type" as a string. * - :py:attr:`~SetTurbulenceType` - Set the value of "Turbulence Type". * - :py:attr:`~GetValidTurbulenceTypeValues` - Get a list of all possible values for "Turbulence Type". * - :py:attr:`~GetTurbulentPrandtl` - Get the value of "Turbulent Prandtl". * - :py:attr:`~SetTurbulentPrandtl` - Set the value of "Turbulent Prandtl". * - :py:attr:`~GetTurbulentViscosityMaximumRatio` - Get the value of "Turbulent Viscosity Maximum Ratio". * - :py:attr:`~SetTurbulentViscosityMaximumRatio` - Set the value of "Turbulent Viscosity Maximum Ratio". * - :py:attr:`~GetUpdateCoupledDensity` - Get the value of "Update Coupled Density". * - :py:attr:`~SetUpdateCoupledDensity` - Set the value of "Update Coupled Density". * - :py:attr:`~GetUseParticlesNeighborsList` - Get the value of "Use Particles Neighbors List". * - :py:attr:`~SetUseParticlesNeighborsList` - Set the value of "Use Particles Neighbors List". * - :py:attr:`~GetViscosityType` - Get "Viscosity Type" as a string. * - :py:attr:`~SetViscosityType` - Set the value of "Viscosity Type". * - :py:attr:`~GetValidViscosityTypeValues` - Get a list of all possible values for "Viscosity Type". * - :py:attr:`~GetViscousForceIntegration` - Get "Viscous Force Integration" as a string. * - :py:attr:`~SetViscousForceIntegration` - Set the value of "Viscous Force Integration". * - :py:attr:`~GetValidViscousForceIntegrationValues` - Get a list of all possible values for "Viscous Force Integration". * - :py:attr:`~GetViscousForceMaximumNumberOfIterations` - Get the value of "Viscous Force Maximum Number of Iterations". * - :py:attr:`~SetViscousForceMaximumNumberOfIterations` - Set the value of "Viscous Force Maximum Number of Iterations". * - :py:attr:`~GetViscousForceRelativeErrorTolerance` - Get the value of "Viscous Force Relative Error Tolerance". * - :py:attr:`~SetViscousForceRelativeErrorTolerance` - Set the value of "Viscous Force Relative Error Tolerance". * - :py:attr:`~GetViscousForceUnderRelaxationFactor` - Get the value of "Viscous Force Under Relaxation Factor". * - :py:attr:`~SetViscousForceUnderRelaxationFactor` - Set the value of "Viscous Force Under Relaxation Factor". * - :py:attr:`~GetXsphFactor` - Get the value of "Xsph Factor". * - :py:attr:`~SetXsphFactor` - Set the value of "Xsph Factor". * - :py:attr:`~GetFluidMaterial` - Get the "Fluid Material". * - :py:attr:`~SetFluidMaterial` - Set the "Fluid Material". * - :py:attr:`~GetAvailableFluidMaterials` - Get all available Fluid Materials. Import detail ------------- .. code-block:: python from ansys.rocky.app.ra_sph_settings import RASPHSettings Method detail ------------- .. py:method:: GetWrappedClass() -> type[rocky30.models.sph.sph_settings.SPHProcess] :classmethod: .. py:method:: GetClassName() -> str :classmethod: .. py:method:: SetSolver(value: str) -> None Set the value of "Solver Model". :param value: The value to set. Must be one of ['WCSPH', 'IISPH']. :raises RockyApiError: If `value` is not a valid "Solver Model" option. .. !! processed by numpydoc !! .. py:method:: GetSolver() -> str Get "Solver Model" as a string. :return: The returned value will be one of ['WCSPH', 'IISPH']. .. !! processed by numpydoc !! .. py:method:: GetCS() -> float Get the value of "C S". .. !! processed by numpydoc !! .. py:method:: SetCS(value: str | float) -> None Set the value of "C S". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetClearyFactor() -> float Get the value of "Cleary Factor". .. !! processed by numpydoc !! .. py:method:: SetClearyFactor(value: str | float) -> None Set the value of "Cleary Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetDensityDevMinus() -> float Get the value of "Density Dev Minus". .. !! processed by numpydoc !! .. py:method:: SetDensityDevMinus(value: str | float) -> None Set the value of "Density Dev Minus". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetDensityDevPlus() -> float Get the value of "Density Dev Plus". .. !! processed by numpydoc !! .. py:method:: SetDensityDevPlus(value: str | float) -> None Set the value of "Density Dev Plus". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetDensityRelativeErrorTolerance() -> float Get the value of "Density Relative Error Tolerance". .. !! processed by numpydoc !! .. py:method:: SetDensityRelativeErrorTolerance(value: str | float) -> None Set the value of "Density Relative Error Tolerance". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetDissFactor() -> float Get the value of "Diss Factor". .. !! processed by numpydoc !! .. py:method:: SetDissFactor(value: str | float) -> None Set the value of "Diss Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetDistFactorNorm() -> float Get the value of "Dist Factor Norm". .. !! processed by numpydoc !! .. py:method:: SetDistFactorNorm(value: str | float) -> None Set the value of "Dist Factor Norm". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetDistFactorTang() -> float Get the value of "Dist Factor Tang". .. !! processed by numpydoc !! .. py:method:: SetDistFactorTang(value: str | float) -> None Set the value of "Dist Factor Tang". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetEnabled() -> bool Get the value of "Enabled". .. !! processed by numpydoc !! .. py:method:: SetEnabled(value: bool) -> None Set the value of "Enabled". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: GetEulerianSolutionEnabled() -> bool Get the value of "Eulerian Solution Enabled". .. !! processed by numpydoc !! .. py:method:: SetEulerianSolutionEnabled(value: bool) -> None Set the value of "Eulerian Solution Enabled". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: EnableEulerianSolution() -> None Set the value of "Eulerian Solution" to True. .. !! processed by numpydoc !! .. py:method:: DisableEulerianSolution() -> None Set the value of "Eulerian Solution" to False. .. !! processed by numpydoc !! .. py:method:: IsEulerianSolutionEnabled() -> bool Check if the "Eulerian Solution" is enabled. .. !! processed by numpydoc !! .. py:method:: GetFreeSurfaceDivergenceLimit() -> float Get the value of "Free Surface Divergence Limit". .. !! processed by numpydoc !! .. py:method:: SetFreeSurfaceDivergenceLimit(value: str | float) -> None Set the value of "Free Surface Divergence Limit". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetIncompressibilityRelaxationFactor() -> float Get the value of "Incompressibility Relaxation Factor". .. !! processed by numpydoc !! .. py:method:: SetIncompressibilityRelaxationFactor(value: str | float) -> None Set the value of "Incompressibility Relaxation Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetKernelDistFactor() -> float Get the value of "Kernel Dist Factor". .. !! processed by numpydoc !! .. py:method:: SetKernelDistFactor(value: str | float) -> None Set the value of "Kernel Dist Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetKernelType() -> str Get "Kernel Type" as a string. :return: The returned value will be one of ['cubic', 'quintic', 'wendland']. .. !! processed by numpydoc !! .. py:method:: SetKernelType(value: str) -> None Set the value of "Kernel Type". :param value: The value to set. Must be one of ['cubic', 'quintic', 'wendland']. :raises RockyApiError: If `value` is not a valid "Kernel Type" option. .. !! processed by numpydoc !! .. py:method:: GetValidKernelTypeValues() -> list[str] Get a list of all possible values for "Kernel Type". :return: The returned list is ['cubic', 'quintic', 'wendland']. .. !! processed by numpydoc !! .. py:method:: GetLimitTurbulentViscosity() -> bool Get the value of "Limit Turbulent Viscosity". .. !! processed by numpydoc !! .. py:method:: SetLimitTurbulentViscosity(value: bool) -> None Set the value of "Limit Turbulent Viscosity". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: GetMaximumExpectedVelocity(unit: str | None = None) -> float Get the value of "Maximum Expected Velocity". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "m/s". .. !! processed by numpydoc !! .. py:method:: SetMaximumExpectedVelocity(value: str | float, unit: str | None = None) -> None Set the value of "Maximum Expected Velocity". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "m/s". .. !! processed by numpydoc !! .. py:method:: GetMaximumNumberOfIterations() -> int Get the value of "Maximum Number of Iterations". .. !! processed by numpydoc !! .. py:method:: SetMaximumNumberOfIterations(value: str | int) -> None Set the value of "Maximum Number of Iterations". :param value: The value to set. This value can be an expression with input variables or int type. .. !! processed by numpydoc !! .. py:method:: GetMinDistFactor() -> float Get the value of "Min Dist Factor". .. !! processed by numpydoc !! .. py:method:: SetMinDistFactor(value: str | float) -> None Set the value of "Min Dist Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetName() -> str Get the value of "Name". .. !! processed by numpydoc !! .. py:method:: SetName(value: str) -> None Set the value of "Name". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: GetNegativePressureFactor() -> float Get the value of "Negative Pressure Factor". .. !! processed by numpydoc !! .. py:method:: SetNegativePressureFactor(value: str | float) -> None Set the value of "Negative Pressure Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetNumCellSteps() -> int Get the value of "Num Cell Steps". .. !! processed by numpydoc !! .. py:method:: SetNumCellSteps(value: str | int) -> None Set the value of "Num Cell Steps". :param value: The value to set. This value can be an expression with input variables or int type. .. !! processed by numpydoc !! .. py:method:: GetNumberOfSteps() -> int Get the value of "Number of Steps". .. !! processed by numpydoc !! .. py:method:: SetNumberOfSteps(value: str | int) -> None Set the value of "Number of Steps". :param value: The value to set. This value can be an expression with input variables or int type. .. !! processed by numpydoc !! .. py:method:: GetPosCorrectionType() -> str Get "Pos Correction Type" as a string. :return: The returned value will be one of ['none', 'xsph', 'shift']. .. !! processed by numpydoc !! .. py:method:: SetPosCorrectionType(value: str) -> None Set the value of "Pos Correction Type". :param value: The value to set. Must be one of ['none', 'xsph', 'shift']. :raises RockyApiError: If `value` is not a valid "Pos Correction Type" option. .. !! processed by numpydoc !! .. py:method:: GetValidPosCorrectionTypeValues() -> list[str] Get a list of all possible values for "Pos Correction Type". :return: The returned list is ['none', 'xsph', 'shift']. .. !! processed by numpydoc !! .. py:method:: GetPressureDeg() -> int Get the value of "Pressure Deg". .. !! processed by numpydoc !! .. py:method:: SetPressureDeg(value: str | int) -> None Set the value of "Pressure Deg". :param value: The value to set. This value can be an expression with input variables or int type. .. !! processed by numpydoc !! .. py:method:: GetPressureUnderRelaxationFactor() -> float Get the value of "Pressure Under Relaxation Factor". .. !! processed by numpydoc !! .. py:method:: SetPressureUnderRelaxationFactor(value: str | float) -> None Set the value of "Pressure Under Relaxation Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetRelaxedIncompressibilityConstraintEnabled() -> bool Get the value of "Relaxed Incompressibility Constraint Enabled". .. !! processed by numpydoc !! .. py:method:: SetRelaxedIncompressibilityConstraintEnabled(value: bool) -> None Set the value of "Relaxed Incompressibility Constraint Enabled". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: EnableRelaxedIncompressibilityConstraint() -> None Set the value of "Relaxed Incompressibility Constraint" to True. .. !! processed by numpydoc !! .. py:method:: DisableRelaxedIncompressibilityConstraint() -> None Set the value of "Relaxed Incompressibility Constraint" to False. .. !! processed by numpydoc !! .. py:method:: IsRelaxedIncompressibilityConstraintEnabled() -> bool Check if the "Relaxed Incompressibility Constraint" is enabled. .. !! processed by numpydoc !! .. py:method:: GetShepardFilterOnDensityEnabled() -> bool Get the value of "Shepard Filter On Density Enabled". .. !! processed by numpydoc !! .. py:method:: SetShepardFilterOnDensityEnabled(value: bool) -> None Set the value of "Shepard Filter On Density Enabled". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: EnableShepardFilterOnDensity() -> None Set the value of "Shepard Filter On Density" to True. .. !! processed by numpydoc !! .. py:method:: DisableShepardFilterOnDensity() -> None Set the value of "Shepard Filter On Density" to False. .. !! processed by numpydoc !! .. py:method:: IsShepardFilterOnDensityEnabled() -> bool Check if the "Shepard Filter On Density" is enabled. .. !! processed by numpydoc !! .. py:method:: GetShepardFilterOnPressureEnabled() -> bool Get the value of "Shepard Filter On Pressure Enabled". .. !! processed by numpydoc !! .. py:method:: SetShepardFilterOnPressureEnabled(value: bool) -> None Set the value of "Shepard Filter On Pressure Enabled". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: EnableShepardFilterOnPressure() -> None Set the value of "Shepard Filter On Pressure" to True. .. !! processed by numpydoc !! .. py:method:: DisableShepardFilterOnPressure() -> None Set the value of "Shepard Filter On Pressure" to False. .. !! processed by numpydoc !! .. py:method:: IsShepardFilterOnPressureEnabled() -> bool Check if the "Shepard Filter On Pressure" is enabled. .. !! processed by numpydoc !! .. py:method:: GetShiftingFactor() -> float Get the value of "Shifting Factor". .. !! processed by numpydoc !! .. py:method:: SetShiftingFactor(value: str | float) -> None Set the value of "Shifting Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetSize(unit: str | None = None) -> float Get the value of "Size". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "m". .. !! processed by numpydoc !! .. py:method:: SetSize(value: str | float, unit: str | None = None) -> None Set the value of "Size". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "m". .. !! processed by numpydoc !! .. py:method:: GetSolverModel() -> str Get "Solver Model" as a string. :return: The returned value will be one of ['WCSPH', 'IISPH', 'DFSPH']. .. !! processed by numpydoc !! .. py:method:: SetSolverModel(value: str) -> None Set the value of "Solver Model". :param value: The value to set. Must be one of ['WCSPH', 'IISPH', 'DFSPH']. :raises RockyApiError: If `value` is not a valid "Solver Model" option. .. !! processed by numpydoc !! .. py:method:: GetValidSolverModelValues() -> list[str] Get a list of all possible values for "Solver Model". :return: The returned list is ['WCSPH', 'IISPH', 'DFSPH']. .. !! processed by numpydoc !! .. py:method:: GetSoundSpeed(unit: str | None = None) -> float Get the value of "Sound Speed". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "m/s". .. !! processed by numpydoc !! .. py:method:: SetSoundSpeed(value: str | float, unit: str | None = None) -> None Set the value of "Sound Speed". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "m/s". .. !! processed by numpydoc !! .. py:method:: GetStabilityDegree() -> int Get the value of "Stability Degree". .. !! processed by numpydoc !! .. py:method:: SetStabilityDegree(value: str | int) -> None Set the value of "Stability Degree". :param value: The value to set. This value can be an expression with input variables or int type. .. !! processed by numpydoc !! .. py:method:: GetStabilityNegFactor() -> float Get the value of "Stability Neg Factor". .. !! processed by numpydoc !! .. py:method:: SetStabilityNegFactor(value: str | float) -> None Set the value of "Stability Neg Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetStabilityPosFactor() -> float Get the value of "Stability Pos Factor". .. !! processed by numpydoc !! .. py:method:: SetStabilityPosFactor(value: str | float) -> None Set the value of "Stability Pos Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetStiffFactor() -> float Get the value of "Stiff Factor". .. !! processed by numpydoc !! .. py:method:: SetStiffFactor(value: str | float) -> None Set the value of "Stiff Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetSurfaceTensionBoundaryAngle(unit: str | None = None) -> float Get the value of "Surface Tension Boundary Angle". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "dega". .. !! processed by numpydoc !! .. py:method:: SetSurfaceTensionBoundaryAngle(value: str | float, unit: str | None = None) -> None Set the value of "Surface Tension Boundary Angle". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "dega". .. !! processed by numpydoc !! .. py:method:: GetSurfaceTensionBoundaryFraction() -> float Get the value of "Surface Tension Boundary Fraction". .. !! processed by numpydoc !! .. py:method:: SetSurfaceTensionBoundaryFraction(value: str | float) -> None Set the value of "Surface Tension Boundary Fraction". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetSurfaceTensionCoefficient(unit: str | None = None) -> float Get the value of "Surface Tension Coefficient". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "N/m". .. !! processed by numpydoc !! .. py:method:: SetSurfaceTensionCoefficient(value: str | float, unit: str | None = None) -> None Set the value of "Surface Tension Coefficient". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "N/m". .. !! processed by numpydoc !! .. py:method:: GetSurfaceTensionType() -> str Get "Surface Tension Type" as a string. :return: The returned value will be one of ['none', 'CSF', 'CSS', 'custom', 'pairwise_potential']. .. !! processed by numpydoc !! .. py:method:: SetSurfaceTensionType(value: str) -> None Set the value of "Surface Tension Type". :param 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. .. !! processed by numpydoc !! .. py:method:: GetValidSurfaceTensionTypeValues() -> list[str] Get a list of all possible values for "Surface Tension Type". :return: The returned list is ['none', 'CSF', 'CSS', 'custom', 'pairwise_potential']. .. !! processed by numpydoc !! .. py:method:: GetTimestepFactor() -> float Get the value of "Timestep Factor". .. !! processed by numpydoc !! .. py:method:: SetTimestepFactor(value: str | float) -> None Set the value of "Timestep Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetTurbDistanceFraction() -> float Get the value of "Turb Distance Fraction". .. !! processed by numpydoc !! .. py:method:: SetTurbDistanceFraction(value: str | float) -> None Set the value of "Turb Distance Fraction". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetTurbulenceType() -> str Get "Turbulence Type" as a string. :return: The returned value will be one of ['laminar', 'les']. .. !! processed by numpydoc !! .. py:method:: SetTurbulenceType(value: str) -> None Set the value of "Turbulence Type". :param value: The value to set. Must be one of ['laminar', 'les']. :raises RockyApiError: If `value` is not a valid "Turbulence Type" option. .. !! processed by numpydoc !! .. py:method:: GetValidTurbulenceTypeValues() -> list[str] Get a list of all possible values for "Turbulence Type". :return: The returned list is ['laminar', 'les']. .. !! processed by numpydoc !! .. py:method:: GetTurbulentPrandtl() -> float Get the value of "Turbulent Prandtl". .. !! processed by numpydoc !! .. py:method:: SetTurbulentPrandtl(value: str | float) -> None Set the value of "Turbulent Prandtl". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetTurbulentViscosityMaximumRatio() -> float Get the value of "Turbulent Viscosity Maximum Ratio". .. !! processed by numpydoc !! .. py:method:: SetTurbulentViscosityMaximumRatio(value: str | float) -> None Set the value of "Turbulent Viscosity Maximum Ratio". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetUpdateCoupledDensity() -> bool Get the value of "Update Coupled Density". .. !! processed by numpydoc !! .. py:method:: SetUpdateCoupledDensity(value: bool) -> None Set the value of "Update Coupled Density". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: GetUseParticlesNeighborsList() -> bool Get the value of "Use Particles Neighbors List". .. !! processed by numpydoc !! .. py:method:: SetUseParticlesNeighborsList(value: bool) -> None Set the value of "Use Particles Neighbors List". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: GetViscosityType() -> str Get "Viscosity Type" as a string. :return: The returned value will be one of ['cleary', 'morris', 'custom']. .. !! processed by numpydoc !! .. py:method:: SetViscosityType(value: str) -> None Set the value of "Viscosity Type". :param value: The value to set. Must be one of ['cleary', 'morris', 'custom']. :raises RockyApiError: If `value` is not a valid "Viscosity Type" option. .. !! processed by numpydoc !! .. py:method:: GetValidViscosityTypeValues() -> list[str] Get a list of all possible values for "Viscosity Type". :return: The returned list is ['cleary', 'morris', 'custom']. .. !! processed by numpydoc !! .. py:method:: GetViscousForceIntegration() -> str Get "Viscous Force Integration" as a string. :return: The returned value will be one of ['explicit', 'implicit']. .. !! processed by numpydoc !! .. py:method:: SetViscousForceIntegration(value: str) -> None Set the value of "Viscous Force Integration". :param value: The value to set. Must be one of ['explicit', 'implicit']. :raises RockyApiError: If `value` is not a valid "Viscous Force Integration" option. .. !! processed by numpydoc !! .. py:method:: GetValidViscousForceIntegrationValues() -> list[str] Get a list of all possible values for "Viscous Force Integration". :return: The returned list is ['explicit', 'implicit']. .. !! processed by numpydoc !! .. py:method:: GetViscousForceMaximumNumberOfIterations() -> int Get the value of "Viscous Force Maximum Number of Iterations". .. !! processed by numpydoc !! .. py:method:: SetViscousForceMaximumNumberOfIterations(value: str | int) -> None Set the value of "Viscous Force Maximum Number of Iterations". :param value: The value to set. This value can be an expression with input variables or int type. .. !! processed by numpydoc !! .. py:method:: GetViscousForceRelativeErrorTolerance() -> float Get the value of "Viscous Force Relative Error Tolerance". .. !! processed by numpydoc !! .. py:method:: SetViscousForceRelativeErrorTolerance(value: str | float) -> None Set the value of "Viscous Force Relative Error Tolerance". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetViscousForceUnderRelaxationFactor() -> float Get the value of "Viscous Force Under Relaxation Factor". .. !! processed by numpydoc !! .. py:method:: SetViscousForceUnderRelaxationFactor(value: str | float) -> None Set the value of "Viscous Force Under Relaxation Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetXsphFactor() -> float Get the value of "Xsph Factor". .. !! processed by numpydoc !! .. py:method:: SetXsphFactor(value: str | float) -> None Set the value of "Xsph Factor". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetFluidMaterial() Get the "Fluid Material". :rtype: :class:`RAFluidMaterial` .. !! processed by numpydoc !! .. py:method:: SetFluidMaterial(value) -> None Set the "Fluid Material". :param unicode, :class:`RAFluidMaterial` value: Either the API object wrapping the desired entity or its name. .. !! processed by numpydoc !! .. py:method:: GetAvailableFluidMaterials() Get all available Fluid Materials. :rtype: List[:class:`RAFluidMaterial`] A list of :class:`RAFluidMaterial`. .. !! processed by numpydoc !!