flixopt.linear_converters

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

Attributes

Classes

Boiler

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

Bases: LinearConverter

Parameters:

Name	Type	Description	Default
`label`	`str`	The label of the Element. Used to identify it in the FlowSystem	required
`eta`	`NumericDataTS`	thermal efficiency.	required
`Q_fu`	`Flow`	fuel input-flow	required
`Q_th`	`Flow`	thermal output-flow.	required
`on_off_parameters`	`OnOffParameters`	Parameters defining the on/off behavior of the component.	`None`
`meta_data`	`Optional[Dict]`	used to store more information about the Element. Is not used internally, but saved in the results. Only use python native types.	`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:

Name	Type	Description	Default
`path`	`Union[str, Path]`	The path to the json file.	required

to_dict

to_dict() -> Dict

Convert the object to a dictionary representation.

from_dict `classmethod`

from_dict(data: Dict) -> Interface

Create an instance from a dictionary representation.

Parameters:

Name	Type	Description	Default
`data`	`Dict`	Dictionary containing the data for the object.	required

Power2Heat

Power2Heat(label: str, eta: NumericDataTS, 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`	The label of the Element. Used to identify it in the FlowSystem	required
`eta`	`NumericDataTS`	thermal efficiency.	required
`P_el`	`Flow`	electric input-flow	required
`Q_th`	`Flow`	thermal output-flow.	required
`on_off_parameters`	`OnOffParameters`	Parameters defining the on/off behavior of the component.	`None`
`meta_data`	`Optional[Dict]`	used to store more information about the Element. Is not used internally, but saved in the results. Only use python native types.	`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:

Name	Type	Description	Default
`path`	`Union[str, Path]`	The path to the json file.	required

to_dict

to_dict() -> Dict

Convert the object to a dictionary representation.

from_dict `classmethod`

from_dict(data: Dict) -> Interface

Create an instance from a dictionary representation.

Parameters:

Name	Type	Description	Default
`data`	`Dict`	Dictionary containing the data for the object.	required

HeatPump

HeatPump(label: str, COP: NumericDataTS, 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`	The label of the Element. Used to identify it in the FlowSystem	required
`COP`	`NumericDataTS`	Coefficient of performance.	required
`P_el`	`Flow`	electricity input-flow.	required
`Q_th`	`Flow`	thermal output-flow.	required
`on_off_parameters`	`OnOffParameters`	Parameters defining the on/off behavior of the component.	`None`
`meta_data`	`Optional[Dict]`	used to store more information about the Element. Is not used internally, but saved in the results. Only use python native types.	`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:

Name	Type	Description	Default
`path`	`Union[str, Path]`	The path to the json file.	required

to_dict

to_dict() -> Dict

Convert the object to a dictionary representation.

from_dict `classmethod`

from_dict(data: Dict) -> Interface

Create an instance from a dictionary representation.

Parameters:

Name	Type	Description	Default
`data`	`Dict`	Dictionary containing the data for the object.	required

CoolingTower

CoolingTower(label: str, specific_electricity_demand: NumericDataTS, 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`	The label of the Element. Used to identify it in the FlowSystem	required
`specific_electricity_demand`	`NumericDataTS`	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
`on_off_parameters`	`OnOffParameters`	Parameters defining the on/off behavior of the component.	`None`
`meta_data`	`Optional[Dict]`	used to store more information about the Element. Is not used internally, but saved in the results. Only use python native types.	`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:

Name	Type	Description	Default
`path`	`Union[str, Path]`	The path to the json file.	required

to_dict

to_dict() -> Dict

Convert the object to a dictionary representation.

from_dict `classmethod`

from_dict(data: Dict) -> Interface

Create an instance from a dictionary representation.

Parameters:

Name	Type	Description	Default
`data`	`Dict`	Dictionary containing the data for the object.	required

CHP

CHP(label: str, eta_th: NumericDataTS, eta_el: NumericDataTS, Q_fu: Flow, 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`	The label of the Element. Used to identify it in the FlowSystem	required
`eta_th`	`NumericDataTS`	thermal efficiency.	required
`eta_el`	`NumericDataTS`	electrical efficiency.	required
`Q_fu`	`Flow`	fuel input-flow.	required
`P_el`	`Flow`	electricity output-flow.	required
`Q_th`	`Flow`	heat output-flow.	required
`on_off_parameters`	`OnOffParameters`	Parameters defining the on/off behavior of the component.	`None`
`meta_data`	`Optional[Dict]`	used to store more information about the Element. Is not used internally, but saved in the results. Only use python native types.	`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:

Name	Type	Description	Default
`path`	`Union[str, Path]`	The path to the json file.	required

to_dict

to_dict() -> Dict

Convert the object to a dictionary representation.

from_dict `classmethod`

from_dict(data: Dict) -> Interface

Create an instance from a dictionary representation.

Parameters:

Name	Type	Description	Default
`data`	`Dict`	Dictionary containing the data for the object.	required

HeatPumpWithSource

HeatPumpWithSource(label: str, COP: NumericDataTS, 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`	The label of the Element. Used to identify it in the FlowSystem	required
`COP`	`NumericDataTS`	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
`on_off_parameters`	`OnOffParameters`	Parameters defining the on/off behavior of the component.	`None`
`meta_data`	`Optional[Dict]`	used to store more information about the Element. Is not used internally, but saved in the results. Only use python native types.	`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:

Name	Type	Description	Default
`path`	`Union[str, Path]`	The path to the json file.	required

to_dict

to_dict() -> Dict

Convert the object to a dictionary representation.

from_dict `classmethod`

from_dict(data: Dict) -> Interface

Create an instance from a dictionary representation.

Parameters:

Name	Type	Description	Default
`data`	`Dict`	Dictionary containing the data for the object.	required

Functions

check_bounds

check_bounds(value: NumericDataTS, parameter_label: str, element_label: str, lower_bound: NumericDataTS, upper_bound: NumericDataTS) -> None

Check if the value is within the bounds. The bounds are exclusive. If not, log a warning. Args: value: The value to check. parameter_label: The label of the value. element_label: The label of the element. lower_bound: The lower bound. upper_bound: The upper bound.

flixopt.linear_converters

Attributes

Classes

Boiler

Functions

to_json

to_dict

from_dict classmethod

Power2Heat

Functions

to_json

to_dict

from_dict classmethod

HeatPump

Functions

to_json

to_dict

from_dict classmethod

CoolingTower

Functions

to_json

to_dict

from_dict classmethod

CHP

Functions

to_json

to_dict

from_dict classmethod

HeatPumpWithSource

Functions

to_json

to_dict

from_dict classmethod

Functions

check_bounds

from_dict `classmethod`

from_dict `classmethod`

from_dict `classmethod`

from_dict `classmethod`

from_dict `classmethod`

from_dict `classmethod`