Merge pull request #382 from wouterpeere/issue380-wrong-result-when-working-with-optimise-power-and-start_month-1

First try to fix 380

Author: wouterpeere

CHANGELOG.md

@@ -11,6 +11,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 - Changed implementation of `optimise_for_energy` to make it three times faster (issue #308).
 - 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 imput (issue #380).
 
 ### Fixed
 

GHEtool/Methods/optimise_load_profile.py

@@ -16,7 +16,8 @@ def optimise_load_profile_power(
         max_peak_heating: float = None,
         max_peak_cooling: float = None,
         dhw_preferential: bool = None
-) -> tuple[HourlyBuildingLoad, HourlyBuildingLoad]:
+) -> tuple[
+    Union[HourlyBuildingLoad, HourlyBuildingLoadMultiYear], Union[HourlyBuildingLoad, HourlyBuildingLoadMultiYear]]:
     """
     This function optimises the load for maximum power in extraction and injection based on the given borefield and
     the given hourly building load. It does so based on a load-duration curve.
@@ -43,7 +44,7 @@ def optimise_load_profile_power(
 
     Returns
     -------
-    tuple [HourlyBuildingLoad, HourlyBuildingLoad]
+    tuple [HourlyBuildingLoad, HourlyBuildingLoad] or tuple [HourlyBuildingLoadMultiYear, HourlyBuildingLoadMultiYear]
         borefield load, external load
 
     Raises
@@ -70,7 +71,6 @@ def optimise_load_profile_power(
 
     # set load
     borefield.load = copy.deepcopy(building_load)
-
     # set initial peak loads
     init_peak_heating: float = borefield.load.max_peak_heating
     init_peak_dhw: float = borefield.load.max_peak_dhw
@@ -92,10 +92,10 @@ def optimise_load_profile_power(
     while not cool_ok or not heat_ok:
         # limit the primary geothermal extraction and injection load to peak_heat_load and peak_cool_load
         borefield.load.set_hourly_cooling_load(
-            np.minimum(peak_cool_load, building_load.hourly_cooling_load
+            np.minimum(peak_cool_load, building_load._hourly_cooling_load
             if isinstance(borefield.load, HourlyBuildingLoad) else building_load.hourly_cooling_load_simulation_period))
         borefield.load.set_hourly_heating_load(
-            np.minimum(peak_heat_load, building_load.hourly_heating_load
+            np.minimum(peak_heat_load, building_load._hourly_heating_load
             if isinstance(borefield.load, HourlyBuildingLoad) else building_load.hourly_heating_load_simulation_period))
         borefield.load.set_hourly_dhw_load(
             np.minimum(peak_dhw_load, building_load.hourly_dhw_load
@@ -145,13 +145,29 @@ def optimise_load_profile_power(
             cool_ok = True
 
     # calculate external load
-    external_load = HourlyBuildingLoad(simulation_period=building_load.simulation_period)
+    if isinstance(building_load, HourlyBuildingLoad):
+        external_load = HourlyBuildingLoad(simulation_period=building_load.simulation_period)
+        external_load.start_month = building_load.start_month
+
+        external_load.set_hourly_heating_load(
+            np.maximum(0, building_load._hourly_heating_load - borefield.load._hourly_heating_load))
+        external_load.set_hourly_cooling_load(
+            np.maximum(0, building_load._hourly_cooling_load - borefield.load._hourly_cooling_load))
+        external_load.set_hourly_dhw_load(
+            np.maximum(0, building_load.hourly_dhw_load - borefield.load.hourly_dhw_load))
+
+        return borefield.load, external_load
+
+    external_load = HourlyBuildingLoadMultiYear()
     external_load.set_hourly_heating_load(
-        np.maximum(0, building_load.hourly_heating_load - borefield.load.hourly_heating_load))
+        np.maximum(0,
+                   building_load.hourly_heating_load_simulation_period - borefield.load.hourly_heating_load_simulation_period))
     external_load.set_hourly_cooling_load(
-        np.maximum(0, building_load.hourly_cooling_load - borefield.load.hourly_cooling_load))
+        np.maximum(0,
+                   building_load.hourly_cooling_load_simulation_period - borefield.load.hourly_cooling_load_simulation_period))
     external_load.set_hourly_dhw_load(
-        np.maximum(0, building_load.hourly_dhw_load - borefield.load.hourly_dhw_load))
+        np.maximum(0,
+                   building_load.hourly_dhw_load_simulation_period - borefield.load.hourly_dhw_load_simulation_period))
 
     return borefield.load, external_load
 
@@ -454,7 +470,8 @@ def optimise_load_profile_balance(
         max_peak_cooling: float = None,
         dhw_preferential: bool = None,
         imbalance_factor: float = 0.01,
-) -> tuple[HourlyBuildingLoad, HourlyBuildingLoad]:
+) -> tuple[
+    Union[HourlyBuildingLoad, HourlyBuildingLoadMultiYear], Union[HourlyBuildingLoad, HourlyBuildingLoadMultiYear]]:
     """
     This function optimises the load for maximum power in extraction and injection based on the given borefield and
     the given hourly building load, by maintaining a zero imbalance. It does so based on a load-duration curve.
@@ -484,7 +501,7 @@ def optimise_load_profile_balance(
         
     Returns
     -------
-    tuple [HourlyBuildingLoad, HourlyBuildingLoad]
+    tuple [HourlyBuildingLoad, HourlyBuildingLoad] or tuple [HourlyBuildingLoadMultiYear, HourlyBuildingLoadMultiYear]
         borefield load, external load
 
     Raises
@@ -536,10 +553,10 @@ def optimise_load_profile_balance(
     while not cool_ok or not heat_ok:
         # limit the primary geothermal extraction and injection load to peak_heat_load and peak_cool_load
         borefield.load.set_hourly_cooling_load(
-            np.minimum(peak_cool_load, building_load.hourly_cooling_load
+            np.minimum(peak_cool_load, building_load._hourly_cooling_load
             if isinstance(borefield.load, HourlyBuildingLoad) else building_load.hourly_cooling_load_simulation_period))
         borefield.load.set_hourly_heating_load(
-            np.minimum(peak_heat_load, building_load.hourly_heating_load
+            np.minimum(peak_heat_load, building_load._hourly_heating_load
             if isinstance(borefield.load, HourlyBuildingLoad) else building_load.hourly_heating_load_simulation_period))
         borefield.load.set_hourly_dhw_load(
             np.minimum(peak_dhw_load, building_load.hourly_dhw_load
@@ -616,12 +633,28 @@ def optimise_load_profile_balance(
             cool_ok = True
 
     # calculate external load
-    external_load = HourlyBuildingLoad(simulation_period=building_load.simulation_period)
+    if isinstance(building_load, HourlyBuildingLoad):
+        external_load = HourlyBuildingLoad(simulation_period=building_load.simulation_period)
+        external_load.start_month = building_load.start_month
+
+        external_load.set_hourly_heating_load(
+            np.maximum(0, building_load._hourly_heating_load - borefield.load._hourly_heating_load))
+        external_load.set_hourly_cooling_load(
+            np.maximum(0, building_load._hourly_cooling_load - borefield.load._hourly_cooling_load))
+        external_load.set_hourly_dhw_load(
+            np.maximum(0, building_load.hourly_dhw_load - borefield.load.hourly_dhw_load))
+
+        return borefield.load, external_load
+
+    external_load = HourlyBuildingLoadMultiYear()
     external_load.set_hourly_heating_load(
-        np.maximum(0, building_load.hourly_heating_load - borefield.load.hourly_heating_load))
+        np.maximum(0,
+                   building_load.hourly_heating_load_simulation_period - borefield.load.hourly_heating_load_simulation_period))
     external_load.set_hourly_cooling_load(
-        np.maximum(0, building_load.hourly_cooling_load - borefield.load.hourly_cooling_load))
+        np.maximum(0,
+                   building_load.hourly_cooling_load_simulation_period - borefield.load.hourly_cooling_load_simulation_period))
     external_load.set_hourly_dhw_load(
-        np.maximum(0, building_load.hourly_dhw_load - borefield.load.hourly_dhw_load))
+        np.maximum(0,
+                   building_load.hourly_dhw_load_simulation_period - borefield.load.hourly_dhw_load_simulation_period))
 
     return borefield.load, external_load

GHEtool/test/general_tests/test_GHEtool.py

@@ -16,7 +16,7 @@
 from GHEtool.VariableClasses.BaseClass import UnsolvableDueToTemperatureGradient, MaximumNumberOfIterations
 from GHEtool.Validation.cases import load_case
 from GHEtool.VariableClasses import MonthlyGeothermalLoadAbsolute, HourlyGeothermalLoad, EERCombined, \
-    HourlyBuildingLoad, EER
+    HourlyBuildingLoad, EER, HourlyBuildingLoadMultiYear
 from GHEtool.Methods import *
 
 data = GroundConstantTemperature(3, 10)
@@ -353,9 +353,9 @@ def test_optimise_load_eer_combined():
                      np.array([5, 30]))  # based on the data of the WRE092 chiller of Galletti
     borefield1 = Borefield()
     borefield1.create_rectangular_borefield(4, 3, 6, 6, 110, 0.7, 0.075)
-    borefield1.set_ground_parameters(ground_data)
-    borefield1.set_fluid_parameters(fluid_data)
-    borefield1.set_pipe_parameters(pipe_data)
+    borefield1.ground_data = ground_data
+    borefield1.fluid_data = fluid_data
+    borefield1.pipe_data = pipe_data
     borefield1.set_max_avg_fluid_temperature(25)
     borefield1.set_min_avg_fluid_temperature(3)
 
@@ -376,3 +376,57 @@ def test_optimise_load_eer_combined():
     borefield1.calculate_temperatures(hourly=True)
     results_25 = copy.deepcopy(borefield1.results)
     assert np.allclose(results_16.peak_injection, results_25.peak_injection)
+
+
+def test_optimise_methods_different_start_year():
+    ground_data = GroundFluxTemperature(3, 10)
+    fluid_data = FluidData(0.2, 0.568, 998, 4180, 1e-3)
+    pipe_data = DoubleUTube(1, 0.015, 0.02, 0.4, 0.05)
+
+    load = HourlyBuildingLoad(efficiency_heating=5)  # use SCOP of 5 for heating
+    load.load_hourly_profile(FOLDER.joinpath("test\methods\hourly_data\\auditorium.csv"), header=True,
+                             separator=";", col_cooling=0, col_heating=1)
+    load.start_month = 5
+
+    borefield = Borefield()
+    borefield.create_rectangular_borefield(20, 5, 6, 6, 110, 0.7, 0.075)
+    borefield.ground_data = ground_data
+    borefield.fluid_data = fluid_data
+    borefield.pipe_data = pipe_data
+
+    borefield_load, ext_load = optimise_load_profile_power(borefield, load)
+    assert borefield_load.start_month == 5
+    assert load.start_month == 5
+    assert ext_load.start_month == 5
+    assert ext_load.max_peak_heating == 0
+    assert ext_load.max_peak_cooling == 0
+    assert isinstance(ext_load, HourlyBuildingLoad)
+
+    borefield_load, ext_load = optimise_load_profile_balance(borefield, load)
+    assert borefield_load.start_month == 5
+    assert load.start_month == 5
+    assert ext_load.start_month == 5
+    assert np.allclose(borefield_load.hourly_heating_load + ext_load.hourly_heating_load, load.hourly_heating_load)
+    assert np.allclose(borefield_load.hourly_cooling_load + ext_load.hourly_cooling_load, load.hourly_cooling_load)
+
+    load = HourlyBuildingLoadMultiYear(load.hourly_heating_load_simulation_period,
+                                       load.hourly_cooling_load_simulation_period)
+
+    borefield_load, ext_load = optimise_load_profile_power(borefield, load)
+    assert isinstance(ext_load, HourlyBuildingLoadMultiYear)
+    assert ext_load.max_peak_heating == 0
+    assert ext_load.max_peak_cooling == 0
+
+    borefield_load, ext_load = optimise_load_profile_balance(borefield, load)
+    assert isinstance(ext_load, HourlyBuildingLoadMultiYear)
+    assert np.allclose(borefield_load.hourly_heating_load + ext_load.hourly_heating_load, load.hourly_heating_load)
+    assert np.allclose(borefield_load.hourly_cooling_load + ext_load.hourly_cooling_load, load.hourly_cooling_load)
+
+    borefield.create_rectangular_borefield(10, 2, 6, 6, 110, 0.7, 0.075)
+    borefield.ground_data = ground_data
+    borefield.fluid_data = fluid_data
+    borefield.pipe_data = pipe_data
+
+    borefield_load, ext_load = optimise_load_profile_power(borefield, load)
+    assert np.allclose(borefield_load.hourly_heating_load + ext_load.hourly_heating_load, load.hourly_heating_load)
+    assert np.allclose(borefield_load.hourly_cooling_load + ext_load.hourly_cooling_load, load.hourly_cooling_load)

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = GHEtool
-version = 2.4.0.dev1
+version = 2.4.0.dev2
 author = Wouter Peere
 author_email = wouter@ghetool.eu
 description = Python package for borefield sizing