Deprecate 'Total Nonvertical Length', rename as 'Nonvertical Length per Multilateral Section' https://github.com/NREL/GEOPHIRES-X/issues/278\?title\=Total+Nonvertical+Length+is+actually+per+section

Author: softwareengineerprogrammer

src/geophires_x/WellBores.py

@@ -1004,15 +1004,15 @@ def __init__(self, model: Model):
 
         # Input data for subsurface condition
         self.Nonvertical_length = self.ParameterDict[self.Nonvertical_length.Name] = floatParameter(
-            "Total Nonvertical Length",
+            "Nonvertical Length per Multilateral Section",
             DefaultValue=1000.0,
             Min=50.0,
             Max=20000.0,
             UnitType=Units.LENGTH,
             PreferredUnits=LengthUnit.METERS,
             CurrentUnits=LengthUnit.METERS,
             Required=True,
-            ErrMessage="assume default Total nonvertical length (1000 m)"
+            ErrMessage="assume default Nonvertical Length per Multilateral Section (1000 m)"
         )
 
         self.nonverticalwellborediameter = self.ParameterDict[self.nonverticalwellborediameter.Name] = floatParameter(
@@ -1228,7 +1228,26 @@ def read_parameters(self, model: Model) -> None:
         # and if you do, do it before or after you call you own version of this method. If you do, you can also choose
         # to call this method from you class, which can modify all these superclass parameters in your class.
 
+
         if len(model.InputParameters) > 0:
+
+            # See https://github.com/NREL/GEOPHIRES-X/issues/278?title=Total+Nonvertical+Length+is+actually+per+section
+            deprecated_nonvertical_length_param_name = 'Total Nonvertical Length'
+            if deprecated_nonvertical_length_param_name in model.InputParameters:
+                model.logger.warning(
+                    f'"{deprecated_nonvertical_length_param_name}" parameter name is deprecated, '
+                    f'use "{self.Nonvertical_length.Name}" instead')
+
+                if self.Nonvertical_length.Name not in model.InputParameters:
+                    model.InputParameters[self.Nonvertical_length.Name] = model.InputParameters[
+                        deprecated_nonvertical_length_param_name]
+                else:
+                    model.logger.warning(
+                        f'Ignoring value of "{deprecated_nonvertical_length_param_name}" '
+                        f'because it is set by "{self.Nonvertical_length.Name}" instead')
+
+                del model.InputParameters[deprecated_nonvertical_length_param_name]
+
             # loop through all the parameters that the user wishes to set, looking for parameters that match this object
             for item in self.ParameterDict.items():
                 ParameterToModify = item[1]

src/geophires_x_schema_generator/geophires-request.json

@@ -30,7 +30,7 @@
     "Closed-loop Configuration",
     "Well Geometry Configuration",
     "Heat Transfer Fluid",
-    "Total Nonvertical Length",
+    "Nonvertical Length per Multilateral Section",
     "Circulation Pump Efficiency",
     "Utilization Factor",
     "Plant Lifetime",
@@ -893,7 +893,7 @@
         }
       ]
     },
