Merge pull request NREL#399 from softwareengineerprogrammer/main

Parameterize Reservoir Stimulation Capital Cost per well [v3.9.33]

Author: softwareengineerprogrammer

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.9.31
+current_version = 3.9.33
 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.9.31
+    version: 3.9.33
     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.9.31.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.9.33.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.31...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.33...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.9.31'
+version = release = '3.9.33'
 
 pygments_style = 'trac'
 templates_path = ['./templates']

setup.py

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

src/geophires_x/Economics.py

@@ -572,6 +572,7 @@ def __init__(self, model: Model):
             ToolTipText="Specify the economic model to calculate the levelized cost of energy. " +
                         '; '.join([f'{it.int_value}: {it.value}' for it in EconomicModel])
         )
+
         self.ccstimfixed = self.ParameterDict[self.ccstimfixed.Name] = floatParameter(
             "Reservoir Stimulation Capital Cost",
             DefaultValue=-1.0,
@@ -584,6 +585,38 @@ def __init__(self, model: Model):
             Valid=False,
             ToolTipText="Total reservoir stimulation capital cost"
         )
+
+        max_stimulation_cost_per_well_MUSD = 100
+        self.stimulation_cost_per_injection_well = \
+          self.ParameterDict[self.stimulation_cost_per_injection_well.Name] = floatParameter(
+            'Reservoir Stimulation Capital Cost per Injection Well',
+            DefaultValue=1.25,
+            Min=0,
+            Max=max_stimulation_cost_per_well_MUSD,
+            UnitType=Units.CURRENCY,
+            PreferredUnits=CurrencyUnit.MDOLLARS,
+            CurrentUnits=CurrencyUnit.MDOLLARS,
+            Provided=False,
+            ToolTipText='Reservoir stimulation capital cost per injection well'
+        )
+
+        stimulation_cost_per_production_well_default_value_MUSD = 0
+        stimulation_cost_per_production_well_default_value_note = \
+            '. By default, only the injection wells are assumed to be stimulated unless this parameter is provided.' \
+                if stimulation_cost_per_production_well_default_value_MUSD == 0 else ''
+        self.stimulation_cost_per_production_well = \
+          self.ParameterDict[self.stimulation_cost_per_production_well.Name] = floatParameter(
+            'Reservoir Stimulation Capital Cost per Production Well',
+            DefaultValue=stimulation_cost_per_production_well_default_value_MUSD,
+            Min=0,
+            Max=max_stimulation_cost_per_well_MUSD,
+            UnitType=Units.CURRENCY,
+            PreferredUnits=CurrencyUnit.MDOLLARS,
+            CurrentUnits=CurrencyUnit.MDOLLARS,
+            ToolTipText=f'Reservoir stimulation capital cost per production well'
+                        f'{stimulation_cost_per_production_well_default_value_note}'
+        )
+
         self.ccstimadjfactor = self.ParameterDict[self.ccstimadjfactor.Name] = floatParameter(
             "Reservoir Stimulation Capital Cost Adjustment Factor",
             DefaultValue=1.0,
@@ -594,7 +627,7 @@ def __init__(self, model: Model):
             CurrentUnits=PercentUnit.TENTH,
             Provided=False,
             Valid=True,
-            ToolTipText="Multiplier for built-in reservoir stimulation capital cost correlation"
+            ToolTipText="Multiplier for reservoir stimulation capital cost correlation"
         )
         self.ccexplfixed = self.ParameterDict[self.ccexplfixed.Name] = floatParameter(
             "Exploration Capital Cost",
@@ -1606,19 +1639,27 @@ def __init__(self, model: Model):
         )
 
         # TODO https://github.com/NREL/GEOPHIRES-X/issues/383?title=Parameterize+indirect+cost+factor
