bio_rtd.uo.special_uo

Special unit operations.

Special unit operations are the ones that cannot be assigned to one of the following groups:

  • Fully continuous (accept constant and provide constant flow rate)

  • Semi continuous (accept constant and provide periodic flow rate)

  • Surge tanks (accept any and provide constant flow rate)

ComboUO

class bio_rtd.uo.special_uo.ComboUO(t, sub_uo_list, uo_id, gui_title='ComboUO')[source]

Bases: bio_rtd.core.UnitOperation

Combines multiple unit operations into one.

Parameters

  • t (ndarray) –

    Simulation time vector.

    All unit operations need to have the same t.

  • sub_uo_list (Sequence[UnitOperation]) – List of unit operations to be merged into ComboUO.

  • uo_id (str) – Unique identified of combined unit operation.

  • gui_title (str) – Human readable title for GUI or plots. Default = “ComboUO”.

sub_uo_list

List of unit operations that are merged into ComboUO.

evaluate(f_in, c_in)[source]

Evaluates all child unit operations.

Parameters

  • f_in (array) – Inlet flow rate profile.

  • c_in (ndarray) – Inlet concentration profile.

Return type

Tuple[ndarray, ndarray]

Returns

  • f_out – Outlet flow rate profile.

  • c_out – Outlet concentration profile.

get_result()

Returns existing flow rate and concentration profiles.

Return type

Tuple[ndarray, ndarray]

Returns

  • f_out – Outlet flow rate profile.

  • c_out – Outlet concentration profile.

property log

Reference of the RtdLogger instance.

Setter also plants instance data tree into passed logger.

If logger is requested, but not yet set, then a bio_rtd.logger.DefaultLogger is instantiated.

Return type

RtdLogger

set_logger_from_parent(parent_id, logger)

Inherit logger from parent.

Parameters

  • parent_id (str) – Unique identifier of parent instance.

  • logger (RtdLogger) – Logger from parent instance.

uo_id: str

Unique identifier of the instance

gui_title: str

Readable title for GUI

gui_hidden: bool

Hide the of the unit operation (default False).

discard_inlet_until_t: float

Discard inlet until given time.

discard_inlet_until_min_c: numpy.ndarray

Discard inlet until given concentration is reached.

discard_inlet_until_min_c_rel: numpy.ndarray

Discard inlet until given concentration relative to is reached.

Specified concentration is relative to the max concentration.

discard_inlet_n_cycles: int

Discard first n cycles of the periodic inlet flow rate profile.

discard_outlet_until_t: float

Discard outlet until given time.

discard_outlet_until_min_c: numpy.ndarray

Discard outlet until given concentration is reached.

discard_outlet_until_min_c_rel: numpy.ndarray

Discard outlet until given concentration relative to is reached.

Specified concentration is relative to the max concentration.

discard_outlet_n_cycles: int

Discard first n cycles of the periodic outlet flow rate profile.

adj_par_list

List of adjustable parameters exposed to the GUI.

Type

list of bio_rtd.adj_par.AdjustableParameter