refactor: parse and validate compressor models when used

This makes it possible to provide more context when validating, or more
context for generating compressor charts and stages for simplified
models.

This has the side-effect of only validating used models, while ignoring
others. Yaml-validation will still happen for all.

Author: jsolaas

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

@@ -1,2 +1 @@
 from .base import CompressorModel
-from .factory import create_compressor_model

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

@@ -99,9 +99,9 @@ def get_consumption_type(self) -> ConsumptionType:
     def evaluate(
         self,
     ) -> CompressorTrainResult:
-        return self.evaluate_turbine_based_on_compressor_model_result(
-            compressor_energy_function_result=self.compressor_model.evaluate()
-        )
+        compressor_model_result = self.compressor_model.evaluate()
+        turbine_result = self.evaluate_turbine_based_on_compressor_model_result(compressor_model_result)
+        return turbine_result
 
     def evaluate_turbine_based_on_compressor_model_result(
         self, compressor_energy_function_result: CompressorTrainResult

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

@@ -1,9 +1,3 @@
-from typing import Any
-
-from libecalc.common.energy_model_type import EnergyModelType
-from libecalc.common.logger import logger
-from libecalc.domain.infrastructure.energy_components.turbine import Turbine
-from libecalc.domain.process.compressor.core.base import CompressorModel, CompressorWithTurbineModel
 from libecalc.domain.process.compressor.core.sampled import CompressorModelSampled
 from libecalc.domain.process.compressor.core.train.simplified_train import (
     CompressorTrainSimplifiedKnownStages,
@@ -24,12 +18,10 @@
     CompressorSampled,
     CompressorTrainSimplifiedWithKnownStages,
     CompressorTrainSimplifiedWithUnknownStages,
-    CompressorWithTurbine,
     SingleSpeedCompressorTrain,
     VariableSpeedCompressorTrain,
     VariableSpeedCompressorTrainMultipleStreamsAndPressures,
 )
-from libecalc.domain.process.compressor.dto.model_types import CompressorModelTypes as CompressorModelDTO
 from libecalc.domain.process.value_objects.fluid_stream.fluid_factory import FluidFactoryInterface
 from libecalc.domain.process.value_objects.fluid_stream.fluid_model import FluidModel
 from libecalc.domain.process.value_objects.fluid_stream.multiple_streams_stream import (
@@ -78,27 +70,6 @@ def _create_compressor_train_simplified_with_known_stages(
     )
 
 
-def _create_turbine(turbine_dto: Turbine) -> Turbine:
-    return Turbine(
-        loads=turbine_dto.loads,
-        lower_heating_value=turbine_dto.lower_heating_value,
-        efficiency_fractions=turbine_dto.efficiency_fractions,
-        energy_usage_adjustment_constant=turbine_dto._energy_usage_adjustment_constant,
-        energy_usage_adjustment_factor=turbine_dto._energy_usage_adjustment_factor,
-    )
-
-
-def _create_compressor_with_turbine(
-    compressor_model_dto: CompressorWithTurbine,
-) -> CompressorWithTurbineModel:
-    return CompressorWithTurbineModel(
-        energy_usage_adjustment_constant=compressor_model_dto.energy_usage_adjustment_constant,
-        energy_usage_adjustment_factor=compressor_model_dto.energy_usage_adjustment_factor,
-        compressor_energy_function=create_compressor_model(compressor_model_dto.compressor_train),
-        turbine_model=_create_turbine(compressor_model_dto.turbine),
-    )
-
-
 def _create_single_speed_compressor_train(
     compressor_model_dto: SingleSpeedCompressorTrain,
 ) -> SingleSpeedCompressorTrainCommonShaft:
@@ -205,32 +176,3 @@ def _create_compressor_sampled(compressor_model_dto: CompressorSampled) -> Compr
         discharge_pressure_values=compressor_model_dto.discharge_pressure_values,
         power_interpolation_values=compressor_model_dto.power_interpolation_values,
     )
-
-
-facility_model_map = {
-    EnergyModelType.COMPRESSOR_SAMPLED: _create_compressor_sampled,
-    EnergyModelType.COMPRESSOR_TRAIN_SIMPLIFIED_WITH_KNOWN_STAGES: _create_compressor_train_simplified_with_known_stages,
-    EnergyModelType.COMPRESSOR_TRAIN_SIMPLIFIED_WITH_UNKNOWN_STAGES: _create_compressor_train_simplified_with_unknown_stages,
-    EnergyModelType.VARIABLE_SPEED_COMPRESSOR_TRAIN_COMMON_SHAFT: _create_variable_speed_compressor_train,
-    EnergyModelType.VARIABLE_SPEED_COMPRESSOR_TRAIN_MULTIPLE_STREAMS_AND_PRESSURES: _create_variable_speed_compressor_train_multiple_streams_and_pressures,
-    EnergyModelType.SINGLE_SPEED_COMPRESSOR_TRAIN_COMMON_SHAFT: _create_single_speed_compressor_train,
-    EnergyModelType.COMPRESSOR_WITH_TURBINE: _create_compressor_with_turbine,
-    EnergyModelType.TURBINE: _create_turbine,
-}
-
-
-def _invalid_compressor_model_type(compressor_model_dto: Any) -> None:
-    try:
-        msg = f"Unsupported energy model type: {compressor_model_dto.typ}."
-        logger.error(msg)
-        raise TypeError(msg)
-    except AttributeError as e:
-        msg = "Unsupported energy model type."
-        logger.exception(msg)
-        raise TypeError(msg) from e
-
-
-def create_compressor_model(compressor_model_dto: CompressorModelDTO) -> CompressorModel:
-    return facility_model_map.get(compressor_model_dto.typ, _invalid_compressor_model_type)(  # type: ignore[operator]
-        compressor_model_dto=compressor_model_dto,
-    )

src/libecalc/domain/process/compressor/dto/__init__.py

@@ -7,4 +7,3 @@
     VariableSpeedCompressorTrain,
     VariableSpeedCompressorTrainMultipleStreamsAndPressures,
 )
