chore: init parallel system yaml

Author: jsolaas

src/libecalc/presentation/yaml/yaml_types/components/yaml_process_system.py

@@ -0,0 +1,112 @@
+from typing import Annotated, Literal, TypeAlias
+
+from pydantic import AfterValidator, Field
+
+from libecalc.presentation.yaml.yaml_types import YamlBase
+from libecalc.presentation.yaml.yaml_types.components.yaml_expression_type import YamlExpressionType
+from libecalc.presentation.yaml.yaml_types.models.model_reference_validation import check_field_model_reference
+from libecalc.presentation.yaml.yaml_types.models.yaml_compressor_chart import UnitsField, YamlCurve, YamlUnits
+from libecalc.presentation.yaml.yaml_types.models.yaml_compressor_stages import YamlControlMarginUnits
+from libecalc.presentation.yaml.yaml_types.yaml_data_or_file import DataOrFile
+from libecalc.presentation.yaml.yaml_validation_context import ModelName
+
+StreamRef = str
+
+
+class YamlControlMargin(YamlBase):
+    unit: YamlControlMarginUnits
+    value: float
+
+
+class YamlCompressorChart(YamlBase):
+    name: ModelName = Field(
+        ...,
+        description="Name of the model. See documentation for more information.",
+        title="NAME",
+    )
+    type: Literal["COMPRESSOR_CHART@v2"] = Field(
+        ...,
+        description="Defines the type of model. See documentation for more information.",
+        title="TYPE",
+    )
+    curves: DataOrFile[list[YamlCurve]] = Field(
+        ..., description="Compressor chart curves, one per speed.", title="CURVES"
+    )
+    units: YamlUnits = UnitsField()
+    control_margin: YamlControlMargin
+
+
+CompressorChartReference = Annotated[
+    ModelName,
+    AfterValidator(
+        check_field_model_reference(
+            allowed_types=[
+                "COMPRESSOR_CHART@v2",
+            ]
+        )
+    ),
+]
+
+CompressorStageReference = str  # TODO: validate correct reference
+
+ProcessSystemReference: TypeAlias = str  # TODO: validate correct reference
+ProcessSystemDefinition: TypeAlias = "YamlCompressorStageProcessSystem" | "YamlSerialParallelProcessSystem"
+ProcessSystemReferenceOrDefinition = ProcessSystemReference | ProcessSystemDefinition
+
+
+class YamlCompressorStageProcessSystem(YamlBase):
+    type: Literal["COMPRESSOR_STAGE"]
+    name: ProcessSystemReferenceOrDefinition
+    inlet_temperature: float = Field(
+        ...,
+        description="Inlet temperature in Celsius for stage",
+        title="INLET_TEMPERATURE",
+    )
+    pressure_drop_ahead_of_stage: float = Field(
+        0.0,
+        description="Pressure drop before compression stage [in bar]",
+        title="PRESSURE_DROP_AHEAD_OF_STAGE",
+    )
+    compressor_chart: CompressorChartReference
+
+
+class YamlItem(YamlBase):
+    target: ProcessSystemReferenceOrDefinition
+
+
+class YamlSerialParallelProcessSystem(YamlBase):
+    type: Literal["SERIAL", "PARALLEL"]
+    name: ProcessSystemReferenceOrDefinition
+    items: list[YamlItem]
+
+
+class YamlOverflow(YamlBase):
+    FROM: CompressorStageReference
+    TO: CompressorStageReference
+
+
+class YamlCommonStreamSetting(YamlBase):
+    rate_fractions: list[YamlExpressionType]
+    overflow: list[YamlOverflow]
+
+
+class YamlCommonStreamDistribution(YamlBase):
+    method: Literal["COMMON_STREAM"]
+    inlet_stream: StreamRef
+    settings: list[YamlCommonStreamSetting]
+
+
+class YamlIndividualStreamDistribution(YamlBase):
+    method: Literal["INDIVIDUAL_STREAMS"]
+    inlet_streams: list[StreamRef]
+
+
+YamlStreamDistribution = Annotated[
+    YamlCommonStreamDistribution | YamlIndividualStreamDistribution, Field(discriminator="method")
+]
+
+
+class YamlProcessSimulation(YamlBase):
+    name: str
+    target: ProcessSystemReferenceOrDefinition
+    stream_distribution: YamlStreamDistribution