Merge pull request NREL#123 from softwareengineerprogrammer/main

Increase Maximum Temperature max value to 500℃ (v3.4.3)

Author: softwareengineerprogrammer

.bumpversion.cfg

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

README.rst

@@ -47,9 +47,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/NREL/GEOPHIRES-X/v3.4.2.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/NREL/GEOPHIRES-X/v3.4.3.svg
     :alt: Commits since latest release
-    :target: https://github.com/NREL/GEOPHIRES-X/compare/v3.4.2...main
+    :target: https://github.com/NREL/GEOPHIRES-X/compare/v3.4.3...main
 
 .. |docs| image:: https://readthedocs.org/projects/GEOPHIRES-X/badge/?style=flat
     :target: https://nrel.github.io/GEOPHIRES-X
@@ -150,7 +150,6 @@ Example usage in Python:
                     "Reservoir Depth": 3,
                     "Number of Segments": 1,
                     "Gradient 1": 50,
-                    "Maximum Temperature": 400,
                     "Number of Production Wells": 2,
                     "Number of Injection Wells": 2,
                     "Production Well Diameter": 7,

docs/conf.py

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

setup.py

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

src/geophires_x/AGSWellBores.py

@@ -926,16 +926,15 @@ def Calculate(self, model: Model) -> None:
         :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 {__class__!s}: {sys._getframe().f_code.co_name}')
 
         self.Tini = model.reserv.Trock.value  # initialize the temperature to be the initial temperature of the reservoir
         if self.Tini > 375.0 or self.numnonverticalsections.value > 1:
             # must be a multilateral setup or too hot for CLGS, so must try to use wanju code.
             if self.Tini > 375.0:
-                model.logger.warning("In AGS, but forced to use Wanju code because initial reservoir temperature \
-                is too high for CLGS")
-                print("In AGS, but forced to use Wanju code because initial reservoir temperature \
-                is too high for CLGS")
+                msg = 'In AGS, but forced to use Wanju code because initial reservoir temperature is too high for CLGS'
+                model.logger.warning(msg)
+                print(f'Warning: {msg}')
 
             # handle special cases for the multilateral calc parameters you added
             if self.nonverticalwellborediameter.value > 2.0:
@@ -1104,7 +1103,12 @@ def Calculate(self, model: Model) -> None:
             tot_length, vert_length, horizontal_lengths = self.calculatedrillinglengths(model)
 
             # in this case, reserv.depth is just the vertical drill depth
-            # FIXME earlier calculations use depth before this value is set, meaning they're using the wrong value
+            # TODO earlier calculations use reserv.depth before it is recalculated here; this should be refactored to avoid
+            #   potential for mix-ups. As of 2024-02-16, calculations correctly account for this on-the-fly change of
+            #   reserv.depth - see https://github.com/NREL/GEOPHIRES-X/issues/122#issuecomment-194869313 - but this
+            #   implementation is fragile and prone to introducing bugs in future changes. Ideally, parameters should
+            #   not be changed once their value has been calculated, and especially not after the first calculated
+            #   value has been used as an input for other calculations.
             model.reserv.depth.value = model.reserv.InputDepth.quantity().to(model.reserv.depth.CurrentUnits).magnitude
 
             # getTandP results must be rejiggered to match wellbores expected output. Once done,

src/geophires_x/Parameter.py

@@ -120,7 +120,11 @@ class boolParameter(Parameter):
         DefaultValue (bool, True):  The default value of that parameter
     """
 
-    value: bool = True # FIXME set from DefaultValue
+    def __post_init__(self):
+        if self.value is None:
+            self.value:bool = self.DefaultValue
+
+    value: bool = None
     DefaultValue: bool = value
     json_parameter_type: str = 'boolean'
 
@@ -137,7 +141,11 @@ class intParameter(Parameter):
         AllowableRange (list): A list of the valid values
     """
 
-    value: int = 0 # FIXME set from DefaultValue
+    def __post_init__(self):
+        if self.value is None:
+            self.value:int = self.DefaultValue
+
+    value: int = None
     DefaultValue: int = value
     AllowableRange: List[int] = field(default_factory=list)
     json_parameter_type: str = 'integer'
