refactor: merge single and variable speed charts into one single chart (#1134)

refactor: merge single and variable speed pumps into one pump model

fix: remove old charts when validating json results

Author: olelod

src/libecalc/common/serializable_chart.py

@@ -1,9 +1,8 @@
-from typing import Annotated, Literal, Self
+from typing import Annotated, Self
 
 import numpy as np
 from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
 
-from libecalc.common.chart_type import ChartType
 from libecalc.common.logger import logger
 from libecalc.common.string.string_utils import to_camel_case
 
@@ -75,12 +74,7 @@ def speed(self) -> float:
         return self.speed_rpm
 
 
-class SingleSpeedChartDTO(ChartCurveDTO):
-    typ: Literal[ChartType.SINGLE_SPEED] = ChartType.SINGLE_SPEED
-
-
-class VariableSpeedChartDTO(EcalcBaseModel):
-    typ: Literal[ChartType.VARIABLE_SPEED] = ChartType.VARIABLE_SPEED
+class ChartDTO(EcalcBaseModel):
     curves: list[ChartCurveDTO]
     control_margin: float | None = None  # Todo: Raise warning if this is used in an un-supported model.
     design_rate: float | None = Field(None, ge=0)

src/libecalc/core/result/base.py

@@ -4,7 +4,7 @@
 from typing import Self
 
 from libecalc.common.logger import logger
-from libecalc.common.serializable_chart import SingleSpeedChartDTO, VariableSpeedChartDTO
+from libecalc.common.serializable_chart import ChartDTO
 from libecalc.common.time_utils import Periods
 from libecalc.common.utils.rates import TimeSeries
 
@@ -26,7 +26,7 @@ def extend(self, other: Self) -> Self:
                 logger.warning(
                     f"Concatenating two temporal compressor results where result attribute '{attribute}' is undefined."
                 )
-            elif isinstance(values, Enum | str | dict | SingleSpeedChartDTO | VariableSpeedChartDTO):
+            elif isinstance(values, Enum | str | dict | ChartDTO):
                 if values != other_values:
                     logger.warning(
                         f"Concatenating two temporal compressor model results where attribute {attribute} changes"

src/libecalc/domain/process/compressor/core/results.py

@@ -2,7 +2,7 @@
 
 import numpy as np
 
-from libecalc.common.serializable_chart import SingleSpeedChartDTO, VariableSpeedChartDTO
+from libecalc.common.serializable_chart import ChartDTO
 from libecalc.common.units import Unit
 from libecalc.domain.process.core.results.compressor import (
     CompressorStageResult,
@@ -203,7 +203,7 @@ def __init__(
     @staticmethod
     def from_result_list_to_dto(
         result_list: list[CompressorTrainResultSingleTimeStep],
-        compressor_charts: list[SingleSpeedChartDTO | VariableSpeedChartDTO] | None,
+        compressor_charts: list[ChartDTO] | None,
     ) -> tuple[CompressorStreamCondition, CompressorStreamCondition, list[CompressorStageResult]]:
         number_of_stages = max([len(t.stage_results) for t in result_list])
 

src/libecalc/domain/process/compressor/core/train/base.py

@@ -192,7 +192,7 @@ def evaluate(
             stage_results,
         ) = CompressorTrainResultSingleTimeStep.from_result_list_to_dto(
             result_list=train_results,
-            compressor_charts=[stage.compressor_chart.data_transfer_object for stage in self.stages],  # type: ignore[misc]
+            compressor_charts=[stage.compressor_chart.data_transfer_object for stage in self.stages],
         )
 
         return CompressorTrainResult(

src/libecalc/domain/process/compressor/core/train/simplified_train.py

@@ -21,7 +21,7 @@
     calculate_polytropic_head_campbell,
 )
 from libecalc.domain.process.value_objects.chart.chart_area_flag import ChartAreaFlag
-from libecalc.domain.process.value_objects.chart.compressor import VariableSpeedCompressorChart
+from libecalc.domain.process.value_objects.chart.compressor import CompressorChart
 from libecalc.domain.process.value_objects.chart.compressor.chart_creator import CompressorChartCreator
 from libecalc.domain.process.value_objects.fluid_stream import FluidStream, ProcessConditions
 from libecalc.domain.process.value_objects.fluid_stream.fluid_factory import FluidFactoryInterface
@@ -398,7 +398,7 @@ def _get_max_std_rate_single_timestep(
                     temperature_kelvin=inlet_temperatures_kelvin_to_use[stage_number],
                     mass_rate_kg_per_h=1,
                 ),
-                compressor_chart=chart,  # type: ignore[arg-type]
+                compressor_chart=chart,
                 pressure_ratio=pressure_ratios_per_stage,  # type: ignore[arg-type]
             )
             for stage_number, chart in enumerate(compressor_charts)
@@ -427,7 +427,7 @@ def _calculate_inlet_pressure_stages(
     def calculate_maximum_rate_for_stage(
         pressure_ratio: float,
         inlet_stream: FluidStream,
-        compressor_chart: VariableSpeedCompressorChart,
+        compressor_chart: CompressorChart,
     ) -> float:
         """Calculate the maximum standard rate for a single set of inputs."""
         outlet_pressure = inlet_stream.pressure_bara * pressure_ratio

src/libecalc/domain/process/compressor/core/train/single_speed_compressor_train_common_shaft.py

@@ -15,7 +15,6 @@
     find_root,
     maximize_x_given_boolean_condition_function,
 )
-from libecalc.domain.process.value_objects.chart.compressor import SingleSpeedCompressorChart
 from libecalc.domain.process.value_objects.fluid_stream.fluid_factory import FluidFactoryInterface
 
 
@@ -158,11 +157,13 @@ def calculate_compressor_train(
         outlet_stream = train_inlet_stream
 
         for stage in self.stages:
+            speed = stage.compressor_chart.curves[0].speed
             inlet_stream = outlet_stream
             stage_result = stage.evaluate(
                 inlet_stream_stage=inlet_stream,
                 asv_rate_fraction=asv_rate_fraction,
                 asv_additional_mass_rate=asv_additional_mass_rate,
+                speed=speed,
             )
             stage_results.append(stage_result)
 
@@ -423,8 +424,14 @@ def _validate_maximum_discharge_pressure(self):
 
     def _validate_stages(self, stages):
         for stage in stages:
-            if not isinstance(stage.compressor_chart, SingleSpeedCompressorChart):
-                msg = "Single Speed Compressor train only accepts Single Speed Compressor Charts."
-                f" Given type was {type(stage.compressor_chart)}"
+            if len(stage.compressor_chart.curves) != 1:
+                msg = "Single Speed Compressor train only accepts one speed curve for each compressor chart."
+                f" The number of curves given is {len(stage.compressor_chart.curves)}."
 
                 raise ProcessChartTypeValidationException(message=str(msg))
+        if not all(
+            stage.compressor_chart.curves[0].speed == stages[0].compressor_chart.curves[0].speed for stage in stages
+        ):
+            msg = "All compressor charts in a Single Speed Compressor Train must have the same speed."
+
+            raise ProcessChartTypeValidationException(message=str(msg))

src/libecalc/domain/process/compressor/core/train/stage.py

@@ -14,8 +14,7 @@
 from libecalc.domain.process.compressor.core.train.utils.numeric_methods import find_root
 from libecalc.domain.process.compressor.dto import InterstagePressureControl
 from libecalc.domain.process.value_objects.chart.compressor import (
-    SingleSpeedCompressorChart,
-    VariableSpeedCompressorChart,
+    CompressorChart,
 )
 from libecalc.domain.process.value_objects.fluid_stream import FluidStream, ProcessConditions
 
@@ -28,7 +27,7 @@ class CompressorTrainStage:
 
     def __init__(
         self,
-        compressor_chart: SingleSpeedCompressorChart | VariableSpeedCompressorChart,
+        compressor_chart: CompressorChart,
         inlet_temperature_kelvin: float,
         remove_liquid_after_cooling: bool,
         pressure_drop_ahead_of_stage: float | None = None,
@@ -47,7 +46,7 @@ def has_control_pressure(self):
     def evaluate(
         self,
         inlet_stream_stage: FluidStream,
-        speed: float | None = None,
+        speed: float,
         asv_rate_fraction: float | None = 0.0,
         asv_additional_mass_rate: float | None = 0.0,
         increase_rate_left_of_minimum_flow_assuming_asv: bool | None = True,
@@ -67,22 +66,13 @@ def evaluate(
 
         Returns: Results of the evaluation
         """
-        if isinstance(self.compressor_chart, VariableSpeedCompressorChart):
-            if speed is None:
-                msg = (
-                    f"Speed value ({speed}) is not allowed for a variable speed compressor chart."
-                    f"You should not end up here, please contact support."
-                )
-                logger.exception(msg)
-                raise IllegalStateException(msg)
-
-            if speed < self.compressor_chart.minimum_speed or speed > self.compressor_chart.maximum_speed:
-                msg = (
-                    f"Speed value ({speed}) outside allowed range ({self.compressor_chart.minimum_speed} -"
-                    f" {self.compressor_chart.maximum_speed}). You should not end up here, please contact support."
-                )
-                logger.exception(msg)
-                raise IllegalStateException(msg)
+        if speed < self.compressor_chart.minimum_speed or speed > self.compressor_chart.maximum_speed:
+            msg = (
+                f"Speed value ({speed}) outside allowed range ({self.compressor_chart.minimum_speed} -"
+                f" {self.compressor_chart.maximum_speed}). You should not end up here, please contact support."
+            )
+            logger.exception(msg)
+            raise IllegalStateException(msg)
 
         if asv_rate_fraction is not None and asv_additional_mass_rate is not None:
             if asv_rate_fraction > 0 and asv_additional_mass_rate > 0:
@@ -107,11 +97,7 @@ def evaluate(
         )
 
         actual_rate_m3_per_hour_to_use = actual_rate_m3_per_hour = inlet_stream_compressor.volumetric_rate
-        compressor_maximum_actual_rate_m3_per_hour = float(
-            self.compressor_chart.maximum_rate_as_function_of_speed(speed)  # type: ignore[arg-type]
-            if isinstance(self.compressor_chart, VariableSpeedCompressorChart)
-            else self.compressor_chart.maximum_rate
-        )
+        compressor_maximum_actual_rate_m3_per_hour = self.compressor_chart.maximum_rate_as_function_of_speed(speed)
         available_capacity_for_actual_rate_m3_per_hour = max(
             0, compressor_maximum_actual_rate_m3_per_hour - actual_rate_m3_per_hour
         )  #  if the actual_rate_m3_per_hour is above capacity, the available capacity should be zero, not negative
@@ -124,24 +110,15 @@ def evaluate(
         if asv_additional_mass_rate:
             additional_rate_m3_per_hour = asv_additional_mass_rate / inlet_stream_compressor.density
 
-        if isinstance(self.compressor_chart, VariableSpeedCompressorChart):
-            compressor_chart_head_and_efficiency_result = (
-                self.compressor_chart.calculate_polytropic_head_and_efficiency_single_point(
-                    speed=speed,  # type: ignore[arg-type]
-                    actual_rate_m3_per_hour=actual_rate_m3_per_hour,
-                    recirculated_rate_m3_per_hour=additional_rate_m3_per_hour,
-                    increase_rate_left_of_minimum_flow_assuming_asv=increase_rate_left_of_minimum_flow_assuming_asv,  # type: ignore[arg-type]
-                    increase_speed_below_assuming_choke=increase_speed_below_assuming_choke,  # type: ignore[arg-type]
-                )
-            )
-        else:
-            compressor_chart_head_and_efficiency_result = (
-                self.compressor_chart.calculate_polytropic_head_and_efficiency_single_point(
-                    actual_rate_m3_per_hour=actual_rate_m3_per_hour,
-                    recirculated_rate_m3_per_hour=additional_rate_m3_per_hour,
-                    increase_rate_left_of_minimum_flow_assuming_asv=increase_rate_left_of_minimum_flow_assuming_asv,  # type: ignore[arg-type]
-                )
+        compressor_chart_head_and_efficiency_result = (
+            self.compressor_chart.calculate_polytropic_head_and_efficiency_single_point(
+                speed=speed,
+                actual_rate_m3_per_hour=actual_rate_m3_per_hour,
+                recirculated_rate_m3_per_hour=additional_rate_m3_per_hour,
+                increase_rate_left_of_minimum_flow_assuming_asv=increase_rate_left_of_minimum_flow_assuming_asv,  # type: ignore[arg-type]
+                increase_speed_below_assuming_choke=increase_speed_below_assuming_choke,  # type: ignore[arg-type]
             )
+        )
 
         actual_rate_m3_per_hour_to_use += additional_rate_m3_per_hour
 
@@ -160,9 +137,7 @@ def evaluate(
             _,
             mass_rate_asv_corrected_kg_per_hour,
         ) = calculate_asv_corrected_rate(
-            minimum_actual_rate_m3_per_hour=float(self.compressor_chart.minimum_rate_as_function_of_speed(speed))  # type: ignore[arg-type]
-            if isinstance(self.compressor_chart, VariableSpeedCompressorChart)
-            else float(self.compressor_chart.minimum_rate),
+            minimum_actual_rate_m3_per_hour=float(self.compressor_chart.minimum_rate_as_function_of_speed(speed)),
             actual_rate_m3_per_hour=actual_rate_m3_per_hour_to_use,
             density_kg_per_m3=inlet_stream_compressor.density,
         )
@@ -230,8 +205,8 @@ def evaluate_given_speed_and_target_discharge_pressure(
             CompressorTrainStageResultSingleTimeStep: The result of the evaluation for the compressor stage,
             including the outlet stream and operational details.
         """
-        # If no speed is defined for VariableSpeedCompressorChart, use the minimum speed
-        if isinstance(self.compressor_chart, VariableSpeedCompressorChart) and speed is None:
+        # If no speed is defined for CompressorChart, use the minimum speed
+        if isinstance(self.compressor_chart, CompressorChart) and speed is None:
             speed = self.compressor_chart.minimum_speed
 
         result_no_recirculation = self.evaluate(
@@ -242,11 +217,7 @@ def evaluate_given_speed_and_target_discharge_pressure(
 
         # result_no_recirculation.inlet_stream.density_kg_per_m3 will have correct pressure and temperature
         # to find max mass rate, inlet_stream_stage will not
-        maximum_rate = (
-            self.compressor_chart.maximum_rate
-            if isinstance(self.compressor_chart, SingleSpeedCompressorChart)
-            else self.compressor_chart.maximum_rate_as_function_of_speed(speed)  # type: ignore[arg-type]
-        )
+        maximum_rate = self.compressor_chart.maximum_rate_as_function_of_speed(speed)
 
         max_recirculation = max(
             maximum_rate * float(result_no_recirculation.inlet_stream.density)
@@ -292,7 +263,7 @@ class UndefinedCompressorStage(CompressorTrainStage):
     def __init__(
         self,
         polytropic_efficiency: float,
-        compressor_chart: VariableSpeedCompressorChart = None,  # Not in use. Not relevant when undefined.
+        compressor_chart: CompressorChart = None,  # Not in use. Not relevant when undefined.
         inlet_temperature_kelvin: float = 0.0,
         remove_liquid_after_cooling: bool = False,
         pressure_drop_ahead_of_stage: float | None = None,

src/libecalc/domain/process/compressor/core/train/utils/variable_speed_compressor_train_common_shaft.py

@@ -22,7 +22,7 @@
     maximize_x_given_boolean_condition_function,
 )
 from libecalc.domain.process.core.results.compressor import TargetPressureStatus
-from libecalc.domain.process.value_objects.chart.compressor import VariableSpeedCompressorChart
+from libecalc.domain.process.value_objects.chart.compressor import CompressorChart
 from libecalc.domain.process.value_objects.fluid_stream.fluid_factory import FluidFactoryInterface
 
 
@@ -176,7 +176,7 @@ def _validate_stages(self, stages):
         min_speed_per_stage = []
         max_speed_per_stage = []
         for stage in stages:
-            if not isinstance(stage.compressor_chart, VariableSpeedCompressorChart):
+            if not isinstance(stage.compressor_chart, CompressorChart):
                 msg = "Variable Speed Compressor train only accepts Variable Speed Compressor Charts."
                 f" Given type was {type(stage.compressor_chart)}"
 

src/libecalc/domain/process/compressor/core/train/variable_speed_compressor_train_common_shaft.py

@@ -8,7 +8,7 @@
 from libecalc.common.errors.exceptions import IllegalStateException
 from libecalc.common.fixed_speed_pressure_control import FixedSpeedPressureControl
 from libecalc.common.logger import logger
-from libecalc.common.serializable_chart import VariableSpeedChartDTO
+from libecalc.common.serializable_chart import ChartDTO
 from libecalc.domain.component_validation_error import ProcessChartTypeValidationException
 from libecalc.domain.process.compressor.core.results import CompressorTrainResultSingleTimeStep
 from libecalc.domain.process.compressor.core.train.base import CompressorTrainModel
@@ -20,7 +20,7 @@
     maximize_x_given_boolean_condition_function,
 )
 from libecalc.domain.process.core.results.compressor import TargetPressureStatus
-from libecalc.domain.process.value_objects.chart.compressor import VariableSpeedCompressorChart
+from libecalc.domain.process.value_objects.chart.compressor import CompressorChart
 from libecalc.domain.process.value_objects.fluid_stream import ProcessConditions, SimplifiedStreamMixing
 from libecalc.domain.process.value_objects.fluid_stream.fluid_factory import FluidFactoryInterface
 from libecalc.domain.process.value_objects.fluid_stream.fluid_model import FluidModel
@@ -175,12 +175,12 @@ def _validate_stages(self, stages):
         min_speed_per_stage = []
         max_speed_per_stage = []
         for stage in stages:
-            if not isinstance(stage.compressor_chart, VariableSpeedCompressorChart | VariableSpeedChartDTO):
+            if not isinstance(stage.compressor_chart, CompressorChart | ChartDTO):
                 msg = "Variable Speed Compressor train only accepts Variable Speed Compressor Charts."
                 f" Given type was {type(stage.compressor_chart)}"
 
                 raise ProcessChartTypeValidationException(message=str(msg))
-            if isinstance(stage.compressor_chart, VariableSpeedCompressorChart):
+            if isinstance(stage.compressor_chart, CompressorChart):
                 max_speed_per_stage.append(stage.compressor_chart.maximum_speed)
                 min_speed_per_stage.append(stage.compressor_chart.minimum_speed)
             else:
@@ -472,6 +472,7 @@ def calculate_compressor_train(
         # This multiple streams train also requires stream_rates to be set
         assert constraints.stream_rates is not None
         assert constraints.suction_pressure is not None
+        assert constraints.speed is not None
         mixing_strategy = SimplifiedStreamMixing()
         stage_results = []
         # Make list of fluid streams for the ingoing streams