CADETProcess.processModel.BindingBaseClass

class CADETProcess.processModel.BindingBaseClass(name, is_kinetic, n_binding_sites, _bound_states)

Bases: Structure

Abstract base class for parameters of binding models.

Attributes:

namestr

name of the binding model.

component_systemComponentSystem

ComponentSystem: Component system of the binding model.

n_compint

int: Number of components.

n_binding_sitesint

Number of binding sites. Relevant for Multi-Site isotherms such as Bi-Langmuir. The default is 1.

bound_stateslist of unsigned integers.

list[int]: Number of bound states per component.

non_binding_component_indiceslist

(Hardcoded) list of non binding modifier components (e.g. pH).

is_kineticbool

If False, adsorption is assumed to be in rapid equilibriu. The default is True.

parametersdict

dict: Parameters of the instance.

property bound_states: list[int]

list[int]: Number of bound states per component.

property component_system: ComponentSystem

ComponentSystem: Component system of the binding model.

is_kinetic

Parameter descriptor constrained to boolean values.

Notes

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

property model: str

str: Name of the binding model.

n_binding_sites

Parameter descriptor for integers parameters constrained within bounds.

property n_bound_states: int

int: Number of bound states.

property n_comp: int

int: Number of components.

name

Parameter descriptor constrained to string values.

non_binding_component_indices = []