flixOpt.calculation
This module contains the Calculation functionality for the flixOpt framework. It is used to calculate a SystemModel for a given FlowSystem through a solver. There are three different Calculation types: 1. FullCalculation: Calculates the SystemModel for the full FlowSystem 2. AggregatedCalculation: Calculates the SystemModel for the full FlowSystem, but aggregates the TimeSeriesData. This simplifies the mathematical model and usually speeds up the solving process. 3. SegmentedCalculation: Solves a SystemModel for each individual Segment of the FlowSystem.
Classes
Calculation
Calculation(name, flow_system: FlowSystem, modeling_language: Literal['pyomo', 'cvxpy'] = 'pyomo', time_indices: Optional[Union[range, List[int]]] = None)
class for defined way of solving a flow_system optimization
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
name of calculation |
required |
flow_system
|
FlowSystem
|
flow_system which should be calculated |
required |
modeling_language
|
'pyomo','cvxpy' (not implemeted yet)
|
choose optimization modeling language |
'pyomo'
|
time_indices
|
List[int] or None
|
list with indices, which should be used for calculation. If None, then all timesteps are used. |
None
|
Functions
FullCalculation
FullCalculation(name, flow_system: FlowSystem, modeling_language: Literal['pyomo', 'cvxpy'] = 'pyomo', time_indices: Optional[Union[range, List[int]]] = None)
Bases: Calculation
class for defined way of solving a flow_system optimization
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
name of calculation |
required |
flow_system
|
FlowSystem
|
flow_system which should be calculated |
required |
modeling_language
|
'pyomo','cvxpy' (not implemeted yet)
|
choose optimization modeling language |
'pyomo'
|
time_indices
|
List[int] or None
|
list with indices, which should be used for calculation. If None, then all timesteps are used. |
None
|
Functions
AggregatedCalculation
AggregatedCalculation(name, flow_system: FlowSystem, aggregation_parameters: AggregationParameters, components_to_clusterize: Optional[List[Component]] = None, modeling_language: Literal['pyomo', 'cvxpy'] = 'pyomo', time_indices: Optional[Union[range, List[int]]] = None)
Bases: Calculation
class for defined way of solving a flow_system optimization
Class for Optimizing the FLowSystem including: 1. Aggregating TimeSeriesData via typical periods using tsam. 2. Equalizing variables of typical periods.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
name of calculation |
required |
aggregation_parameters
|
AggregationParameters
|
Parameters for aggregation. See documentation of AggregationParameters class. |
required |
components_to_clusterize
|
Optional[List[Component]]
|
List of Components to perform aggregation on. If None, then all components are aggregated. This means, teh variables in the components are equalized to each other, according to the typical periods computed in the DataAggregation |
None
|
flow_system
|
FlowSystem
|
flow_system which should be calculated |
required |
modeling_language
|
'pyomo','cvxpy' (not implemeted yet)
|
choose optimization modeling language |
'pyomo'
|
time_indices
|
List[int] or None
|
list with indices, which should be used for calculation. If None, then all timesteps are used. |
None
|
Functions
SegmentedCalculation
SegmentedCalculation(name, flow_system: FlowSystem, segment_length: int, overlap_length: int, modeling_language: Literal['pyomo', 'cvxpy'] = 'pyomo', time_indices: Optional[Union[range, list[int]]] = None)
Bases: Calculation
Dividing and Modeling the problem in (overlapping) segments. The final values of each Segment are recognized by the following segment, effectively coupling charge_states and flow_rates between segments. Because of this intersection, both modeling and solving is done in one step
Take care: Parameters like InvestParameters, sum_of_flow_hours and other restrictions over the total time_series don't really work in this Calculation. Lower bounds to such SUMS can lead to weird results. This is NOT yet explicitly checked for...
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
name of calculation |
required |
flow_system
|
FlowSystem
|
flow_system which should be calculated |
required |
segment_length
|
int
|
The number of time_steps per individual segment (without the overlap) |
required |
overlap_length
|
int
|
The number of time_steps that are added to each individual model. Used for better results of storages) |
required |
modeling_language
|
'pyomo', 'cvxpy' (not implemeted yet)
|
choose optimization modeling language |
'pyomo'
|
time_indices
|
List[int] or None
|
list with indices, which should be used for calculation. If None, then all timesteps are used. |
None
|
Attributes
start_values_of_segments
property
Gives an overview of the start values of all Segments
Functions
results
results(combined_arrays: bool = False, combined_scalars: bool = False, individual_results: bool = False) -> Dict[str, Union[Numeric, Dict[str, Numeric]]]
Retrieving the results of a Segmented Calculation is not as straight forward as with other Calculation types. You have 3 options: 1. combined_arrays: Retrieve the combined array Results of all Segments as 'combined_arrays'. All result arrays ar concatenated, taking care of removing the overlap. These results can be directly compared to other Calculation results. Unfortunately, Scalar values like the total of effects can not be combined in a deterministic way. Rather convert the time series effect results to a sum yourself. 2. combined_scalars: Retrieve the combined scalar Results of all Segments. All Scalar Values like the total of effects are combined and stored in a List. Take care that the total of multiple Segment is not equivalent to the total of the total timeSeries, as it includes the Overlap! 3. individual_results: Retrieve the individual results of each Segment