-        contingency_and_indirect_costs_tooltip = 'plus 15% contingency plus 12% indirect costs'
+        stimulation_contingency_and_indirect_costs_tooltip = 'plus 15% contingency plus 5% indirect costs'
 
         # noinspection SpellCheckingInspection
         self.Cstim = self.OutputParameterDict[self.Cstim.Name] = OutputParameter(
             Name="Stimulation costs",
             UnitType=Units.CURRENCY,
             PreferredUnits=CurrencyUnit.MDOLLARS,
             CurrentUnits=CurrencyUnit.MDOLLARS,
-            ToolTipText=f'Default correlation: $1.25M per injection well {contingency_and_indirect_costs_tooltip}. '
-                        f'Provide {self.ccstimadjfactor.Name} to multiply the default correlation. '
-                        f'Provide {self.ccstimfixed.Name} to override the default correlation and set your own cost.'
+            ToolTipText=f'Default correlation: ${self.stimulation_cost_per_injection_well.value}M '
+                        f'per injection well {stimulation_contingency_and_indirect_costs_tooltip}. '
+                        f'Provide {self.stimulation_cost_per_injection_well.Name} and '
+                        f'{self.stimulation_cost_per_production_well.Name} to set the correlation '
+                        f'costs per well. '
+                        f'Provide {self.ccstimadjfactor.Name} to multiply the correlation-calculated cost. '
+                        f'Provide {self.ccstimfixed.Name} to override the correlation and set your own '
+                        f'total stimulation cost.'
         )
 