@@ -180,8 +188,11 @@ class strParameter(Parameter):
         value (str): The value of that parameter
         DefaultValue (str, ""):  The default value of that parameter
     """
+    def __post_init__(self):
+        if self.value is None:
+            self.value:str = self.DefaultValue
 
-    value: str = "" # FIXME set from DefaultValue
+    value: str = None
     DefaultValue: str = value
     json_parameter_type: str = 'string'
 

src/geophires_x/Reservoir.py

@@ -74,10 +74,9 @@ def __init__(self, model: Model):
 
         self.Tmax = self.ParameterDict[self.Tmax.Name] = floatParameter(
             "Maximum Temperature",
-            value=400.0,
             DefaultValue=400.0,
             Min=50,
-            Max=400,
+            Max=500,
             UnitType=Units.TEMPERATURE,
             PreferredUnits=TemperatureUnit.CELSIUS,
             CurrentUnits=TemperatureUnit.CELSIUS,

src/geophires_x/SurfacePlant.py

@@ -89,8 +89,9 @@ def reinjection_temperature(self, model: Model, ambient_temperature: float, Tent
         # check if reinjectemp (model calculated) >= Tinj (user provided)
         if np.min(ReinjTemp) < Tinj:
             Tinj = np.min(ReinjTemp)
-            print("Warning: injection temperature lowered")
-            model.logger.warning("injection temperature lowered")
+            msg = 'injection temperature lowered'
+            print(f'Warning: {msg}')
+            model.logger.warning(msg)
         return Tinj, ReinjTemp, etau
 
     def electricity_heat_production(self, enduse_option: EndUseOptions, availability: np.ndarray, etau: np.ndarray, nprod: int,
@@ -205,7 +206,8 @@ def __init__(self, model: Model):
         :type model: :class:`~geophires_x.Model.Model`
         :return: None
         """
-        model.logger.info(f"Init {self.__class__.__name__}: {__name__}")
+        model.logger.info(f'Init {self.__class__.__name__}: {__name__}')
+
         self.Tinj = 0.0
 
         # Set up all the Parameters that will be predefined by this class using the different types of parameter classes.
@@ -475,10 +477,10 @@ def __init__(self, model: Model):
             CurrentUnits=PowerUnit.MW
         )
 
-        model.logger.info(f"Complete {self.__class__.__name__}: {__name__}")
+        model.logger.info(f'Complete {self.__class__.__name__}: {__name__}')
 
     def __str__(self):
-        return "SurfacePlant"
+        return 'SurfacePlant'
 
     def read_parameters(self, model:Model) -> None:
         """
@@ -488,7 +490,7 @@ def read_parameters(self, model:Model) -> None:
         :param model: The container class of the application, giving access to everything else, including the logger
         :return: None
         """
-        model.logger.info(f"Init {self.__class__.__name__}: {__name__}")
+        model.logger.info(f'Init {self.__class__.__name__}: {__name__}')
 
         # Deal with all the parameter values that the user has provided.  They should really only provide values that
         # they want to change from the default values, but they can provide a value that is already set because it is a
@@ -514,7 +516,7 @@ def read_parameters(self, model:Model) -> None:
                     ReadParameter(ParameterReadIn, ParameterToModify, model)
 
                     # handle special cases
-                    if ParameterToModify.Name == "End-Use Option":
+                    if ParameterToModify.Name == 'End-Use Option':
                         if ParameterReadIn.sValue == str(1):
                             ParameterToModify.value = EndUseOptions.ELECTRICITY
                         elif ParameterReadIn.sValue == str(2):
@@ -533,7 +535,7 @@ def read_parameters(self, model:Model) -> None:
                         elif ParameterReadIn.sValue == str(52):
                             ParameterToModify.value = EndUseOptions.COGENERATION_PARALLEL_EXTRA_ELECTRICITY
 
-                    elif ParameterToModify.Name == "Power Plant Type":
+                    elif ParameterToModify.Name == 'Power Plant Type':
                         if ParameterReadIn.sValue == str(1):
                             ParameterToModify.value = PlantType.SUB_CRITICAL_ORC
                         elif ParameterReadIn.sValue == str(2):
