flixOpt.linear_converters

This Module contains high-level classes to easily model a FlowSystem.

Classes

Boiler

Boiler(label: str, eta: Numeric_TS, Q_fu: Flow, Q_th: Flow, on_off_parameters: OnOffParameters = None, meta_data: Optional[Dict] = None)

Bases: LinearConverter

constructor for boiler

Parameters:

Name	Type	Description	Default
`label`	`str`	name of bolier.	required
`eta`	`float or TS`	thermal efficiency.	required
`Q_fu`	`Flow`	fuel input-flow	required
`Q_th`	`Flow`	thermal output-flow.	required
`meta_data`	`Optional[Dict]`	used to store more information about the element. Is not used internally, but saved in the results	`None`

Functions

to_json

to_json(path: Union[str, Path])

Saves the element to a json file. This not meant to be reloaded and recreate the object, but rather used to document or compare the object.

Parameters:

path : Union[str, pathlib.Path] The path to the json file.

Power2Heat

Power2Heat(label: str, eta: Numeric_TS, P_el: Flow, Q_th: Flow, on_off_parameters: OnOffParameters = None, meta_data: Optional[Dict] = None)

Bases: LinearConverter

Parameters:

Name	Type	Description	Default
`label`	`str`	name of bolier.	required
`eta`	`float or TS`	thermal efficiency.	required
`P_el`	`Flow`	electric input-flow	required
`Q_th`	`Flow`	thermal output-flow.	required
`meta_data`	`Optional[Dict]`	used to store more information about the element. Is not used internally, but saved in the results	`None`

Functions

to_json

to_json(path: Union[str, Path])

Saves the element to a json file. This not meant to be reloaded and recreate the object, but rather used to document or compare the object.

Parameters:

path : Union[str, pathlib.Path] The path to the json file.

HeatPump

HeatPump(label: str, COP: Numeric_TS, P_el: Flow, Q_th: Flow, on_off_parameters: OnOffParameters = None, meta_data: Optional[Dict] = None)

Bases: LinearConverter

Parameters:

Name	Type	Description	Default
`label`	`str`	name of heatpump.	required
`COP`	`float or TS`	Coefficient of performance.	required
`P_el`	`Flow`	electricity input-flow.	required
`Q_th`	`Flow`	thermal output-flow.	required
`meta_data`	`Optional[Dict]`	used to store more information about the element. Is not used internally, but saved in the results	`None`

Functions

to_json

to_json(path: Union[str, Path])

Saves the element to a json file. This not meant to be reloaded and recreate the object, but rather used to document or compare the object.

Parameters:

path : Union[str, pathlib.Path] The path to the json file.

CoolingTower

CoolingTower(label: str, specific_electricity_demand: Numeric_TS, P_el: Flow, Q_th: Flow, on_off_parameters: OnOffParameters = None, meta_data: Optional[Dict] = None)

Bases: LinearConverter

Parameters:

Name	Type	Description	Default
`label`	`str`	name of cooling tower.	required
`specific_electricity_demand`	`float or TS`	auxiliary electricty demand per cooling power, i.g. 0.02 (2 %).	required
`P_el`	`Flow`	electricity input-flow.	required
`Q_th`	`Flow`	thermal input-flow.	required
`meta_data`	`Optional[Dict]`	used to store more information about the element. Is not used internally, but saved in the results	`None`

Functions

to_json

to_json(path: Union[str, Path])

Saves the element to a json file. This not meant to be reloaded and recreate the object, but rather used to document or compare the object.

Parameters:

path : Union[str, pathlib.Path] The path to the json file.

CHP

CHP(label: str, eta_th: Numeric_TS, eta_el: Numeric_TS, Q_fu: Flow, P_el: Flow, Q_th: Flow, on_off_parameters: OnOffParameters = None, meta_data: Optional[Dict] = None)

Bases: LinearConverter

constructor of cCHP

Parameters:

Name	Type	Description	Default
`label`	`str`	name of CHP-unit.	required
`eta_th`	`float or TS`	thermal efficiency.	required
`eta_el`	`float or TS`	electrical efficiency.	required
`Q_fu`	`cFlow`	fuel input-flow.	required
`P_el`	`cFlow`	electricity output-flow.	required
`Q_th`	`cFlow`	heat output-flow.	required
`meta_data`	`Optional[Dict]`	used to store more information about the element. Is not used internally, but saved in the results	`None`

Functions

to_json

to_json(path: Union[str, Path])

Saves the element to a json file. This not meant to be reloaded and recreate the object, but rather used to document or compare the object.

Parameters:

path : Union[str, pathlib.Path] The path to the json file.

HeatPumpWithSource

HeatPumpWithSource(label: str, COP: Numeric_TS, P_el: Flow, Q_ab: Flow, Q_th: Flow, on_off_parameters: OnOffParameters = None, meta_data: Optional[Dict] = None)

Bases: LinearConverter

Parameters:

Name	Type	Description	Default
`label`	`str`	name of heatpump.	required
`COP`	`(float, TS)`	Coefficient of performance.	required
`Q_ab`	`Flow`	Heatsource input-flow.	required
`P_el`	`Flow`	electricity input-flow.	required
`Q_th`	`Flow`	thermal output-flow.	required
`meta_data`	`Optional[Dict]`	used to store more information about the element. Is not used internally, but saved in the results	`None`

Functions

to_json

to_json(path: Union[str, Path])

Saves the element to a json file. This not meant to be reloaded and recreate the object, but rather used to document or compare the object.

Parameters:

path : Union[str, pathlib.Path] The path to the json file.

Functions

check_bounds

check_bounds(value: Numeric_TS, parameter_label: str, element_label: str, lower_bound: Numeric_TS, upper_bound: Numeric_TS)

Check if the value is within the bounds. The bounds are exclusive. If not, log a warning.

Parameters:

Name	Type	Description	Default
`value`	`Numeric_TS`	The value to check.	required
`parameter_label`	`str`	The label of the value.	required
`element_label`	`str`	The label of the element.	required
`lower_bound`	`Numeric_TS`	The lower bound.	required
`upper_bound`	`Numeric_TS`	The upper bound.	required