refactor: rename variables to include units

Author: kjbrak

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

@@ -134,15 +134,15 @@ def mass_rate_kg_per_hour(self) -> float:
         if self.inlet_stream is None:
             return 0.0
         else:
-            return self.inlet_stream.mass_rate
+            return self.inlet_stream.mass_rate_kg_per_h
 
     @property
     def mass_rate_asv_corrected_kg_per_hour(self) -> float:
         """Mass rate in kg/hour, corrected for ASV."""
         if self.inlet_stream_including_asv is None:
             return 0.0
         else:
-            return self.inlet_stream_including_asv.mass_rate
+            return self.inlet_stream_including_asv.mass_rate_kg_per_h
 
     @property
     def is_valid(self) -> bool:

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

@@ -163,7 +163,7 @@ def evaluate_given_constraints(
             temperature_kelvin=self.stages[0].inlet_temperature_kelvin,
             standard_rate_m3_per_day=constraints.rate,
         )
-        if inlet_stream.mass_rate > 0:
+        if inlet_stream.mass_rate_kg_per_h > 0:
             compressor_stages_result = []
             for stage in self.stages:
                 compressor_stage_result = self.calculate_compressor_stage_work_given_outlet_pressure(
@@ -206,7 +206,7 @@ def calculate_compressor_stage_work_given_outlet_pressure(
         )
 
         # To avoid passing empty arrays down to the enthalpy calculation.
-        if inlet_stream.mass_rate > 0:
+        if inlet_stream.mass_rate_kg_per_h > 0:
             polytropic_enthalpy_change_joule_per_kg, polytropic_efficiency = calculate_enthalpy_change_head_iteration(
                 inlet_streams=inlet_stream,
                 outlet_pressure=outlet_pressure,
@@ -234,7 +234,7 @@ def calculate_compressor_stage_work_given_outlet_pressure(
             else:
                 polytropic_enthalpy_change_to_use_joule_per_kg = polytropic_enthalpy_change_joule_per_kg
                 asv_corrected_actual_rate_m3_per_hour = inlet_stream.volumetric_rate
-                mass_rate_to_use_kg_per_hour = inlet_stream.mass_rate
+                mass_rate_to_use_kg_per_hour = inlet_stream.mass_rate_kg_per_h
                 rate_has_recirc = False
                 pressure_is_choked = False
                 rate_exceeds_maximum = False
@@ -246,7 +246,7 @@ def calculate_compressor_stage_work_given_outlet_pressure(
             polytropic_enthalpy_change_joule_per_kg = 0.0
             polytropic_efficiency = np.nan
             asv_corrected_actual_rate_m3_per_hour = inlet_stream.volumetric_rate
-            mass_rate_to_use_kg_per_hour = inlet_stream.mass_rate
+            mass_rate_to_use_kg_per_hour = inlet_stream.mass_rate_kg_per_h
             rate_has_recirc = False
             pressure_is_choked = False
             rate_exceeds_maximum = False
@@ -255,7 +255,7 @@ def calculate_compressor_stage_work_given_outlet_pressure(
 
         outlet_stream = inlet_stream.create_stream_with_new_pressure_and_enthalpy_change(
             pressure_bara=outlet_pressure,
-            enthalpy_change=polytropic_enthalpy_change_to_use_joule_per_kg,  # type: ignore[arg-type]
+            enthalpy_change_joule_per_kg=polytropic_enthalpy_change_to_use_joule_per_kg,  # type: ignore[arg-type]
         )
 
         power_mw = (
@@ -290,11 +290,11 @@ def calculate_compressor_stage_work_given_outlet_pressure(
             outlet_stream=outlet_stream,
             inlet_stream_including_asv=FluidStream(
                 thermo_system=inlet_stream.thermo_system,
-                mass_rate=mass_rate_to_use_kg_per_hour,
+                mass_rate_kg_per_h=mass_rate_to_use_kg_per_hour,
             ),
             outlet_stream_including_asv=FluidStream(
                 thermo_system=outlet_stream.thermo_system,
-                mass_rate=mass_rate_to_use_kg_per_hour,
+                mass_rate_kg_per_h=mass_rate_to_use_kg_per_hour,
             ),
             power_megawatt=power_mw,  # type: ignore[arg-type]
             chart_area_flag=chart_area_flag,
@@ -460,7 +460,7 @@ def calculate_maximum_rate_for_stage(
             enthalpy_change_joule_per_kg = polytropic_head / polytropic_efficiency
 
             outlet_stream = inlet_stream.create_stream_with_new_pressure_and_enthalpy_change(
-                pressure_bara=outlet_pressure, enthalpy_change=enthalpy_change_joule_per_kg
+                pressure_bara=outlet_pressure, enthalpy_change_joule_per_kg=enthalpy_change_joule_per_kg
             )
 
             # Set convergence criterion on actual volume rate

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

@@ -165,11 +165,11 @@ def evaluate(
         )
         inlet_stream_compressor_asv_corrected = FluidStream(
             thermo_system=inlet_stream_compressor.thermo_system,
-            mass_rate=mass_rate_asv_corrected_kg_per_hour,
+            mass_rate_kg_per_h=mass_rate_asv_corrected_kg_per_hour,
         )
         power_megawatt = calculate_power_in_megawatt(
             enthalpy_change_joule_per_kg=enthalpy_change_J_per_kg,
-            mass_rate_kg_per_hour=inlet_stream_compressor_asv_corrected.mass_rate,
+            mass_rate_kg_per_hour=inlet_stream_compressor_asv_corrected.mass_rate_kg_per_h,
         )
 
         (
@@ -187,7 +187,7 @@ def evaluate(
             inlet_stream_including_asv=inlet_stream_compressor_asv_corrected,
             outlet_stream_including_asv=FluidStream(
                 thermo_system=outlet_stream.thermo_system,
-                mass_rate=inlet_stream_compressor_asv_corrected.mass_rate,
+                mass_rate_kg_per_h=inlet_stream_compressor_asv_corrected.mass_rate_kg_per_h,
             ),
             polytropic_head_kJ_per_kg=polytropic_head_J_per_kg / 1000,
             polytropic_efficiency=polytropic_efficiency,
@@ -246,7 +246,9 @@ def evaluate_given_speed_and_target_discharge_pressure(
         )
 
         max_recirculation = max(
-            maximum_rate * result_no_recirculation.inlet_stream.density - inlet_stream_stage.mass_rate - EPSILON,
+            maximum_rate * result_no_recirculation.inlet_stream.density
+            - inlet_stream_stage.mass_rate_kg_per_h
+            - EPSILON,
             0,
         )
         result_max_recirculation = self.evaluate(

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

@@ -110,7 +110,7 @@ def calculate_outlet_pressure_and_stream(
 
     outlet_stream_compressor_current_iteration = inlet_stream.create_stream_with_new_pressure_and_enthalpy_change(
         pressure_bara=float(outlet_pressure_this_stage_bara_based_on_inlet_z_and_kappa),
-        enthalpy_change=polytropic_head_joule_per_kg / polytropic_efficiency,
+        enthalpy_change_joule_per_kg=polytropic_head_joule_per_kg / polytropic_efficiency,
     )
 
     outlet_pressure_this_stage_bara = outlet_pressure_this_stage_bara_based_on_inlet_z_and_kappa * 0.95
@@ -140,7 +140,7 @@ def calculate_outlet_pressure_and_stream(
 
         outlet_stream_compressor_current_iteration = inlet_stream.create_stream_with_new_pressure_and_enthalpy_change(
             pressure_bara=outlet_pressure_this_stage_bara,
-            enthalpy_change=polytropic_head_joule_per_kg / polytropic_efficiency,
+            enthalpy_change_joule_per_kg=polytropic_head_joule_per_kg / polytropic_efficiency,
         )
 
         diff = abs(outlet_pressure_previous - outlet_pressure_this_stage_bara) / outlet_pressure_this_stage_bara

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

@@ -97,7 +97,7 @@ def calculate_enthalpy_change_head_iteration(
         # Update outlet streams
         outlet_streams = [
             stream.create_stream_with_new_pressure_and_enthalpy_change(
-                pressure_bara=pressure, enthalpy_change=enthalpy_change
+                pressure_bara=pressure, enthalpy_change_joule_per_kg=enthalpy_change
             )
             for stream, pressure, enthalpy_change in zip(inlet_streams, outlet_pressure, enthalpy_change_joule_per_kg)
         ]

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

@@ -434,7 +434,8 @@ def calculate_compressor_train(
                 else:
                     stage_inlet_stream = stage_inlet_stream.from_standard_rate(
                         thermo_system=stage_inlet_stream.thermo_system,
-                        standard_rate=stage_inlet_stream.standard_rate - constraints.stream_rates[stream_number],
+                        standard_rate_m3_per_day=stage_inlet_stream.standard_rate
+                        - constraints.stream_rates[stream_number],
                     )
             for stream_number in self.inlet_stream_connected_to_stage.get(stage_number):
                 if stream_number > 0:
@@ -706,7 +707,7 @@ def set_fluid_to_recirculate_in_stage_when_inlet_rate_is_zero(
         if fluid_stream is not None:
             self.fluid_to_recirculate_in_stage_when_inlet_rate_is_zero[stage_number] = FluidStream(
                 thermo_system=fluid_stream.thermo_system,
-                mass_rate=EPSILON,
+                mass_rate_kg_per_h=EPSILON,
             )
 
     def get_fluid_to_recirculate_in_stage_when_inlet_rate_is_zero(self, stage_number: int) -> FluidStream:

src/libecalc/domain/process/value_objects/fluid_stream/fluid_stream.py

@@ -20,12 +20,12 @@ class FluidStream:
     """
 
     thermo_system: ThermoSystemInterface
-    mass_rate: float
+    mass_rate_kg_per_h: float
 
     def __post_init__(self):
         """Validate stream properties"""
-        if self.mass_rate < 0:
-            raise NegativeMassRateException(self.mass_rate)
+        if self.mass_rate_kg_per_h < 0:
+            raise NegativeMassRateException(self.mass_rate_kg_per_h)
 
     @property
     def conditions(self) -> ProcessConditions:
@@ -80,12 +80,12 @@ def vapor_fraction_molar(self) -> float:
     @cached_property
     def volumetric_rate(self) -> float:
         """Calculate volumetric flow rate [m³/h]."""
-        return self.mass_rate / self.density
+        return self.mass_rate_kg_per_h / self.density
 
     @cached_property
     def standard_rate(self) -> float:
         """Calculate standard volumetric flow rate [Sm³/day]."""
-        return self.mass_rate / self.standard_density_gas_phase_after_flash * UnitConstants.HOURS_PER_DAY
+        return self.mass_rate_kg_per_h / self.standard_density_gas_phase_after_flash * UnitConstants.HOURS_PER_DAY
 
     def create_stream_with_new_conditions(
         self, conditions: ProcessConditions, remove_liquid: bool = False
@@ -107,11 +107,11 @@ def create_stream_with_new_conditions(
         )
         return FluidStream(
             thermo_system=new_state,
-            mass_rate=self.mass_rate,
+            mass_rate_kg_per_h=self.mass_rate_kg_per_h,
         )
 
     def create_stream_with_new_pressure_and_enthalpy_change(
-        self, pressure_bara: float, enthalpy_change: float, remove_liquid: bool = False
+        self, pressure_bara: float, enthalpy_change_joule_per_kg: float, remove_liquid: bool = False
     ) -> FluidStream:
         """Create a new stream with modified pressure and changed enthalpy.
         This performs a PH-flash on the fluid.
@@ -127,17 +127,17 @@ def create_stream_with_new_pressure_and_enthalpy_change(
         """
         new_state = self.thermo_system.flash_to_pressure_and_enthalpy_change(
             pressure_bara=pressure_bara,
-            enthalpy_change=enthalpy_change,
+            enthalpy_change=enthalpy_change_joule_per_kg,
             remove_liquid=remove_liquid,
         )
 
         return FluidStream(
             thermo_system=new_state,
-            mass_rate=self.mass_rate,
+            mass_rate_kg_per_h=self.mass_rate_kg_per_h,
         )
 
     @classmethod
-    def from_standard_rate(cls, standard_rate: float, thermo_system: ThermoSystemInterface) -> FluidStream:
+    def from_standard_rate(cls, standard_rate_m3_per_day: float, thermo_system: ThermoSystemInterface) -> FluidStream:
         """Create a stream from standard volumetric flow rate.
 
         This allows creating a stream based on standard volumetric flow rate instead of mass rate.
@@ -153,6 +153,6 @@ def from_standard_rate(cls, standard_rate: float, thermo_system: ThermoSystemInt
         """
         # Calculate mass rate from standard rate
         standard_density = thermo_system.standard_density_gas_phase_after_flash
-        mass_rate = standard_rate * standard_density / UnitConstants.HOURS_PER_DAY
+        mass_rate_kg_per_h = standard_rate_m3_per_day * standard_density / UnitConstants.HOURS_PER_DAY
 
-        return cls(thermo_system=thermo_system, mass_rate=mass_rate)
+        return cls(thermo_system=thermo_system, mass_rate_kg_per_h=mass_rate_kg_per_h)

src/libecalc/domain/process/value_objects/fluid_stream/mixing.py

@@ -58,12 +58,12 @@ def mix_streams(self, streams: list[FluidStream]) -> FluidStream:
         if not streams:
             raise EmptyStreamListException()
 
-        total_mass_rate = sum(s.mass_rate for s in streams)
+        total_mass_rate = sum(s.mass_rate_kg_per_h for s in streams)
         if total_mass_rate == 0:
             raise ZeroTotalMassRateException()
 
         # Calculate mass-weighted average temperature
-        temperature_mix = sum(s.mass_rate * s.temperature_kelvin for s in streams) / total_mass_rate
+        temperature_mix = sum(s.mass_rate_kg_per_h * s.temperature_kelvin for s in streams) / total_mass_rate
 
         # Lowest pressure among all streams
         reference_pressure = min(s.pressure_bara for s in streams)
@@ -82,7 +82,7 @@ def mix_streams(self, streams: list[FluidStream]) -> FluidStream:
                 raise IncompatibleEoSModelsException(reference_eos_model, s.thermo_system.eos_model)
 
         # Compute total molar flow for each stream
-        stream_total_molar_rates = [s.mass_rate / s.molar_mass for s in streams]
+        stream_total_molar_rates = [s.mass_rate_kg_per_h / s.molar_mass for s in streams]
         mix_total_molar_rate = sum(stream_total_molar_rates)
 
         # Sum molar flow of each component across all streams
@@ -117,5 +117,5 @@ def mix_streams(self, streams: list[FluidStream]) -> FluidStream:
         # Create a new stream with calculated properties
         return FluidStream(
             thermo_system=thermo_system_mix,
-            mass_rate=total_mass_rate,
+            mass_rate_kg_per_h=total_mass_rate,
         )

src/libecalc/infrastructure/neqsim_fluid_provider/neqsim_fluid_factory.py

@@ -72,7 +72,7 @@ def create_stream_from_standard_rate(
             temperature_kelvin=temperature_kelvin,
         )
         return FluidStream.from_standard_rate(
-            standard_rate=standard_rate_m3_per_day,
+            standard_rate_m3_per_day=standard_rate_m3_per_day,
             thermo_system=thermo_system,
         )
 
@@ -95,7 +95,7 @@ def create_stream_from_mass_rate(
         )
         return FluidStream(
             thermo_system=thermo_system,
-            mass_rate=mass_rate_kg_per_h,
+            mass_rate_kg_per_h=mass_rate_kg_per_h,
         )
 
     def standard_rate_to_mass_rate(

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

@@ -266,7 +266,7 @@ def test_fluid_streams(unisim_test_data):
     outlet_streams_enthalpy = [
         s.create_stream_with_new_pressure_and_enthalpy_change(
             pressure_bara=unisim_test_data.output_stream_data.pressures[index],
-            enthalpy_change=compressor_data_enthalpy_change_joule_per_kg[index],
+            enthalpy_change_joule_per_kg=compressor_data_enthalpy_change_joule_per_kg[index],
         )
         for index, s in enumerate(inlet_streams)
     ]