ecoengine 3.3.0__tar.gz → 3.3.1__tar.gz

{ecoengine-3.3.0 → ecoengine-3.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ecoengine
-Version: 3.3.0
+Version: 3.3.1
 Requires-Python: >=3.11
 Requires-Dist: numpy<3.0,>=2.4
 Requires-Dist: scipy<2.0,>=1.17

{ecoengine-3.3.0 → ecoengine-3.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ecoengine"
-version = "3.3.0"
+version = "3.3.1"
 requires-python = ">=3.11"
 
 # Ranges are bounded on purpose, and the shared ones are kept in sync with

{ecoengine-3.3.0 → ecoengine-3.3.1}/src/ecoengine/objects/components/heating/WaterHeater.py

@@ -307,33 +307,44 @@ class WaterHeater:
             raise ValueError(f"No Controls configured for hour {hour_of_day}.")
         return controls.outlet_temp_f
 
-    def update_state(self, storage_tank: StorageTank, hour_of_day: int) -> None:
+    def update_state(
+        self,
+        storage_tank: StorageTank,
+        timestep_interval: int,
+        interval_min: int = 1,
+    ) -> None:
         """
-        Look up the active Controls for the given hour, then update
+        Look up the active Controls for this timestep's hour, then update
         active/inactive state based on current tank condition.
 
+        On the first interval after a mode change in the control schedule,
+        the heater is turned off before the control check.
         If the heater is currently ON, check should_turn_off().
         If the heater is currently OFF, check should_turn_on().
 
         Parameters
         ----------
         storage_tank : StorageTank
-        hour_of_day : int
-            Hour of the day (0-23), used to select the active Controls from
-            the control schedule.
+        timestep_interval : int
+            Number of elapsed intervals since the start of the simulation.
+        interval_min : int
+            Length of each interval [minutes]. Default 1.
 
         Raises
         ------
         ValueError
-            If no Controls are configured for the given hour.
+            If no Controls are configured for this timestep's hour.
         """
+        hour_of_day = (timestep_interval * interval_min // 60) % 24
         controls = self.get_controls_for_hour(hour_of_day)
         if controls is None:
             raise ValueError(f"No Controls configured for hour {hour_of_day}.")
-        
+
         # QPL Alignment block : QPL states Upon change of load shift operation, disable all heaters if “on sensor” is warmer than “on temperature”.
-        # To do this in EcosizerEngine, we simply turn off water heaters at the beginning of a mode change
-        previous_hour = 23 if hour_of_day == 0 else hour_of_day - 1
+        # To do this in EcosizerEngine, we turn off water heaters on the first interval of a mode change.
+        # previous_hour is the hour of the previous timestep, so it differs from hour_of_day
+        # only on the first interval of an hour (timestep 0 → hour 23).
+        previous_hour = ((timestep_interval - 1) * interval_min // 60) % 24
         if self.control_schedule[hour_of_day] != self.control_schedule[previous_hour]:
             self.turn_off()
 

{ecoengine-3.3.0 → ecoengine-3.3.1}/src/ecoengine/objects/dhwsystems/DHWSystem.py

@@ -1632,7 +1632,7 @@ class DHWSystem:
         if self.storage_tank is not None:
             # Update on/off state for each heater based on current tank condition
             for wh in self.water_heaters:
-                wh.update_state(self.storage_tank, hour_of_day)
+                wh.update_state(self.storage_tank, timestep_interval, interval_min)
 
             # Apply heating from all active heaters to the tank
             total_kbtuh    = sum(

{ecoengine-3.3.0 → ecoengine-3.3.1}/src/ecoengine/objects/dhwsystems/recirc_systems/ParallelLoopSystem.py

@@ -388,7 +388,7 @@ class ParallelLoopSystem(RecircSystem):
             self.return_flow_gpm, self.return_temp_f, interval_min
         )
 
-        self.tm_water_heater.update_state(self.tm_storage_tank, hour_of_day)
+        self.tm_water_heater.update_state(self.tm_storage_tank, timestep_interval, interval_min)
 
         tm_top_temp_f   = self.tm_storage_tank.get_temperature_at_fraction(1.0)
         tm_inlet_temp_f = (self.tm_off_temp_f + self.tm_on_temp_f) / 2.0

{ecoengine-3.3.0 → ecoengine-3.3.1}/src/ecoengine/objects/dhwsystems/recirc_systems/SwingDualFuelSystem.py

@@ -84,7 +84,7 @@ class _SwingDualFuelPrimary(DHWSystem):
         outlet_temp_f = self._get_outlet_temp_f(hour_of_day)
 
         for wh in self.water_heaters:
-            wh.update_state(self.storage_tank, hour_of_day)
+            wh.update_state(self.storage_tank, timestep_interval, interval_min)
 
         total_kbtuh = sum(
             wh.get_output_kbtuh(oat_f, wh.get_outlet_temp_f(hour_of_day), inlet_temp_f)
@@ -420,7 +420,7 @@ class SwingDualFuelSystem(SwingSystem):
 
         # --- 2. Primary heater: update state and heat primary tank ---
         for wh in self.water_heaters:
-            wh.update_state(self.storage_tank, hour_of_day)
+            wh.update_state(self.storage_tank, timestep_interval, interval_min)
 
         primary_kbtuh = sum(
             wh.get_output_kbtuh(oat_f, wh.get_outlet_temp_f(hour_of_day), inlet_temp_f)
@@ -463,7 +463,7 @@ class SwingDualFuelSystem(SwingSystem):
         self.tm_storage_tank.mix_primary_inflow(result["storage_draw_gal"], result["inlet_temp_f"])
 
         # --- 5. TM element: update state and heat swing tank ---
-        self.tm_water_heater.update_state(self.tm_storage_tank, hour_of_day)
+        self.tm_water_heater.update_state(self.tm_storage_tank, timestep_interval, interval_min)
         tm_ctrl     = self.tm_water_heater.get_controls_for_hour(hour_of_day)
         tm_outlet_f = tm_ctrl.off_trigger_t_f
         tm_kbtuh    = self.tm_water_heater.get_output_kbtuh(oat_f, tm_outlet_f)

{ecoengine-3.3.0 → ecoengine-3.3.1}/src/ecoengine/objects/dhwsystems/recirc_systems/SwingSystem.py

@@ -953,7 +953,7 @@ class SwingSystem(RecircSystem):
         )
         # --- 2. Primary heater: update state and heat primary tank ---
         for wh in self.water_heaters:
-            wh.update_state(self.storage_tank, hour_of_day)
+            wh.update_state(self.storage_tank, timestep_interval, interval_min)
 
         top_temp_f    = self.storage_tank.get_temperature_at_fraction(1.0)
         primary_kbtuh = sum(
@@ -992,7 +992,7 @@ class SwingSystem(RecircSystem):
             self.get_recirc_loss_kbtuh(), interval_min
         )
         # --- 7. TM element: update state and heat swing tank ---
-        self.tm_water_heater.update_state(self.tm_storage_tank, hour_of_day)
+        self.tm_water_heater.update_state(self.tm_storage_tank, timestep_interval, interval_min)
         tm_ctrl     = self.tm_water_heater.get_controls_for_hour(hour_of_day)
         tm_outlet_f = tm_ctrl.off_trigger_t_f
         tm_kbtuh    = self.tm_water_heater.get_output_kbtuh(oat_f, tm_outlet_f)

{ecoengine-3.3.0 → ecoengine-3.3.1}/src/ecoengine/objects/dhwsystems/rtp_systems/MP_RTPInSeriesSystem.py

@@ -347,7 +347,7 @@ class MP_RTPInSeriesSystem(MultiPassRTPSystem):
         # the fully-mixed slug zone, so get_temperature_at_fraction returns
         # slug_temp_f.  The heater turns off when slug_temp_f >= off_trigger_t_f.
         for wh in self.water_heaters:
-            wh.update_state(tank, hour_of_day)
+            wh.update_state(tank, timestep_interval, interval_min)
 
         is_heating = any(wh.is_active() for wh in self.water_heaters)
 
@@ -401,7 +401,7 @@ class MP_RTPInSeriesSystem(MultiPassRTPSystem):
             self.gas_storage_tank.mix_primary_inflow(draw_gal, primary_draw_temp_f)
 
         # Gas water heater heating
-        self.gas_water_heater.update_state(self.gas_storage_tank, hour_of_day)
+        self.gas_water_heater.update_state(self.gas_storage_tank, timestep_interval, interval_min)
         gas_ctrl     = self.gas_water_heater.get_controls_for_hour(hour_of_day)
         gas_outlet_f = gas_ctrl.outlet_temp_f
         gas_kbtuh    = self.gas_water_heater.get_output_kbtuh(oat_f, gas_outlet_f)

{ecoengine-3.3.0 → ecoengine-3.3.1}/src/ecoengine/objects/dhwsystems/rtp_systems/MultiPassRTPSystem.py

@@ -590,7 +590,7 @@ class MultiPassRTPSystem(RTPSystem):
         # the fully-mixed slug zone, so get_temperature_at_fraction returns
         # slug_temp_f.  The heater turns off when slug_temp_f >= off_trigger_t_f.
         for wh in self.water_heaters:
-            wh.update_state(tank, hour_of_day)
+            wh.update_state(tank, timestep_interval, interval_min)
 
         is_heating = any(wh.is_active() for wh in self.water_heaters)
 

{ecoengine-3.3.0 → ecoengine-3.3.1}/src/ecoengine/objects/dhwsystems/rtp_systems/SP_RTPInParallelSystem.py

@@ -432,8 +432,8 @@ class SP_RTPInParallelSystem(SinglePassRTPSystem):
         self.storage_tank.update_cold_temp_f(inlet_temp_f)
         # Update on/off state for each heater based on current tank condition
         for wh in self.water_heaters:
-            wh.update_state(self.storage_tank, hour_of_day)
-        self.gas_water_heater.update_state(self.storage_tank, hour_of_day)
+            wh.update_state(self.storage_tank, timestep_interval, interval_min)
+        self.gas_water_heater.update_state(self.storage_tank, timestep_interval, interval_min)
         # Apply heating from all active heaters to the tank
         total_kbtuh    = sum(
             wh.get_output_kbtuh(oat_f, wh.get_outlet_temp_f(hour_of_day), inlet_temp_f)

{ecoengine-3.3.0 → ecoengine-3.3.1}/src/ecoengine/objects/dhwsystems/rtp_systems/SP_RTPInSeriesSystem.py

@@ -354,7 +354,7 @@ class SP_RTPInSeriesSystem(SinglePassRTPSystem):
         self.storage_tank.update_cold_temp_f(inlet_temp_f)
         # Update on/off state for each heater based on current tank condition
         for wh in self.water_heaters:
-            wh.update_state(self.storage_tank, hour_of_day)
+            wh.update_state(self.storage_tank, timestep_interval, interval_min)
 
         # Apply heating from all active heaters to the tank
         total_kbtuh    = sum(
@@ -391,7 +391,7 @@ class SP_RTPInSeriesSystem(SinglePassRTPSystem):
 
         # Gas water heater heating
         self.gas_storage_tank.mix_primary_inflow(draw_gal, primary_draw_temp_f)
-        self.gas_water_heater.update_state(self.gas_storage_tank, hour_of_day)
+        self.gas_water_heater.update_state(self.gas_storage_tank, timestep_interval, interval_min)
         gas_ctrl     = self.gas_water_heater.get_controls_for_hour(hour_of_day)
         gas_outlet_f = gas_ctrl.outlet_temp_f if gas_ctrl is not None else self.supply_temp_f + _GAS_DEADBAND_F
         gas_kbtuh    = self.gas_water_heater.get_output_kbtuh(oat_f, gas_outlet_f)

{ecoengine-3.3.0 → ecoengine-3.3.1}/src/ecoengine/objects/dhwsystems/rtp_systems/SinglePassRTPSystem.py

@@ -376,7 +376,7 @@ class SinglePassRTPSystem(RTPSystem):
             self.storage_tank.update_cold_temp_f(inlet_temp_f)
             # Update on/off state for each heater based on current tank condition
             for wh in self.water_heaters:
-                wh.update_state(self.storage_tank, hour_of_day)
+                wh.update_state(self.storage_tank, timestep_interval, interval_min)
 
             # Apply heating from all active heaters to the tank
             total_kbtuh    = sum(

{ecoengine-3.3.0 → ecoengine-3.3.1}/src/ecoengine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ecoengine
-Version: 3.3.0
+Version: 3.3.1
 Requires-Python: >=3.11
 Requires-Dist: numpy<3.0,>=2.4
 Requires-Dist: scipy<2.0,>=1.17