chore: avoid shared state

Author: frodehk

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

@@ -1,7 +1,9 @@
 from __future__ import annotations
 
 from abc import abstractmethod
+from copy import deepcopy
 from functools import partial
+from typing import Self
 
 import numpy as np
 from numpy.typing import NDArray
@@ -72,6 +74,9 @@ def check_for_undefined_stages(
     ) -> None:
         pass
 
+    def clone(self) -> Self:
+        return deepcopy(self)
+
 
 class CompressorWithTurbineModel(CompressorModel):
     def __init__(

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

@@ -8,14 +8,13 @@
 )
 from libecalc.domain.process.compressor.core.results import CompressorTrainResultSingleTimeStep
 from libecalc.domain.process.compressor.core.train.base import CompressorTrainModel
+from libecalc.domain.process.compressor.core.train.stage import CompressorTrainStage
 from libecalc.domain.process.compressor.core.train.train_evaluation_input import CompressorTrainEvaluationInput
 from libecalc.domain.process.compressor.core.train.utils.common import EPSILON
 from libecalc.domain.process.compressor.core.train.utils.numeric_methods import (
     find_root,
     maximize_x_given_boolean_condition_function,
 )
-from libecalc.domain.process.compressor.core.utils import map_compressor_train_stage_to_domain
-from libecalc.domain.process.compressor.dto import CompressorStage
 from libecalc.domain.process.value_objects.chart.compressor import SingleSpeedCompressorChart
 from libecalc.domain.process.value_objects.fluid_stream.fluid_factory import FluidFactoryInterface
 
@@ -67,27 +66,27 @@ def __init__(
         fluid_factory: FluidFactoryInterface,
         energy_usage_adjustment_constant: float,
         energy_usage_adjustment_factor: float,
-        stages: list[CompressorStage],
+        stages: list[CompressorTrainStage],
         pressure_control: FixedSpeedPressureControl | None = None,
         calculate_max_rate: bool = False,
         maximum_power: float | None = None,
         maximum_discharge_pressure: float | None = None,
     ):
         logger.debug(f"Creating SingleSpeedCompressorTrainCommonShaft with n_stages: {len(stages)}")
-        stages_mapped = [map_compressor_train_stage_to_domain(stage_dto) for stage_dto in stages]
+        # stages_mapped = [map_compressor_train_stage_to_domain(stage_dto) for stage_dto in stages]
         super().__init__(
             fluid_factory=fluid_factory,
             energy_usage_adjustment_constant=energy_usage_adjustment_constant,
             energy_usage_adjustment_factor=energy_usage_adjustment_factor,
-            stages=stages_mapped,
+            stages=stages,
             typ=EnergyModelType.SINGLE_SPEED_COMPRESSOR_TRAIN_COMMON_SHAFT,
             maximum_power=maximum_power,
             pressure_control=pressure_control,
             maximum_discharge_pressure=maximum_discharge_pressure,
             calculate_max_rate=calculate_max_rate,
         )
         self._validate_maximum_discharge_pressure()
