Merge pull request #175 from softwareengineerprogrammer/stimulation-cost-per-fracture-surface-area

Stimulation cost per fracture surface area [v3.15.2]

Author: softwareengineerprogrammer

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.15.0
+current_version = 3.15.2
 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.15.0
+    version: 3.15.2
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"

CHANGELOG.rst

@@ -8,7 +8,7 @@ GEOPHIRES v3 (2023-2026)
 3.15
 ^^^^
 
-3.15: `Calculate S-DAC carbon revenue (BICYCLE) <https://github.com/NREL/GEOPHIRES-X/pull/510>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.15.0>`__ | **Changed:** S-DAC carbon revenue is now calculated. See `the tracking issue <https://github.com/NatLabRockies/GEOPHIRES-X/issues/341>`__ for details.
+3.15: `Calculate S-DAC carbon revenue (BICYCLE); Reservoir Stimulation Capital Cost per Fracture Surface Area <https://github.com/NREL/GEOPHIRES-X/pull/510>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.15.2>`__ | **Changed:** S-DAC carbon revenue is now calculated. See `the tracking issue <https://github.com/NatLabRockies/GEOPHIRES-X/issues/341>`__ for details.
 
 3.14
 ^^^^

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.15.0.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.15.2.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.15.0...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.15.2...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://softwareengineerprogrammer.github.io/GEOPHIRES

docs/conf.py

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

setup.py

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

src/geophires_x/Economics.py

@@ -16,8 +16,9 @@
     project_payback_period_parameter, inflation_cost_during_construction_output_parameter, \
     interest_during_construction_output_parameter, total_capex_parameter_output_parameter, \
     overnight_capital_cost_output_parameter, CONSTRUCTION_CAPEX_SCHEDULE_PARAMETER_NAME, \
-    _YEAR_INDEX_VALUE_EXPLANATION_SNIPPET, investment_tax_credit_output_parameter, lcoh_output_parameter, lcoc_output_parameter
-from geophires_x.ParameterUtils import expand_schedule_dsl
+    _YEAR_INDEX_VALUE_EXPLANATION_SNIPPET, investment_tax_credit_output_parameter, lcoh_output_parameter, \
+    lcoc_output_parameter
+from geophires_x.ParameterUtils import expand_schedule_dsl, CALCULATED_PARAMETER_PLACEHOLDER_VALUE
 from geophires_x.GeoPHIRESUtils import quantity
 from geophires_x.OptionList import Configuration, WellDrillingCostCorrelation, EconomicModel, EndUseOptions, PlantType, \
     _WellDrillingCostCorrelationCitation
@@ -652,6 +653,8 @@ def __init__(self, model: Model):
                         f'For traditional hydrothermal reservoirs, this parameter should be set to $0.'
         )
 
+        before_stim_modifiers_note = f'before adjustment factor, indirect costs, and contingency'
+
         max_stimulation_cost_per_well_MUSD = 100
         self.stimulation_cost_per_injection_well = \
           self.ParameterDict[self.stimulation_cost_per_injection_well.Name] = floatParameter(
@@ -663,7 +666,7 @@ def __init__(self, model: Model):
             PreferredUnits=CurrencyUnit.MDOLLARS,
             CurrentUnits=CurrencyUnit.MDOLLARS,
             Provided=False,
-            ToolTipText='Reservoir stimulation capital cost per injection well before indirect costs and contingency'
+            ToolTipText=f'Reservoir stimulation capital cost per injection well {before_stim_modifiers_note}'
         )
 
         stimulation_cost_per_production_well_default_value_MUSD = 0
@@ -674,15 +677,30 @@ def __init__(self, model: Model):
           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,
+            Min=-1,
             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 before indirect costs and contingency'
+            ToolTipText=f'Reservoir stimulation capital cost per production well {before_stim_modifiers_note}'
                         f'{stimulation_cost_per_production_well_default_value_note}'
         )
 
+        self.stimulation_cost_per_fracture_surface_area = \
+          self.ParameterDict[self.stimulation_cost_per_fracture_surface_area.Name] = floatParameter(
+            'Reservoir Stimulation Capital Cost per Fracture Surface Area',
+            Min=0,
+            Max=1000,
+            DefaultValue=0.9,
+            UnitType=Units.COSTPERAREA,
+            PreferredUnits=CostPerAreaUnit.DOLLARSPERMETERS2,
+            CurrentUnits=CostPerAreaUnit.DOLLARSPERMETERS2,
+            ToolTipText=f'Direct reservoir stimulation cost per fracture surface area {before_stim_modifiers_note}. '
+                        f'By default, this applies only to injection wells. To include production wells, set '
+                        f'{self.stimulation_cost_per_production_well.Name} = {CALCULATED_PARAMETER_PLACEHOLDER_VALUE}.'
+        )
+
+        # noinspection SpellCheckingInspection
         self.ccstimadjfactor = self.ParameterDict[self.ccstimadjfactor.Name] = floatParameter(
             "Reservoir Stimulation Capital Cost Adjustment Factor",
             DefaultValue=1.0,
@@ -2822,6 +2840,8 @@ def _warn(_msg: str) -> None:
                     if sam_em_only_param.Provided:
                         raise NotImplementedError(f'{sam_em_only_param.Name} is only supported for SAM Economic Models')
 
+            self._validate_read_stimulation_cost_parameters(model)
+
         else:
             model.logger.info("No parameters read because no content provided")
 
@@ -2865,6 +2885,34 @@ def _set_ratio(frac: float) -> None:
 
         model.logger.info(f'complete {__class__!s}: {sys._getframe().f_code.co_name}')
 
+    def _validate_read_stimulation_cost_parameters(self, _model: Model) -> None:
+        def _raise_mutually_exclusive_error(param1: Parameter, param2: Parameter) -> None:
+            raise ValueError(f'Cannot provide both {param1.Name} and {param2.Name} parameters. ')
+
+        if self.stimulation_cost_per_fracture_surface_area.Provided:
+            if self.ccstimfixed.Provided:
+                _raise_mutually_exclusive_error(
+                    self.ccstimfixed,
+                    self.stimulation_cost_per_fracture_surface_area
+                )
+            if self.stimulation_cost_per_injection_well.Provided:
+                _raise_mutually_exclusive_error(
+                    self.stimulation_cost_per_injection_well,
+                    self.stimulation_cost_per_fracture_surface_area
+                )
+            if self.stimulation_cost_per_production_well.Provided and \
+                    self.stimulation_cost_per_production_well.value != \
+                    CALCULATED_PARAMETER_PLACEHOLDER_VALUE:  # Placeholder indicates production wells are stimulated
+                _raise_mutually_exclusive_error(
+                    self.stimulation_cost_per_production_well,
+                    self.stimulation_cost_per_fracture_surface_area
+                )
+        elif self.stimulation_cost_per_production_well.Provided and self.stimulation_cost_per_production_well.value < 0:
+            raise ValueError(f'{self.stimulation_cost_per_production_well.Name} must be positive')
+
+        # TODO validate fixed stimulation cost param mutual exclusivity with stim cost per well params (warn instead of
+        #  raising error for backwards compatibility where applicable)
+
     def sync_interest_rate(self, model):
         def discount_rate_display() -> str:
             return str(self.discountrate.quantity()).replace(' dimensionless', '')
@@ -3099,6 +3147,7 @@ def calculate_wellfield_costs(self, model: Model) -> None:
 
     def calculate_stimulation_costs(self, model: Model) -> PlainQuantity:
         production_wells_stimulated: bool = self.stimulation_cost_per_production_well.Provided
+
         if self.ccstimfixed.Valid:
             stimulation_costs_cstim_u = self.ccstimfixed.quantity().to(self.Cstim.CurrentUnits).magnitude
 
@@ -3122,6 +3171,39 @@ def calculate_stimulation_costs(self, model: Model) -> PlainQuantity:
 
             ret = quantity(stimulation_costs_cstim_u, self.Cstim.CurrentUnits)
         else:
+            if self.stimulation_cost_per_fracture_surface_area.Provided:
+                total_fracture_surface_area_q = (model.reserv.fracareacalc.quantity() * model.reserv.fracnumbcalc.value).to(
+                    self.stimulation_cost_per_fracture_surface_area.CurrentUnits.get_area_unit_str())
+                direct_stim_cost_q = (total_fracture_surface_area_q *
+                                      self.stimulation_cost_per_fracture_surface_area.quantity())
+                inj_to_prod_cost_ratio = 1 if not production_wells_stimulated else \
+                    model.wellbores.ninj.value / (model.wellbores.nprod.value + model.wellbores.ninj.value)
+
+                # Coerces equal injection and production well costs required for stimulation cost per well output
+                # display heuristic
+                per_well_cost_precision = 3
+
+                self.stimulation_cost_per_injection_well.value = round(
+                    quantity(
+                        inj_to_prod_cost_ratio * direct_stim_cost_q / model.wellbores.ninj.value,
+                        self.stimulation_cost_per_fracture_surface_area.CurrentUnits.get_currency_unit_str()
+                    ).to(self.stimulation_cost_per_injection_well.CurrentUnits).magnitude,
+                    per_well_cost_precision
+                )
+
+                self.stimulation_cost_per_production_well.value = round(
+                    quantity(
+                        (1 - inj_to_prod_cost_ratio) * direct_stim_cost_q / model.wellbores.nprod.value,
+                        self.stimulation_cost_per_fracture_surface_area.CurrentUnits.get_currency_unit_str()
+                    ).to(self.stimulation_cost_per_production_well.CurrentUnits).magnitude,
+                    per_well_cost_precision
+                )
+
+                # In an ideal world we might use separate calculated values instead of mutating
+                # stimulation_cost_per_injection_well and stimulation_cost_per_production_well above. But the current
+                # pattern is OK for now and nominally captures the fact that the value is mutated internally by
+                # virtue of the Provided attribute remaining False.
+
             direct_stim_cost_per_injection_well_cstim_u = self.stimulation_cost_per_injection_well.quantity().to(
                 self.Cstim.CurrentUnits).magnitude
             direct_stim_cost_per_production_well_cstim_u = self.stimulation_cost_per_production_well.quantity().to(

src/geophires_x/ParameterUtils.py

@@ -11,6 +11,8 @@
 
 COMMENT_PARAMETER_NAME_PREFIX: str = '_COMMENT-'
 
+CALCULATED_PARAMETER_PLACEHOLDER_VALUE = -1
+
 
 def expand_schedule_dsl(
     schedule_strings: list[str | float], total_years: int, allow_schedule_length_to_exceed_total_years: bool = False

src/geophires_x/Units.py

@@ -88,6 +88,7 @@ class Units(IntEnum):
     DECAY_RATE = auto()
     INFLATION_RATE = auto()
     DYNAMIC_VISCOSITY = auto()
+    COSTPERAREA = auto()
 
 
 class AngleUnit(str, Enum):
@@ -243,6 +244,15 @@ class CostPerDistanceUnit(str, Enum):
     DOLLARSPERM = "USD/m"
 
 
+class CostPerAreaUnit(str, Enum):
+    DOLLARSPERMETERS2 = "USD/m**2"
+
+    def get_currency_unit_str(self) -> str:
+        return self.value.split('/')[0]
+
+    def get_area_unit_str(self) -> str:
+        return self.value.split('/')[1]
+
 class PressureUnit(str, Enum):
     """Pressure Units"""
     MPASCAL = "MPa"

src/geophires_x/__init__.py

@@ -1 +1 @@
-__version__ = '3.15.0'
+__version__ = '3.15.2'