@@ -579,40 +581,38 @@ def read_parameters(self, model:Model) -> None:
                             if ParameterToModify.value in [PlantType.SINGLE_FLASH, PlantType.DOUBLE_FLASH]:
                                 model.wellbores.impedancemodelallowed.value = False
                                 self.setinjectionpressurefixed = True
-                    elif ParameterToModify.Name == "Plant Outlet Pressure":
+                    elif ParameterToModify.Name == 'Plant Outlet Pressure':
                         if ParameterToModify.value < 0 or ParameterToModify.value > 10000:
                                 if self.setinjectionpressurefixed:
                                     ParameterToModify.value = 100
-                                    print("Warning: Provided plant outlet pressure outside of range 0-10000." +
-                                    " GEOPHIRES will assume default plant outlet pressure (100 kPa)")
-                                    model.logger.warning("Provided plant outlet pressure outside of range 0-10000." +
-                                    " GEOPHIRES will assume default plant outlet pressure (100 kPa)")
+                                    msg = f'Provided plant outlet pressure outside of range 0-10000. GEOPHIRES will assume default plant outlet pressure ({ParameterToModify.value} kPa)'
+                                    print(f'Warning: {msg}')
+                                    model.logger.warning(msg)
                                 else:
                                     self.usebuiltinoutletplantcorrelation.value = True
-                                    print("Warning: Provided plant outlet pressure outside of range 0-10000 kPa." +
-                                    " GEOPHIRES will calculate plant outlet pressure based on" +
-                                    " production wellhead pressure and surface equipment pressure drop of 10 psi")
-                                    model.logger.warning("Provided plant outlet pressure outside of range 0-10000 kPa." +
-                                    " GEOPHIRES will calculate plant outlet pressure based on" +
-                                    " production wellhead pressure and surface equipment pressure drop of 10 psi")
+                                    msg = ('Provided plant outlet pressure outside of range 0-10000 kPa. '
+                                           'GEOPHIRES will calculate plant outlet pressure based on production '
+                                           'wellhead pressure and surface equipment pressure drop of 10 psi')
+                                    print(f'Warning: {msg}')
+                                    model.logger.warning(msg)
             if "Plant Outlet Pressure" not in model.InputParameters:
                 if self.setinjectionpressurefixed:
                     self.usebuiltinoutletplantcorrelation.value = False
                     self.plant_outlet_pressure.value = 100
-                    print("Warning: No valid plant outlet pressure provided." +
-                    " GEOPHIRES will assume default plant outlet pressure (100 kPa)")
-                    model.logger.warning("No valid plant outlet pressure provided." +
-                    " GEOPHIRES will assume default plant outlet pressure (100 kPa)")
+                    msg = (f'No valid plant outlet pressure provided. '
+                           f'GEOPHIRES will assume default plant outlet pressure ({self.plant_outlet_pressure.value} kPa)')
+                    print(f'Warning: {msg}')
+                    model.logger.warning(msg)
                 else:
                     self.usebuiltinoutletplantcorrelation.value = True
-                    print("Warning: No valid plant outlet pressure provided. GEOPHIRES will calculate plant outlet" +
-                    " pressure based on production wellhead pressure and surface equipment pressure drop of 10 psi")
-                    model.logger.warning("No valid plant outlet pressure provided. GEOPHIRES will calculate plant outlet" +
-                     " pressure based on production wellhead pressure and surface equipment pressure drop of 10 psi")
+                    msg = (f'No valid plant outlet pressure provided. GEOPHIRES will calculate plant outlet pressure '
+                           f'based on production wellhead pressure and surface equipment pressure drop of 10 psi')
+                    print(f'Warning: {msg}')
+                    model.logger.warning(msg)
         else:
-            model.logger.info("No parameters read because no content provided")
+            model.logger.info('No parameters read because no content provided')
 
-        model.logger.info(f"Complete {self.__class__.__name__}: {__name__}")
+        model.logger.info(f'Complete {self.__class__.__name__}: {__name__}')
 
     def Calculate(self, model: Model) -> None:
         """
@@ -622,8 +622,8 @@ def Calculate(self, model: Model) -> None:
         :type model: :class:`~geophires_x.Model.Model`
         :return: Nothing, but it does make calculations and set values in the model
         """