+        # TODO https://github.com/NREL/GEOPHIRES-X/issues/383?title=Parameterize+indirect+cost+factor
+        contingency_and_indirect_costs_tooltip = 'plus 15% contingency plus 12% indirect costs'
+
         # See TODO re:parameterizing indirect costs at src/geophires_x/Economics.py:652
         #    (https://github.com/NREL/GEOPHIRES-X/issues/383)
         self.Cexpl = self.OutputParameterDict[self.Cexpl.Name] = OutputParameter(
@@ -2336,12 +2377,18 @@ def Calculate(self, model: Model) -> None:
         if self.ccstimfixed.Valid:
             self.Cstim.value = self.ccstimfixed.value
         else:
-            base_stimulation_cost_MUSD_per_injection_well = 1.25  # TODO parameterize
+            stim_cost_per_injection_well = self.stimulation_cost_per_injection_well.quantity().to(
+                self.Cstim.CurrentUnits).magnitude
+            stim_cost_per_production_well = self.stimulation_cost_per_production_well.quantity().to(
+                self.Cstim.CurrentUnits).magnitude
 
             # 1.15 for 15% contingency and 1.05 for 5% indirect costs
             # TODO https://github.com/NREL/GEOPHIRES-X/issues/383?title=Parameterize+indirect+cost+factor
-            self.Cstim.value = (base_stimulation_cost_MUSD_per_injection_well * self.ccstimadjfactor.value
-                                * model.wellbores.ninj.value
+            self.Cstim.value = ((
+                                 stim_cost_per_injection_well * model.wellbores.ninj.value
+                                 + stim_cost_per_production_well * model.wellbores.nprod.value
+                                )
+                                * self.ccstimadjfactor.value
                                 * 1.05 * 1.15)
 
         # field gathering system costs (M$)

src/geophires_x/MPFReservoir.py

@@ -67,7 +67,7 @@ def Calculate(self, model: Model):
         :type model: :class:`~geophires_x.Model.Model`
         :return: None
         """
-        model.logger.info("Init " + str(__class__) + ": " + sys._getframe().f_code.co_name)
+        model.logger.info(f'Init {str(__class__)}: {sys._getframe().f_code.co_name}')
         super().Calculate(model)  # run calculate for the parent.
 
         # convert flowrate to volumetric rate
@@ -90,14 +90,15 @@ def Calculate(self, model: Model):
             for t in range(1, len(model.reserv.timevector.value)):
                 Twnd = Twnd + [float(invertlaplace(fp, td[t], method='stehfest'))]
         except:
-            print(
-                "Error: GEOPHIRES could not execute numerical inverse laplace calculation for reservoir model 1. Simulation will abort.")
-            sys.exit()
+            msg = ('Error: GEOPHIRES could not execute numerical inverse laplace calculation for reservoir model 1. '
+                   'Simulation will abort.')
+            print(msg)
+            raise RuntimeError(msg)
 
         Twnd = np.asarray(Twnd)
 
         # calculate dimensional temperature, add initial rock temperature to beginning of array
         model.reserv.Tresoutput.value = model.reserv.Trock.value - (Twnd * (model.reserv.Trock.value - model.wellbores.Tinj.value))
         model.reserv.Tresoutput.value = np.append([model.reserv.Trock.value], model.reserv.Tresoutput.value)
 
-        model.logger.info("Complete " + str(__class__) + ": " + sys._getframe().f_code.co_name)
+        model.logger.info(f'Complete {str(__class__)}: {sys._getframe().f_code.co_name}')

src/geophires_x/Outputs.py

@@ -478,7 +478,7 @@ def PrintOutputs(self, model: Model):
                 if model.economics.totalcapcost.Valid and model.wellbores.redrill.value > 0:
                     f.write(f'         Drilling and completion costs (for redrilling):{model.economics.Cwell.value:10.2f} ' + model.economics.Cwell.CurrentUnits.value + NL)
                     f.write(f'      Drilling and completion costs per redrilled well: {(model.economics.Cwell.value/(model.wellbores.nprod.value+model.wellbores.ninj.value)):10.2f} ' + model.economics.Cwell.CurrentUnits.value + NL)
-                    f.write(f'         Stimulation costs (for redrilling):            {model.economics.Cstim.value:10.2f} ' + model.economics.Cstim.CurrentUnits.value + NL)
+                    f.write(f'         Stimulation costs (for redrilling):            {econ.Cstim.value:10.2f} {econ.Cstim.CurrentUnits.value}\n')
                 if model.economics.RITCValue.value:
                     f.write(f'         {model.economics.RITCValue.display_name}:                         {-1*model.economics.RITCValue.value:10.2f} {model.economics.RITCValue.CurrentUnits.value}\n')
 

src/geophires_x/WellBores.py

@@ -824,17 +824,28 @@ def __init__(self, model: Model):
                         'production well, this parameter specifies the overall pressure drop in the reservoir between '
                         'injection well and production well (see docs)'
         )
+
+        well_separation_default_value_m = 1000
+        well_separation_default_unit = LengthUnit.INCHES
+        well_separation_preferred_unit = LengthUnit.METERS
+        well_separation_unit_mismatch_note = (f'. (Note that the default unit is '
+                                              f'{well_separation_default_unit.name.lower()}.)'
+                                              if well_separation_default_unit != well_separation_preferred_unit else '')
+        # noinspection SpellCheckingInspection
         self.wellsep = self.ParameterDict[self.wellsep.Name] = floatParameter(
             "Well Separation",
-            DefaultValue=1000.0,
+            DefaultValue=int(quantity(well_separation_default_value_m, 'm')
+                             .to(well_separation_default_unit.value).magnitude),
             Min=10.,
-            Max=10000.,
+            Max=int(quantity(10000, 'm').to(well_separation_default_unit.value).magnitude),
             UnitType=Units.LENGTH,
-            PreferredUnits=LengthUnit.METERS,
-            CurrentUnits=LengthUnit.INCHES,
-            ErrMessage="assume default well separation (1000 m)",
-            ToolTipText="Well separation for built-in TOUGH2 doublet reservoir model"
+            PreferredUnits=well_separation_preferred_unit,
+            CurrentUnits=well_separation_default_unit,
+            ErrMessage=f'assume default well separation ({well_separation_default_value_m} m)',
+            ToolTipText=f'Well separation for built-in TOUGH2 doublet reservoir model'
+                        f'{well_separation_unit_mismatch_note}'
         )
+
         self.Tinj = self.ParameterDict[self.Tinj.Name] = floatParameter(
             "Injection Temperature",
             DefaultValue=70.0,

src/geophires_x/__init__.py

@@ -1 +1 @@
-__version__ = '3.9.31'
+__version__ = '3.9.33'