Coerce intParameters with ValueEnums to their enum values

Author: softwareengineerprogrammer

src/geophires_x/Economics.py

@@ -5,7 +5,8 @@
 import numpy_financial as npf
 import geophires_x.Model as Model
 from geophires_x.OptionList import Configuration, WellDrillingCostCorrelation, EconomicModel, EndUseOptions, PlantType
-from geophires_x.Parameter import intParameter, floatParameter, OutputParameter, ReadParameter, boolParameter
+from geophires_x.Parameter import intParameter, floatParameter, OutputParameter, ReadParameter, boolParameter, \
+    coerce_int_params_to_enum_values
 from geophires_x.Units import *
 
 
@@ -2223,6 +2224,8 @@ def read_parameters(self, model: Model) -> None:
                 self.DoSDACGTCalculations.value = True
                 break
 
+        coerce_int_params_to_enum_values(self.ParameterDict)
+
         model.logger.info(f'complete {__class__!s}: {sys._getframe().f_code.co_name}')
 
     def Calculate(self, model: Model) -> None:

src/geophires_x/GeoPHIRESUtils.py

@@ -619,3 +619,4 @@ def static_pressure_MPa(rho_kg_per_m3: float, depth_m: float) -> float:
     pressure_mpa = quantity(pressure_Pa, 'Pa').to('MPa').magnitude
 
     return pressure_mpa
+

src/geophires_x/OptionList.py

@@ -1,4 +1,5 @@
 # copyright, 2023, Malcolm I Ross
+
 from enum import Enum
 
 
@@ -41,6 +42,12 @@ def get_end_use_option_from_input_string(input_string:str):
 
         raise ValueError(f'Unknown End-Use Option input value: {input_string}')
 
+    @staticmethod
+    def from_int(int_val):
+        for member in __class__:
+            if member.int_value == int_val:
+                return member
+
 
 class PlantType(GeophiresInputEnum):
     SUB_CRITICAL_ORC = 1, "Subcritical ORC"
@@ -65,6 +72,12 @@ def get_plant_type_from_input_string(input_string:str):
 
         raise ValueError(f'Unknown Power Plant Type input value: {input_string}')
 
+    @staticmethod
+    def from_int(int_val):
+        for member in __class__:
+            if member.int_value == int_val:
+                return member
+
 
 class EconomicModel(str, Enum):
     CLGS = "Simple (CLGS)"
@@ -95,6 +108,12 @@ def get_reservoir_model_from_input_string(input_string:str):
 
         raise ValueError(f'Unknown Reservoir Model input value: {input_string}')
 
+    @staticmethod
+    def from_int(int_val):
+        for member in __class__:
+            if member.int_value == int_val:
+                return member
+
 
 class ReservoirVolume(str, Enum):
     FRAC_NUM_SEP = "Specify number of fractures and fracture separation"

src/geophires_x/Parameter.py

@@ -1,4 +1,6 @@
 # copyright, 2023, Malcolm I Ross
+from __future__ import annotations
+
 import copy
 import dataclasses
 
@@ -12,6 +14,8 @@
 from abc import ABC
 
 from pint.facets.plain import PlainQuantity
+
+from geophires_x.OptionList import GeophiresInputEnum
 from geophires_x.Units import *
 
 _ureg = get_unit_registry()
@@ -119,13 +123,12 @@ def UnitsMatch(self) -> bool:
 
     parameter_category: str = None
 
-    ValuesEnum:Enum = None
+    ValuesEnum:GeophiresInputEnum = None
 
     def __post_init__(self):
         if self.PreferredUnits is None:
             self.PreferredUnits = self.CurrentUnits
 
