CADETProcess.processModel.discretization.GRMDiscretizationDG

class CADETProcess.processModel.discretization.GRMDiscretizationDG(spatial_method, nelem, par_nelem, par_geom, par_disc_type, par_disc_vector, par_boundary_order, use_analytic_jacobian, polydeg, par_polydeg, exact_integration, par_exact_integration, fix_zero_surface_diffusion)

Bases: DGMixin

Discretization parameters of the DG version of the GRM.

Attributes:

nelemUnsignedInteger, optional

Number of axial column elements. Default is 16.

par_nelemUnsignedInteger, optional

Number of particle (radial) discretization cells for each particle type. Default is 1.

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.

polydegUnsignedInteger, optional

Degree of the polynomial used for axial discretization. Default is 4.

par_polydegUnsignedInteger, optional

Degree of the polynomial used for particle radial discretization. Default is 4.

exact_integrationBool, optional

Whether to use exact integration for the axial discretization. Default is False.

par_exact_integrationBool, optional

Whether to use exact integration for the particle radial discretization. Default is True.

fix_zero_surface_diffusionBool, optional

Whether to fix zero surface diffusion for particles. Default is False. If True, the parameters must not become non-zero during this or subsequent simulation runs. The internal data structures are optimized for a more efficient simulation. Default is False (optimization disabled in favor of flexibility).

See also

CADETProcess.processModel.GRMDiscretizationDG

CADETProcess.processModel.GeneralRateModel

property axial_dof: int

int: Number of axial degrees of freedom in the axial discretization.

exact_integration

Parameter descriptor constrained to boolean values.

Notes

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

fix_zero_surface_diffusion

Parameter descriptor constrained to boolean values.

Notes

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

nelem

Parameter descriptor for unsigned integer parameters.

par_boundary_order

Parameter descriptor for integers parameters constrained within bounds.

par_disc_type

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.

par_disc_vector

Descriptor for ranged lists whose size depends on other instance attributes.

property par_disc_vector_length: int

int: Number of entries in the particle discretization vector.

property par_dof: int

int: Number of particle degrees of freedom in the axial discretization.

par_exact_integration

Parameter descriptor constrained to boolean values.

Notes

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

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.

par_nelem

Parameter descriptor for unsigned integer parameters.

par_polydeg

Parameter descriptor for unsigned integer parameters.

polydeg

Parameter descriptor for unsigned integer 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.