WIP - PlantType as GeophiresInputEnum - default value discrepancy headache...

Author: softwareengineerprogrammer

src/geophires_x/OptionList.py

@@ -42,43 +42,28 @@ def get_end_use_option_from_input_string(input_string:str):
         raise ValueError(f'Unknown End-Use Option input value: {input_string}')
 
 
-class PlantType(str, Enum):
-    SUB_CRITICAL_ORC = "Subcritical ORC" # 1
-    SUPER_CRITICAL_ORC = "Supercritical ORC" # 2
-    SINGLE_FLASH = "Single-Flash" # 3
-    DOUBLE_FLASH = "Double-Flash" # 4
-    ABSORPTION_CHILLER = "Absorption Chiller"  # 5
-    HEAT_PUMP = "Heat Pump"  # 6
-    DISTRICT_HEATING = "District Heating"  # 7
-    RTES = "Reservoir Thermal Energy Storage"  # 8
-    INDUSTRIAL = "Industrial"  # 9
+class PlantType(GeophiresInputEnum):
+    SUB_CRITICAL_ORC = 1, "Subcritical ORC"
+    SUPER_CRITICAL_ORC = 2, "Supercritical ORC"
+    SINGLE_FLASH = 3, "Single-Flash"
+    DOUBLE_FLASH = 4, "Double-Flash"
+    ABSORPTION_CHILLER = 5, "Absorption Chiller"
+    HEAT_PUMP = 6, "Heat Pump"
+    DISTRICT_HEATING = 7, "District Heating"
+    RTES = 8, "Reservoir Thermal Energy Storage"
+    INDUSTRIAL = 9, "Industrial"
 
     @staticmethod
     def get_plant_type_from_input_string(input_string:str):
         """
         :rtype: PlantType
         """
 
-        if input_string == str(1):
-            return PlantType.SUB_CRITICAL_ORC
-        elif input_string == str(2):
-            return PlantType.SUPER_CRITICAL_ORC
-        elif input_string == str(3):
-            return PlantType.SINGLE_FLASH
-        elif input_string == str(4):
-            return PlantType.DOUBLE_FLASH
-        elif input_string == str(5):
-            return PlantType.ABSORPTION_CHILLER
-        elif input_string == str(6):
-            return PlantType.HEAT_PUMP
-        elif input_string == str(7):
-            return PlantType.DISTRICT_HEATING
-        elif input_string == str(8):
-            return PlantType.RTES
-        else:
-            return PlantType.INDUSTRIAL
+        for type in PlantType:
+            if input_string == str(type.int_value):
+                return type
 
-        raise ValueError(f'Unknown End-Use Option input value: {input_string}')
+        raise ValueError(f'Unknown Power Plant Type input value: {input_string}')
 
 
 class EconomicModel(str, Enum):

src/geophires_x/SurfacePlant.py

@@ -244,11 +244,11 @@ def __init__(self, model: Model):
             "Power Plant Type",
             DefaultValue=PlantType.SUB_CRITICAL_ORC,
             AllowableRange=[1, 2, 3, 4, 5, 6, 7, 8, 9],
+            ValuesEnum=PlantType,
             UnitType=Units.NONE,
             ErrMessage="assume default power plant type (1: subcritical ORC)",
-            ToolTipText="Specify the type of physical plant. 1: Subcritical ORC," +
-            " 2: Supercritical ORC, 3: Single-flash, 4: Double-flash, 5: Absorption Chiller, 6: Heat Pump" +  # 6
-            " 7: District Heating, 8: Reservoir Thermal Energy Storage"
+            ToolTipText="Specify the type of physical plant. " +
+                        '; '.join([f'{it.int_value}: {it.value}' for it in PlantType])
         )
         self.pump_efficiency = self.ParameterDict[self.pump_efficiency.Name] = floatParameter(
             "Circulation Pump Efficiency",

src/geophires_x_schema_generator/geophires-request.json

@@ -785,13 +785,60 @@
       ]
     },
     "Power Plant Type": {
-      "description": "Specify the type of physical plant. 1: Subcritical ORC, 2: Supercritical ORC, 3: Single-flash, 4: Double-flash, 5: Absorption Chiller, 6: Heat Pump 7: District Heating, 8: Reservoir Thermal Energy Storage",
+      "description": "Specify the type of physical plant. 1: Subcritical ORC; 2: Supercritical ORC; 3: Single-Flash; 4: Double-Flash; 5: Absorption Chiller; 6: Heat Pump; 7: District Heating; 8: Reservoir Thermal Energy Storage; 9: Industrial",
       "type": "integer",
       "units": null,
       "category": "Surface Plant",
-      "default": "Subcritical ORC",
+      "default": "",
       "minimum": 1,
-      "maximum": 9
+      "maximum": 9,
+      "enum_values": [
+        {
+          "name": "SUB_CRITICAL_ORC",
+          "value": "Subcritical ORC",
+          "int_value": 1
+        },
+        {
+          "name": "SUPER_CRITICAL_ORC",
+          "value": "Supercritical ORC",
+          "int_value": 2
+        },
+        {
+          "name": "SINGLE_FLASH",
+          "value": "Single-Flash",
+          "int_value": 3
+        },
+        {
+          "name": "DOUBLE_FLASH",
+          "value": "Double-Flash",
+          "int_value": 4
+        },
+        {
+          "name": "ABSORPTION_CHILLER",
+          "value": "Absorption Chiller",
+          "int_value": 5
+        },
+        {
+          "name": "HEAT_PUMP",
+          "value": "Heat Pump",
+          "int_value": 6
+        },
+        {
+          "name": "DISTRICT_HEATING",
+          "value": "District Heating",
+          "int_value": 7
+        },
+        {
+          "name": "RTES",
+          "value": "Reservoir Thermal Energy Storage",
+          "int_value": 8
+        },
+        {
+          "name": "INDUSTRIAL",
+          "value": "Industrial",
+          "int_value": 9
+        }
+      ]
     },
     "Circulation Pump Efficiency": {
       "description": "Specify the overall efficiency of the injection and production well pumps",