Merge pull request NREL#412 from softwareengineerprogrammer/main

softwareengineerprogrammer · web-flow · commit efc5aa95801b · 2025-08-02T13:46:59.000-07:00
Well diameter outputs, surface plant cost, non-SAM-EM Inflation costs during construction [v3.9.48]
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.9.47
+current_version = 3.9.48
 commit = True
 tag = True
 
diff --git a/.cookiecutterrc b/.cookiecutterrc
@@ -54,7 +54,7 @@ default_context:
     sphinx_doctest: "no"
     sphinx_theme: "sphinx-py3doc-enhanced-theme"
     test_matrix_separate_coverage: "no"
-    version: 3.9.47
+    version: 3.9.48
     version_manager: "bump2version"
     website: "https://github.com/NREL"
     year_from: "2023"
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -8,6 +8,8 @@ GEOPHIRES v3 (2023-2025)
 3.9
 ^^^
 
+3.9.48: `Well diameter outputs, surface plant cost, non-SAM-EM Inflation costs during construction <https://github.com/NREL/GEOPHIRES-X/pull/412>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.48>`__
+
 3.9.47: `Add-Ons support for SAM Economic Models <https://nrel.github.io/GEOPHIRES-X/SAM-Economic-Models.html#add-ons>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.47>`__
 
 3.9.43: `Inflation costs <https://github.com/NREL/GEOPHIRES-X/pull/409>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.43>`__
diff --git a/README.rst b/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.47.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.9.48.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.47...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.9.48...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,7 +18,7 @@
 year = '2025'
 author = 'NREL'
 copyright = f'{year}, {author}'
-version = release = '3.9.47'
+version = release = '3.9.48'
 
 pygments_style = 'trac'
 templates_path = ['./templates']
