CADETProcess.simulator.ModelSolverParameters

CADETProcess.simulator.ModelSolverParameters#

class CADETProcess.simulator.ModelSolverParameters(gs_type, max_krylov, max_restarts, schur_safety, linear_solution_mode)[source]#

Converter for model solver parameters from CADETProcess to CADET.

See also

Structure
Attributes:
gs_type{1, 0}, optional

Valid modes: - 0: Classical Gram-Schmidet orthogonalization. - 1: Modified Gram-Schmidt. The default is 1.

max_krylovint, optional

Size of the Krylov subspace in the iterative linear GMRES solver. The default is 0.

max_restartsint, optional

Maximum number of restarts in the GMRES algorithm. If lack of memory is not an issue, better use a larger Krylov space than restarts. The default is 10.

schur_safetyfloat, optional

Schur safety factor. Influences the tradeoff between linear iterations and nonlinear error control The default is 1e-8.

linear_solution_modeint

Valid modes: - 0: Automatically chose mode based on heuristic. - 1: Solve system of models in parallel - 2: Solve system of models sequentially (only possible for systems without cyclic connections) The default is 0.

Methods

check_required_parameters()

Verify if all required parameters are set.