CADETProcess.processModel.discretization.LRMPDiscretizationFV

class CADETProcess.processModel.discretization.LRMPDiscretizationFV(spatial_method, ncol, par_geom, use_analytic_jacobian, reconstruction, gs_type, max_krylov, max_restarts, schur_safety)

Bases: DiscretizationParametersBase

Discretization parameters of the FV version of the LRMP.

Attributes:

ncolUnsignedInteger, optional

Number of axial column discretization cells. Default is 100.

par_geomSwitch, optional

The geometry of the particles in the model. Valid values are ‘SPHERE’, ‘CYLINDER’, and ‘SLAB’. Default is ‘SPHERE’.

use_analytic_jacobianBool, optional

If True, use analytically computed Jacobian matrix (faster). If False, use Jacobians generated by algorithmic differentiation (slower). Default is True.

reconstructionSwitch, optional

Method for spatial reconstruction. Valid values are ‘WENO’ (Weighted Essentially Non-Oscillatory). Default is ‘WENO’.

gs_typeBool, optional

Type of Gram-Schmidt orthogonalization. If 0, use classical Gram-Schmidt. If 1, use modified Gram-Schmidt. The default is 1.

max_krylovUnsignedInteger, optional

Size of the Krylov subspace in the iterative linear GMRES solver. If 0, max_krylov = NCOL * NCOMP * NPARTYPE is used. The default is 0.

max_restartsUnsignedInteger, optional

Maximum number of restarts to use for the GMRES method. Default is 10.

schur_safetyUnsignedFloat, optional

Safety factor for the Schur complement solver. Default is 1.0e-8.

See also

CADETProcess.processModel.LRMPDiscretizationDG

CADETProcess.processModel.LumpedRateModelWithPores

gs_type

Parameter descriptor constrained to boolean values.

Notes

This class also supports casting integers 0 and 1 to their boolean equivalents.

max_krylov

Parameter descriptor for unsigned integer parameters.

max_restarts

Parameter descriptor for unsigned integer parameters.

ncol

Parameter descriptor for unsigned integer parameters.

par_geom

Parameter that can be set to one of several predefined options.

Attributes:

validlist

List of valid options for the parameter.

Notes

Assign a value to this parameter from the valid list.

reconstruction

Parameter that can be set to one of several predefined options.

Attributes:

validlist

List of valid options for the parameter.

Notes

Assign a value to this parameter from the valid list.

schur_safety

Parameter descriptor for unsigned floating-point parameters.

spatial_method

Parameter that is immutable once set.

Attributes:

valueAny

The immutable value of the parameter.

Notes

Once set, the value of a Constant parameter cannot be modified.

use_analytic_jacobian

Parameter descriptor constrained to boolean values.

Notes

This class also supports casting integers 0 and 1 to their boolean equivalents.