Merge pull request #346 from wouterpeere/issue345-bring-up-to-date-with-pygfunction-v230

Issue345 bring up to date with pygfunction v230

Author: wouterpeere

CHANGELOG.md

@@ -20,6 +20,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 - Added U-bend to the pressure drop calculation of the pipe (issue #332).
 - Remove optimise_load_power and optimise_load_energy from Borefield object (issue #332).
+- Changed back-end to be compatible with pygfunction 2.3.0 (issue #345).
 
 ## Fixed
 

GHEtool/Borefield.py

@@ -48,7 +48,7 @@ def __init__(
             peak_injection: ArrayLike = None,
             baseload_extraction: ArrayLike = None,
             baseload_injection: ArrayLike = None,
-            borefield: list[gt.boreholes.Borehole] = None,
+            borefield: gt.borefield.Borefield = None,
             custom_gfunction: CustomGFunction = None,
             load: _LoadData = None,
             **kwargs
@@ -187,7 +187,7 @@ def number_of_boreholes(self) -> int:
         int
             Number of boreholes
         """
-        return len(self.borefield) if self.borefield is not None else 0
+        return self.borefield.nBoreholes if self.borefield is not None else 0
 
     @property
     def depth(self) -> float:
@@ -217,7 +217,7 @@ def calculate_depth(self, borehole_length: float, buried_depth: float) -> float:
         float
             Depth of the borehole [m]
         """
-        if np.isclose(self.avg_tilt, 0):
+        if self.borefield is None or np.all(self.borefield.tilt == 0):
             return borehole_length + buried_depth
         return np.average([bor.H * math.cos(bor.tilt) for bor in self.borefield]) + buried_depth
 
@@ -248,20 +248,19 @@ def H(self, H: float) -> None:
         None
         """
         self._H = H
-        for bor in self._borefield:
-            bor.H = H
+        self._borefield.H = np.full(self.number_of_boreholes, H)
 
         # the boreholes are equal in length
         self.gfunction_calculation_object.store_previous_values = \
             self.gfunction_calculation_object._store_previous_values_backup
 
-    def set_borefield(self, borefield: list[gt.boreholes.Borehole] = None) -> None:
+    def set_borefield(self, borefield: gt.borefield.Borefield = None) -> None:
         """
         This function set the borefield object. When None is given, the borefield will be deleted.
 
         Parameters
         ----------
-        borefield : List[pygfunction.boreholes.Borehole]
+        borefield : pygfunction.borefield.Borefield
             Borefield created with the pygfunction package
 
         Returns
@@ -298,7 +297,7 @@ def create_rectangular_borefield(self, N_1: int, N_2: int, B_1: float, B_2: floa
         -------
         pygfunction borefield object
         """
-        borefield = gt.boreholes.rectangle_field(N_1, N_2, B_1, B_2, H, D, r_b)
+        borefield = gt.borefield.Borefield.rectangle_field(N_1, N_2, B_1, B_2, H, D, r_b)
         self.set_borefield(borefield)
 
         return borefield
@@ -326,7 +325,7 @@ def create_circular_borefield(self, N: int, R: float, H: float, D: float = 1, r_
         -------
         pygfunction borefield object
         """
-        borefield = gt.boreholes.circle_field(N, R, H, D, r_b)
+        borefield = gt.borefield.Borefield.circle_field(N, R, H, D, r_b)
         self.set_borefield(borefield)
         return borefield
 
@@ -358,7 +357,7 @@ def create_U_shaped_borefield(self, N_1: int, N_2: int, B_1: float, B_2: float,
         -------
         pygfunction borefield object
         """
-        borefield = gt.boreholes.U_shaped_field(N_1, N_2, B_1, B_2, H, D, r_b)
+        borefield = gt.borefield.Borefield.U_shaped_field(N_1, N_2, B_1, B_2, H, D, r_b)
         self.set_borefield(borefield)
         return borefield
 
@@ -390,7 +389,7 @@ def create_L_shaped_borefield(self, N_1: int, N_2: int, B_1: float, B_2: float,
         -------
         pygfunction borefield object
         """
-        borefield = gt.boreholes.L_shaped_field(N_1, N_2, B_1, B_2, H, D, r_b)
+        borefield = gt.borefield.Borefield.L_shaped_field(N_1, N_2, B_1, B_2, H, D, r_b)
         self.set_borefield(borefield)
         return borefield
 
@@ -422,7 +421,7 @@ def create_box_shaped_borefield(self, N_1: int, N_2: int, B_1: float, B_2: float
         -------
         pygfunction borefield object
         """
-        borefield = gt.boreholes.box_shaped_field(N_1, N_2, B_1, B_2, H, D, r_b)
+        borefield = gt.borefield.Borefield.box_shaped_field(N_1, N_2, B_1, B_2, H, D, r_b)
         self.set_borefield(borefield)
         return borefield
 
@@ -438,13 +437,13 @@ def borefield(self):
         return self._borefield
 
     @borefield.setter
-    def borefield(self, borefield: list[gt.boreholes.Borehole] = None) -> None:
+    def borefield(self, borefield: gt.borefield.Borefield = None) -> None:
         """
         This function sets the borefield configuration. When no input is given, the borefield variable will be deleted.
 
         Parameters
         ----------
-        borefield : List[pygfunction.boreholes.Borehole]
+        borefield : pygfunction.borefield.Borefield
             Borefield created with the pygfunction package
 
         Returns
@@ -455,14 +454,14 @@ def borefield(self, borefield: list[gt.boreholes.Borehole] = None) -> None:
             del self.borefield
             return
         self._borefield = borefield
-        self.D = np.average([bor.D for bor in borefield])
-        self.r_b = np.average([bor.r_b for bor in borefield])
-        self._H = np.average([bor.H for bor in borefield])
-        self.avg_tilt = np.average([bor.tilt for bor in borefield])
-        if not np.isclose(self.avg_tilt, 0):
+        self.D = np.average(borefield.D)
+        self.r_b = np.average(borefield.r_b)
+        self._H = np.average(borefield.H)
+        self.avg_tilt = np.average(borefield.tilt)
+        if not np.all(borefield.tilt == 0):
             self.gfunction_calculation_object.options['method'] = 'similarities'
         self.gfunction_calculation_object.remove_previous_data()
-        unequal_length = np.any([bor.H != borefield[0].H for bor in borefield])
+        unequal_length = not np.all(borefield.H == self.H)
         if unequal_length:
             self.gfunction_calculation_object._store_previous_values = not unequal_length
         else:
@@ -1860,9 +1859,7 @@ def create_custom_dataset(self, time_array: ArrayLike = None, borehole_length_ar
             When no borefield or ground data is set
         """
 
-        try:
-            self.borefield[0]
-        except TypeError:
+        if self.borefield is None:
             raise ValueError("No borefield is set for which the gfunctions should be calculated")
         try:
             self.ground_data.alpha(depth=100)

GHEtool/Examples/custom_borefield_configuration.py

@@ -53,7 +53,7 @@ def custom_borefield_configuration():
     borefield.set_min_avg_fluid_temperature(0)  # minimum temperature
 
     # create custom borefield based on pygfunction
-    custom_field = gt.boreholes.L_shaped_field(N_1=4, N_2=5, B_1=5., B_2=5., H=100., D=4, r_b=0.05)
+    custom_field = gt.borefield.Borefield.L_shaped_field(N_1=4, N_2=5, B_1=5., B_2=5., H=100., D=4, r_b=0.05)
 
     # set the custom borefield (so the number of boreholes is correct)
     borefield.set_borefield(custom_field)

GHEtool/Examples/effect_of_borehole_configuration.py

@@ -11,7 +11,7 @@
 def effect_borefield_configuration():
     # GroundData for an initial field of 11 x 11
     data = GroundConstantTemperature(3, 10)
-    borefield_gt = gt.boreholes.rectangle_field(11, 11, 6, 6, 110, 1, 0.075)
+    borefield_gt = gt.borefield.Borefield.rectangle_field(11, 11, 6, 6, 110, 1, 0.075)
 
     # Monthly loading values
     peak_cooling = np.array([0., 0, 34., 69., 133., 187., 213., 240., 160., 37., 0., 0.])  # Peak cooling in kW
@@ -52,7 +52,7 @@ def effect_borefield_configuration():
 
     # borefield of 6x20
     data = GroundConstantTemperature(3, 10)
-    borefield_gt = gt.boreholes.rectangle_field(6, 20, 6, 6, 110, 1, 0.075)
+    borefield_gt = gt.borefield.Borefield.rectangle_field(6, 20, 6, 6, 110, 1, 0.075)
 
     # set ground parameters to borefield
     borefield.set_borefield(borefield_gt)

GHEtool/Examples/find_optimal_borefield.py

@@ -61,31 +61,31 @@
 
 @cache
 def line(x, y):
-    temp = gt.boreholes.rectangle_field(x, y, max(B_max, width / x), max(B_max, length / y), 100, 0.7, 0.07)
+    temp = gt.borefield.Borefield.rectangle_field(x, y, max(B_max, width / x), max(B_max, length / y), 100, 0.7, 0.07)
     return len(temp), temp
 
 
 @cache
 def L(x, y):
-    temp = gt.boreholes.L_shaped_field(x, y, max(B_max, width / x), max(B_max, length / y), 100, 0.7, 0.07)
+    temp = gt.borefield.Borefield.L_shaped_field(x, y, max(B_max, width / x), max(B_max, length / y), 100, 0.7, 0.07)
     return len(temp), temp
 
 
 @cache
 def U(x, y):
-    temp = gt.boreholes.U_shaped_field(x, y, max(B_max, width / x), max(B_max, length / y), 100, 0.7, 0.07)
+    temp = gt.borefield.Borefield.U_shaped_field(x, y, max(B_max, width / x), max(B_max, length / y), 100, 0.7, 0.07)
     return len(temp), temp
 
 
 @cache
 def box(x, y):
-    temp = gt.boreholes.box_shaped_field(x, y, max(B_max, width / x), max(B_max, length / y), 100, 0.7, 0.07)
+    temp = gt.borefield.Borefield.box_shaped_field(x, y, max(B_max, width / x), max(B_max, length / y), 100, 0.7, 0.07)
     return len(temp), temp
 
 
 @cache
 def rectangle(x, y):
-    temp = gt.boreholes.rectangle_field(x, y, max(B_max, width / x), max(B_max, length / y), 100, 0.7, 0.07)
+    temp = gt.borefield.Borefield.rectangle_field(x, y, max(B_max, width / x), max(B_max, length / y), 100, 0.7, 0.07)
     return len(temp), temp
 
 

GHEtool/Examples/import_data.py

@@ -8,7 +8,7 @@
 
 # initiate ground data
 data = GroundConstantTemperature(3, 10, 2.4 * 10 ** 6)
-borefield_gt = gt.boreholes.rectangle_field(10, 12, 6, 6, 110, 1, 0.075)
+borefield_gt = gt.borefield.Borefield.rectangle_field(10, 12, 6, 6, 110, 1, 0.075)
 
 # initiate borefield
 borefield = Borefield()

GHEtool/Examples/sizing_with_Rb_calculation.py

@@ -42,7 +42,7 @@ def sizing_with_Rb():
     fluid_data = FluidData(0.2, 0.568, 998, 4180, 1e-3)
     pipe_data = DoubleUTube(1, 0.015, 0.02, 0.4, 0.05)
 
-    borefield_gt = gt.boreholes.rectangle_field(10, 12, 6, 6, 100, 1, 0.075)
+    borefield_gt = gt.borefield.Borefield.rectangle_field(10, 12, 6, 6, 100, 1, 0.075)
 
     # Monthly loading values
     peak_cooling = np.array([0., 0, 34., 69., 133., 187., 213., 240., 160., 37., 0., 0.])  # Peak cooling in kW
@@ -128,8 +128,8 @@ def sizing_with_Rb():
 
     # Do the same thing but with another constant Rb* value based on a borehole length of 185m.
 
-    borefield_gt = gt.boreholes.rectangle_field(10, 12, 6, 6, 185, 1,
-                                                0.075)  # borefield with an accurate guess of 185m for the borehole length
+    borefield_gt = gt.borefield.Borefield.rectangle_field(10, 12, 6, 6, 185, 1,
+                                                          0.075)  # borefield with an accurate guess of 185m for the borehole length
     borefield.set_borefield(borefield_gt)
 
     # size with a constant Rb* value

GHEtool/Examples/sizing_with_building_load_hourly.py

@@ -12,7 +12,7 @@
 
 # initiate ground data
 data = GroundFluxTemperature(2.1, 10, flux=0.07)
-borefield_gt = gt.boreholes.rectangle_field(10, 12, 6, 6, 110, 1, 0.075)
+borefield_gt = gt.borefield.Borefield.rectangle_field(10, 12, 6, 6, 110, 1, 0.075)
 
 cop = COP(np.array(
     [4.42, 5.21, 6.04, 7.52, 9.5, 3.99, 4.58, 5.21, 6.02, 6.83, 3.86, 4.39, 4.97,

GHEtool/Examples/tilted_borefield.py

@@ -24,10 +24,11 @@ def tilted():
     )
 
     # define borefield
-    borefield_tilted = [gt.boreholes.Borehole(150, 0.75, 0.07, -3, 0, math.pi / 7, orientation=math.pi),
-                        gt.boreholes.Borehole(150, 0.75, 0.07, 3, 0, math.pi / 7, orientation=0)]
-    borefield_without_tilt = [gt.boreholes.Borehole(150, 0.75, 0.07, -3, 0),
-                              gt.boreholes.Borehole(150, 0.75, 0.07, 3, 0)]
+    borefield_tilted = gt.borefield.Borefield.from_boreholes(
+        [gt.boreholes.Borehole(150, 0.75, 0.07, -3, 0, math.pi / 7, orientation=math.pi),
+         gt.boreholes.Borehole(150, 0.75, 0.07, 3, 0, math.pi / 7, orientation=0)])
+    borefield_without_tilt = gt.borefield.Borefield.from_boreholes([gt.boreholes.Borehole(150, 0.75, 0.07, -3, 0),
+                                                                    gt.boreholes.Borehole(150, 0.75, 0.07, 3, 0)])
 
     # initiate GHEtool object with tilted borefield
     borefield = Borefield(borefield=borefield_tilted, load=load_data)

GHEtool/Validation/cases.py

@@ -13,9 +13,9 @@
 
 # relevant borefield data for the calculations
 data = GroundConstantTemperature(3.5,  # conductivity of the soil (W/mK)
-                                 10)   # Ground temperature at infinity (degrees C)
+                                 10)  # Ground temperature at infinity (degrees C)
 
-borefield_gt = gt.boreholes.rectangle_field(10, 12, 6.5, 6.5, 100, 4, 0.075)
+borefield_gt = gt.borefield.Borefield.rectangle_field(10, 12, 6.5, 6.5, 100, 4, 0.075)
 
 
 def load_case(number):
@@ -24,7 +24,8 @@ def load_case(number):
     if number == 1:
         # case 1
         # limited in the first year by cooling
-        monthly_load_heating_percentage = np.array([0.155, 0.148, 0.125, .099, .064, 0., 0., 0., 0.061, 0.087, 0.117, 0.144])
+        monthly_load_heating_percentage = np.array(
+            [0.155, 0.148, 0.125, .099, .064, 0., 0., 0., 0.061, 0.087, 0.117, 0.144])
         monthly_load_cooling_percentage = np.array([0.025, 0.05, 0.05, .05, .075, .1, .2, .2, .1, .075, .05, .025])
         monthly_load_heating = monthly_load_heating_percentage * 300 * 10 ** 3  # kWh
         monthly_load_cooling = monthly_load_cooling_percentage * 150 * 10 ** 3  # kWh
@@ -34,7 +35,8 @@ def load_case(number):
     elif number == 2:
         # case 2
         # limited in the last year by cooling
-        monthly_load_heating_percentage = np.array([0.155, 0.148, 0.125, .099, .064, 0., 0., 0., 0.061, 0.087, .117, 0.144])
+        monthly_load_heating_percentage = np.array(
+            [0.155, 0.148, 0.125, .099, .064, 0., 0., 0., 0.061, 0.087, .117, 0.144])
         monthly_load_cooling_percentage = np.array([0.025, 0.05, 0.05, .05, .075, .1, .2, .2, .1, .075, .05, .025])
         monthly_load_heating = monthly_load_heating_percentage * 160 * 10 ** 3  # kWh
         monthly_load_cooling = monthly_load_cooling_percentage * 240 * 10 ** 3  # kWh
@@ -44,7 +46,8 @@ def load_case(number):
     elif number == 3:
         # case 3
         # limited in the first year by heating
-        monthly_load_heating_percentage = np.array([0.155, 0.148, 0.125, .099, .064, 0., 0., 0., 0.061, 0.087, .117, 0.144])
+        monthly_load_heating_percentage = np.array(
+            [0.155, 0.148, 0.125, .099, .064, 0., 0., 0., 0.061, 0.087, .117, 0.144])
         monthly_load_cooling_percentage = np.array([0.025, 0.05, 0.05, .05, .075, .1, .2, .2, .1, .075, .05, .025])
         monthly_load_heating = monthly_load_heating_percentage * 160 * 10 ** 3  # kWh
         monthly_load_cooling = monthly_load_cooling_percentage * 240 * 10 ** 3  # kWh
@@ -54,7 +57,8 @@ def load_case(number):
     else:
         # case 4
         # limited in the last year by heating
-        monthly_load_heating_percentage = np.array([0.155, 0.148, 0.125, .099, .064, 0., 0., 0., 0.061, 0.087, 0.117, 0.144])
+        monthly_load_heating_percentage = np.array(
+            [0.155, 0.148, 0.125, .099, .064, 0., 0., 0., 0.061, 0.087, 0.117, 0.144])
         monthly_load_cooling_percentage = np.array([0.025, 0.05, 0.05, .05, .075, .1, .2, .2, .1, .075, .05, .025])
         monthly_load_heating = monthly_load_heating_percentage * 300 * 10 ** 3  # kWh
         monthly_load_cooling = monthly_load_cooling_percentage * 150 * 10 ** 3  # kWh
@@ -65,7 +69,6 @@ def load_case(number):
 
 
 def check_cases():
-
     """
     This function checks whether the borefield sizing gives the correct (i.e. validated) results for the 4 cases.
     If not, an assertion error is raised.
@@ -87,14 +90,14 @@ def check_cases():
         borefield.set_min_avg_fluid_temperature(0)  # minimum temperature
 
         borefield.size(100, L2_sizing=True)
-        print(f'correct answer L2: {correct_answers_L2[i-1]}; calculated answer L2: {round(borefield.H,2)}; error: '
+        print(f'correct answer L2: {correct_answers_L2[i - 1]}; calculated answer L2: {round(borefield.H, 2)}; error: '
               f'{round(abs(1 - borefield.H / correct_answers_L2[i - 1]) * 100, 4)} %')
-        assert np.isclose(borefield.H, correct_answers_L2[i-1], rtol=0.001)
+        assert np.isclose(borefield.H, correct_answers_L2[i - 1], rtol=0.001)
 
         borefield.size(100, L3_sizing=True)
         print(f'correct answer L3: {correct_answers_L3[i - 1]}; calculated answer L3: {round(borefield.H, 2)}; error: '
               f'{round(abs(1 - borefield.H / correct_answers_L3[i - 1]) * 100, 4)} %')
-        assert np.isclose(borefield.H, correct_answers_L3[i-1], rtol=0.001)
+        assert np.isclose(borefield.H, correct_answers_L3[i - 1], rtol=0.001)
 
 
 def check_custom_datafile():
@@ -107,7 +110,7 @@ def check_custom_datafile():
 
     correct_answers = (56.75, 117.23, 66.94, 91.32)
 
-    custom_field = gt.boreholes.rectangle_field(N_1=12, N_2=10, B_1=6.5, B_2=6.5, H=110., D=4, r_b=0.075)
+    custom_field = gt.borefield.Borefield.rectangle_field(N_1=12, N_2=10, B_1=6.5, B_2=6.5, H=110., D=4, r_b=0.075)
 
     for i in (1, 2, 3, 4):
         borefield = Borefield(load=MonthlyGeothermalLoadAbsolute(*load_case(i)))
@@ -121,11 +124,11 @@ def check_custom_datafile():
         borefield.set_min_avg_fluid_temperature(0)  # minimum temperature
 
         borefield.size(100, L3_sizing=True)
-        print(f'correct answer: {correct_answers[i-1]}; calculated '
-              f'answer: {round(borefield.H,2)}; error: '
-              f'{round(abs(1-borefield.H/correct_answers[i - 1])*100,4)} %')
+        print(f'correct answer: {correct_answers[i - 1]}; calculated '
+              f'answer: {round(borefield.H, 2)}; error: '
+              f'{round(abs(1 - borefield.H / correct_answers[i - 1]) * 100, 4)} %')
 
 
-if __name__ == "__main__":   # pragma: no cover
+if __name__ == "__main__":  # pragma: no cover
     check_cases()  # check different cases
     check_custom_datafile()  # check if the custom datafile is correct