CADETProcess.processModel.ComponentSystem

Contents

CADETProcess.processModel.ComponentSystem#

class CADETProcess.processModel.ComponentSystem(components: int | list[str | Component | None] = None, name: str | None = None, charges: list[int | None] = None, molar_masses: list[float | None] = None, densities: list[float | None] = None)[source]#

Bases: object

An ordered collection of components defining the chemical system.

Parameters:

componentsint | list[str | Component], optional: Number of anonymous components, or an explicit list of names or Component instances.
namestr, optional: Name of the system.
chargeslist[int | None], optional: Charges per component.
molar_masseslist[float | None], optional: Molar masses per component in kg/mol.
densitieslist[float | None], optional: Densities per component in kg/m³.

See also

Species
Component

add_component(component: str | Component, *args: Any, **kwargs: Any) → None[source]#

Add a component to the system.

Parameters:

componentstr | Component: Component instance or name of the component to add.
*args, **kwargs: Passed to Component constructor when component is a string.

property charges: list[int | None]#: list[int | None]: Charges per species.

property components: list[Component]#: list[Component]: Components in the system.

property components_dict: dict[str, Component]#: dict[str, Component]: Components indexed by name.

property densities: list[float | None]#: list[float | None]: Densities per species in kg/m³.

property indices: dict[str, list[int]]#: dict[str, list[int]]: Species indices per component name.

property molar_masses: list[float | None]#: list[float | None]: Molar masses per species in kg/mol.

property molecular_weights: list[float | None]#: Deprecated. Use molar_masses.

property n_comp: int#: int: Total number of species.

property n_components: int#: int: Number of components.

property n_species: int#: int: Total number of species.

property names: list[str]#: list[str]: Component names.

remove_component(component: str | Component) → None[source]#

Remove a component from the system.

Parameters:

componentstr | Component: Name or instance of the component to remove.

property species: list[str]#: list[str]: Species names in order.

property species_indices: dict[str, int]#: dict[str, int]: Index per species name.