-
 @dataclass
 class boolParameter(Parameter):
     """
@@ -167,6 +170,11 @@ def __post_init__(self):
     AllowableRange: List[int] = field(default_factory=list)
     json_parameter_type: str = 'integer'
 
+    def coerce_value_to_enum(self):
+        if self.ValuesEnum is not None:
+            if not isinstance(self.value, self.ValuesEnum):
+                self.value = self.ValuesEnum.from_int(self.value)
+
 
 @dataclass
 class floatParameter(Parameter):
@@ -1040,3 +1048,16 @@ def ConvertOutputUnits(oparam: OutputParameter, newUnit: Units, model):
         oparam.value = Factor * conv_rate * float(oparam.value)
         oparam.CurrentUnits = DefUnit
         model.logger.info(f'Complete {str(__name__)}: {sys._getframe().f_code.co_name}')
+
+
+def coerce_int_params_to_enum_values(parameter_dict:dict[str,Parameter]) -> None:
+    """
+    Some modules have intParameters with an int default value whose working value gets set to an
+    enum when the parameter is read. If the parameter is not provided as an input, the default int value needs to
+    be coerced into the corresponding enum value.
+    TODO: resolve these enum/int value discrepancies so this workaround can be removed
+    """
+
+    for param_name, param in parameter_dict.items():
+        if isinstance(param, intParameter):
+            parameter_dict[param_name].coerce_value_to_enum()

src/geophires_x/Reservoir.py

@@ -6,7 +6,8 @@
 from pint.facets.plain import PlainQuantity
 
 from .OptionList import ReservoirModel, FractureShape, ReservoirVolume
-from .Parameter import intParameter, floatParameter, listParameter, OutputParameter, ReadParameter
+from .Parameter import intParameter, floatParameter, listParameter, OutputParameter, ReadParameter, \
+    coerce_int_params_to_enum_values
 from .Units import *
 import geophires_x.Model as Model
 
@@ -638,11 +639,7 @@ def read_parameters(self, model: Model) -> None:
         else:
             model.logger.info("No parameters read because no content provided")
 
-        if not isinstance(self.resoption.value, ReservoirModel):
-            # resoption is an intParameter with an int default value whose working value gets set to a ReservoirModel
-            # enum when the parameter is read, so convert to the enum from the default if it's not read as a parameter.
-            # (TODO: resolve the enum/int value discrepancy so this workaround can be removed)
-            self.resoption.value = ReservoirModel.get_reservoir_model_from_input_string(str(self.resoption.value))
+        coerce_int_params_to_enum_values(self.ParameterDict)
 
         model.logger.info(f'complete {str(__class__)}: {sys._getframe().f_code.co_name}')
 

src/geophires_x/SurfacePlant.py

@@ -1,8 +1,10 @@
 import sys
 import os
 import numpy as np
+
 from .OptionList import EndUseOptions, PlantType
-from .Parameter import floatParameter, intParameter, strParameter, OutputParameter, ReadParameter
+from .Parameter import floatParameter, intParameter, strParameter, OutputParameter, ReadParameter, \
+    coerce_int_params_to_enum_values
 from .Units import *
 import geophires_x.Model as Model
 import pandas as pd
@@ -232,7 +234,7 @@ def __init__(self, model: Model):
 
         self.enduse_option = self.ParameterDict[self.enduse_option.Name] = intParameter(
             "End-Use Option",
-            value=EndUseOptions.ELECTRICITY,
+            value=EndUseOptions.ELECTRICITY, # TODO should be DefaultValue instead
             AllowableRange=[1, 2, 31, 32, 41, 42, 51, 52],
             ValuesEnum=EndUseOptions,
             UnitType=Units.NONE,
@@ -242,7 +244,7 @@ def __init__(self, model: Model):
         )
         self.plant_type = self.ParameterDict[self.plant_type.Name] = intParameter(
             "Power Plant Type",
-            DefaultValue=PlantType.SUB_CRITICAL_ORC,
+            DefaultValue=PlantType.SUB_CRITICAL_ORC.int_value,
             AllowableRange=[1, 2, 3, 4, 5, 6, 7, 8, 9],
             ValuesEnum=PlantType,
             UnitType=Units.NONE,
@@ -577,6 +579,8 @@ def read_parameters(self, model:Model) -> None:
         else:
             model.logger.info('No parameters read because no content provided')
 
+        coerce_int_params_to_enum_values(self.ParameterDict)
+
         model.logger.info(f'Complete {self.__class__.__name__}: {__name__}')
 
     def Calculate(self, model: Model) -> None:

src/geophires_x_schema_generator/geophires-request.json

@@ -789,7 +789,7 @@
       "type": "integer",
       "units": null,
       "category": "Surface Plant",
-      "default": "",
+      "default": 1,
       "minimum": 1,
       "maximum": 9,
       "enum_values": [

tests/geophires_x_tests/test_options_list.py

@@ -11,6 +11,9 @@ def test_get_end_use_option_from_input_string(self):
         with self.assertRaises(ValueError):
             EndUseOptions.get_end_use_option_from_input_string('2034982309')
 
+    def test_get_end_use_option_from_int_val(self):
+        self.assertEqual(EndUseOptions.from_int(1), EndUseOptions.ELECTRICITY)
+
     def test_cast_from_name_string(self):
         self.assertIs(EndUseOptions('Electricity'), EndUseOptions.ELECTRICITY)
         self.assertIs(EndUseOptions('Direct-Use Heat'), EndUseOptions.HEAT)