CADETProcess.reference.ReferenceBase#

class CADETProcess.reference.ReferenceBase(name, time, solution, c_min)[source]#

Class representing references to be compared with SimulationResults.

Attributes:

aggregated_parameters: dict: Aggregated parameters of the instance.
c_min
component_coordinates: np.ndarray: Indices of the components.
component_system: ComponentSystem: ComponentSystem of the Solution object.
coordinates: np.ndarray: Coordinates of the Solution.
cycle_time: float: Cycle time.
local_purity_components: np.ndarray: Local purity of each component.
local_purity_species: np.ndarray: Local purity of components.
missing_parameters: list: Parameters that are required but not set.
n_comp: int: Number of components.
name
nt: int: Number of time steps.
parameters: dict: Parameters of the instance.
polynomial_parameters: dict: Polynomial parameters of the instance.
required_parameters: list: Parameters that have no default value.
sized_parameters: dict: Sized parameters of the instance.
solution
solution_shape: tuple: (Expected) shape of the solution.
time
total_concentration: np.ndarray: Total concentration (sum) of all components.
total_concentration_components: np.ndarray: Total concentration of components (sum of species).

Methods

`check_required_parameters`()	Verify if all required parameters are set.
`reset`()	Reset component system, time, and solution arrays to their original values.
`update`()	Update the solution.
`update_transform`()	Update the transforms.

CADETProcess.reference.ReferenceBase