rs3.projectSettings.SolverOptions module#

class rs3.projectSettings.SolverOptions.SolverOptions(client: Client, projectId: str)#

Bases: _ProxyObject

Set the solid and fluid interaction type and solver type.

Examples

See Project Settings Script Examples.

getAnalysisType() → AnalysisType#

Get the interaction between fluid pore pressure and solid stresses and deformation.

setAnalysisType(value: AnalysisType)#

Set the interaction between fluid pore pressure and solid stresses and deformation.

getSolverType() → SolverType#

Get the currently configured solver type for solving the matrix representing the system of equations defined by your model.

Returns:

The solver type currently set for this model.

Return type:

SolverType

Notes

  • DIRECT_CPU: Direct solver running on CPU.

  • ITERATIVE_CPU: Iterative CPU solver (PCG with ICT preconditioner).

  • FGMRES_AMG_PRECONDITIONER_CPU: FGMRES solver on CPU with AMG preconditioner.

  • FGMRESG_ILU_PRECONDITIONER_CPU: FGMRES(G) solver on CPU with ILU preconditioner.

  • DIRECT_GPU: Direct solver running on GPU.

  • FGMRES_AMG_GPU: FGMRES solver on GPU with AMG preconditioner.

  • AUTO: Automatically select the solver based on the problem configuration.

setSolverType(value: SolverType)#

Set the currently configured solver type for solving the matrix representing the system of equations defined by your model.

Parameters:

value (SolverType) – The solver type to configure.

Notes

  • ITERATIVE_CPU corresponds to a CPU-based PCG solver with an ICT preconditioner.

  • GPU-based solvers require compatible GPU hardware.

  • AUTO allows the system to determine the most appropriate solver.

getMemoryFillLevel() → float#
setMemoryFillLevel(value: float)#
getRelativeTolerance() → float#
setRelativeTolerance(value: float)#
getProperties()#
setProperties(AnalysisMethod: AnalysisType = None, Solver: SolverType = None)#