-from .with_turbine import CompressorWithTurbine

src/libecalc/domain/process/compressor/dto/model_types.py

@@ -1,11 +1,25 @@
+import abc
 from collections.abc import Iterable
 from typing import Protocol
 
 from libecalc.domain.infrastructure.energy_components.generator_set import GeneratorSetModel
 from libecalc.domain.infrastructure.energy_components.legacy_consumer.tabulated import TabularEnergyFunction
-from libecalc.domain.process.compressor.core import CompressorModel
 from libecalc.domain.process.pump.pump import PumpModel
 from libecalc.dto import FuelType
+from libecalc.presentation.yaml.mappers.yaml_path import YamlPath
+from libecalc.presentation.yaml.yaml_types.facility_model.yaml_facility_model import YamlCompressorTabularModel
+from libecalc.presentation.yaml.yaml_types.models import (
+    YamlCompressorChart,
+    YamlCompressorWithTurbine,
+    YamlFluidModel,
+    YamlTurbine,
+)
+from libecalc.presentation.yaml.yaml_types.models.yaml_compressor_trains import (
+    YamlSimplifiedVariableSpeedCompressorTrain,
+    YamlSingleSpeedCompressorTrain,
+    YamlVariableSpeedCompressorTrain,
+    YamlVariableSpeedCompressorTrainMultipleStreamsAndPressures,
+)
 
 
 class InvalidReferenceException(Exception):
