flixOpt.elements
This module contains the basic elements of the flixOpt framework.
Classes
Component
Component(label: str, inputs: Optional[List[Flow]] = None, outputs: Optional[List[Flow]] = None, on_off_parameters: Optional[OnOffParameters] = None, prevent_simultaneous_flows: Optional[List[Flow]] = None, meta_data: Optional[Dict] = None)
Bases: Element
basic component class for all components
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
label
|
str
|
name. |
required |
meta_data
|
Optional[Dict]
|
used to store more information about the element. Is not used internally, but saved in the results |
None
|
inputs
|
input flows.
|
|
None
|
outputs
|
output flows.
|
|
None
|
on_off_parameters
|
Optional[OnOffParameters]
|
Component is On/Off, if all connected Flows are On/Off. Induces On-Variable in all FLows! See class OnOffParameters. |
None
|
prevent_simultaneous_flows
|
Optional[List[Flow]]
|
Induces On-Variable in all FLows! |
None
|
Bus
Bus(label: str, excess_penalty_per_flow_hour: Optional[Numeric_TS] = 100000.0, meta_data: Optional[Dict] = None)
Bases: Element
realizing balance of all linked flows (penalty flow is excess can be activated)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
label
|
str
|
name. |
required |
meta_data
|
Optional[Dict]
|
used to store more information about the element. Is not used internally, but saved in the results |
None
|
excess_penalty_per_flow_hour
|
(none or scalar, array or TimeSeriesData)
|
excess costs / penalty costs (bus balance compensation) (none/ 0 -> no penalty). The default is 1e5. (Take care: if you use a timeseries (no scalar), timeseries is aggregated if calculation_type = aggregated!) |
100000.0
|
Functions
infos
Generate a dictionary representation of the object's constructor arguments. Excludes default values and empty dictionaries and lists. Converts data to be compatible with JSON.
Parameters:
use_numpy bool:
Whether to convert NumPy arrays to lists. Defaults to True.
If True, numeric numpy arrays (np.ndarray) are preserved as-is.
If False, they are converted to lists.
use_element_label bool:
Whether to use the element label instead of the infos of the element. Defaults to False.
Note that Elements used as keys in dictionaries are always converted to their labels.
Returns: Dict: A dictionary representation of the object's constructor arguments.
Flow
Flow(label: str, bus: Bus, size: Union[Skalar, InvestParameters] = None, fixed_relative_profile: Optional[Numeric_TS] = None, relative_minimum: Numeric_TS = 0, relative_maximum: Numeric_TS = 1, effects_per_flow_hour: EffectValues = None, on_off_parameters: Optional[OnOffParameters] = None, flow_hours_total_max: Optional[Skalar] = None, flow_hours_total_min: Optional[Skalar] = None, load_factor_min: Optional[Skalar] = None, load_factor_max: Optional[Skalar] = None, previous_flow_rate: Optional[Numeric] = None, meta_data: Optional[Dict] = None)
Bases: Element
flows are inputs and outputs of components
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
label
|
str
|
name of flow |
required |
meta_data
|
Optional[Dict]
|
used to store more information about the element. Is not used internally, but saved in the results |
None
|
bus
|
Bus
|
bus to which flow is linked |
required |
size
|
(scalar, InvestmentParameters)
|
size of the flow. If InvestmentParameters is used, size is optimized. If size is None, a default value is used. |
None
|
relative_minimum
|
(scalar, array, TimeSeriesData)
|
min value is relative_minimum multiplied by size |
0
|
relative_maximum
|
(scalar, array, TimeSeriesData)
|
max value is relative_maximum multiplied by size. If size = max then relative_maximum=1 |
1
|
load_factor_min
|
scalar
|
minimal load factor general: avg Flow per nominalVal/investSize
(e.g. boiler, kW/kWh=h; solarthermal: kW/m²;
def: :math: |
None
|
load_factor_max
|
scalar
|
maximal load factor (see minimal load factor) |
None
|
effects_per_flow_hour
|
(scalar, array, TimeSeriesData)
|
operational costs, costs per flow-"work" |
None
|
on_off_parameters
|
OnOffParameters
|
If present, flow can be "off", i.e. be zero (only relevant if relative_minimum > 0) Therefore a binary var "on" is used. Further, several other restrictions and effects can be modeled through this On/Off State (See OnOffParameters) |
None
|
flow_hours_total_max
|
TYPE
|
maximum flow-hours ("flow-work") (if size is not const, maybe load_factor_max fits better for you!) |
None
|
flow_hours_total_min
|
TYPE
|
minimum flow-hours ("flow-work") (if size is not const, maybe load_factor_min fits better for you!) |
None
|
fixed_relative_profile
|
(scalar, array, TimeSeriesData)
|
fixed relative values for flow (if given). val(t) := fixed_relative_profile(t) * size(t) With this value, the flow_rate is no opt-variable anymore; (relative_minimum u. relative_maximum are making sense anymore) used for fixed load profiles, i.g. heat demand, wind-power, solarthermal If the load-profile is just an upper limit, use relative_maximum instead. |
None
|
previous_flow_rate
|
(scalar, array)
|
previous flow rate of the component. |
None
|
FlowModel
Bases: ElementModel
Attributes
absolute_flow_rate_bounds
property
Returns absolute flow rate bounds. Important for OnOffModel
ComponentModel
Bases: ElementModel