ecoengine 3.1.2__tar.gz → 3.1.4__tar.gz

{ecoengine-3.1.2 → ecoengine-3.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ecoengine
-Version: 3.1.2
+Version: 3.1.4
 Requires-Python: >=3.11
 Requires-Dist: numpy
 Requires-Dist: scipy

{ecoengine-3.1.2 → ecoengine-3.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ecoengine"
-version = "3.1.2"
+version = "3.1.4"
 requires-python = ">=3.11"
 dependencies = ["numpy", "scipy", "plotly>=4.12.0"]
 

{ecoengine-3.1.2 → ecoengine-3.1.4}/src/ecoengine/objects/components/storage/StratifiedTank.py

@@ -264,8 +264,8 @@ class StratifiedTank(StorageTank):
                 hi = mid
             if hi - lo < 1e-6:
                 break
-
-        if yield_mid < volume_supplyT_gal - 1e-6:
+            
+        if yield_mid < volume_supplyT_gal - 1e-6 and hi == self.total_volume_gal and hi - lo < 1e-6:
             # Even the largest physical draw the search explored (bounded at
             # total_volume_gal) falls short of demand -- a true outage. The
             # binary search's upper bound assumes one tank-volume of draw is

{ecoengine-3.1.2 → ecoengine-3.1.4}/src/ecoengine/objects/dhwsystems/DHWSystem.py

@@ -1188,95 +1188,6 @@ class DHWSystem:
 
         return (transition_temp_sum + fully_hot_temp_sum) / total_phys_gal
 
-    def _strat_factor_for_on_params(
-        self,
-        on_fract: float,
-        on_temp_f: float,
-        strat_slope: float,
-    ) -> float:
-        """
-        Compute the stratification factor for a single (on_fract, on_temp_f) pair.
-
-        The tank temperature profile is modeled as a linear gradient in the
-        transition zone between cold and fully-hot layers. The slope of that
-        gradient is strat_slope [°F / %-height].
-
-        Parameters
-        ----------
-        on_fract : float
-            Fractional height of the aquastat ON sensor (0 = bottom, 1 = top).
-        on_temp_f : float
-            Temperature at the aquastat sensor when the heater turns on [°F].
-        strat_slope : float
-            Temperature gradient [°F per percentage-point of tank height].
-
-        Returns
-        -------
-        float
-            Stratification factor (0-1). A value of 1.0 means all storage
-            above the aquastat is at full storage temperature (ideal).
-        """
-        on_pct  = on_fract * 100
-        delta_t = self.storage_temp_f - self.supply_temp_f
-
-        # Tank height (%) where temperature profile crosses supply and storage setpoints
-        supply_height_pct  = on_pct + (self.supply_temp_f  - on_temp_f) / strat_slope
-        storage_height_pct = on_pct + (self.storage_temp_f - on_temp_f) / strat_slope
-        storage_height_pct = min(storage_height_pct, 100.0)
-        # TODO : if storage_height_pct is 100, shouldn't we realculate 
-        #   delta_t based off of what temperature is actually at the top
-
-        # Clamp supply_height_pct so the transition zone stays within [on_pct, 100].
-        # If on_temp_f >= storage_temp_f the whole tank above the aquastat is fully
-        # hot, which gives a factor of 1.0 — the clamp produces that naturally.
-        supply_height_pct = max(supply_height_pct, on_pct)
-        # TODO: shouldn't supply_height_pct always just be where supply temp percentage height is on the tank?
-        #   If there is some water that is supply temp under on_pct, it is still usable water
-
-        # Volume above supply temp = fully-hot zone + trapezoidal transition zone
-        vol_fully_hot    = (100 - storage_height_pct) * delta_t
-        vol_transition   = (storage_height_pct - supply_height_pct) * delta_t / 2
-        # TODO : delta T in the above two lines should, I am pretty sure, be the difference between supply temp (or lowest emp in tank if whole tank is above supply)
-        #   and true top of tank temperature
-        vol_above_supply = vol_fully_hot + vol_transition
-
-        # Ideal case: all volume above the aquastat is at full storage temp
-        ideal_vol = (100 - on_pct) * delta_t
-        # TODO : delta_t in this case is actually the difference between storage and supply as this is a perfectly stratified tank
-
-        return vol_above_supply / ideal_vol
-
-    def _strat_pct_of_tank(
-        self,
-        on_fract: float,
-        on_temp_f: float,
-        strat_slope: float,
-    ) -> float:
-        """
-        Return the fraction of the *total* tank volume that is at or above
-        supply temperature when the ON sensor is at on_fract and reads
-        on_temp_f.
-
-        This is the "percent of whole tank" form of the stratification factor:
-
-            strat_pct = strat_factor * (1 - on_fract)
-
-        Used in load-shift sizing where the effective storage band is the
-        difference between two aquastat levels expressed as fractions of the
-        entire tank volume, not just the volume above one aquastat.
-
-        Parameters
-        ----------
-        on_fract : float
-        on_temp_f : float
-        strat_slope : float
-
-        Returns
-        -------
-        float
-        """
-        return self._strat_factor_for_on_params(on_fract, on_temp_f, strat_slope) * (1.0 - on_fract)
-
     @staticmethod
     def _is_load_shifting(control_map: dict[str, Controls] | None) -> bool:
         """Return True if the control_map has a ``"shed"`` key."""
@@ -1398,6 +1309,7 @@ class DHWSystem:
             Generation rate [gal/hr at supplyT].
         """
         daily_gal           = building.daily_dhw_use_supplyT_gal
+        inlet_temp_f      = self._require_design_inlet_temp(building)
         normal_gen_rate_gph = daily_gal / self.max_daily_run_hr #TODO min of this and number of non-shed hours?
 
         _, load_up_hours = self._get_first_shed_block_and_load_up_hours(control_schedule)
@@ -1412,15 +1324,15 @@ class DHWSystem:
         lu_ctrl     = control_map.get("loadUp", normal_ctrl)
         shed_ctrl   = control_map["shed"]
 
-        normal_strat_pct = self._strat_pct_of_tank(
-            normal_ctrl.on_sensor_fract, normal_ctrl.on_trigger_t_f, strat_slope
-        )
-        lu_strat_pct = self._strat_pct_of_tank(
-            lu_ctrl.on_sensor_fract, lu_ctrl.on_trigger_t_f, strat_slope
-        )
-        shed_strat_pct = self._strat_pct_of_tank(
-            shed_ctrl.on_sensor_fract, shed_ctrl.on_trigger_t_f, strat_slope
-        )
+        normal_strat_pct = self._calc_supply_temp_gal_from_100gal_tank(
+                normal_ctrl.on_sensor_fract, normal_ctrl.on_trigger_t_f, strat_slope, inlet_temp_f
+            ) / 100.0
+        lu_strat_pct = self._calc_supply_temp_gal_from_100gal_tank(
+                lu_ctrl.off_sensor_fract, lu_ctrl.off_trigger_t_f, strat_slope, inlet_temp_f
+            ) / 100.0
+        shed_strat_pct = self._calc_supply_temp_gal_from_100gal_tank(
+                shed_ctrl.on_sensor_fract, shed_ctrl.on_trigger_t_f, strat_slope, inlet_temp_f
+            ) / 100.0
 
         ls_band = lu_strat_pct - shed_strat_pct
         if ls_band <= 0:

{ecoengine-3.1.2 → ecoengine-3.1.4}/src/ecoengine/objects/dhwsystems/recirc_systems/SwingSystem.py

@@ -585,6 +585,7 @@ class SwingSystem(RecircSystem):
         Returns the maximum.
         """
         daily_gal           = building.daily_dhw_use_supplyT_gal
+        inlet_temp_f      = self._require_design_inlet_temp(building)
         normal_gen_rate_gph = daily_gal * self._eff_mix_fraction / self.max_daily_run_hr
 
         _, load_up_hours = self._get_first_shed_block_and_load_up_hours(control_schedule)
@@ -598,10 +599,15 @@ class SwingSystem(RecircSystem):
         normal_ctrl = control_map["normal"]
         lu_ctrl     = control_map.get("loadUp", normal_ctrl)
         shed_ctrl   = control_map["shed"]
-
-        lu_strat     = self._strat_pct_of_tank(lu_ctrl.on_sensor_fract,     lu_ctrl.on_trigger_t_f,     strat_slope)
-        normal_strat = self._strat_pct_of_tank(normal_ctrl.on_sensor_fract, normal_ctrl.on_trigger_t_f, strat_slope)
-        shed_strat   = self._strat_pct_of_tank(shed_ctrl.on_sensor_fract,   shed_ctrl.on_trigger_t_f,   strat_slope)
+        normal_strat = self._calc_supply_temp_gal_from_100gal_tank(
+                normal_ctrl.on_sensor_fract, normal_ctrl.on_trigger_t_f, strat_slope, inlet_temp_f
+            ) / 100.0
+        lu_strat = self._calc_supply_temp_gal_from_100gal_tank(
+                lu_ctrl.off_sensor_fract, lu_ctrl.off_trigger_t_f, strat_slope, inlet_temp_f
+            ) / 100.0
+        shed_strat = self._calc_supply_temp_gal_from_100gal_tank(
+                shed_ctrl.on_sensor_fract, shed_ctrl.on_trigger_t_f, strat_slope, inlet_temp_f
+            ) / 100.0
 
         ls_band = lu_strat - shed_strat
         if ls_band <= 0:

{ecoengine-3.1.2 → ecoengine-3.1.4}/src/ecoengine/objects/simulation/SimulationRun.py

@@ -332,7 +332,16 @@ class SimulationRun:
 
         Columns: timestep, time_min, dhw_demand_supplyT_gal,
         usable_volume_supplyT_gal, heater_output_kbtuh, heater_power_in_kw,
-        oat_f, inlet_water_temp_f, tank_temp_0pct, tank_temp_20pct, ..., tank_temp_100pct.
+        oat_f, inlet_water_temp_f, tank_temp_0pct, tank_temp_20pct, ...,
+        tank_temp_100pct, mode.
+
+        When applicable (non-empty for this run), also includes
+        tm_tank_temp_f, tm_heater_output_kbtuh, tm_heater_input_kw. These
+        columns cover the swing/TM tank for SwingSystem-family schematics,
+        the gas storage tank + gas heater for the in-series dual-fuel
+        schematics (SP_RTPInSeriesSystem, MP_RTPInSeriesSystem), and the gas
+        heater's output/input power for SP_RTPInParallelSystem (which has no
+        separate tank, so tm_tank_temp_f is omitted for that schematic).
 
         Parameters
         ----------
@@ -342,17 +351,31 @@ class SimulationRun:
         import csv as _csv
         n = len(self.dhw_demand_supplyT_gal)
         tank_col_names = [f"tank_temp_{int(f*100)}pct" for f in _TANK_NODE_FRACTS]
+
+        has_tm_temp   = len(self.tm_tank_temp_f)         == n
+        has_tm_output = len(self.tm_heater_output_kbtuh) == n
+        has_tm_kw     = len(self.tm_heater_input_kw)     == n
+
+        header = [
+            "timestep", "time_min",
+            "dhw_demand_supplyT_gal", "usable_volume_supplyT_gal",
+            "heater_output_kbtuh", "heater_power_in_kw",
+            "oat_f", "inlet_water_temp_f",
+            *tank_col_names,
+            "mode",
+        ]
+        if has_tm_temp:
+            header.append("tm_tank_temp_f")
+        if has_tm_output:
+            header.append("tm_heater_output_kbtuh")
+        if has_tm_kw:
+            header.append("tm_heater_input_kw")
+
         with open(filepath, "w", newline="") as f:
             writer = _csv.writer(f)
-            writer.writerow([
-                "timestep", "time_min",
-                "dhw_demand_supplyT_gal", "usable_volume_supplyT_gal",
-                "heater_output_kbtuh", "heater_power_in_kw",
-                "oat_f", "inlet_water_temp_f",
-                *tank_col_names,
-            ])
+            writer.writerow(header)
             for i in range(n):
-                writer.writerow([
+                row = [
                     i,
                     i * self.timestep_min,
                     self.dhw_demand_supplyT_gal[i],
@@ -362,7 +385,15 @@ class SimulationRun:
                     self.oat_f[i],
                     self.inlet_water_temp_f[i],
                     *(self.tank_temps_f[node][i] for node in range(len(_TANK_NODE_FRACTS))),
-                ])
+                    self.heater_mode[i],
+                ]
+                if has_tm_temp:
+                    row.append(self.tm_tank_temp_f[i])
+                if has_tm_output:
+                    row.append(self.tm_heater_output_kbtuh[i])
+                if has_tm_kw:
+                    row.append(self.tm_heater_input_kw[i])
+                writer.writerow(row)
 
     def to_plotly(
         self,

{ecoengine-3.1.2 → ecoengine-3.1.4}/src/ecoengine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ecoengine
-Version: 3.1.2
+Version: 3.1.4
 Requires-Python: >=3.11
 Requires-Dist: numpy
 Requires-Dist: scipy