define separate end-use option output parameter in preparation to add theoretical basis tooltip text (WIP)

Author: softwareengineerprogrammer

src/geophires_x/OptionList.py

@@ -25,18 +25,22 @@ def __ne__(self, other):
         return str(self) != str(other)
 
 
+_EXTRA_HEAT_SNIPPET = 'Heat sales considered as extra income'
+_EXTRA_ELECTRICITY_SNIPPET = 'Electricity sales considered as extra income'
+
+
 class EndUseOptions(GeophiresInputEnum):
-    ELECTRICITY = 1, "Electricity"
-    HEAT = 2, "Direct-Use Heat"
-    COGENERATION_TOPPING_EXTRA_HEAT = 31, "Cogeneration Topping Cycle, Heat sales considered as extra income"
-    COGENERATION_TOPPING_EXTRA_ELECTRICITY = 32, "Cogeneration Topping Cycle, Electricity sales considered as extra income"
-    COGENERATION_BOTTOMING_EXTRA_HEAT = 41, "Cogeneration Bottoming Cycle, Heat sales considered as extra income"
-    COGENERATION_BOTTOMING_EXTRA_ELECTRICITY = 42, "Cogeneration Bottoming Cycle, Electricity sales considered as extra income"
-    COGENERATION_PARALLEL_EXTRA_HEAT = 51, "Cogeneration Parallel Cycle, Heat sales considered as extra income"
-    COGENERATION_PARALLEL_EXTRA_ELECTRICITY = 52, "Cogeneration Parallel Cycle, Electricity sales considered as extra income"
+    ELECTRICITY = 1, 'Electricity'
+    HEAT = 2, 'Direct-Use Heat'
+    COGENERATION_TOPPING_EXTRA_HEAT = 31, f'Cogeneration Topping Cycle, {_EXTRA_HEAT_SNIPPET}'
+    COGENERATION_TOPPING_EXTRA_ELECTRICITY = 32, f'Cogeneration Topping Cycle, {_EXTRA_ELECTRICITY_SNIPPET}'
+    COGENERATION_BOTTOMING_EXTRA_HEAT = 41, f'Cogeneration Bottoming Cycle, {_EXTRA_HEAT_SNIPPET}'
+    COGENERATION_BOTTOMING_EXTRA_ELECTRICITY = 42, f'Cogeneration Bottoming Cycle, {_EXTRA_ELECTRICITY_SNIPPET}'
+    COGENERATION_PARALLEL_EXTRA_HEAT = 51, f'Cogeneration Parallel Cycle, {_EXTRA_HEAT_SNIPPET}'
+    COGENERATION_PARALLEL_EXTRA_ELECTRICITY = 52, f'Cogeneration Parallel Cycle, {_EXTRA_ELECTRICITY_SNIPPET}'
 
     @staticmethod
-    def from_input_string(input_string: str):
+    def from_input_string(input_string: str) -> 'EndUseOptions':
         """
         :rtype: EndUseOptions
         """
@@ -48,11 +52,17 @@ def from_input_string(input_string: str):
         raise ValueError(f'Unknown End-Use Option input value: {input_string}')
 
     @staticmethod
-    def from_int(int_val):
+    def from_int(int_val: int) -> 'EndUseOptions':
+        """
+        :rtype: EndUseOptions
+        """
+
         for member in __class__:
             if member.int_value == int_val:
                 return member
 
+        raise ValueError(f'Unknown End-Use Option integer input value: {int_val}')
+
 
 class PlantType(GeophiresInputEnum):
     SUB_CRITICAL_ORC = 1, "Subcritical ORC"

src/geophires_x/Outputs.py

@@ -195,7 +195,8 @@ def PrintOutputs(self, model: Model):
                 f.write(NL)
                 f.write('                           ***SUMMARY OF RESULTS***\n')
                 f.write(NL)
-                f.write(f'      End-Use Option: {str(model.surfaceplant.enduse_option.value.value)}\n')
+                f.write(f'      {model.surfaceplant.enduse_option_output.display_name}: '
+                        f'{model.surfaceplant.enduse_option_output.value}\n')
                 if model.surfaceplant.plant_type.value in [PlantType.ABSORPTION_CHILLER, PlantType.HEAT_PUMP, PlantType.DISTRICT_HEATING]:
                     f.write('      Surface Application: ' + str(model.surfaceplant.plant_type.value.value) + NL)
                 if model.surfaceplant.enduse_option.value in [EndUseOptions.ELECTRICITY, EndUseOptions.COGENERATION_TOPPING_EXTRA_HEAT, EndUseOptions.COGENERATION_TOPPING_EXTRA_ELECTRICITY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_ELECTRICITY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_ELECTRICITY]: # there is an electricity component

src/geophires_x/SUTRAOutputs.py

@@ -67,7 +67,8 @@ def PrintOutputs(self, model: Model):
                 f.write(NL)
                 f.write('                           ***SUMMARY OF RESULTS***\n')
                 f.write(NL)
-                f.write("      End-Use Option: " + str(model.surfaceplant.enduse_option.value.value) + NL)
+                f.write(f'      {model.surfaceplant.enduse_option_output.display_name}: '
+                        f'{model.surfaceplant.enduse_option_output.value}\n')
                 f.write("      Reservoir Model = " + str(model.reserv.resoption.value.value) + " Model\n")
                 f.write(f"      Direct-Use heat breakeven price:                  {model.economics.LCOH.value:10.2f} " + model.economics.LCOH.CurrentUnits.value + NL)
 

src/geophires_x/SurfacePlant.py

@@ -471,6 +471,13 @@ def __init__(self, model: Model):
         self.MyPath = os.path.abspath(__file__)
 
         # Results - used by other objects or printed in output downstream
+        self.enduse_option_output = self.OutputParameterDict[self.enduse_option_output.Name] = OutputParameter(
+            Name=self.enduse_option.Name,
+            UnitType=Units.NONE,
+            # FIXME WIP
+            # ToolTipText="Select the end-use application of the geofluid heat: " +
+            #             '; '.join([f'{it.int_value}: {it.value}' for it in EndUseOptions])
+        )
         self.usebuiltinoutletplantcorrelation = self.OutputParameterDict[self.usebuiltinoutletplantcorrelation.Name] = OutputParameter(
             Name="usebuiltinoutletplantcorrelation",
             UnitType=Units.NONE
@@ -697,3 +704,5 @@ def _calculate_derived_outputs(self, model: Model) -> None:
                 convertible_unit(self.heat_to_power_conversion_efficiency.CurrentUnits)).magnitude
             if avg_efficiency > 0:  # 0 is presumed to mean N/A
                 self.heat_to_power_conversion_efficiency.value = avg_efficiency
+
+        self.enduse_option_output.value = self.enduse_option.value.value