diff --git a/setup.py b/setup.py
@@ -13,7 +13,7 @@ def read(*names, **kwargs):
 
 setup(
     name='geophires-x',
-    version='3.9.47',
+    version='3.9.48',
     license='MIT',
     description='GEOPHIRES is a free and open-source geothermal techno-economic simulator.',
     long_description='{}\n{}'.format(
diff --git a/src/geophires_x/AGSWellBores.py b/src/geophires_x/AGSWellBores.py
@@ -1028,6 +1028,8 @@ def Calculate(self, model: Model) -> None:
             # (b/c we are not generating electricity) = thermosiphon is happening!
             self.PumpingPower.value = [max(x, 0.) for x in self.PumpingPower.value]
 
+        self._sync_output_params_from_input_params()
+
         model.logger.info(f'complete {str(__class__)}: {sys._getframe().f_code.co_name}')
 
     def __str__(self):
diff --git a/src/geophires_x/Economics.py b/src/geophires_x/Economics.py
diff --git a/src/geophires_x/EconomicsUtils.py b/src/geophires_x/EconomicsUtils.py
@@ -139,8 +139,8 @@ def total_capex_parameter_output_parameter() -> OutputParameter:
         UnitType=Units.CURRENCY,
         CurrentUnits=CurrencyUnit.MDOLLARS,
         PreferredUnits=CurrencyUnit.MDOLLARS,
-        ToolTipText="The total capital expenditure (CAPEX) required to construct the plant. "
-                    "This value includes all direct and indirect costs, contingency, and any cost escalation from "
-                    "inflation during construction. It is used as the total installed cost input for "
-                    "SAM Economic Models."
+        ToolTipText='The total capital expenditure (CAPEX) required to construct the plant. '
+                    'This value includes all direct and indirect costs, and contingency. '
+                    'For SAM Economic models, it also includes any cost escalation from inflation during construction. '
+                    'It is used as the total installed cost input for SAM Economic Models.'
     )
diff --git a/src/geophires_x/Outputs.py b/src/geophires_x/Outputs.py
@@ -274,6 +274,20 @@ def PrintOutputs(self, model: Model):
                 acf_label = Outputs._field_label(acf.display_name, 49)
                 f.write(f'      {acf_label}{acf.value:10.2f} {acf.CurrentUnits.value}\n')
 
+                display_inflation_costs_in_economic_parameters: bool = (
+                    econ.econmodel.value in [EconomicModel.BICYCLE,
+                                             EconomicModel.FCR,
+                                             EconomicModel.STANDARDIZED_LEVELIZED_COST]
+                    and
+                    econ.inflation_cost_during_construction.value != 0.
+                )
+                if display_inflation_costs_in_economic_parameters:
+                    # Inflation cost is displayed here for economic models that don't treat inflation cost as a
+                    # capital cost
+                    icc: OutputParameter = econ.inflation_cost_during_construction
+                    icc_label = Outputs._field_label(icc.display_name, 49)
+                    f.write(f'      {icc_label}{icc.value:10.2f} {icc.CurrentUnits.value}\n')
+
                 f.write(f'      Project lifetime:                              {model.surfaceplant.plant_lifetime.value:10.0f} {model.surfaceplant.plant_lifetime.CurrentUnits.value}\n')
                 f.write(f'      Capacity factor:                                 {model.surfaceplant.utilization_factor.value * 100:10.1f} %\n')
 
@@ -327,8 +341,8 @@ def PrintOutputs(self, model: Model):
                     f.write('      User-provided production well temperature drop\n')
                     f.write(f'      Constant production well temperature drop:       {model.wellbores.tempdropprod.value:10.1f} ' + model.wellbores.tempdropprod.PreferredUnits.value + NL)
                 f.write(f'      Flowrate per production well:                    {model.wellbores.prodwellflowrate.value:10.1f} ' + model.wellbores.prodwellflowrate.CurrentUnits.value + NL)
-                f.write(f'      Injection well casing ID:                          {model.wellbores.injwelldiam.value:10.3f} ' + model.wellbores.injwelldiam.CurrentUnits.value + NL)
-                f.write(f'      Production well casing ID:                         {model.wellbores.prodwelldiam.value:10.3f} ' + model.wellbores.prodwelldiam.CurrentUnits.value + NL)
+                f.write(f'      {model.wellbores.injection_well_casing_inner_diameter.display_name}:                          {model.wellbores.injection_well_casing_inner_diameter.value:10.3f} {model.wellbores.injection_well_casing_inner_diameter.CurrentUnits.value}\n')
+                f.write(f'      {model.wellbores.production_well_casing_inner_diameter.display_name}:                         {model.wellbores.production_well_casing_inner_diameter.value:10.3f} {model.wellbores.production_well_casing_inner_diameter.CurrentUnits.value}\n')
                 f.write(f'      {model.wellbores.redrill.display_name}:                    {model.wellbores.redrill.value:10.0f}\n')
                 if model.surfaceplant.enduse_option.value in [EndUseOptions.ELECTRICITY, EndUseOptions.COGENERATION_TOPPING_EXTRA_HEAT, EndUseOptions.COGENERATION_TOPPING_EXTRA_ELECTRICITY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_ELECTRICITY, EndUseOptions.COGENERATION_BOTTOMING_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_HEAT, EndUseOptions.COGENERATION_PARALLEL_EXTRA_ELECTRICITY]:
                     f.write('      Power plant type:                                       ' + str(model.surfaceplant.plant_type.value.value) + NL)
@@ -497,8 +511,8 @@ def PrintOutputs(self, model: Model):
                         #  expenditure.
                         pass
 
-                if is_sam_econ_model:
-                    # TODO calculate & display for other economic models
+                display_inflation_during_construction_in_capital_costs = is_sam_econ_model
+                if display_inflation_during_construction_in_capital_costs:
                     icc_label = Outputs._field_label(econ.inflation_cost_during_construction.display_name, 47)
                     f.write(f'         {icc_label}{econ.inflation_cost_during_construction.value:10.2f} {econ.inflation_cost_during_construction.CurrentUnits.value}\n')
 
diff --git a/src/geophires_x/SBTWellbores.py b/src/geophires_x/SBTWellbores.py
@@ -286,6 +286,8 @@ def Calculate(self, model: Model) -> None:
         # (b/c we are not generating electricity) = thermosiphon is happening!
         self.PumpingPower.value = [max(x, 0.) for x in self.PumpingPower.value]
 
+        self._sync_output_params_from_input_params()
+
         model.logger.info(f'complete {str(__class__)}: {sys._getframe().f_code.co_name}')
 
     def CalculateNonverticalPressureDrop(self, model, value, time_max, al):
diff --git a/src/geophires_x/SUTRAOutputs.py b/src/geophires_x/SUTRAOutputs.py
@@ -104,8 +104,8 @@ def PrintOutputs(self, model: Model):
                 f.write(f'      Pump efficiency:                               {pump_efficiency_display}{NL}')
 
                 f.write(f"      Lifetime Average Well Flow Rate:               {np.average(abs(model.wellbores.ProductionWellFlowRates.value)):10.1f} "  + model.wellbores.ProductionWellFlowRates.CurrentUnits.value + NL)
-                f.write(f"      Injection well casing ID:                      {model.wellbores.injwelldiam.value:10.3f} " + model.wellbores.injwelldiam.CurrentUnits.value + NL)
-                f.write(f"      Production well casing ID:                     {model.wellbores.prodwelldiam.value:10.3f} " + model.wellbores.prodwelldiam.CurrentUnits.value + NL)
+                f.write(f'      {model.wellbores.injection_well_casing_inner_diameter.display_name}:                          {model.wellbores.injection_well_casing_inner_diameter.value:10.3f} {model.wellbores.injection_well_casing_inner_diameter.CurrentUnits.value}\n')
+                f.write(f'      {model.wellbores.production_well_casing_inner_diameter.display_name}:                         {model.wellbores.production_well_casing_inner_diameter.value:10.3f} {model.wellbores.production_well_casing_inner_diameter.CurrentUnits.value}\n')
                 f.write(NL)
                 f.write(NL)
                 f.write("                           ***RESERVOIR SIMULATION RESULTS***" + NL)
diff --git a/src/geophires_x/SUTRAWellBores.py b/src/geophires_x/SUTRAWellBores.py
@@ -342,4 +342,6 @@ def Calculate(self, model: Model) -> None:
             / model.surfaceplant.pump_efficiency.value
         )
 
