Merge pull request #384 from wouterpeere/issue381-change-the-way-dhw-is-handled-in-hourly-load

First try

Author: wouterpeere

CHANGELOG.md

@@ -12,11 +12,13 @@ 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).
+- Return multiyear external load if multiyear load is given as an input (issue #380).
+- Change how DHW is stored in the classes (issue #381).
 
 ### Fixed
 
 - Problem in ConicalPipe class when working with vfr (issue #378).
+- Problem with start month DHW and optimisation (issue #378).
 
 ## [2.3.4] - 2025-07-29
 

GHEtool/Examples/optimise_load_profile.py

@@ -98,7 +98,7 @@ def optimise_load_profile_power(
             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
+            np.minimum(peak_dhw_load, building_load._hourly_dhw_load
             if isinstance(borefield.load, HourlyBuildingLoad) else building_load.hourly_dhw_load_simulation_period))
 
         # calculate temperature profile, just for the results
@@ -154,7 +154,7 @@ def optimise_load_profile_power(
         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))
+            np.maximum(0, building_load._hourly_dhw_load - borefield.load._hourly_dhw_load))
 
         return borefield.load, external_load
 
@@ -559,7 +559,7 @@ def optimise_load_profile_balance(
             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
+            np.minimum(peak_dhw_load, building_load._hourly_dhw_load
             if isinstance(borefield.load, HourlyBuildingLoad) else building_load.hourly_dhw_load_simulation_period))
 
         # calculate temperature profile, just for the results
@@ -568,7 +568,6 @@ def optimise_load_profile_balance(
         # calculate relative imbalance
         imbalance = borefield.load.imbalance / np.maximum(borefield.load.yearly_average_injection_load,
                                                           borefield.load.yearly_average_extraction_load)
-
         # deviation from minimum temperature
         if abs(min(borefield.results.peak_extraction) - borefield.Tf_min) > temperature_threshold or \
                 (abs(imbalance) > imbalance_factor and imbalance < 0):
@@ -642,7 +641,7 @@ def optimise_load_profile_balance(
         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))
+            np.maximum(0, building_load._hourly_dhw_load - borefield.load._hourly_dhw_load))
 
         return borefield.load, external_load
 

GHEtool/Methods/optimise_load_profile.py

@@ -35,18 +35,24 @@ def __init__(self,
         multiyear : bool
             True if multiyear data
         """
-        _LoadDataBuilding.__init__(self, efficiency_heating, efficiency_cooling, dhw, efficiency_dhw, multiyear)
+        _LoadDataBuilding.__init__(self, efficiency_heating, efficiency_cooling, efficiency_dhw, multiyear)
         _HourlyData.__init__(self)
 
+        # overwritten by HourlyData
+        self._multiyear = multiyear
+
         # initiate variables
         self._hourly_heating_load: np.ndarray = np.zeros(8760)
         self._hourly_cooling_load: np.ndarray = np.zeros(8760)
+        self._hourly_dhw_load: np.ndarray = None
+        self._set_dhw(dhw)
 
         # delete unnecessary variables
         del self._peak_cooling
         del self._peak_heating
         del self._baseload_cooling
         del self._baseload_heating
+        del self._baseload_dhw
 
     @abc.abstractmethod
     def hourly_cooling_load_simulation_period(self) -> np.ndarray:
@@ -117,6 +123,40 @@ def hourly_dhw_load(self) -> np.ndarray:
         """
         return np.mean(self.hourly_dhw_load_simulation_period.reshape((self.simulation_period, 8760)), axis=0)
 
+    def _set_dhw(self, dhw: Union[float, np.ndarray]) -> None:
+        """
+        This function sets the dhw.
+
+        Parameters
+        ----------
+        dhw : float, np.ndarray
+            Yearly value of array with energy demand for domestic hot water (DHW) [kWh]
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+        ValueError
+            When a yearly value is given or values are negative.
+        """
+        if dhw is None:
+            return
+        if self._multiyear:
+            if isinstance(dhw, (float, int)):
+                raise ValueError('When using a multi year data input, it is not allowed to enter a yearly DHW demand.')
+            self.hourly_dhw_load = dhw
+            return
+
+        # just hourly load
+        if isinstance(dhw, (float, int)):
+            if not dhw >= 0:
+                raise ValueError(f'Please fill in a positive value for the domestic hot water instead of {dhw}.')
+            self.hourly_dhw_load = np.full(8760, dhw / 8760)
+            return
+        self.hourly_dhw_load = dhw
+
     def _get_hourly_cop(self, power: np.ndarray = None) -> Union[float, np.ndarray]:
         """
         This function returns the hourly COP value for the given temperature result profile.
@@ -232,8 +272,6 @@ def hourly_extraction_load_simulation_period(self) -> np.ndarray:
         hourly extraction : np.ndarray
             Hourly extraction values [kWh/h] for the whole simulation period
         """
-        if isinstance(self.dhw, (int, float)) and self.dhw == 0.:
-            return self._hourly_extraction_load_heating_simulation_period
         return self._hourly_extraction_load_heating_simulation_period + self._hourly_extraction_load_dhw_simulation_period
 
     @property

GHEtool/VariableClasses/LoadData/Baseclasses/_HourlyDataBuilding.py

@@ -17,7 +17,6 @@ class _LoadDataBuilding(_LoadData, ABC):
     def __init__(self,
                  efficiency_heating: Union[int, float, COP, SCOP],
                  efficiency_cooling: Union[int, float, EER, SEER, EERCombined],
-                 dhw: Union[float, np.ndarray] = None,
                  efficiency_dhw: Union[int, float, COP, SCOP] = 4,
                  multiyear: bool = False):
         """
@@ -28,8 +27,6 @@ def __init__(self,
             Efficiency in heating
         efficiency_cooling : int, float, EER, SEER
             Efficiency in cooling
-        dhw : float, np.ndarray
-            Yearly value of array with energy demand for domestic hot water (DHW) [kWh]
         efficiency_dhw : int, float, COP, SCOP,
             Efficiency in DHW
         multiyear : bool
@@ -43,7 +40,7 @@ def __init__(self,
         self._baseload_cooling: np.ndarray = np.zeros(12)
         self._peak_heating: np.ndarray = np.zeros(12)
         self._peak_cooling: np.ndarray = np.zeros(12)
-        self._dhw = None
+        self._baseload_dhw: np.ndarray = np.zeros(12)
 
         self._cop = None
         self._eer = None
@@ -57,15 +54,15 @@ def __init__(self,
         self.cop = efficiency_heating
         self.eer = efficiency_cooling
         self.cop_dhw = efficiency_dhw
-        self.dhw = dhw
 
     @abc.abstractmethod
     def monthly_baseload_heating_simulation_period(self) -> np.ndarray:
         """
         This function returns the monthly heating baseload in kWh/month for the whole simulation period.
 
         Returns
-        -------        baseload heating : np.ndarray
+        -------
+        baseload heating : np.ndarray
             Baseload heating for the whole simulation period
         """
 
@@ -142,8 +139,7 @@ def monthly_baseload_cooling(self) -> np.ndarray:
         -------
         monthly baseload cooling : np.ndarray
         """
-        return np.mean(self.monthly_baseload_cooling_simulation_period.reshape((self.simulation_period, 12)),
-                       axis=0)
+        return np.mean(self.monthly_baseload_cooling_simulation_period.reshape((self.simulation_period, 12)), axis=0)
 
     @property
     def monthly_baseload_heating(self) -> np.ndarray:
@@ -154,8 +150,7 @@ def monthly_baseload_heating(self) -> np.ndarray:
         -------
         monthly baseload heating : np.ndarray
         """
-        return np.mean(self.monthly_baseload_heating_simulation_period.reshape((self.simulation_period, 12)),
-                       axis=0)
+        return np.mean(self.monthly_baseload_heating_simulation_period.reshape((self.simulation_period, 12)), axis=0)
 
     @property
     def monthly_peak_cooling(self) -> np.ndarray:
@@ -166,8 +161,7 @@ def monthly_peak_cooling(self) -> np.ndarray:
         -------
         monthly peak cooling : np.ndarray
         """
-        return np.mean(self.monthly_peak_cooling_simulation_period.reshape((self.simulation_period, 12)),
-                       axis=0)
+        return np.mean(self.monthly_peak_cooling_simulation_period.reshape((self.simulation_period, 12)), axis=0)
 
     @property
     def monthly_peak_heating(self) -> np.ndarray:
@@ -178,8 +172,7 @@ def monthly_peak_heating(self) -> np.ndarray:
         -------
         monthly peak heating : np.ndarray
         """
-        return np.mean(self.monthly_peak_heating_simulation_period.reshape((self.simulation_period, 12)),
-                       axis=0)
+        return np.mean(self.monthly_peak_heating_simulation_period.reshape((self.simulation_period, 12)), axis=0)
 
     @property
     def monthly_baseload_cooling_power(self) -> np.ndarray:
@@ -522,7 +515,7 @@ def monthly_baseload_extraction_simulation_period(self) -> np.ndarray:
         baseload extraction : np.ndarray
             Baseload extraction for the whole simulation period
         """
-        if isinstance(self.dhw, (int, float)) and self.dhw == 0.:
+        if not np.any(self.monthly_baseload_dhw):
             return self._monthly_baseload_extraction_heating_simulation_period
         return self._monthly_baseload_extraction_heating_simulation_period + self._monthly_baseload_extraction_dhw_simulation_period
 
@@ -583,7 +576,7 @@ def monthly_peak_extraction_simulation_period(self) -> np.ndarray:
         peak extraction : np.ndarray
             Peak extraction for the whole simulation period
         """
-        if self.exclude_DHW_from_peak or (isinstance(self.dhw, (int, float)) and self.dhw == 0.):
+        if self.exclude_DHW_from_peak:
             return self._monthly_peak_extraction_heating_simulation_period
         return self._monthly_peak_extraction_heating_simulation_period + self._monthly_peak_extraction_dhw_simulation_period
 
@@ -740,6 +733,40 @@ def add_dhw(self, dhw: Union[float, np.ndarray]) -> None:
         """
         self.dhw = dhw
 
+    def _set_dhw(self, dhw: Union[float, np.ndarray]) -> None:
+        """
+        This function sets the dhw.
+
+        Parameters
+        ----------
+        dhw : float, np.ndarray
+            Yearly value of array with energy demand for domestic hot water (DHW) [kWh]
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+        ValueError
+            When a yearly value is given or values are negative.
+        """
+        if dhw is None:
+            return
+        if self._multiyear:
+            if isinstance(dhw, (float, int)):
+                raise ValueError('When using a multi year data input, it is not allowed to enter a yearly DHW demand.')
+            self.baseload_dhw = dhw
+            return
+
+        # just hourly load
+        if isinstance(dhw, (float, int)):
+            if not dhw >= 0:
+                raise ValueError(f'Please fill in a positive value for the domestic hot water instead of {dhw}.')
+            self.baseload_dhw = dhw * self.UPM / 8760.
+            return
+        self.baseload_dhw = dhw
+
     @property
     def dhw(self) -> Union[float, np.ndarray]:
         """
@@ -749,9 +776,9 @@ def dhw(self) -> Union[float, np.ndarray]:
         -------
         DHW object
         """
-        if self._dhw is None:
-            return 0.
-        return self._dhw
+        if self._baseload_dhw is not None:
+            return self._baseload_dhw
+        return np.zeros(12 * self.simulation_period)
 
     @dhw.setter
     def dhw(self, dhw: Union[float, np.ndarray]) -> None:
@@ -768,19 +795,7 @@ def dhw(self, dhw: Union[float, np.ndarray]) -> None:
         -------
         None
         """
-        if dhw is None:
-            return
-        if isinstance(dhw, (float, int)):
-            if self._multiyear:
-                raise ValueError('When using a multi year data input, it is not allowed to enter a yearly DHW demand.')
-            if not dhw >= 0:
-                raise ValueError(f'Please fill in a positive value for the domestic hot water instead of {dhw}.')
-            self._dhw = dhw
-            return
-        if not self._check_input(dhw):
-            raise ValueError('Wrong value for the DHW array. Please make sure the length matches that of the heating '
-                             'and cooling array.')
-        self._dhw = dhw
+        self._set_dhw(dhw)
 
     @property
     def monthly_baseload_dhw_power_simulation_period(self) -> np.ndarray: