base_consumer

Class for base consumer

class Consumer(control_type: str = 'energy', diameter: float = 0.02, mass_flow_min: float = 1e-06, heat_demand: float = 5000.0, design_delta_t: float = -30.0, setpoint_type_hx: str = 'delta_t', setpoint_type_hx_rev: str = 'delta_t', setpoint_value_hx: float = -30.0, setpoint_value_hx_rev: float = 0.0, power_max_hx: float = nan, t_out_min_hx: float = nan, setpoint_type_hyd: str = 'mass_flow', setpoint_value_hyd: float = 1e-06, **kwargs)[source]

Bases: Component

Class for base Consumer component. It has no operational parameters, only a mass flow setpoint is specified.

__init__(control_type: str = 'energy', diameter: float = 0.02, mass_flow_min: float = 1e-06, heat_demand: float = 5000.0, design_delta_t: float = -30.0, setpoint_type_hx: str = 'delta_t', setpoint_type_hx_rev: str = 'delta_t', setpoint_value_hx: float = -30.0, setpoint_value_hx_rev: float = 0.0, power_max_hx: float = nan, t_out_min_hx: float = nan, setpoint_type_hyd: str = 'mass_flow', setpoint_value_hyd: float = 1e-06, **kwargs) → None[source]

Init Consumer

Parameters:

  • control_type (str, optional) – Control type to define how mass flow is imposed. The default is energy.

  • diameter (float, optional) – Diameter (m). Unused. The default is 0.02.

  • mass_flow_min (float, optional) – Minimum mass flow (kg/s) allowed. The default is 1e-06.

  • heat_demand (float, optional) – Heat demand (Wh) used to compute the hydraulic setpoint in case the ‘energy’ control type is used. The default is 5000.0.

  • design_delta_t (float, optional) – Design temperature difference (K) of the heat exchanger used to compute the hydraulic setpoint in case the ‘energy’ control type is used. The default is -30.0.

  • setpoint_type_hx (str, optional) – Type of thermal setpoint to use. The default is delta_t.

  • setpoint_type_hx_rev (str, optional) – Type of thermal setpoint to use in case of reverse flow. The default is delta_t.

  • setpoint_value_hx (float, optional) – Value of the thermal setpoint. The default is -30.0.

  • setpoint_value_hx_rev (float, optional) – Value of the thermal setpoint in case of reverse flow. The default is 0.0.

  • power_max_hx (float, optional) – Maximum energy (Wh) that the consumer can exchange. The default is nan.

  • t_out_min_hx (float, optional) – Minimum outlet temperature (°C) of the consumer. The default is nan.

  • setpoint_type_hyd (str, optional) – Hydraulic setpoint type. The default is mass_flow.

  • setpoint_value_hyd (float, optional) – Hydraulic setpoint value. The default is 1e-06.

  • **kwargs – Arbitrary keyword arguments.

Return type:

None