-        model.logger.info("complete " + str(__class__) + ": " + sys._getframe().f_code.co_name)
+        self._sync_output_params_from_input_params()
+
+        model.logger.info(f'complete {str(__class__)}: {sys._getframe().f_code.co_name}')
diff --git a/src/geophires_x/WellBores.py b/src/geophires_x/WellBores.py
@@ -3,7 +3,7 @@
 from pint.facets.plain import PlainQuantity
 
 from .Parameter import floatParameter, intParameter, boolParameter, OutputParameter, ReadParameter, \
-    coerce_int_params_to_enum_values
+    coerce_int_params_to_enum_values, Parameter
 from geophires_x.GeoPHIRESUtils import vapor_pressure_water_kPa, quantity, static_pressure_MPa
 from geophires_x.GeoPHIRESUtils import density_water_kg_per_m3
 from geophires_x.GeoPHIRESUtils import viscosity_water_Pa_sec
@@ -738,6 +738,7 @@ def __init__(self, model: Model):
                         "same value."
         )
 
+        # noinspection SpellCheckingInspection
         self.prodwelldiam = self.ParameterDict[self.prodwelldiam.Name] = floatParameter(
             "Production Well Diameter",
             DefaultValue=8.0,
@@ -748,9 +749,10 @@ def __init__(self, model: Model):
             CurrentUnits=LengthUnit.INCHES,
             Required=True,
             ErrMessage="assume default production well diameter (8 inch)",
-            ToolTipText="Inner diameter of production wellbore (assumed constant along the wellbore) to calculate \
-            frictional pressure drop and wellbore heat transmission with Rameys model"
+            ToolTipText='Inner diameter of production wellbore (assumed constant along the wellbore) to calculate '
+                        'frictional pressure drop and wellbore heat transmission with Rameys model'
         )