-    "Total Nonvertical Length": {
+    "Nonvertical Length per Multilateral Section": {
       "description": "",
       "type": "number",
       "units": "meter",

tests/multilateral-section-nonvertical-length.txt

@@ -0,0 +1,42 @@
+Is AGS, True
+Has Nonvertical Section, True
+Multilaterals Cased, True
+Well Geometry Configuration, 1, -- --U-loop (could be Eavor style)
+Plant Lifetime, 40, -- -Years
+Water Thermal Conductivity, 0.65
+Nonvertical Wellbore Diameter, 0.23495, -- ---m
+Cylindrical Reservoir Radius of Effect Factor, 5.0
+Closed Loop Calculation Start Year, 0.1
+Number of Multilateral Sections, 6
+Well Drilling Cost Correlation, 3, -- - [-] Use built-in well drilling cost correlation #3 = vertical open-hole, large diameter
+Horizontal Well Drilling Cost Correlation, 1, -- - [-] Use built-in well drilling cost correlation #3 = vertical open-hole, large diameter
+Reservoir Impedance, 1E-4, -- --assume a very low reservoir impedance since the working fluid is never in contact with the reservoir
+Production Flow Rate per Well, 110, -- - [kg/s]
+Injection Temperature, 60, -- ---C
+Gradient 1, 26.25, -- -[deg.C/km]
+Reservoir Depth, 10.0, -- --km
+Cylindrical Reservoir Input Depth, 10, -- ---km
+Cylindrical Reservoir Output Depth, 10, -- ----km
+Cylindrical Reservoir Length, 10, -- --km
+Reservoir Model, 0, -- -simple cylinder reservoir model
+Number of Production Wells, 1, -- -[-]
+Number of Injection Wells, 1, -- -[-]
+Ramey Production Wellbore Model, 0, -- - Should be 0 (disable) or 1 (enable)
+Production Wellbore Temperature Drop, 0, -- - [deg.C]
+Maximum Temperature, 375, -- - [deg.C]
+Reservoir Volume Option, 4, -- - Should be 1 2 3 or 4. See manual for details.
+Reservoir Volume, 1e9, -- - [m3] (required for reservoir volume option 3 and 4
+Reservoir Heat Capacity, 1050, -- - [J/kg/K]
+End-Use Option, 1, -- - [-] Electricity
+Power Plant Type, 1, -- - [1] Subcritical ORC
+Circulation Pump Efficiency, 0.8, -- - [-]
+Plant Outlet Pressure, 68.95
+Economic Model, 3, -- - Should be 1 (FCR model) 2 (Standard LCOE/LCOH model) or 3 (Bicycle model).
+Fraction of Investment in Bonds, 0.65, -- - [-] Required if Bicycle model is selected. See manual for details.
+Inflated Bond Interest Rate, 0.07, -- - [-] Required if Bicycle model is selected. See manual for details.
+Inflated Equity Interest Rate, 0.12, -- - [-] Required if Bicycle model is selected. See manual for details.
+Inflation Rate, 0.025, -- - [-] Required if Bicycle model is selected. See manual for details.
+Combined Income Tax Rate, 0.392, -- - [-] Required if Bicycle model is selected. See manual for details.
+Gross Revenue Tax Rate, 0, -- - [-] Required if Bicycle model is selected. See manual for details.
+Reservoir Stimulation Capital Cost, 0, -- - [M$/injection well] Reservoir stimulation capital cost per injection well
+Print Output to Console, 1, -- - [-] Should be 0 (don't print results to console) or 1 (print results to console)

tests/test_geophires_x.py

@@ -485,3 +485,41 @@ def test_convert_output_psi_to_kpa(self):
         )
 
         # TODO validate output values (for now we are just testing an exception isn't thrown)
+
+    def test_multilateral_section_nonvertical_length(self):
+        def s(r):
+            del r.result['metadata']
+            del r.result['Simulation Metadata']
+            return r
+
+        deprecated_param = s(
+            GeophiresXClient().get_geophires_result(
+                GeophiresInputParameters(
+                    from_file_path=self._get_test_file_path(Path('multilateral-section-nonvertical-length.txt')),
+                    params={'Total Nonvertical Length': 6000.0},
+                )
+            )
+        )
+
+        non_deprecated_param = s(
+            GeophiresXClient().get_geophires_result(
+                GeophiresInputParameters(
+                    from_file_path=self._get_test_file_path(Path('multilateral-section-nonvertical-length.txt')),
+                    params={'Nonvertical Length per Multilateral Section': 6000.0},
+                )
+            )
+        )
+
+        self.assertDictEqual(deprecated_param.result, non_deprecated_param.result)
+
+        both_params = s(
+            GeophiresXClient().get_geophires_result(
+                GeophiresInputParameters(
+                    from_file_path=self._get_test_file_path(Path('multilateral-section-nonvertical-length.txt')),
+                    params={'Nonvertical Length per Multilateral Section': 6000.0, 'Total Nonvertical Length': 4000.0},
+                )
+            )
+        )
+
+        # deprecated is ignored if both are present.
+        self.assertDictEqual(both_params.result, non_deprecated_param.result)