Merge pull request #416 from wouterpeere/issue338-planned-depreciations-for-v240

Issue338 planned depreciations for v240

Author: wouterpeere

CHANGELOG.md

@@ -16,6 +16,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Changed
 
 - Changed implementation of `optimise_for_energy` to make it three times faster (issue #308).
+- Remove FluidClass (issue #338).
+- Remove custom_gfunction from Borefield class initiation (issue #338).
+- Remove baseload extraction/injection and peak extraction/injection from Borefield class initiation (issue #338).
+- Remove set_ground_parameters, set_fluid_parameters, set_pipe_parameters from Borefield class (issue #338).
 - Add support for EPW files from PVGIS (issue #376).
 - Fix problem with start month in optimise for power/balance (issue #380).
 - Return multiyear external load if multiyear load is given as an input (issue #380).

GHEtool/Borefield.py

@@ -46,12 +46,7 @@ class Borefield(BaseClass):
 
     def __init__(
             self,
-            peak_extraction: ArrayLike = None,
-            peak_injection: ArrayLike = None,
-            baseload_extraction: ArrayLike = None,
-            baseload_injection: ArrayLike = None,
             borefield: gt.borefield.Borefield = None,
-            custom_gfunction: CustomGFunction = None,
             *,
             load: _LoadData = None,
             ground_data: _GroundData = GroundConstantTemperature(),
@@ -64,18 +59,8 @@ def __init__(
 
         Parameters
         ----------
-        peak_extraction : list, numpy array
-            Monthly peak extraction values [kW]
-        peak_injection : list, numpy array
-            Monthly peak injection values [kW]
-        baseload_extraction : list, numpy array
-            Monthly baseload extraction values [kWh]
-        baseload_injection : list, numpy array
-            Monthly baseload extraction values [kWh]
         borefield : pygfunction borehole/borefield object
             Set the borefield for which the calculations will be carried out
-        custom_gfunction : CustomGFunction
-            Custom gfunction dataset
         load : _LoadData
             Load data of the borefield
         ground_data : _GroundData
@@ -96,11 +81,6 @@ def __init__(
         if len(kwargs) != 0:
             raise ValueError('Please check your input for the Borefield class')
 
-        if custom_gfunction is not None:
-            warnings.warn(
-                'From version 2.4.0 it will no longer be possible to initiate a borefield object with a custom gfunction.'
-                'Please use the load_custom_gfunction function.', DeprecationWarning)
-            self.custom_gfunction: CustomGFunction = custom_gfunction
         self.gfunction_calculation_object: GFunction = GFunction()
 
         # initialize variables for temperature plotting
@@ -133,12 +113,8 @@ def __init__(
         if load is not None:
             self.load = load
         else:
-            warnings.warn('From version 2.4.0 you will need to load a load object instead of the base and peak load.',
-                          DeprecationWarning)
-            self.load = MonthlyGeothermalLoadAbsolute(baseload_extraction,
-                                                      baseload_injection,
-                                                      peak_extraction,
-                                                      peak_injection)
+
+            self.load = MonthlyGeothermalLoadAbsolute()
 
         # set investment cost
         self.cost_investment: list = Borefield.DEFAULT_INVESTMENT
@@ -660,24 +636,6 @@ def ground_data(self, data: _GroundData) -> None:
         # the stored gfunction data should be deleted
         self.gfunction_calculation_object.remove_previous_data()
 
-    def set_ground_parameters(self, data: _GroundData) -> None:
-        """
-        This function sets the relevant ground parameters.
-
-        Parameters
-        ----------
-        data : GroundData
-            All the relevant ground data
-
-        Returns
-        -------
-        None
-        """
-        warnings.warn(
-            'From version 2.4.0 this function will be depreciated. Please set the ground properties by using a direct '
-            'assignment.', DeprecationWarning)
-        self.ground_data = data
-
     @property
     def pipe_data(self) -> _PipeData:
         """
@@ -762,42 +720,6 @@ def flow_data(self, data: _FlowData) -> None:
         """
         self.borehole.flow_data = data
 
-    def set_fluid_parameters(self, data: _FluidData) -> None:
-        """
-        This function sets the fluid parameters.
-
-        Parameters
-        ----------
-        data : FluidData
-            All the relevant fluid data
-
-        Returns
-        -------
-        None
-        """
-        warnings.warn(
-            'From version 2.4.0 this function will be depreciated. Please set the fluid properties by using a direct '
-            'assignment.', DeprecationWarning)
-        self.fluid_data = data
-
-    def set_pipe_parameters(self, data: _PipeData) -> None:
-        """
-        This function sets the pipe parameters.
-
-        Parameters
-        ----------
-        data : PipeData
-            All the relevant pipe parameters
-
-        Returns
-        -------
-        None
-        """
-        warnings.warn(
-            'From version 2.4.0 this function will be depreciated. Please set the pipe properties by using a direct '
-            'assignment.', DeprecationWarning)
-        self.pipe_data = data
-
     def set_Rb(self, Rb: float) -> None:
         """
         This function sets the constant equivalent borehole thermal resistance.

GHEtool/Examples/effect_of_borehole_configuration.py

@@ -56,7 +56,7 @@ def effect_borefield_configuration():
 
     # set ground parameters to borefield
     borefield.set_borefield(borefield_gt)
-    borefield.set_ground_parameters(data)
+    borefield.ground_data = data
 
     # set Rb
     borefield.Rb = 0.2

GHEtool/Examples/energy_pile.py

@@ -22,17 +22,19 @@
 def test_1a_6h():
     # initiate ground, fluid and pipe data
     ground_data = GroundFluxTemperature(k_s=1.8, T_g=17.5, volumetric_heat_capacity=2073600, flux=0)
-    fluid_data = FluidData(mfr=0.440, rho=1052, Cp=3795, mu=0.0052, k_f=0.48)
+    fluid_data = ConstantFluidData(rho=1052, cp=3795, mu=0.0052, k_f=0.48)
+    flow_data = ConstantFlowRate(mfr=0.44)
     pipe_data = MultipleUTube(r_in=0.0137, r_out=0.0167, D_s=0.075 / 2, k_g=1.4, k_p=0.43, number_of_pipes=1)
 
     # start test with dynamic Rb*
     # initiate borefield
     borefield = Borefield()
 
     # set ground data in borefield
-    borefield.set_ground_parameters(ground_data)
-    borefield.set_fluid_parameters(fluid_data)
-    borefield.set_pipe_parameters(pipe_data)
+    borefield.ground_data = ground_data
+    borefield.fluid_data = fluid_data
+    borefield.pipe_data = pipe_data
+    borefield.flow_data = flow_data
     borefield.create_rectangular_borefield(1, 1, 6, 6, 110, 4, 0.075)
 
     # load the hourly profile
@@ -41,7 +43,7 @@ def test_1a_6h():
                              col_extraction=1, col_injection=0)
     borefield.load = load
 
-    delta_t = max(load.max_peak_extraction, load.max_peak_injection) * 1000 / (fluid_data.Cp * fluid_data.mfr)
+    delta_t = max(load.max_peak_extraction, load.max_peak_injection) * 1000 / (fluid_data.cp() * flow_data.mfr())
 
     # set temperature bounds
     borefield.set_max_avg_fluid_temperature(35 + delta_t / 2)
@@ -120,7 +122,8 @@ def test_1a_6h():
 def test_1a_1h():
     # initiate ground, fluid and pipe data
     ground_data = GroundFluxTemperature(k_s=1.8, T_g=17.5, volumetric_heat_capacity=2073600, flux=0)
-    fluid_data = FluidData(mfr=0.440, rho=1052, Cp=3795, mu=0.0052, k_f=0.48)
+    fluid_data = ConstantFluidData(rho=1052, cp=3795, mu=0.0052, k_f=0.48)
+    flow_data = ConstantFlowRate(mfr=0.44)
     pipe_data = MultipleUTube(r_in=0.0137, r_out=0.0167, D_s=0.075 / 2, k_g=1.4, k_p=0.43, number_of_pipes=1)
 
     # start test with dynamic Rb*
@@ -131,6 +134,7 @@ def test_1a_1h():
     borefield.ground_data = ground_data
     borefield.fluid_data = fluid_data
     borefield.pipe_data = pipe_data
+    borefield.flow_data = flow_data
     borefield.create_rectangular_borefield(1, 1, 6, 6, 110, 4, 0.075)
 
     # load the hourly profile
@@ -140,7 +144,7 @@ def test_1a_1h():
     borefield.load = load
     borefield.load.peak_duration = 1
 
-    delta_t = max(load.max_peak_extraction, load.max_peak_injection) * 1000 / (fluid_data.Cp * fluid_data.mfr)
+    delta_t = max(load.max_peak_extraction, load.max_peak_injection) * 1000 / (fluid_data.cp() * flow_data.mfr())
 
     # set temperature bounds
     borefield.set_max_avg_fluid_temperature(35 + delta_t / 2)

GHEtool/Validation/comparison_with_other_sizing_tools/test1a/test1a.py

@@ -22,17 +22,19 @@
 def test_1b():
     # initiate ground, fluid and pipe data
     ground_data = GroundFluxTemperature(k_s=1.8, T_g=17.5, volumetric_heat_capacity=2073600, flux=0)
-    fluid_data = FluidData(mfr=0.5585, rho=1052, Cp=3795, mu=0.0052, k_f=0.48)
+    fluid_data = ConstantFluidData(rho=1052, cp=3795, mu=0.0052, k_f=0.48)
+    flow_data = ConstantFlowRate(mfr=0.5585)
     pipe_data = MultipleUTube(r_in=0.0137, r_out=0.0167, D_s=0.075 / 2, k_g=1.4, k_p=0.43, number_of_pipes=1)
 
     # start test with dynamic Rb*
     # initiate borefield
     borefield = Borefield()
 
     # set ground data in borefield
-    borefield.set_ground_parameters(ground_data)
-    borefield.set_fluid_parameters(fluid_data)
-    borefield.set_pipe_parameters(pipe_data)
+    borefield.ground_data = ground_data
+    borefield.fluid_data = fluid_data
+    borefield.pipe_data = pipe_data
+    borefield.flow_data = flow_data
     borefield.create_rectangular_borefield(1, 1, 6, 6, 110, 4, 0.075)
 
     # load the hourly profile
@@ -42,7 +44,7 @@ def test_1b():
                              col_injection=0)
     borefield.load = load
 
-    delta_t = max(load.max_peak_extraction, load.max_peak_injection) * 1000 / (fluid_data.Cp * fluid_data.mfr)
+    delta_t = max(load.max_peak_extraction, load.max_peak_injection) * 1000 / (fluid_data.cp() * flow_data.mfr())
 
     # set temperature bounds
     borefield.set_max_avg_fluid_temperature(35 + delta_t / 2)
@@ -72,9 +74,10 @@ def test_1b():
     borefield = Borefield()
 
     # set ground data in borefield
-    borefield.set_ground_parameters(ground_data)
-    borefield.set_fluid_parameters(fluid_data)
-    borefield.set_pipe_parameters(pipe_data)
+    borefield.ground_data = ground_data
+    borefield.fluid_data = fluid_data
+    borefield.pipe_data = pipe_data
+    borefield.flow_data = flow_data
     borefield.create_rectangular_borefield(1, 1, 6, 6, 110, 4, 0.075)
     Rb_static = 0.13
     borefield.set_Rb(Rb_static)

GHEtool/Validation/comparison_with_other_sizing_tools/test1b/test1b.py

@@ -22,17 +22,19 @@
 def test_2_6h():
     # initiate ground, fluid and pipe data
     ground_data = GroundFluxTemperature(k_s=2.25, T_g=12.41, volumetric_heat_capacity=2877000, flux=0)
-    fluid_data = FluidData(mfr=0.2416667, rho=1026, Cp=4019, mu=0.003377, k_f=0.468)
+    fluid_data = ConstantFluidData(rho=1026, cp=4019, mu=0.003377, k_f=0.468)
+    flow_data = ConstantFlowRate(mfr=0.2416667)
     pipe_data = MultipleUTube(r_in=0.0137, r_out=0.0167, D_s=0.0471 / 2, k_g=1.73, k_p=0.45)
 
     # start test with dynamic Rb*
     # initiate borefield
     borefield = Borefield()
 
     # set ground data in borefield
-    borefield.set_ground_parameters(ground_data)
-    borefield.set_fluid_parameters(fluid_data)
-    borefield.set_pipe_parameters(pipe_data)
+    borefield.ground_data = ground_data
+    borefield.fluid_data = fluid_data
+    borefield.pipe_data = pipe_data
+    borefield.flow_data = flow_data
     borefield.create_rectangular_borefield(12, 10, 6, 6, 110, 3, 0.054)
 
     # load the hourly profile
@@ -41,7 +43,7 @@ def test_2_6h():
                              col_extraction=1, col_injection=0)
     borefield.load = load
 
-    delta_t = max(load.max_peak_extraction, load.max_peak_injection) * 1000 / (fluid_data.Cp * fluid_data.mfr) / 120
+    delta_t = max(load.max_peak_extraction, load.max_peak_injection) * 1000 / (fluid_data.cp() * flow_data.mfr()) / 120
 
     # set temperature bounds
     borefield.set_max_avg_fluid_temperature(35 + delta_t / 2)
@@ -70,9 +72,10 @@ def test_2_6h():
     borefield = Borefield()
 
     # set ground data in borefield
-    borefield.set_ground_parameters(ground_data)
-    borefield.set_fluid_parameters(fluid_data)
-    borefield.set_pipe_parameters(pipe_data)
+    borefield.ground_data = ground_data
+    borefield.fluid_data = fluid_data
+    borefield.pipe_data = pipe_data
+    borefield.flow_data = flow_data
     borefield.create_rectangular_borefield(12, 10, 6, 6, 110, 3, 0.054)
     Rb_static = 0.113
     borefield.set_Rb(Rb_static)

GHEtool/Validation/comparison_with_other_sizing_tools/test2/test2.py

@@ -22,17 +22,19 @@
 def test_3_6h():
     # initiate ground, fluid and pipe data
     ground_data = GroundFluxTemperature(k_s=2.25, T_g=10, volumetric_heat_capacity=2592000, flux=0)
-    fluid_data = FluidData(mfr=33.1 / 49, rho=1026, Cp=4019, mu=0.003377, k_f=0.468)
+    fluid_data = ConstantFluidData(rho=1026, cp=4019, mu=0.003377, k_f=0.468)
+    flow_data = ConstantFlowRate(mfr=33.1 / 49)
     pipe_data = MultipleUTube(r_in=0.013, r_out=0.0167, D_s=0.075 / 2, k_g=1.73, k_p=0.4, number_of_pipes=1)
 
     # start test with dynamic Rb*
     # initiate borefield
     borefield = Borefield()
 
     # set ground data in borefield
-    borefield.set_ground_parameters(ground_data)
-    borefield.set_fluid_parameters(fluid_data)
-    borefield.set_pipe_parameters(pipe_data)
+    borefield.ground_data = ground_data
+    borefield.fluid_data = fluid_data
+    borefield.pipe_data = pipe_data
+    borefield.flow_data = flow_data
     borefield.create_rectangular_borefield(7, 7, 5, 5, 110, 2.5, 0.075)
 
     # load the hourly profile
@@ -41,7 +43,7 @@ def test_3_6h():
                              col_extraction=1, col_injection=0)
     borefield.load = load
 
-    delta_t = max(load.max_peak_extraction, load.max_peak_injection) * 1000 / (fluid_data.Cp * fluid_data.mfr) / 49
+    delta_t = max(load.max_peak_extraction, load.max_peak_injection) * 1000 / (fluid_data.cp() * flow_data.mfr()) / 49
 
     # set temperature bounds
     borefield.set_max_avg_fluid_temperature(35 + delta_t / 2)
@@ -77,9 +79,10 @@ def test_3_6h():
             borefield = Borefield()
 
             # set ground data in borefield
-            borefield.set_ground_parameters(ground_data)
-            borefield.set_fluid_parameters(fluid_data)
-            borefield.set_pipe_parameters(pipe_data)
+            borefield.ground_data = ground_data
+            borefield.fluid_data = fluid_data
+            borefield.pipe_data = pipe_data
+            borefield.flow_data = flow_data
             borefield.create_rectangular_borefield(7, 7, B, B, 110, 2.5, 0.075)
             Rb_static = 0.1
             borefield.set_Rb(Rb_static)