-        model.logger.info(f"Init {self.__class__.__name__}: {__name__}")
+        model.logger.info(f'Init {self.__class__.__name__}: {__name__}')
 
         # All calculations are handled in subclasses of this class, so this function is empty.
 
-        model.logger.info(f"Complete {self.__class__.__name__}: {__name__}")
+        model.logger.info(f'Complete {self.__class__.__name__}: {__name__}')

src/geophires_x/WellBores.py

@@ -373,32 +373,33 @@ def ProdPressureDropAndPumpingPowerUsingIndexes(
             Pprodwellhead = ppwellhead
             if Pprodwellhead < Pminimum_kPa:
                 Pprodwellhead = Pminimum_kPa
-                msg = ('Provided production wellhead pressure under minimum pressure. '
-                       'GEOPHIRES will assume minimum wellhead pressure')
+                msg = (f'Provided production wellhead pressure ({Pprodwellhead}kPa) '
+                       f'under minimum pressure ({Pminimum_kPa}kPa). '
+                       f'GEOPHIRES will assume minimum wellhead pressure')
 
                 print(f'Warning: {msg}')
                 model.logger.warning(msg)
 
-        PIkPa = PI / 100.0  # convert PI from kg/s/bar to kg/s/kPa
+        PI_kPa = PI / 100.0  # convert PI from kg/s/bar to kg/s/kPa
 
         # calculate pumping depth
-        pumpdepth = depth_m + (Pminimum_kPa - Phydrostaticcalc_kPa + wellflowrate / PIkPa) / (
+        pumpdepth_m = depth_m + (Pminimum_kPa - Phydrostaticcalc_kPa + wellflowrate / PI_kPa) / (
             f3 * (rhowaterprod * vprod ** 2 / 2.) * (1 / prodwelldiam) / 1E3 + rhowaterprod * 9.81 / 1E3)
-        pumpdepthfinal = np.max(pumpdepth)
-        if pumpdepthfinal < 0.0:
-            pumpdepthfinal = 0.0
-            msg = ('GEOPHIRES calculates negative production well pumping depth. '
-                   'No production well pumps will be assumed')
+        pumpdepthfinal_m = np.max(pumpdepth_m)
+        if pumpdepthfinal_m < 0.0:
+            pumpdepthfinal_m = 0.0
+            msg = (f'GEOPHIRES calculates negative production well pumping depth. ({pumpdepthfinal_m}m)'
+                   f'No production well pumps will be assumed')
             print(f'Warning: {msg}')
             model.logger.warning(msg)
-        elif pumpdepthfinal > 600.0:
-            msg = ('GEOPHIRES calculates production pump depth to be deeper than 600 m. '
-                   'Verify reservoir pressure, production well flow rate and production well dimensions')
+        elif pumpdepthfinal_m > 600.0:
+            msg = (f'GEOPHIRES calculates production pump depth to be deeper than 600m ({pumpdepthfinal_m}m). '
+                   f'Verify reservoir pressure, production well flow rate and production well dimensions')
             print(f'Warning: {msg}')
             model.logger.warning(msg)
 
         # calculate production well pumping pressure [kPa]
-        DPProdWell = Pprodwellhead - (Phydrostaticcalc_kPa - wellflowrate / PIkPa - rhowaterprod * 9.81 * depth_m / 1E3 - f3 *
+        DPProdWell = Pprodwellhead - (Phydrostaticcalc_kPa - wellflowrate / PI_kPa - rhowaterprod * 9.81 * depth_m / 1E3 - f3 *
                                       (rhowaterprod * vprod ** 2 / 2.) * (depth_m / prodwelldiam) / 1E3)
         # [MWe] total pumping power for production wells
         PumpingPowerProd = DPProdWell * nprod * wellflowrate / rhowaterprod / pumpeff / 1E3
@@ -549,7 +550,7 @@ def __init__(self, model: Model):
         :type model: :class:`~geophires_x.Model.Model`
         :return: Nothing, and is used to initialize the class
         """
-        model.logger.info(f"Init {self.__class__.__name__}: {__name__}")
+        model.logger.info(f'Init {self.__class__.__name__}: {__name__}')
         self.rhowaterprod = self.rhowaterinj = 0.0
 
         # Set up all the Parameters that will be predefined by this class using the different types of parameter classes.