Merge pull request #427 from wouterpeere/explicit_models

Explicit models

Author: wouterpeere

CHANGELOG.md

@@ -16,6 +16,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Add set_min_fluid_temperature and set_max_fluid_temperature to the Borefield class (issue #271).
 - Add flow per borefield to flow classes (issue #408).
 - Average baseload fluid temperature (issue #418).
+- Explicit formulations of the multipole method (issue #425).
+- Convective resistance calculation with array inputs (issue #425).
+- Option to change pipe configuration in MultipleUTube (either diagonal (default) or adjacent) (issue #425).
 
 ## Changed
 
@@ -27,6 +30,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Remove Python 3.9 compatibility (issue #420).
 - Change default test to 3.13 instead of 3.12 (issue #420).
 
+## Fixed
+
+- Fixed minor mistake in Separatus Rb* calculation (issue #425).
+
 ## [2.4.0] - 2025-12-19
 
 ### Added

GHEtool/Borefield.py

@@ -583,7 +583,8 @@ def Rb(self) -> float:
         """
         return self.borehole.get_Rb(self.H, self.D, self.r_b, self.ground_data.k_s, self.depth,
                                     temperature=self.results.min_temperature if self.results.min_temperature is not None else self.Tf_min,
-                                    nb_of_boreholes=self.number_of_boreholes)
+                                    nb_of_boreholes=self.number_of_boreholes,
+                                    use_explicit_models=self._calculation_setup.use_explicit_multipole)
 
     @Rb.setter
     def Rb(self, Rb: float) -> None:
@@ -908,7 +909,9 @@ def _Ahmadfard(self, th: float, qh: float, qm: float, qa: float, Tf: float) -> f
             # calculate the total borehole length
             L = (qa * Ra + qm * Rm + qh * Rd + qh *
                  self.borehole.get_Rb(self.H, self.D, self.r_b, self.ground_data.k_s, self.depth, temperature=Tfint,
-                                      nb_of_boreholes=self.number_of_boreholes)) / abs(Tfint - self._Tg())
+                                      nb_of_boreholes=self.number_of_boreholes,
+                                      use_explicit_models=self._calculation_setup.use_explicit_multipole)) / abs(
+                Tfint - self._Tg())
             # updating the borehole length values
             H_prev = self.H
             self.H = L / self.number_of_boreholes
@@ -980,7 +983,8 @@ def _Carcel(self, th: float, tcm: float, qh: float, qpm: float, qm: float, Tf: f
             # calculate the total length
             L = (qh * self.borehole.get_Rb(self.H, self.D, self.r_b, self.ground_data.k_s, self.depth,
                                            temperature=Tfint,
-                                           nb_of_boreholes=self.number_of_boreholes) + qh * Rh + qm * Rcm + qpm * Rpm) / abs(
+                                           nb_of_boreholes=self.number_of_boreholes,
+                                           use_explicit_models=self._calculation_setup.use_explicit_multipole) + qh * Rh + qm * Rcm + qpm * Rpm) / abs(
                 Tfint - self._Tg())
 
             # updating the borehole lengths
@@ -1835,27 +1839,31 @@ def calculate_temperatures(H, hourly=hourly, results_temperature=ResultsMonthly(
             results = None
 
             def get_rb(temperature, limit=None):
-
                 if self.USE_SPEED_UP_IN_SIZING and sizing and not variable_efficiency:
                     # use only extreme temperatures when sizing
                     if limit is not None:
                         if len(temperature) == 0:
                             return self.borehole.get_Rb(H, self.D, self.r_b, self.ground_data.k_s(depth, self.D), depth,
-                                                        temperature=Tmin, nb_of_boreholes=self.number_of_boreholes)
+                                                        temperature=Tmin, nb_of_boreholes=self.number_of_boreholes,
+                                                        use_explicit_models=self._calculation_setup.use_explicit_multipole)
                         elif limit == (Tmax if Tmax is not None else self.Tf_max):
                             return self.borehole.get_Rb(H, self.D, self.r_b, self.ground_data.k_s(depth, self.D), depth,
                                                         temperature=max(temperature),
-                                                        nb_of_boreholes=self.number_of_boreholes)
+                                                        nb_of_boreholes=self.number_of_boreholes,
+                                                        use_explicit_models=self._calculation_setup.use_explicit_multipole)
                         else:
                             return self.borehole.get_Rb(H, self.D, self.r_b, self.ground_data.k_s(depth, self.D), depth,
                                                         temperature=min(temperature),
-                                                        nb_of_boreholes=self.number_of_boreholes)
+                                                        nb_of_boreholes=self.number_of_boreholes,
+                                                        use_explicit_models=self._calculation_setup.use_explicit_multipole)
                 if len(temperature) == 0:
                     return self.borehole.get_Rb(H, self.D, self.r_b, self.ground_data.k_s(depth, self.D), depth,
-                                                temperature=Tmin, nb_of_boreholes=self.number_of_boreholes)
+                                                temperature=Tmin, nb_of_boreholes=self.number_of_boreholes,
+                                                use_explicit_models=self._calculation_setup.use_explicit_multipole)
 
                 return self.borehole.get_Rb(H, self.D, self.r_b, self.ground_data.k_s(depth, self.D), depth,
-                                            temperature=temperature, nb_of_boreholes=self.number_of_boreholes)
+                                            temperature=temperature, nb_of_boreholes=self.number_of_boreholes,
+                                            use_explicit_models=self._calculation_setup.use_explicit_multipole)
 
             if not hourly:
                 # self.g-function is a function that uses the precalculated data to interpolate the correct values of the

GHEtool/Examples/HF_14obs.kmz

@@ -6,7 +6,7 @@
 The correlations for both the convective heat transfer coefficient and the friction factor, which are used internally
 to calculate respectively the effective borehole thermal resistance and the pressure drop, were created by Niklas Hidman,
 Division of Fluid Dynamics, Department of Mechanical and Maritime Sciences, Chalmers University of Technology, Gothenburg, Sweden.
-The study can be found here: https://www.muovitech.com/studies/Thermohydraulic_performance_evaluation_250519.pdf
+The study can be found here: https://www.sciencedirect.com/science/article/pii/S0017931025014498?via%3Dihub
 """
 import matplotlib.pyplot as plt
 import numpy as np

GHEtool/Examples/pipe.py

@@ -107,16 +107,15 @@ def test_1a_6h():
         f"The sizing according to L3 has a depth of {depth_L3:.2f}m (using dynamic Rb* of {Rb_L3:.3f}) and {depth_L3s:.2f}m (using constant Rb*)")
     print(
         f"The sizing according to L4 has a depth of {depth_L4:.2f}m (using dynamic Rb* of {Rb_L4:.3f}) and {depth_L4s:.2f}m (using constant Rb*)")
-
-    assert np.isclose(depth_L2, 59.366333293365)
-    assert np.isclose(depth_L3, 59.542511807290666)
-    assert np.isclose(depth_L4, 56.2659729399716)
-    assert np.isclose(depth_L2s, 59.83238790604271)
-    assert np.isclose(depth_L3s, 60.00736579796592)
+    assert np.isclose(depth_L2, 59.3636198458606)
+    assert np.isclose(depth_L3, 59.539512919146844)
+    assert np.isclose(depth_L4, 56.263487685923195)
+    assert np.isclose(depth_L2s, 59.8323879060427)
+    assert np.isclose(depth_L3s, 60.00760582636102)
     assert np.isclose(depth_L4s, 56.732044011668464)
-    assert np.isclose(Rb_L2, 0.12801945735995454)
-    assert np.isclose(Rb_L3, 0.1280244880933401)
-    assert np.isclose(Rb_L4, 0.12793335445966403)
+    assert np.isclose(Rb_L2, 0.12800794794314643)
+    assert np.isclose(Rb_L3, 0.12801297090220962)
+    assert np.isclose(Rb_L4, 0.1279218446632468)
 
 
 def test_1a_1h():
@@ -209,16 +208,15 @@ def test_1a_1h():
         f"The sizing according to L3 has a depth of {depth_L3:.2f}m (using dynamic Rb* of {Rb_L3:.3f}) and {depth_L3s:.2f}m (using constant Rb*)")
     print(
         f"The sizing according to L4 has a depth of {depth_L4:.2f}m (using dynamic Rb* of {Rb_L4:.3f}) and {depth_L4s:.2f}m (using constant Rb*)")
-
-    assert np.isclose(depth_L2, 46.44356767605206)
-    assert np.isclose(depth_L3, 46.73933500137179)
-    assert np.isclose(depth_L4, 56.2659729399716)
+    assert np.isclose(depth_L2, 46.4408463170366)
+    assert np.isclose(depth_L3, 46.73652745970898)
+    assert np.isclose(depth_L4, 56.26298710970397)
     assert np.isclose(depth_L2s, 46.986986159967906)
-    assert np.isclose(depth_L3s, 47.28220733547535)
-    assert np.isclose(depth_L4s, 56.73136082379056)
-    assert np.isclose(Rb_L2, 0.12769092836836982)
-    assert np.isclose(Rb_L3, 0.12769755355584275)
-    assert np.isclose(Rb_L4, 0.12793335445966403)
+    assert np.isclose(depth_L3s, 47.282207335475356)
+    assert np.isclose(depth_L4s, 56.73157055683088)
+    assert np.isclose(Rb_L2, 0.12767939520070198)
+    assert np.isclose(Rb_L3, 0.1276860188802275)
+    assert np.isclose(Rb_L4, 0.12792183113119798)
 
 
 if __name__ == "__main__":  # pragma: no cover

GHEtool/Examples/readkml.py

@@ -109,16 +109,15 @@ def test_1b():
         f"The sizing according to L3 has a depth of {depth_L3:.2f}m (using dynamic Rb* of {Rb_L3:.3f}) and {depth_L3s:.2f}m (using constant Rb*)")
     print(
         f"The sizing according to L4 has a depth of {depth_L4:.2f}m (using dynamic Rb* of {Rb_L4:.3f}) and {depth_L4s:.2f}m (using constant Rb*)")
-
-    assert np.isclose(depth_L2, 75.67161488446233)
-    assert np.isclose(depth_L3, 75.62427445122744)
-    assert np.isclose(depth_L4, 71.49641008062054)
+    assert np.isclose(depth_L2, 75.66849470883834)
+    assert np.isclose(depth_L3, 75.62186680865247)
+    assert np.isclose(depth_L4, 71.49342289581354)
     assert np.isclose(depth_L2s, 76.71715998100636)
     assert np.isclose(depth_L3s, 76.67104470064083)
-    assert np.isclose(depth_L4s, 72.52389782010322)
-    assert np.isclose(Rb_L2, 0.12648875915036317)
-    assert np.isclose(Rb_L3, 0.12648767833749805)
-    assert np.isclose(Rb_L4, 0.12639600391560102)
+    assert np.isclose(depth_L4s, 72.52389782010319)
+    assert np.isclose(Rb_L2, 0.12647828821436058)
+    assert np.isclose(Rb_L3, 0.12647722358651553)
+    assert np.isclose(Rb_L4, 0.1263855489907598)
 
 
 if __name__ == "__main__":  # pragma: no cover

GHEtool/Examples/regex.py

@@ -109,15 +109,15 @@ def test_2_6h():
     print(
         f"The sizing according to L4 has a depth of {depth_L4:.2f}m (using dynamic Rb* of {Rb_L4:.3f}) and {depth_L4s:.2f}m (using constant Rb*)")
 
-    assert np.isclose(depth_L2, 76.84063723898525)
-    assert np.isclose(depth_L3, 79.10831161518712)
-    assert np.isclose(depth_L4, 84.77053904958063)
+    assert np.isclose(depth_L2, 76.80635452477883)
+    assert np.isclose(depth_L3, 79.07410794395845)
+    assert np.isclose(depth_L4, 84.73663201563583)
     assert np.isclose(depth_L2s, 77.43318625702659)
     assert np.isclose(depth_L3s, 79.6008906105556)
     assert np.isclose(depth_L4s, 84.97960330484824)
-    assert np.isclose(Rb_L2, 0.11113022659380956)
-    assert np.isclose(Rb_L3, 0.11146734480480838)
-    assert np.isclose(Rb_L4, 0.11234852494964061)
+    assert np.isclose(Rb_L2, 0.11102256296596089)
+    assert np.isclose(Rb_L3, 0.11135938474158981)
+    assert np.isclose(Rb_L4, 0.11224117157204798)
 
 
 if __name__ == "__main__":  # pragma: no cover