WorkingFluid enum values NREL#245

Author: softwareengineerprogrammer

src/geophires_x/OptionList.py

@@ -194,7 +194,6 @@ def from_input_string(input_string: str):
         raise ValueError(f'Unknown Well Drilling Cost Correlation input value: {input_string}')
 
 
-
 class FractureShape(GeophiresInputEnum):
     CIRCULAR_AREA = 1, "Circular fracture with known area"
     CIRCULAR_DIAMETER = 2, "Circular fracture with known diameter"
@@ -215,9 +214,26 @@ def from_input_string(input_string:str):
 
         raise ValueError(f'Unknown Fracture Shape input value: {input_string}')
 
-class WorkingFluid(str, Enum):
-    WATER = "water"
-    SCO2 = "sCO2"
+
+class WorkingFluid(GeophiresInputEnum):
+    WATER = 1, "water"
+    SCO2 = 2, "sCO2"
+
+    @staticmethod
+    def from_int(int_val):
+        for member in __class__:
+            if member.int_value == int_val:
+                return member
+
+    @staticmethod
+    def from_input_string(input_string: str):
+        for member in __class__:
+            if input_string == str(member.int_value):
+                return member
+
+        raise ValueError(f'Unknown Working Fluid input value: {input_string}')
+
+
 
 
 class Configuration(str, Enum):

src/geophires_x/WellBores.py

@@ -2,7 +2,8 @@
 import numpy as np
 from pint.facets.plain import PlainQuantity
 
-from .Parameter import floatParameter, intParameter, boolParameter, OutputParameter, ReadParameter
+from .Parameter import floatParameter, intParameter, boolParameter, OutputParameter, ReadParameter, \
+    coerce_int_params_to_enum_values
 from geophires_x.GeoPHIRESUtils import vapor_pressure_water_kPa, quantity, static_pressure_MPa
 from geophires_x.GeoPHIRESUtils import density_water_kg_per_m3
 from geophires_x.GeoPHIRESUtils import viscosity_water_Pa_sec
@@ -917,11 +918,13 @@ def __init__(self, model: Model):
 
         self.Fluid = self.ParameterDict[self.Fluid.Name] = intParameter(
             "Heat Transfer Fluid",
-            DefaultValue=WorkingFluid.WATER,
+            DefaultValue=WorkingFluid.WATER.int_value,
             AllowableRange=[1, 2],
+            ValuesEnum=WorkingFluid,
             UnitType=Units.NONE,
             Required=True,
-            ErrMessage="assume default Heat transfer fluid is water (1)"
+            ErrMessage="assume default Heat transfer fluid is water (1)",
+            ToolTipText='; '.join([f'{it.int_value}: {it.value}' for it in WorkingFluid])
         )
 
         # Input data for subsurface condition
@@ -1136,15 +1139,13 @@ def read_parameters(self, model: Model) -> None:
 
                     # handle special cases
                     if ParameterToModify.Name == "Heat Transfer Fluid":
-                        if ParameterReadIn.sValue == str(1):
-                            self.Fluid.value = WorkingFluid.WATER
-                        else:
-                            self.Fluid.value = WorkingFluid.SCO2
-                    # IsAGS is false by default - if it equal 1, then it is true
+                        self.Fluid.value = WorkingFluid.from_input_string(ParameterReadIn.sValue)
+
+                    # IsAGS is false by default - if it equals 1, then it is true
                     if ParameterToModify.Name == "Ramey Production Wellbore Model":
                         if ParameterReadIn.sValue == '0':
                             ParameterToModify.value = False
-                    # Ramey Production Wellbore Model is true by default - if it equal 0, then it is false
+                    # Ramey Production Wellbore Model is true by default - if it equals 0, then it is false
                     elif ParameterToModify.Name == "Is AGS":
                         if ParameterReadIn.sValue == '1':
                             ParameterToModify.value = True
@@ -1180,6 +1181,9 @@ def read_parameters(self, model: Model) -> None:
                             raise ValueError(f'Invalid Configuration: {self.Configuration.value}')
         else:
             model.logger.info("No parameters read because no content provided")
+
+        coerce_int_params_to_enum_values(self.ParameterDict)
+
         model.logger.info(f"read parameters complete {self.__class__.__name__}: {__name__}")
 
     def Calculate(self, model: Model) -> None:

src/geophires_x_schema_generator/geophires-request.json

@@ -724,13 +724,25 @@
       "maximum": 100.0
     },
     "Heat Transfer Fluid": {
-      "description": "",
+      "description": "1: water; 2: sCO2",
       "type": "integer",
       "units": null,
       "category": "Well Bores",
-      "default": "water",
+      "default": 1,
       "minimum": 1,
-      "maximum": 2
+      "maximum": 2,
+      "enum_values": [
+        {
+          "name": "WATER",
+          "value": "water",
+          "int_value": 1
+        },
+        {
+          "name": "SCO2",
+          "value": "sCO2",
+          "int_value": 2
+        }
+      ]
     },
     "Total Nonvertical Length": {
       "description": "",