+        # noinspection SpellCheckingInspection
         self.injwelldiam = self.ParameterDict[self.injwelldiam.Name] = floatParameter(
             "Injection Well Diameter",
             DefaultValue=8.0,
@@ -761,8 +763,8 @@ def __init__(self, model: Model):
             CurrentUnits=LengthUnit.INCHES,
             Required=True,
             ErrMessage="assume default injection well diameter (8 inch)",
-            ToolTipText="Inner diameter of production wellbore (assumed constant along the wellbore) to calculate "
-                        "frictional pressure drop and wellbore heat transmission with Rameys model"
+            ToolTipText='Inner diameter of injection wellbore (assumed constant along the wellbore) to calculate '
+                        'frictional pressure drop and wellbore heat transmission with Rameys model'
         )
         self.rameyoptionprod = self.ParameterDict[self.rameyoptionprod.Name] = boolParameter(
             "Ramey Production Wellbore Model",
@@ -1097,6 +1099,21 @@ def __init__(self, model: Model):
         self.MyPath = __file__
 
         # Results - used by other objects or printed in output downstream
+
+        self.injection_well_casing_inner_diameter = self.OutputParameterDict[self.injection_well_casing_inner_diameter.Name] = OutputParameter(
+            Name='Injection well casing ID',
+            UnitType=self.injwelldiam.UnitType,
+            PreferredUnits=self.injwelldiam.PreferredUnits,
+            CurrentUnits=self.injwelldiam.CurrentUnits,
+            ToolTipText=self.injwelldiam.ToolTipText,
+        )
+        self.production_well_casing_inner_diameter = self.OutputParameterDict[self.production_well_casing_inner_diameter.Name] = OutputParameter(
+            Name='Production well casing ID',
+            UnitType=self.prodwelldiam.UnitType,
+            PreferredUnits=self.prodwelldiam.PreferredUnits,
+            CurrentUnits=self.prodwelldiam.CurrentUnits,
+            ToolTipText=self.prodwelldiam.ToolTipText,
+        )
         self.production_reservoir_pressure = self.OutputParameterDict[self.production_reservoir_pressure.Name] = OutputParameter(
             Name="Calculated Reservoir Pressure",
             value=self.Phydrostatic.value,
@@ -1537,4 +1554,19 @@ def Calculate(self, model: Model) -> None:
             # negative pumping power values become zero (b/c we are not generating electricity)
             self.PumpingPower.value = [0. if x < 0. else x for x in self.PumpingPower.value]
 
+        self._sync_output_params_from_input_params()
+
         model.logger.info(f'complete {self.__class__.__name__}: {__name__}')
+
+    def _sync_output_params_from_input_params(self) -> None:
+        """
+        Handles setting output parameters whose values are based on 1:1 corresponding input parameters.
+        """
+
+        def _set_output_param_from_input_param(input_param: Parameter, output_param: OutputParameter) -> None:
+            output_param.value = input_param.quantity().to(output_param.CurrentUnits).magnitude
+
+        # Injection/production well casing ID have same value as inputs but exist as separate output parameters due to
+        # having a different display name.
+        _set_output_param_from_input_param(self.injwelldiam, self.injection_well_casing_inner_diameter)
+        _set_output_param_from_input_param(self.prodwelldiam, self.production_well_casing_inner_diameter)
diff --git a/src/geophires_x/__init__.py b/src/geophires_x/__init__.py
@@ -1 +1 @@
-__version__ = '3.9.47'
+__version__ = '3.9.48'
diff --git a/src/geophires_x_client/geophires_x_result.py b/src/geophires_x_client/geophires_x_result.py
@@ -79,6 +79,8 @@ class GeophiresXResult:
                 'Nominal Discount Rate',
                 'WACC',
                 'Accrued financing during construction',
+                # Displayed for economic models that don't treat inflation costs as capital costs (non-SAM-EM)
+                'Inflation costs during construction',
                 'Project lifetime',
                 'Capacity factor',
                 'Project NPV',
@@ -261,6 +263,7 @@ class GeophiresXResult:
                 'Total surface equipment costs',
                 'Exploration costs',
                 'Investment Tax Credit',
+                # Displayed for economic models that treat inflation costs as capital costs (SAM-EM)
                 'Inflation costs during construction',
                 'Total Add-on CAPEX',
                 'Total capital costs',
diff --git a/src/geophires_x_schema_generator/geophires-request.json b/src/geophires_x_schema_generator/geophires-request.json
@@ -1510,7 +1510,7 @@
       "category": "Economics",
       "default": -1.0,
       "minimum": 0,
-      "maximum": 1000
+      "maximum": 10000
     },
     "Surface Plant Capital Cost Adjustment Factor": {
       "description": "Multiplier for built-in surface plant capital cost correlation",
diff --git a/src/geophires_x_schema_generator/geophires-result.json b/src/geophires_x_schema_generator/geophires-result.json
@@ -20,7 +20,7 @@
         },
         "Total CAPEX": {
           "type": "number",
-          "description": "The total capital expenditure (CAPEX) required to construct the plant. This value includes all direct and indirect costs, contingency, and any cost escalation from inflation during construction. It is used as the total installed cost input for SAM Economic Models.",
+          "description": "The total capital expenditure (CAPEX) required to construct the plant. This value includes all direct and indirect costs, and contingency. For SAM Economic models, it also includes any cost escalation from inflation during construction. It is used as the total installed cost input for SAM Economic Models.",
           "units": "MUSD"
         },
         "Average Direct-Use Heat Production": {},
@@ -100,6 +100,11 @@
           "description": "The accrued inflation on total capital costs over the construction period, as defined by Inflation Rate During Construction. For SAM Economic Models, this is calculated automatically by compounding Inflation Rate over Construction Years if Inflation Rate During Construction is not provided.",
           "units": "%"
         },
