CADETProcess.processModel.UnitBaseClass

class CADETProcess.processModel.UnitBaseClass(name)

Bases: Structure

Base class for all UnitOperation classes.

A UnitOperation object stores model parameters and states of a unit. Every unit operation can be assotiated with a binding behavior and a reaction model. UnitOperations can be connected in a FlowSheet.

Attributes:

n_compUnsignedInteger

int: Number of components.

parameterslist

dict: Dictionary with parameter values.

nameString

name of the unit operation.

has_portsbool

flag if unit has ports. The default is False.

binding_modelBindingBaseClass

BindingBaseClass: binding model parameters of the unit operation.

solution_recorderIORecorder

Solution recorder for the unit operation.

See also

CADETProcess.processModel.binding

CADETProcess.processModel.reaction

CADETProcess.processModel.FlowSheet

property binding_model: BindingBaseClass

BindingBaseClass: binding model parameters of the unit operation.

Raises:

TypeError

If binding_model object is not an instance of BindingBaseClass.

CADETProcessError

If number of components do not match.

property bulk_reaction_model: BulkReactionBase

BulkReactionBase: Reaction in bulk phase.

Raises:

TypeError

If bulk_reaction_model is not an instance of ReactionBaseClass.

CADETProcessError

If unit does not support bulk reaction model. If number of components do not match.

check_required_parameters() → bool

Checkf if there are missing parameters left.

property component_system: ComponentSystem

ComponentSystem: Component of the unit operation.

property discretization: DiscretizationParametersBase

DiscretizationParametersBase: Discretization parameters of the unit operation.

discretization_schemes = ()

has_ports = False

property initial_state: dict

dict: Dictionary with initial states.

property missing_parameters: list

Return list of missing parameters.

property model: str

str: Return model name.

property n_bound_states: int

int: Return number of bound states.

property n_comp: int

int: Number of components.

property n_ports: int

int: Number of ports.

name

Parameter descriptor constrained to string values.

property parameters: dict

dict: Dictionary with parameter values.

property particle_reaction_model: ParticleReactionBase

ParticleReactionBase: Reaction in particle liquid phase.

Raises:

TypeError

If particle_reaction_model is not an instance of ReactionBaseClass.

CADETProcessError

If unit does not support particle reaction model. If number of components do not match.

property ports: list

list: Ports of the unit operation.

property section_dependent_parameters: dict

Return section dependent parameters.

supports_binding = False

supports_bulk_reaction = False

supports_particle_reaction = False