Merge pull request #113 from softwareengineerprogrammer/number-of-fractures-per-stimulated-well

Add 'Number of Fractures per Stimulated Well' parameter [v3.10.15] (NREL#426)

Author: softwareengineerprogrammer

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.10.14
+current_version = 3.10.15
 commit = True
 tag = True
 

.cookiecutterrc

@@ -54,7 +54,7 @@ default_context:
     sphinx_doctest: "no"
     sphinx_theme: "sphinx-py3doc-enhanced-theme"
     test_matrix_separate_coverage: "no"
-    version: 3.10.14
+    version: 3.10.15
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"

README.rst

@@ -58,9 +58,9 @@ Free software: `MIT license <LICENSE>`__
     :alt: Supported implementations
     :target: https://pypi.org/project/geophires-x
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.10.14.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.10.15.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.10.14...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.10.15...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X

docs/conf.py

@@ -18,7 +18,7 @@
 year = '2025'
 author = 'NREL'
 copyright = f'{year}, {author}'
-version = release = '3.10.14'
+version = release = '3.10.15'
 
 pygments_style = 'trac'
 templates_path = ['./templates']

setup.py

@@ -13,7 +13,7 @@ def read(*names, **kwargs):
 
 setup(
     name='geophires-x',
-    version='3.10.14',
+    version='3.10.15',
     license='MIT',
     description='GEOPHIRES is a free and open-source geothermal techno-economic simulator.',
     long_description='{}\n{}'.format(

src/geophires_x/Reservoir.py

@@ -14,6 +14,9 @@
 from geophires_x.GeoPHIRESUtils import heat_capacity_water_J_per_kg_per_K, quantity, static_pressure_MPa
 from geophires_x.GeoPHIRESUtils import density_water_kg_per_m3
 
+_MAX_ALLOWED_FRACTURES = 1_000_000
+
+
 class Reservoir:
     """
     This class is the parent class for modeling the Reservoir.
@@ -284,15 +287,32 @@ def __init__(self, model: Model):
             ToolTipText="Width of each fracture"
         )
 
+        fracnumb_allowable_range = list(range(1, _MAX_ALLOWED_FRACTURES + 1, 1))
         self.fracnumb = self.ParameterDict[self.fracnumb.Name] = intParameter(
             "Number of Fractures",
             DefaultValue=10,
-            AllowableRange=list(range(1, 100_000, 1)),
+            AllowableRange=fracnumb_allowable_range,
             UnitType=Units.NONE,
             ErrMessage="assume default number of fractures (10)",
             ToolTipText="Number of identical parallel fractures in EGS fracture-based reservoir model."
         )
 
+        # Variable is a workaround for the fact that model.economics has not been initialized yet.
+        model_economics_stimulation_cost_per_production_well_name = \
+            'Reservoir Stimulation Capital Cost per Production Well'
+        # noinspection SpellCheckingInspection
+        self.fracnumb_per_stimulated_well = self.ParameterDict[self.fracnumb_per_stimulated_well.Name] = intParameter(
+            'Number of Fractures per Stimulated Well',
+            DefaultValue=20,
+            AllowableRange=fracnumb_allowable_range,
+            UnitType=Units.NONE,
+            ToolTipText=f'Number of identical parallel fractures per stimulated well '
+                        f'in EGS fracture-based reservoir model. '
+                        f'(Note that injection wells are assumed to be stimulated by default; '
+                        f'production wells are assumed to be stimulated if '
+                        f'{model_economics_stimulation_cost_per_production_well_name} is provided.)'
+        )
+
         self.fracsep = self.ParameterDict[self.fracsep.Name] = floatParameter(
             "Fracture Separation",
             DefaultValue=50.0,
@@ -617,8 +637,6 @@ def read_parameters(self, model: Model) -> None:
 
                     elif ParameterToModify.Name.startswith("Fracture Separation"):
                         self.fracsepcalc.value = self.fracsep.value
-                    elif ParameterToModify.Name.startswith("Number of Fractures"):
-                        self.fracnumbcalc.value = self.fracnumb.value
                     elif ParameterToModify.Name.startswith("Fracture Width"):
                         self.fracwidthcalc.value = self.fracwidth.value
                     elif ParameterToModify.Name.startswith("Fracture Height"):
@@ -656,6 +674,11 @@ def read_parameters(self, model: Model) -> None:
 
         model.reserv.layerthickness.value[model.reserv.numseg.value-1] = 100_000.0
 
+        if self.fracnumb.Provided and self.fracnumb_per_stimulated_well.Provided:
+            raise ValueError(f'Only one of {self.fracnumb_per_stimulated_well.Name} and {self.fracnumb.Name}'
+                             f'may be provided. '
+                             f'Please provide only one of these parameters.')
+
 
         model.logger.info(f'complete {str(__class__)}: {sys._getframe().f_code.co_name}')
 
@@ -676,9 +699,22 @@ def Calculate(self, model: Model) -> None:
         # If you choose to subclass this master class, you can also choose to override this method (or not),
         # 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 effectively run the calculations of the superclass,
-        # making all thr values available to your methods. but you had n better set all the parameters!
+        # making all the values available to your methods. but you had n better set all the parameters!
+
+        # calculate fracture count and geometry
+        if self.fracnumb_per_stimulated_well.Provided:
+            stimulated_wells_count = model.wellbores.ninj.value
+            if model.economics.stimulation_cost_per_production_well.Provided:
+                # Only injection wells are assumed to be stimulated unless stimulation cost per
+                # production well parameter is provided (even if provided cost is $0).
+                stimulated_wells_count += model.wellbores.nprod.value
+            self.fracnumbcalc.value = self.fracnumb_per_stimulated_well.value * stimulated_wells_count
+        else:
+            self.fracnumbcalc.value = self.fracnumb.value
+        if self.fracnumbcalc.value > _MAX_ALLOWED_FRACTURES:
+            raise ValueError(f'{self.fracnumb.Name} ({self.fracnumbcalc.value}) must not exceed '
+                             f'{_MAX_ALLOWED_FRACTURES}.')
 
-        # calculate fracture geometry
         if self.fracshape.value == FractureShape.CIRCULAR_AREA:
             self.fracheightcalc.value = math.sqrt(4 / math.pi * self.fracareacalc.value)
             self.fracwidthcalc.value = self.fracheightcalc.value

src/geophires_x/__init__.py

@@ -1 +1 @@
-__version__ = '3.10.14'
+__version__ = '3.10.15'

src/geophires_x_schema_generator/geophires-request.json

@@ -320,7 +320,16 @@
       "category": "Reservoir",
       "default": 10,
       "minimum": 1,
-      "maximum": 99999
+      "maximum": 1000000
+    },
+    "Number of Fractures per Stimulated Well": {
+      "description": "Number of identical parallel fractures per stimulated well in EGS fracture-based reservoir model. (Note that injection wells are assumed to be stimulated by default; production wells are assumed to be stimulated if Reservoir Stimulation Capital Cost per Production Well is provided.)",
+      "type": "integer",
+      "units": null,
+      "category": "Reservoir",
+      "default": 20,
+      "minimum": 1,
+      "maximum": 1000000
     },
     "Fracture Separation": {
       "description": "Separation of identical parallel fractures with uniform spatial distribution             in EGS fracture-based reservoir",

tests/geophires_x_tests/generic-egs-case-4_no-fractures-specified.txt

@@ -0,0 +1,61 @@
+Reservoir Model, 1
+Reservoir Volume Option, 1
+Reservoir Density, 2800
+Reservoir Heat Capacity, 790
+Reservoir Thermal Conductivity, 3.05
+Reservoir Porosity, 0.0118
+Reservoir Impedance, 0.001
+
+Fracture Shape, 4
+Fracture Height, 2000
+Fracture Width, 10000
+Fracture Separation, 30
+
+Number of Segments, 1
+
+Production Well Diameter, 7
+Injection Well Diameter, 7
+Well Separation, 365 feet
+Injection Temperature, 60 degC
+Injection Wellbore Temperature Gain, 3
+Plant Outlet Pressure, 1000 psi
+Ramey Production Wellbore Model, 1
+Utilization Factor, .9
+Water Loss Fraction, 0.05
+Maximum Drawdown, 1
+Ambient Temperature, 10 degC
+#Surface Temperature, 10 degC
+End-Use Option, 1
+
+Plant Lifetime, 25
+
+Circulation Pump Efficiency, 0.80
+
+Economic Model, 3
+Starting Electricity Sale Price, 0.15
+Ending Electricity Sale Price, 1.00
+Electricity Escalation Rate Per Year, 0.004053223
+Electricity Escalation Start Year, 1
+Fraction of Investment in Bonds, .5
+Combined Income Tax Rate, .3
+Gross Revenue Tax Rate, 0
+Inflated Bond Interest Rate, .05
+Inflated Equity Interest Rate, .08
+Inflation Rate, .02
+Investment Tax Credit Rate, .3, -- https://programs.dsireusa.org/system/program/detail/658
+Production Tax Credit Electricity, 0.0275, -- https://programs.dsireusa.org/system/program/detail/734
+Inflation Rate During Construction, 0.05
+Property Tax Rate, 0
+Time steps per year, 10
+Maximum Temperature, 500
+
+
+Print Output to Console, 0
+Surface Temperature, 12
+Reservoir Depth, 5.4
+Gradient 1, 36.7
+Power Plant Type, 4
+
+Number of Injection Wells, 54
+Number of Production Wells, 54
+Production Flow Rate per Well, 80

tests/geophires_x_tests/test_reservoir.py

@@ -10,6 +10,9 @@
 
 from geophires_x.GeoPHIRESUtils import static_pressure_MPa
 from geophires_x.Model import Model
+
+# noinspection PyProtectedMember
+from geophires_x.Reservoir import _MAX_ALLOWED_FRACTURES
 from geophires_x.Reservoir import Reservoir
 from geophires_x_client import GeophiresInputParameters
 from geophires_x_client import GeophiresXClient
@@ -228,3 +231,55 @@ def _get_result() -> GeophiresXResult:
 
         for k, v in expected.items():
             self.assertEqual(summary[k], v)
+
+    def test_number_of_fractures_per_stimulated_well(self):
+        def _get_result(
+            fracs_per_stimulated_well: int | None,
+            inj_wells: int,
+            prod_wells: int | None = None,
+            prod_wells_stimulated: bool = True,
+            fracs_total: int | None = None,
+        ) -> GeophiresXResult:
+            if prod_wells is None:
+                prod_wells = inj_wells
+
+            params = {
+                'Number of Production Wells': prod_wells,
+                'Number of Injection Wells': inj_wells,
+            }
+
+            if fracs_per_stimulated_well is not None:
+                params['Number of Fractures per Stimulated Well'] = fracs_per_stimulated_well
+
+            if fracs_total is not None:
+                params['Number of Fractures'] = fracs_total
+
+            if prod_wells_stimulated:
+                # stim cost per production well indicates prod wells are stimulated (cost doesn't matter for this test)
+                params['Reservoir Stimulation Capital Cost per Production Well'] = 1
+
+            return GeophiresXClient().get_geophires_result(
+                GeophiresInputParameters(
+                    from_file_path=self._get_test_file_path('generic-egs-case-4_no-fractures-specified.txt'),
+                    params=params,
+                )
+            )
+
+        r_102_per = _get_result(102, 59)
+        self.assertEqual(12_036, r_102_per.result['RESERVOIR PARAMETERS']['Number of fractures']['value'])
+
+        r_102_per_total_equivalent = _get_result(None, 59, fracs_total=12_036)
+        self.assertEqual(
+            12_036, r_102_per_total_equivalent.result['RESERVOIR PARAMETERS']['Number of fractures']['value']
+        )
+
+        r_102_per_inj = _get_result(102, 59, prod_wells_stimulated=False)
+        self.assertEqual(12_036 / 2, r_102_per_inj.result['RESERVOIR PARAMETERS']['Number of fractures']['value'])
+
+        with self.assertRaises(RuntimeError) as e:
+            _get_result(102, 59, fracs_total=12_036)
+        self.assertIn('provide only one', str(e.exception))
+
+        with self.assertRaises(RuntimeError) as e:
+            _get_result(_MAX_ALLOWED_FRACTURES, 59)
+        self.assertIn(f'({_MAX_ALLOWED_FRACTURES*59*2}) must not exceed {_MAX_ALLOWED_FRACTURES}', str(e.exception))