+        "Inflation costs during construction": {
+          "type": "number",
+          "description": "The calculated amount of cost escalation due to inflation over the construction period.",
+          "units": "MUSD"
+        },
         "Project lifetime": {},
         "Capacity factor": {},
         "Project NPV": {
@@ -212,8 +217,16 @@
         },
         "Average production well temperature drop": {},
         "Flowrate per production well": {},
-        "Injection well casing ID": {},
-        "Production well casing ID": {},
+        "Injection well casing ID": {
+          "type": "number",
+          "description": "Inner diameter of injection wellbore (assumed constant along the wellbore) to calculate frictional pressure drop and wellbore heat transmission with Rameys model",
+          "units": "in"
+        },
+        "Production well casing ID": {
+          "type": "number",
+          "description": "Inner diameter of production wellbore (assumed constant along the wellbore) to calculate frictional pressure drop and wellbore heat transmission with Rameys model",
+          "units": "in"
+        },
         "Number of times redrilling": {
           "type": "number",
           "description": "redrill",
@@ -424,7 +437,7 @@
         "Annualized capital costs": {},
         "Total CAPEX": {
           "type": "number",
-          "description": "The total capital expenditure (CAPEX) required to construct the plant. This value includes all direct and indirect costs, contingency, and any cost escalation from inflation during construction. It is used as the total installed cost input for SAM Economic Models.",
+          "description": "The total capital expenditure (CAPEX) required to construct the plant. This value includes all direct and indirect costs, and contingency. For SAM Economic models, it also includes any cost escalation from inflation during construction. It is used as the total installed cost input for SAM Economic Models.",
           "units": "MUSD"
         },
         "Drilling Cost": {},
diff --git a/tests/examples/Fervo_Norbeck_Latimer_2023.out b/tests/examples/Fervo_Norbeck_Latimer_2023.out
@@ -4,10 +4,10 @@
 
 Simulation Metadata
 ----------------------
- GEOPHIRES Version: 3.9.28
- Simulation Date: 2025-07-02
- Simulation Time:  12:19
- Calculation Time:      0.481 sec
+ GEOPHIRES Version: 3.9.47
+ Simulation Date: 2025-07-31
+ Simulation Time:  08:57
+ Calculation Time:      0.475 sec
 
                            ***SUMMARY OF RESULTS***
 
@@ -24,7 +24,8 @@ Simulation Metadata
                            ***ECONOMIC PARAMETERS***
 
       Economic Model = BICYCLE
-      Accrued financing during construction:                  5.00 %
+      Accrued financing during construction:                 5.00 %
+      Inflation costs during construction:                   1.41 MUSD
       Project lifetime:                                      10 yr
       Capacity factor:                                       90.0 %
       Project NPV:                                         -13.03 MUSD
diff --git a/tests/examples/Fervo_Project_Cape-2.out b/tests/examples/Fervo_Project_Cape-2.out
diff --git a/tests/examples/Fervo_Project_Cape-3.out b/tests/examples/Fervo_Project_Cape-3.out
diff --git a/tests/examples/Fervo_Project_Cape.out b/tests/examples/Fervo_Project_Cape.out
diff --git a/tests/examples/example10_HP.out b/tests/examples/example10_HP.out
diff --git a/tests/examples/example11_AC.out b/tests/examples/example11_AC.out
diff --git a/tests/examples/example13.out b/tests/examples/example13.out
diff --git a/tests/examples/example3.out b/tests/examples/example3.out
diff --git a/tests/test_geophires_x.py b/tests/test_geophires_x.py
