Define 'Heat to Power Conversion Efficiency' as a separate output that is calculated in _calculate_derived_outputs.

Author: softwareengineerprogrammer

src/geophires_x/Outputs.py

@@ -1912,12 +1912,10 @@ def PrintOutputs(self, model: Model):
 
                 f.write(f'      Average Pumping Power:                            {np.average(model.wellbores.PumpingPower.value):10.2f} {model.wellbores.PumpingPower.CurrentUnits.value}{NL}')
 
-                if model.surfaceplant.FirstLawEfficiency is not None:
-                    avg_efficiency = np.average(model.surfaceplant.FirstLawEfficiency.value) * 100
-                    first_law_efficiency_output_name = 'Heat to power conversion efficiency'
-                    if avg_efficiency > 0:  # 0 is presumed to mean N/A
-                        f.write(
-                        f'      {Outputs._field_label(first_law_efficiency_output_name, 50)}{avg_efficiency:10.2f} {model.surfaceplant.FirstLawEfficiency.CurrentUnits.value}\n')
+                if model.surfaceplant.heat_to_power_conversion_efficiency.value is not None:
+                    hpce = model.surfaceplant.heat_to_power_conversion_efficiency
+                    f.write(f'      {Outputs._field_label(hpce.Name, 50)}'
+                            f'{hpce.value:10.2f} {model.surfaceplant.heat_to_power_conversion_efficiency.CurrentUnits.value}\n')
 
                 f.write(NL)
                 f.write('                            ************************************************************\n')

src/geophires_x/SurfacePlant.py

@@ -487,7 +487,14 @@ def __init__(self, model: Model):
             UnitType=Units.PERCENT,
             PreferredUnits=PercentUnit.PERCENT,
             CurrentUnits=PercentUnit.PERCENT,
-            ToolTipText='Heat to power conversion efficiency'
+            ToolTipText='Net electricity produced divided by heat extracted towards electricity'
+        )
+        self.heat_to_power_conversion_efficiency = self.OutputParameterDict[self.heat_to_power_conversion_efficiency.Name] = OutputParameter(
+            Name='Heat to Power Conversion Efficiency',
+            UnitType=Units.PERCENT,
+            PreferredUnits=PercentUnit.PERCENT,
+            CurrentUnits=PercentUnit.PERCENT,
+            ToolTipText='First law efficiency average over project lifetime'
         )
         self.HeatExtracted = self.OutputParameterDict[self.HeatExtracted.Name] = OutputParameter(
             Name="Heat Extracted",
@@ -637,4 +644,18 @@ def Calculate(self, model: Model) -> None:
 
         # All calculations are handled in subclasses of this class, so this function is empty.
 
+        # Subclasses should call _calculate_derived_outputs at the end of their Calculate methods.
+        self._calculate_derived_outputs(model)
+
         model.logger.info(f'Complete {self.__class__.__name__}: {__name__}')
+
+    def _calculate_derived_outputs(self, model: Model) -> None:
+        """
+        Subclasses should call _calculate_derived_outputs at the end of their Calculate methods to populate output
+        values that are derived from subclass-calculated outputs.
+        """
+
+        if self.FirstLawEfficiency is not None:
+            avg_efficiency = np.average(model.surfaceplant.FirstLawEfficiency.value) * 100  # TODO proper unit conversion
+            if avg_efficiency > 0:  # 0 is presumed to mean N/A
+                self.heat_to_power_conversion_efficiency.value = avg_efficiency

src/geophires_x/SurfacePlantAGS.py

@@ -783,4 +783,5 @@ def Calculate(self, model: Model) -> None:
             print(f'Error: {class_file_info_msg}. Exiting....')
             raise RuntimeError(base_msg)
 
+        self._calculate_derived_outputs(model)
         model.logger.info(f"complete {str(__class__)}: {sys._getframe().f_code.co_name}")

src/geophires_x/SurfacePlantAbsorptionChiller.py

@@ -141,4 +141,6 @@ def Calculate(self, model: Model) -> None:
         # calculate reservoir heat content
         self.RemainingReservoirHeatContent.value = SurfacePlant.remaining_reservoir_heat_content(
             self, model.reserv.InitialReservoirHeatContent.value, self.HeatkWhExtracted.value)
+
+        self._calculate_derived_outputs(model)
         model.logger.info(f"complete {self.__class__.__name__}: {__name__}")

src/geophires_x/SurfacePlantDistrictHeating.py

@@ -249,6 +249,7 @@ def Calculate(self, model: Model) -> None:
         self.RemainingReservoirHeatContent.value = SurfacePlant.remaining_reservoir_heat_content(
             self, model.reserv.InitialReservoirHeatContent.value, self.HeatkWhExtracted.value)
 
+        self._calculate_derived_outputs(model)
         model.logger.info(f"Complete {self.__class__.__name__}: {__name__}")
 
     # district heating routines below

src/geophires_x/SurfacePlantDoubleFlash.py

@@ -133,4 +133,5 @@ def Calculate(self, model: Model) -> None:
         self.RemainingReservoirHeatContent.value = SurfacePlant.remaining_reservoir_heat_content(
             self, model.reserv.InitialReservoirHeatContent.value, self.HeatkWhExtracted.value)
 
+        self._calculate_derived_outputs(model)
         model.logger.info(f'complete {self.__class__.__name__}: {__name__}')

src/geophires_x/SurfacePlantHeatPump.py

@@ -131,4 +131,5 @@ def Calculate(self, model: Model) -> None:
         self.RemainingReservoirHeatContent.value = SurfacePlant.remaining_reservoir_heat_content(
             self, model.reserv.InitialReservoirHeatContent.value, self.HeatkWhExtracted.value)
 
-        model.logger.info("complete " + str(__class__) + ": " + inspect.currentframe().f_code.co_name)
+        self._calculate_derived_outputs(model)
+        model.logger.info(f"complete {str(__class__)}: {inspect.currentframe().f_code.co_name}")

src/geophires_x/SurfacePlantIndustrialHeat.py

@@ -98,4 +98,5 @@ def Calculate(self, model: Model) -> None:
         self.RemainingReservoirHeatContent.value = SurfacePlant.remaining_reservoir_heat_content(
             self, model.reserv.InitialReservoirHeatContent.value, self.HeatkWhExtracted.value)
 
-        model.logger.info("complete " + self.__class__.__name__ + ": " + __name__)
+        self._calculate_derived_outputs(model)
+        model.logger.info(f"complete {self.__class__.__name__}: {__name__}")

src/geophires_x/SurfacePlantSUTRA.py

@@ -204,5 +204,6 @@ def Calculate(self, model: Model) -> None:
         # calculate maximum auxiliary boiler demand
         self.max_peaking_boiler_demand.value = max(self.AnnualAuxiliaryHeatProduced.value)
 
+        self._calculate_derived_outputs(model)
         model.logger.info(f"complete {self.__class__.__name__}: {self.__init__.__name__}")
 

src/geophires_x/SurfacePlantSingleFlash.py

@@ -133,4 +133,5 @@ def Calculate(self, model: Model) -> None:
         self.RemainingReservoirHeatContent.value = SurfacePlant.remaining_reservoir_heat_content(
             self, model.reserv.InitialReservoirHeatContent.value, self.HeatkWhExtracted.value)
 
-        model.logger.info("complete " + str(__class__) + ": " + sys._getframe().f_code.co_name)
+        self._calculate_derived_outputs(model)
+        model.logger.info(f"complete {str(__class__)}: {sys._getframe().f_code.co_name}")