CADETProcess.simulator.Cadet

class CADETProcess.simulator.Cadet(timeout, use_dll, time_resolution, resolution_cutoff, n_cycles, evaluate_stationarity, n_cycles_min, n_cycles_max, raise_exception_on_max_cycles)

CADET class for running a simulation for given process objects.

See also

ReturnParameters

ModelSolverParameters

SolverParameters

SolverTimeIntegratorParameters

CadetAPI

Attributes:

install_path: str

Path to the root of the CADET installation

time_outUnsignedFloat

Maximum duration for simulations

model_solver_parametersModelSolverParameters

Container for solver parameters

unit_discretization_parametersUnitDiscretizationParameters

Container for unit discretization parameters

discretization_weno_parametersDiscretizationWenoParameters

Container for weno discretization parameters in units

adsorption_consistency_solver_parametersConsistencySolverParameters

Container for consistency solver parameters

solver_parametersSolverParameters

Container for general solver settings

time_integrator_parametersSolverTimeIntegratorParameters

Container for time integrator parameters

return_parametersReturnParameters

Container for return information of the system

..todo::

Implement method for loading CADET file that have not been generated with CADETProcess and create Process

Methods

__call__(process[, previous_results])	Simulate the process.
add_parameter_section(model_units, ...)	Add section value to parameter branch.
autodetect_cadet()	Autodetect installation CADET based on operating system and API usage.
cadet_connections(flow_rates, flow_sheet)	list: Connections matrix for flow_rates state.
check_cadet()	Check if CADET installation can run a basic LWE example.
check_required_parameters()	Verify if all required parameters are set.
create_lwe([file_path])	Create basic LWE example.
evaluate(process[, previous_results])	Simulate the process.
get_adsorption_config(binding)	Config branch /input/model/unit_xxx/adsorption for individual unit.
get_input_model(process)	Config branch /input/model/
get_input_return(process)	Config branch /input/return
get_input_sensitivity(process)	Config branch /input/sensitivity
get_input_solver(process)	Config branch /input/solver/
get_model_connections(process)	Config branch /input/model/connections
get_model_units(process)	Config branches for all units /input/model/unit_000 .
get_parameter_sensitivities(process)	Config branches for all parameter sensitivities /input/sensitivity/param_000 .
get_process_config(process)	Create the CADET config.
get_reaction_config(reaction)	Config branch /input/model/unit_xxx/reaction for individual unit.
get_section_times(process)	Get the section times for a single cycle of a process.
get_section_times_complete(process)	Get the section times for multiple cycles of a process.
get_simulation_results(process, cadet[, ...])	Read simulation results from CADET configuration.
get_solution_time(process[, cycle])	Get the time vector for one cycle of a process.
get_solution_time_complete(process)	Get the time vector for multiple cycles of a process.
get_solver_sections(process)	Config branch /input/solver/sections
get_unit_config(unit)	Config branch /input/model/unit_xxx for individual unit.
get_unit_index(process, unit)	Helper function for getting unit index in CADET format unit_xxx.
get_unit_return_parameters(process)	Config branches for all units /input/return/unit_000 .
locks_process()	Lock process to enable caching.
run(process[, cadet, file_path])	Interface to the solver run function.
set_section_dependent_parameters(...)	Add time dependent model parameters to units.
set_state_from_results(process, results)	Set the process state from the simulation results.
simulate(process[, previous_results])	Simulate the process.
simulate_n_cycles(process, n_cyc[, ...])	Simulate the process for a given number of cycles.
simulate_to_stationarity(process[, results])	Simulate the process until stationarity is reached.

add_inlet_section
get_new_cadet_instance
get_sensitivity_config
get_tempfile_name
load_from_h5
load_simulation_results
run_h5
save_to_h5