Address WIPs for Number of Doublets

Author: softwareengineerprogrammer

src/geophires_x/WellBores.py

@@ -708,19 +708,22 @@ def __init__(self, model: Model):
         self.ParameterDict = {}
         self.OutputParameterDict = {}
 
+        max_doublets = 200
+        # noinspection SpellCheckingInspection
         self.nprod = self.ParameterDict[self.nprod.Name] = intParameter(
             "Number of Production Wells",
             DefaultValue=2,
-            AllowableRange=list(range(1, 201, 1)),
+            AllowableRange=list(range(1, max_doublets+1, 1)),
             UnitType=Units.NONE,
             Required=False,
             ErrMessage="assume default number of production wells (2)",
             ToolTipText="Number of (identical) production wells"
         )
+        # noinspection SpellCheckingInspection
         self.ninj = self.ParameterDict[self.ninj.Name] = intParameter(
             "Number of Injection Wells",
             DefaultValue=2,
-            AllowableRange=list(range(0, 201, 1)),
+            AllowableRange=list(range(0, max_doublets+1, 1)),
             UnitType=Units.NONE,
             Required=False,
             ErrMessage="assume default number of injection wells (2)",
@@ -729,10 +732,12 @@ def __init__(self, model: Model):
         self.doublets_count = self.ParameterDict[self.doublets_count.Name] = intParameter(
             "Number of Doublets",
             DefaultValue=2,
-            AllowableRange=list(range(0, 201, 1)),
+            AllowableRange=list(range(0, max_doublets+1, 1)),
             UnitType=Units.NONE,
-            ToolTipText="Number of doublets"  # FIXME WIP
+            ToolTipText="Pass this parameter to set the Number of Production Wells and Number of Injection Wells to "
+                        "same value."
         )
+
         self.prodwelldiam = self.ParameterDict[self.prodwelldiam.Name] = floatParameter(
             "Production Well Diameter",
             DefaultValue=8.0,
@@ -1325,7 +1330,15 @@ def read_parameters(self, model: Model) -> None:
         coerce_int_params_to_enum_values(self.ParameterDict)
 
         if self.doublets_count.Provided:
-            # FIXME WIP validate that ninj/nprod haven't been provided and vice versa
+            def _error(num_wells_param_:intParameter):
+                msg = f'{num_wells_param_.Name} may not be provided when {self.doublets_count.Name} is provided.'
+                model.logger.error(msg)
+                raise ValueError(msg)
+
+            for num_wells_param in [self.ninj, self.nprod]:
+                if num_wells_param.Provided:
+                    _error(num_wells_param)
+
             self.ninj.value = self.doublets_count.value
             self.nprod.value = self.doublets_count.value
 

src/geophires_x_schema_generator/geophires-request.json

@@ -637,6 +637,15 @@
       "minimum": 0,
       "maximum": 200
     },
+    "Number of Doublets": {
+      "description": "Pass this parameter to set the Number of Production Wells and Number of Injection Wells to same value.",
+      "type": "integer",
+      "units": null,
+      "category": "Well Bores",
+      "default": 2,
+      "minimum": 0,
+      "maximum": 200
+    },
     "Production Well Diameter": {
       "description": "Inner diameter of production wellbore (assumed constant along the wellbore) to calculate             frictional pressure drop and wellbore heat transmission with Rameys model",
       "type": "number",

tests/geophires_x_tests/test_well_bores.py

@@ -28,10 +28,13 @@ def _get_result(_params) -> GeophiresXResult:
             )
             return GeophiresXClient().get_geophires_result(params)
 
-        def _prod_inj(_r: GeophiresXResult) -> tuple[int, int]:
+        def _prod_inj_lcoe(_r: GeophiresXResult) -> tuple[int, int]:
             return (
                 _r.result['ENGINEERING PARAMETERS']['Number of Production Wells']['value'],
                 _r.result['ENGINEERING PARAMETERS']['Number of Injection Wells']['value'],
+                _r.result['SUMMARY OF RESULTS']['Electricity breakeven price']['value'],
+                _r.result['SUMMARY OF RESULTS']['Electricity breakeven price']['value'],
+                _r.result['SURFACE EQUIPMENT SIMULATION RESULTS']['Average Net Electricity Generation']['value'],
             )
 
         r_prod_inj: GeophiresXResult = _get_result(
@@ -47,5 +50,42 @@ def _prod_inj(_r: GeophiresXResult) -> tuple[int, int]:
             }
         )
 
-        self.assertEqual(_prod_inj(r_doublets), _prod_inj(r_prod_inj))
-        # FIXME WIP assert results look superficially equal
+        self.assertEqual(_prod_inj_lcoe(r_doublets), _prod_inj_lcoe(r_prod_inj))
+
+    def test_number_of_doublets_validation(self):
+        def _get_result(_params) -> GeophiresXResult:
+            params = GeophiresInputParameters(
+                {
+                    'Reservoir Depth': 5,
+                    'Gradient 1': 74,
+                    'Power Plant Type': 2,
+                    'Maximum Temperature': 600,
+                }
+                | _params
+            )
+            return GeophiresXClient().get_geophires_result(params)
+
+        with self.assertRaises(RuntimeError):
+            _get_result(
+                {
+                    'Number of Production Wells': 10,
+                    'Number of Injection Wells': 10,
+                    'Number of Doublets': 10,
+                }
+            )
+
+        with self.assertRaises(RuntimeError):
+            _get_result(
+                {
+                    'Number of Production Wells': 10,
+                    'Number of Doublets': 10,
+                }
+            )
+
+        with self.assertRaises(RuntimeError):
+            _get_result(
+                {
+                    'Number of Injection Wells': 10,
+                    'Number of Doublets': 10,
+                }
+            )