Merge pull request NREL#158 from softwareengineerprogrammer/main

Don't take pressure as parameter for vapor pressure

Author: softwareengineerprogrammer

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.4.21
+current_version = 3.4.22
 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.21
+    version: 3.4.22
     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/softwareengineerprogrammer/GEOPHIRES-X/v3.4.21.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/GEOPHIRES-X/v3.4.22.svg
     :alt: Commits since latest release
-    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.21...main
+    :target: https://github.com/softwareengineerprogrammer/GEOPHIRES-X/compare/v3.4.22...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 = '2023'
 author = 'NREL'
 copyright = f'{year}, {author}'
-version = release = '3.4.21'
+version = release = '3.4.22'
 
 pygments_style = 'trac'
 templates_path = ['./templates']

setup.py

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

src/geophires_x/AGSWellBores.py

@@ -1069,8 +1069,7 @@ def Calculate(self, model: Model) -> None:
 
                 # recalculate the pumping power by looking at the difference between the upgoing and downgoing and the nonvertical
                 self.PumpingPower.value = DowngoingPumpingPower + NonverticalPumpingPower - UpgoingPumpingPower
-                self.PumpingPower.value = [0. if x < 0. else x for x in
-                                           self.PumpingPower.value]  # cannot be negative, so set to 0
+                self.PumpingPower.value = [max(x, 0.) for x in self.PumpingPower.value]  # cannot be negative, so set to 0
 
         else:
             # do the CLGS-style calculation
@@ -1129,7 +1128,7 @@ def Calculate(self, model: Model) -> None:
             self.PumpingPower.value = self.DPOverall.value * self.prodwellflowrate.value / rho_water / model.surfaceplant.pump_efficiency.value / 1E3
             # in GEOPHIRES v1.2, negative pumping power values become zero
             # (b/c we are not generating electricity) = thermosiphon is happening!
-            self.PumpingPower.value = [0. if x < 0. else x for x in self.PumpingPower.value]
+            self.PumpingPower.value = [max(x, 0.) for x in self.PumpingPower.value]
 
         model.logger.info(f'complete {str(__class__)}: {sys._getframe().f_code.co_name}')
 

src/geophires_x/GeoPHIRESUtils.py

@@ -244,37 +244,30 @@ def RecoverableHeat(Twater_degC: float) -> float:
 
 
 @lru_cache
-def vapor_pressure_water_kPa(Twater_degC: float, pressure: Optional[PlainQuantity] = None) -> float:
+def vapor_pressure_water_kPa(temperature_degC: float) -> float:
     """
     Calculate the vapor pressure of water as a function of temperature.
 
     Args:
-        Twater_degC: the temperature of water in degrees C
-        pressure: Pressure - should be provided as a Pint quantity that knows its units
+        temperature_degC: the temperature of water in degrees C
     Returns:
         The vapor pressure of water as a function of temperature in kPa
     Raises:
-        ValueError: If Twater_degC is not a float or convertible to float.
-        ValueError: If Twater_degC is below 0.
+        ValueError: If temperature_degC is not a float or convertible to float.
+        ValueError: If temperature_degC is below 0.
     """
 
-    if not isinstance(Twater_degC, (int, float)):
-        raise ValueError(f'Twater_degC ({Twater_degC}) must be a number')
-    if Twater_degC < 0:
-        raise ValueError(f'Twater_degC ({Twater_degC}) must be greater than or equal to 0')
+    if not isinstance(temperature_degC, (int, float)):
+        raise ValueError(f'Input temperature ({temperature_degC}) must be a number')
+    if temperature_degC < 0:
+        raise ValueError(f'Input temperature ({temperature_degC}C) must be greater than or equal to 0')
 
     try:
-        if pressure is not None:
-            return (quantity(
-                CP.PropsSI('P', 'T', celsius_to_kelvin(Twater_degC), 'P', pressure.to('Pa').magnitude, 'Water'), 'Pa')
-                    .to('kPa').magnitude)
-        else:
-            _logger.warning(f'vapor_pressure_water: No pressure provided, using vapor quality=0 instead')
-            return (quantity(CP.PropsSI('P', 'T', celsius_to_kelvin(Twater_degC), 'Q', 0, 'Water'), 'Pa')
+        return (quantity(CP.PropsSI('P', 'T', celsius_to_kelvin(temperature_degC), 'Q', 0, 'Water'), 'Pa')
                     .to('kPa').magnitude)
 
     except (NotImplementedError, ValueError) as e:
-        raise ValueError(f'Input temperature {Twater_degC} is out of range or otherwise not implemented') from e
+        raise ValueError(f'Input temperature ({temperature_degC}C) is out of range or otherwise not implemented') from e
 
 
 @lru_cache

src/geophires_x/WellBores.py

@@ -362,10 +362,7 @@ def ProdPressureDropAndPumpingPowerUsingIndexes(
         Pexcess_kPa = 344.7  # = 50 psi
 
         # Minimum production pump inlet pressure and minimum wellhead pressure
-        Pminimum_kPa = vapor_pressure_water_kPa(
-            Trock_degC,
-            pressure=quantity(Phydrostaticcalc_kPa, 'kPa'),
-        ) + Pexcess_kPa
+        Pminimum_kPa = vapor_pressure_water_kPa(Trock_degC) + Pexcess_kPa
 
         if usebuiltinppwellheadcorrelation:
             Pprodwellhead = Pminimum_kPa  # production wellhead pressure [kPa]
@@ -411,7 +408,7 @@ def ProdPressureDropAndPumpingPowerUsingIndexes(
         PumpingPower = PumpingPowerProd
 
     # negative pumping power values become zero (b/c we are not generating electricity)
-    PumpingPower = [0. if x < 0. else x for x in PumpingPower]
+    PumpingPower = [max(x, 0.) for x in PumpingPower]
 
     return PumpingPower, PumpingPowerProd, DPProdWell, Pprodwellhead
 
@@ -495,10 +492,7 @@ def InjPressureDropAndPumpingPowerUsingIndexes(
         Pexcess_kPa = 344.7 # = 50 psi
 
         # Minimum production pump inlet pressure and minimum wellhead pressure
-        Pminimum_kPa = vapor_pressure_water_kPa(
-            Trock_degC,
-            pressure=quantity(Phydrostaticcalc_kPa, 'kPa'),
-        ) + Pexcess_kPa
+        Pminimum_kPa = vapor_pressure_water_kPa(Trock_degC) + Pexcess_kPa
 
         if usebuiltinppwellheadcorrelation:
             Pprodwellhead = Pminimum_kPa  # production wellhead pressure [kPa]

src/geophires_x/__init__.py

@@ -1 +1 @@
-__version__ = '3.4.21'
+__version__ = '3.4.22'