-        self._validate_stages(stages_mapped)
+        self._validate_stages(stages)
 
     def evaluate_given_constraints(
         self,

src/libecalc/presentation/yaml/mappers/model.py

@@ -12,6 +12,7 @@
 from libecalc.domain.process.compressor.core.train.single_speed_compressor_train_common_shaft import (
     SingleSpeedCompressorTrainCommonShaft,
 )
+from libecalc.domain.process.compressor.core.utils import map_compressor_train_stage_to_domain
 from libecalc.domain.process.compressor.dto import (
     CompressorStage,
     CompressorTrainSimplifiedWithKnownStages,
@@ -475,10 +476,10 @@ def _single_speed_compressor_train_mapper(
     fluid_factory = _create_fluid_factory(fluid_model=fluid_model)
     if fluid_factory is None:
         raise ValueError("Fluid model is required for compressor train")
-
+    stages_mapped = [map_compressor_train_stage_to_domain(stage_dto) for stage_dto in stages]
     return SingleSpeedCompressorTrainCommonShaft(
         fluid_factory=fluid_factory,
-        stages=stages,
+        stages=stages_mapped,
         pressure_control=pressure_control,
         maximum_discharge_pressure=maximum_discharge_pressure,
         energy_usage_adjustment_constant=model_config.power_adjustment_constant,

src/libecalc/presentation/yaml/yaml_reference_service.py

@@ -121,9 +121,9 @@ def get_generator_set_model(self, reference: str) -> GeneratorSetModel:
 
     def get_compressor_model(self, reference: str) -> CompressorModel:
         model = self._get_model_reference(reference, "compressor model")
-        # Check if already a domain compressor model
+        # Check if already a domain compressor model, and clone it to ensure no state is shared
         if isinstance(model, CompressorModel):
-            return model
+            return model.clone()
         # Otherwise: check if it is a DTO -> convert to domain model
         if isinstance(model, get_args(CompressorModelTypes)):
             return create_compressor_model(model)

tests/libecalc/core/models/compressor_modelling/conftest.py

@@ -194,19 +194,21 @@ def single_speed_compressor_train_unisim_methane(
     )
 
     fluid_factory = NeqSimFluidFactory(FluidModel(composition=FluidComposition(methane=1.0), eos_model=EoSModel.SRK))
+    stages = [
+        dto.CompressorStage(
+            compressor_chart=chart,
+            inlet_temperature_kelvin=293.15,  # 20 C.
+            pressure_drop_before_stage=0,
+            remove_liquid_after_cooling=True,
+            control_margin=0,
+        )
+    ]
+    stages_mapped = [map_compressor_train_stage_to_domain(stage_dto) for stage_dto in stages]
     return SingleSpeedCompressorTrainCommonShaft(
         fluid_factory=fluid_factory,
         energy_usage_adjustment_constant=0,
         energy_usage_adjustment_factor=1,
-        stages=[
-            dto.CompressorStage(
-                compressor_chart=chart,
-                inlet_temperature_kelvin=293.15,  # 20 C.
-                pressure_drop_before_stage=0,
-                remove_liquid_after_cooling=True,
-                control_margin=0,
-            )
-        ],
+        stages=stages_mapped,
         pressure_control=libecalc.common.fixed_speed_pressure_control.FixedSpeedPressureControl.DOWNSTREAM_CHOKE,
         calculate_max_rate=False,
     )

tests/libecalc/core/models/compressor_modelling/test_single_speed_compressor_train_common_shaft.py

@@ -7,6 +7,7 @@
 )
 from libecalc.domain.process.compressor.core.train.stage import CompressorTrainStage
 from libecalc.domain.process.compressor.core.train.train_evaluation_input import CompressorTrainEvaluationInput
+from libecalc.domain.process.compressor.core.utils import map_compressor_train_stage_to_domain
 from libecalc.domain.process.core.results.compressor import CompressorTrainCommonShaftFailureStatus
 from libecalc.domain.process.value_objects.chart.chart_area_flag import ChartAreaFlag
 from libecalc.domain.process.value_objects.fluid_stream.fluid_model import FluidModel
@@ -52,12 +53,12 @@ def create_single_speed_compressor_train(
         if stages is None:
             stages = single_speed_stages
         fluid_factory = NeqSimFluidFactory(fluid_model)
-
+        stages_mapped = [map_compressor_train_stage_to_domain(stage_dto) for stage_dto in stages]
         return SingleSpeedCompressorTrainCommonShaft(
             fluid_factory=fluid_factory,
             energy_usage_adjustment_constant=energy_usage_adjustment_constant,
             energy_usage_adjustment_factor=energy_usage_adjustment_factor,
-            stages=stages,
+            stages=stages_mapped,
             pressure_control=pressure_control,
             calculate_max_rate=calculate_max_rate,
             maximum_power=maximum_power,

tests/libecalc/dto/test_energy_model.py

@@ -16,6 +16,7 @@
 from libecalc.domain.process.compressor.core.train.single_speed_compressor_train_common_shaft import (
     SingleSpeedCompressorTrainCommonShaft,
 )
+from libecalc.domain.process.compressor.core.utils import map_compressor_train_stage_to_domain
 from libecalc.domain.process.value_objects.chart.generic import GenericChartFromDesignPoint, GenericChartFromInput
 from libecalc.domain.process.value_objects.fluid_stream.fluid_model import EoSModel, FluidComposition, FluidModel
 from libecalc.infrastructure.neqsim_fluid_provider.neqsim_fluid_factory import NeqSimFluidFactory
@@ -240,22 +241,24 @@ def test_valid_train_known_stages(self):
         fluid_factory = NeqSimFluidFactory(
             fluid_model=FluidModel(eos_model=EoSModel.PR, composition=FluidComposition(methane=1))
         )
+        stages = [
+            dto.CompressorStage(
+                compressor_chart=SingleSpeedChartDTO(
+                    speed_rpm=1,
+                    rate_actual_m3_hour=[1, 2],
+                    polytropic_head_joule_per_kg=[3, 4],
+                    efficiency_fraction=[0.5, 0.5],
+                ),
+                inlet_temperature_kelvin=300,
+                pressure_drop_before_stage=0,
+                remove_liquid_after_cooling=True,
+                control_margin=0.0,
+            )
+        ]
+        stages_mapped = [map_compressor_train_stage_to_domain(stage_dto) for stage_dto in stages]
         SingleSpeedCompressorTrainCommonShaft(
             fluid_factory=fluid_factory,
-            stages=[
-                dto.CompressorStage(
-                    compressor_chart=SingleSpeedChartDTO(
-                        speed_rpm=1,
-                        rate_actual_m3_hour=[1, 2],
-                        polytropic_head_joule_per_kg=[3, 4],
-                        efficiency_fraction=[0.5, 0.5],
-                    ),
-                    inlet_temperature_kelvin=300,
-                    pressure_drop_before_stage=0,
-                    remove_liquid_after_cooling=True,
-                    control_margin=0.0,
-                )
-            ],
+            stages=stages_mapped,
             energy_usage_adjustment_factor=1,
             energy_usage_adjustment_constant=0,
             pressure_control=libecalc.common.fixed_speed_pressure_control.FixedSpeedPressureControl.DOWNSTREAM_CHOKE,
@@ -266,18 +269,20 @@ def test_invalid_chart(self):
         fluid_factory = NeqSimFluidFactory(
             fluid_model=FluidModel(eos_model=EoSModel.PR, composition=FluidComposition(methane=1))
         )
+        stages = [
+            dto.CompressorStage(
+                compressor_chart=VariableSpeedChartDTO(curves=[]),
+                inlet_temperature_kelvin=300,
+                pressure_drop_before_stage=0,
+                remove_liquid_after_cooling=True,
+                control_margin=0.0,
+            )
+        ]
+        stages_mapped = [map_compressor_train_stage_to_domain(stage_dto) for stage_dto in stages]
         with pytest.raises(ProcessChartTypeValidationException):
             SingleSpeedCompressorTrainCommonShaft(
                 fluid_factory=fluid_factory,
-                stages=[
-                    dto.CompressorStage(
-                        compressor_chart=VariableSpeedChartDTO(curves=[]),
-                        inlet_temperature_kelvin=300,
-                        pressure_drop_before_stage=0,
-                        remove_liquid_after_cooling=True,
-                        control_margin=0.0,
-                    )
-                ],
+                stages=stages_mapped,
                 energy_usage_adjustment_factor=1,
                 energy_usage_adjustment_constant=0,
                 pressure_control=libecalc.common.fixed_speed_pressure_control.FixedSpeedPressureControl.DOWNSTREAM_CHOKE,