EconomicModel values enum

Author: softwareengineerprogrammer

src/geophires_x/Economics.py

@@ -609,12 +609,13 @@ def __init__(self, model: Model):
         # This is the default.
         self.econmodel = self.ParameterDict[self.econmodel.Name] = intParameter(
             "Economic Model",
-            DefaultValue=EconomicModel.STANDARDIZED_LEVELIZED_COST,
+            DefaultValue=EconomicModel.STANDARDIZED_LEVELIZED_COST.int_value,
             AllowableRange=[1, 2, 3, 4],
+            ValuesEnum=EconomicModel,
             Required=True,
             ErrMessage="assume default economic model (2)",
             ToolTipText="Specify the economic model to calculate the levelized cost of energy." +
-                        " 1: Fixed Charge Rate Model, 2: Standard Levelized Cost Model, 3: BICYCLE Levelized Cost Model, 4: CLGS"
+                        '; '.join([f'{it.int_value}: {it.value}' for it in EconomicModel])
         )
         self.ccstimfixed = self.ParameterDict[self.ccstimfixed.Name] = floatParameter(
             "Reservoir Stimulation Capital Cost",
@@ -1853,17 +1854,10 @@ def read_parameters(self, model: Model) -> None:
 
                     # handle special cases
                     if ParameterToModify.Name == "Economic Model":
-                        if ParameterReadIn.sValue == '1':
-                            self.econmodel.value = EconomicModel.FCR
-                        elif ParameterReadIn.sValue == '2':
-                            # use standard LCOE/LCOH calculation as found on wikipedia (requires an interest rate).
-                            self.econmodel.value = EconomicModel.STANDARDIZED_LEVELIZED_COST
-                        elif ParameterReadIn.sValue == '3':
-                            # use Bicycle LCOE/LCOH model (requires several financial input parameters)
-                            self.econmodel.value = EconomicModel.BICYCLE
-                        else:
-                            self.econmodel.value = EconomicModel.CLGS  # CLGS
+                        self.econmodel.value = EconomicModel.from_input_string(ParameterReadIn.sValue)
+
                     elif ParameterToModify.Name == "Well Drilling Cost Correlation":
+                        # TODO WellDrillingCostCorrelation.from_input_string
                         if ParameterReadIn.sValue == '1':
                             ParameterToModify.value = WellDrillingCostCorrelation.VERTICAL_SMALL
                         elif ParameterReadIn.sValue == '2':

src/geophires_x/OptionList.py

@@ -79,11 +79,25 @@ def from_int(int_val):
                 return member
 
 
-class EconomicModel(str, Enum):
-    CLGS = "Simple (CLGS)"
-    FCR = "Fixed Charge Rate (FCR)"
-    STANDARDIZED_LEVELIZED_COST = "Standard Levelized Cost"
-    BICYCLE = "BICYCLE"
+class EconomicModel(GeophiresInputEnum):
+    FCR = 1, "Fixed Charge Rate (FCR)"
+    STANDARDIZED_LEVELIZED_COST = 2, "Standard Levelized Cost"
+    BICYCLE = 3, "BICYCLE"
+    CLGS = 4, "Simple (CLGS)"
+
+    @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 Economic Model input value: {input_string}')
 
 
 class ReservoirModel(GeophiresInputEnum):

src/geophires_x_schema_generator/geophires-request.json

@@ -1047,13 +1047,35 @@
       "maximum": 200.0
     },
     "Economic Model": {
-      "description": "Specify the economic model to calculate the levelized cost of energy. 1: Fixed Charge Rate Model, 2: Standard Levelized Cost Model, 3: BICYCLE Levelized Cost Model, 4: CLGS",
+      "description": "Specify the economic model to calculate the levelized cost of energy.1: Fixed Charge Rate (FCR); 2: Standard Levelized Cost; 3: BICYCLE; 4: Simple (CLGS)",
       "type": "integer",
       "units": null,
       "category": "Economics",
-      "default": "Standard Levelized Cost",
+      "default": 2,
       "minimum": 1,
-      "maximum": 4
+      "maximum": 4,
+      "enum_values": [
+        {
+          "name": "FCR",
+          "value": "Fixed Charge Rate (FCR)",
+          "int_value": 1
+        },
+        {
+          "name": "STANDARDIZED_LEVELIZED_COST",
+          "value": "Standard Levelized Cost",
+          "int_value": 2
+        },
+        {
+          "name": "BICYCLE",
+          "value": "BICYCLE",
+          "int_value": 3
+        },
+        {
+          "name": "CLGS",
+          "value": "Simple (CLGS)",
+          "int_value": 4
+        }
+      ]
     },
     "Reservoir Stimulation Capital Cost": {
       "description": "Total reservoir stimulation capital cost",