CADETProcess.simulationResults.SimulationResults

class CADETProcess.simulationResults.SimulationResults(solver_name, solver_parameters, exit_flag, exit_message, time_elapsed, solution_cycles, sensitivity_cycles, system_state, chromatograms)

Bases: Structure

Class for storing simulation results including the solver configuration.

Attributes:

solver_namestr

Name of the solver used to simulate the process

solver_parametersdict

Dictionary with parameters used by the solver

exit_flagint

Information about the solver termination.

exit_messagestr

Additional information about the solver status

time_elapsedfloat

Execution time of simulation.

process: Process

Simulated Process.

solutiondict

Construct complete solution from individual cyles.

solution_cyclesdict

Solution objects for individual cycles of all Unit Operations.

sensitivitydict

Construct complete sensitivity from individual cyles.

sensitivity_cyclesdict

Solution objects for all sensitivities of individual cycles of all Unit Operations.

system_statedict

Final state and state_derivative of the system.

chromatogramsList of chromatogram

Solution of the final cycle of the product outlets.

n_cyclesint

int: Number of simulated cycles.

Notes

Ideally, the final state for each unit operation should be saved. However, CADET does currently provide this functionality.

chromatograms

Parameter descriptor constrained to list values.

property component_system: ComponentSystem

ComponentSystem: The component system used in the simulation.

exit_flag

Parameter descriptor for unsigned integer parameters.

exit_message

Parameter descriptor constrained to string values.

property n_cycles: int

int: Number of simulated cycles.

property process_meta: ProcessMeta

ProcessMeta: Process meta information.

property sensitivity: Dict

Construct complete sensitivity from individual cyles.

sensitivity_cycles

Parameter descriptor constrained to dictionary (dict) values.

property solution: Dict

Construct complete solution from individual cyles.

solution_cycles

Parameter descriptor constrained to dictionary (dict) values.

solver_name

Parameter descriptor constrained to string values.

solver_parameters

Parameter descriptor constrained to dictionary (dict) values.

system_state

Parameter descriptor constrained to dictionary (dict) values.

property time_complete: ndarray

np.ndarray: Solution times vector for all cycles.

property time_cycle: ndarray

np.array: Solution times vector.

time_elapsed

Parameter descriptor for unsigned floating-point parameters.

update(new_results: SimulationResults) → None

Update the simulation results with results from a new cycle.