CADETProcess.processModel.FlowSheet

Contents

CADETProcess.processModel.FlowSheet#

class CADETProcess.processModel.FlowSheet(name)[source]#

Class to design process flow sheet.

In this class, UnitOperation models are added and connected in a flow sheet.

Attributes:
n_compUnsignedInteger

int: The number of components.

nameString

Name of the FlowSheet.

unitslist

list: list of all unit_operations in the flow sheet.

connectionsdict

dict: In- and outgoing connections for each unit.

output_statesdict

dict: Output states of the unit operations.

Methods

add_connection(origin, destination[, ...])

Add connection between units 'origin' and 'destination'.

add_eluent_inlet(eluent_inlet)

Add inlet to list of units to be considered for eluent consumption.

add_feed_inlet(feed_inlet)

Add inlet to list of units to be considered for recovery.

add_product_outlet(product_outlet)

Add outlet to list of units considered for fractionation.

add_unit(unit[, feed_inlet, eluent_inlet, ...])

Add unit to the flow sheet.

check_connections()

Validate that units are connected correctly.

check_flow_rates([state])

Check if in and outgoing flow rates of unit operations are balanced.

check_required_parameters()

Verify if all required parameters are set.

check_units_config()

Check if units are configured correctly.

connection_exists(origin, destination[, ...])

bool: check if connection exists in flow sheet.

get_flow_rates([state, eps])

Calculate flow rate for all connections.

get_port_index(unit, port)

Return the port index of a unit.

get_unit_index(unit)

Return the unit index of the unit.

origin_destination_name_decorator()

Wrap methods to enable calling functions using origin and destination units.

remove_connection(origin, destination[, ...])

Remove connection between units 'origin' and 'destination'.

remove_eluent_inlet(eluent_inlet)

Remove inlet from list of units considered for eluent consumption.

remove_feed_inlet(feed_inlet)

Remove inlet from list of units to be considered for recovery.

remove_product_outlet(product_outlet)

Remove outlet from list of units to be considered for fractionation.

remove_unit(unit)

Remove unit from flow sheet.

set_output_state(unit, state[, port])

Set split ratio of outgoing streams for UnitOperation.

unit_name_decorator()

Wrap methods to enable calling functions with unit object or unit name.

update_parameters()

Update current parameters.

update_parameters_decorator()

Wrap method s.t.