CADETProcess.fractionation.Fractionator

class CADETProcess.fractionation.Fractionator(name, cycle_time, _lock)

Class for Chromatogram Fractionation.

To set Events for starting and ending a fractionation it inherits from the EventHandler class. It defines a ranking list for components as a DependentlySizedUnsignedList with the number of components as dependent size. The time_signal to fractionate is defined. If no ranking is set, every component is equivalently.

Attributes:

aggregated_parameters

dict: Aggregated parameters of the instance.

chromatogram_events

chromatogram_names

list: Chromatogram names

chromatograms

list: Chromatograms to be fractionized.

chromatograms_dict

dict: Chromatogram names and objects.

component_system

ComponentSystem: The component system of the chromatograms.

concentration

ndarray: Component concentration in corresponding fraction pool.

cycle_time

float: The cycle time of the Fractionator.

eluent_consumption

ndarray: Specific eluent consumption in corresponding fraction pool.

fraction_pools

List of the component and waste fraction pools.

fractionation_states

dict: Fractionation state of Chromatograms.

lock

mass

ndarray: Component mass in corresponding fraction pools.

mass_balance_difference

ndarray: Difference in mass balance between m_feed and fraction pools.

missing_parameters

list: Parameters that are required but not set.

n_chromatograms

int: Number of Chromatograms Fractionator.

n_comp

int: Number of components to be fractionized

n_fractions_per_pool

list: number of fractions per pool.

n_sections

int: Number of sections.

name

parameters

dict: The EventHandler parameters.

performance

Performance: The performance metrics of the fractionation.

performer_events

dict: Event performer mapped to their corresponding list of events.

polynomial_parameters

dict: Polynomial parameters of the instance.

process

Process: The process from the simulation results.

productivity

ndarray: Specific productivity in corresponding fraction pool.

purity

ndarray: Component purity in corresponding fraction pool.

recovery

ndarray: Component recovery yield in corresponding fraction pool.

required_parameters

list: Parameters that have no default value.

section_dependent_parameters

simulation_results

SimulationResults: The simulation results containing the chromatograms.

sized_parameters

dict: Compilation of parameters from events with indices.

time

np.ndarray: solution times of Chromatogram.

total_mass

ndarray: Total mass of each component in all fraction pools.

Methods

add_duration(name[, time])	Register a new duration or time point of interest.
add_event(name, parameter_path, state[, ...])	Add a new event that changes a parameter during the process.
add_event_dependency(dependent_event, ...[, ...])	Create a dependency relationship between events.
add_fraction(fraction, target)	Add Fraction to the FractionPool of target component.
add_fractionation_event(event_name, target, time)	Add a fractionation event.
call_by_chrom_name()	Decorator to enable calling functions with chromatogram object or name.
check_config()	Validate the event configuration.
check_duplicate_events()	Ensure no simulateneous events are scheduled for a specific parameter and index.
check_required_parameters()	Verify if all required parameters are set.
check_uninitialized_indices()	Ensure all indices are specified when a parameter isn't initialized.
initial_values([purity_required])	Create events from chromatogram with minimum purity.
plot_events()	Plot parameter state as a function of time.
plot_fraction_signal([chromatogram, ax])	Plot the signal without the waste fractions.
remove_duration(duration_name)	Remove a specified duration or time point from tracking.
remove_event(evt_name)	Remove a specified event from the event handler.
remove_event_dependency(dependent_event, ...)	Remove a previously defined dependency between events.
reset()	Reset the results when fractionation times are changed.
set_fractionation_state(chrom, state)	Set fractionation states of Chromatogram.

save