@@ -17,13 +31,40 @@ def __init__(self, reference_type: str, reference: str, available_references: It
         super().__init__(f"Invalid {reference_type} reference '{reference}'. {available_message}")
 
 
+YamlCompressorModel = (
+    YamlSimplifiedVariableSpeedCompressorTrain
+    | YamlVariableSpeedCompressorTrain
+    | YamlSingleSpeedCompressorTrain
+    | YamlCompressorWithTurbine
+    | YamlVariableSpeedCompressorTrainMultipleStreamsAndPressures
+    | YamlCompressorTabularModel
+)
+
+
 class ReferenceService(Protocol):
+    @abc.abstractmethod
+    def get_yaml_path(self, reference: str) -> YamlPath: ...
+
+    @abc.abstractmethod
+    def get_fluid(self, reference: str) -> YamlFluidModel: ...
+
+    @abc.abstractmethod
+    def get_turbine(self, reference: str) -> YamlTurbine: ...
+
+    @abc.abstractmethod
+    def get_compressor_chart(self, reference: str) -> YamlCompressorChart: ...
+
+    @abc.abstractmethod
     def get_fuel_reference(self, reference: str) -> FuelType: ...
 
+    @abc.abstractmethod
     def get_generator_set_model(self, reference: str) -> GeneratorSetModel: ...
 
-    def get_compressor_model(self, reference: str) -> CompressorModel: ...
+    @abc.abstractmethod
+    def get_compressor_model(self, reference: str) -> YamlCompressorModel: ...
 
+    @abc.abstractmethod
     def get_pump_model(self, reference: str) -> PumpModel: ...
 
+    @abc.abstractmethod
     def get_tabulated_model(self, reference: str) -> TabularEnergyFunction: ...

src/libecalc/domain/process/compressor/dto/with_turbine.py

@@ -31,6 +31,7 @@
 from libecalc.domain.infrastructure.energy_components.installation.installation import InstallationComponent
 from libecalc.domain.infrastructure.path_id import PathID
 from libecalc.domain.regularity import Regularity
+from libecalc.domain.resource import Resources
 from libecalc.dto import FuelType
 from libecalc.expression.expression import InvalidExpressionError
 from libecalc.presentation.yaml.domain.expression_time_series_cable_loss import ExpressionTimeSeriesCableLoss
@@ -181,9 +182,10 @@ def _resolve_fuel(
 
 
 class ConsumerMapper:
-    def __init__(self, references: ReferenceService, target_period: Period):
+    def __init__(self, resources: Resources, references: ReferenceService, target_period: Period):
         self.__references = references
         self._target_period = target_period
+        self._resources = resources
 
     def from_yaml_to_domain(
         self,
@@ -199,6 +201,8 @@ def from_yaml_to_domain(
         default_fuel: str | None = None,
     ) -> Consumer | None:
         energy_usage_model_mapper = ConsumerFunctionMapper(
+            configuration=configuration,
+            resources=self._resources,
             references=self.__references,
             target_period=self._target_period,
             expression_evaluator=expression_evaluator,
@@ -311,10 +315,10 @@ def create_error(
 
 
 class GeneratorSetMapper:
-    def __init__(self, references: ReferenceService, target_period: Period):
+    def __init__(self, resources: Resources, references: ReferenceService, target_period: Period):
         self.__references = references
         self._target_period = target_period
-        self.__consumer_mapper = ConsumerMapper(references=references, target_period=target_period)
+        self.__consumer_mapper = ConsumerMapper(resources=resources, references=references, target_period=target_period)
 
     def from_yaml_to_domain(
         self,
@@ -450,11 +454,13 @@ def create_error(message: str, key: str | None = None) -> ModelValidationError:
 
 
 class InstallationMapper:
-    def __init__(self, references: ReferenceService, target_period: Period):
+    def __init__(self, resources: Resources, references: ReferenceService, target_period: Period):
         self.__references = references
         self._target_period = target_period
-        self.__generator_set_mapper = GeneratorSetMapper(references=references, target_period=target_period)
-        self.__consumer_mapper = ConsumerMapper(references=references, target_period=target_period)
+        self.__generator_set_mapper = GeneratorSetMapper(
+            resources=resources, references=references, target_period=target_period
+        )
+        self.__consumer_mapper = ConsumerMapper(resources=resources, references=references, target_period=target_period)
 
     def from_yaml_venting_emitter_to_domain(
         self,
@@ -675,13 +681,16 @@ def create_error(message: str, key: str | None = None) -> ModelValidationError:
 class EcalcModelMapper:
     def __init__(
         self,
+        resources: Resources,
         references: ReferenceService,
         target_period: Period,
         expression_evaluator: ExpressionEvaluator,
         mapping_context: MappingContext,
     ):
         self.__references = references
-        self.__installation_mapper = InstallationMapper(references=references, target_period=target_period)
+        self.__installation_mapper = InstallationMapper(
+            resources=resources, references=references, target_period=target_period
+        )
         self.__expression_evaluator = expression_evaluator
         self.__mapping_context = mapping_context