Fix space sizing output (spsz) when there is no space HVAC equipment #10947

mjwitte · 2025-02-20T23:44:02Z

Pull request overview

Fixes Space sizing spsz output file is not populated when space sizing is active but there is no space HVAC equipment #10946

Description of the purpose of this PR

Write the spsz output file anytime "Do Space Heat Balance for Sizing" is Yes. Previously it was only written if the idf also included SpaceHVAC:* objects.
Avoid opening and leaving an empty spsz output file if it will not be filled.

Pull Request Author

Reviewer

mjwitte · 2025-02-21T03:44:43Z

tst/EnergyPlus/unit/SizingManager.unit.cc

@@ -4301,4 +4301,6 @@ TEST_F(EnergyPlusFixture, SizingManager_ZoneSizing_Coincident_NonAir_10x_Latent_
    EXPECT_EQ("CHICAGO_IL_USA ANNUAL COOLING 1% DESIGN CONDITIONS DB/MCWB",
              OutputReportPredefined::RetrievePreDefTableEntry(*state, state->dataOutRptPredefined->pdchZnClDesDay, "ZONE 1"));
    EXPECT_EQ("7/21 16:00:00", OutputReportPredefined::RetrievePreDefTableEntry(*state, state->dataOutRptPredefined->pdchZnClPkTime, "ZONE 1"));
+    // Expect output to spsz file
+    EXPECT_FALSE(state->files.spsz.get_output().empty());


This doesn't work. Tried several different ways to check the contents of this file.

mjwitte · 2025-02-21T03:46:29Z

Tested with example files:
5ZoneAirCooledWithSpaces - no spsz output before and after fix
5ZoneAirCooledWithSpaceHeatBalance - spsz output is now fully populated
5ZoneAirCooledWithSpacesHVAC - spsz output fully populated before and after fix

rraustad · 2025-02-21T14:10:23Z

This probably doesn't need any attention but I noticed that, for 5ZoneAirCooledWithSpaceHeatBalance which has auto generated spaces, the header for epluszsz and eplusspsz look the same. Reported as Zone/Space Name ":" Design Day Name ":" Variable Name, so am just noting it here.

Then I checked eplusout.csv and the spaces have their own report names which allows proper reporting (i.e., if they had the same report name they would be duplicates and excel would likely not show the duplicate, they would be in the csv but excel might? get confused). Again, probably nothing to do here.

UPDATE: I have noticed this "duplicate" issue before but it happened when the cooling design day and heating design day date were the same (e.g., 1/21 for cooling and heating), so the header should report accurately). It was the rows that did not show up correctly, not the columns.

rraustad · 2025-02-21T14:29:27Z

Tested 5ZoneAirCooledWithSpaceHeatBalance before and after this fix. This is eplusspsz.csv:

rraustad · 2025-02-21T14:36:28Z

Also tested 5ZoneAirCooledWithSpaceHeatBalance with Do Space Heat Balance for Sizing set as Yes and No. eplusspsz.csv is blank when set to No so this works as expected.

ZoneAirHeatBalanceAlgorithm,
  ThirdOrderBackwardDifference,  !- Algorithm
  No,                      !- Do Space Heat Balance for Sizing
  Yes;                      !- Do Space Heat Balance for Simulation

rraustad · 2025-02-21T15:49:08Z

Just out of curiosity of why the unit test didn't work, at the end of writeZszSpsz the spsz file is closed. Just before it's closed os = unique_ptr, after it's closed os = empty. It's the os pointer that is getting tested in state->files.spsz.get_output().empty()

rraustad · 2025-02-21T19:06:30Z

src/EnergyPlus/ZoneEquipmentManager.cc

+        if (forSpaces) {
+            zoneNum = state.dataHeatBal->space(i).zoneNum;
+        }
+        if (!state.dataHeatBal->Zone(zoneNum).IsControlled) continue;


Only if you have any other changes.

int zoneNum = (forSpaces) ? state.dataHeatBal->space(i).zoneNum : i;

Yes, of course. That construct still is not my first thought, or second, or ...

rraustad

These changes correct the issue.

mjwitte

Walkthru

mjwitte · 2025-02-21T20:14:38Z

src/EnergyPlus/SizingManager.cc

@@ -219,25 +219,6 @@ void ManageSizing(EnergyPlusData &state)
        state.dataGlobal->ZoneSizingCalc = true;
        Available = true;

-        if (state.dataSize->SizingFileColSep == CharComma) {


Move to ZoneEquipmentManager to avoid creating an empty spsz output file. Can't make that decision here yet, because the project data (with Do Space Heat Balance flags) has not been read yet.

mjwitte · 2025-02-21T20:15:08Z

src/EnergyPlus/ZoneEquipmentManager.cc

@@ -2346,14 +2346,15 @@ std::string sizingPeakTimeStamp(EnergyPlusData const &state, int timeStepIndex)
 void writeZszSpsz(EnergyPlusData &state,
                  EnergyPlus::InputOutputFile &outputFile,
                  int const numSpacesOrZones,
-                  Array1D<DataZoneEquipment::EquipConfiguration> const &zsEquipConfig,


This is no longer needed.

mjwitte · 2025-02-21T20:16:40Z

src/EnergyPlus/ZoneEquipmentManager.cc

-        if (!zsEquipConfig(i).IsControlled) continue;
+        int zoneNum = (forSpaces) ? state.dataHeatBal->space(i).zoneNum : i;
+        if (!state.dataHeatBal->Zone(zoneNum).IsControlled) continue;


For sizing output, check if the parent zone is controlled instead of checking zsEquipConfig(i).IsControlled (which is only true if there are SpaceHVAC:* objects).

mjwitte · 2025-02-21T20:18:13Z

src/EnergyPlus/ZoneEquipmentManager.cc

+                } else {
+                    state.files.spsz.filePath = state.files.outputSpszTxtFilePath;
+                }
+                state.files.spsz.ensure_open(state, "UpdateZoneSizing", state.files.outputControl.spsz);


Wait until here to open zsz and spsz files. At this point we know if doSpaceHeatBalanceSizing is active.

Actually glad you fixed this. I saw the 0 kB files but wasn't sure how to avoid that. This is a perfect fix.

mjwitte added 2 commits February 20, 2025 17:29

Update SpaceHVAC idd notes

cccac75

Unit test for spsz output

21a94a3

mjwitte added Defect Includes code to repair a defect in EnergyPlus IDDChange Code changes impact the IDD file (cannot be merged after IO freeze) labels Feb 20, 2025

mjwitte added this to the EnergyPlus 25.1 IO Freeze milestone Feb 20, 2025

Fix spsz output

7d3f762

mjwitte marked this pull request as ready for review February 21, 2025 03:43

mjwitte commented Feb 21, 2025

View reviewed changes

cleanup

b3919bb

rraustad reviewed Feb 21, 2025

View reviewed changes

rraustad approved these changes Feb 21, 2025

View reviewed changes

Use conditional assignment and avoid empty spsz output

1ffab86

mjwitte commented Feb 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix space sizing output (spsz) when there is no space HVAC equipment #10947

Fix space sizing output (spsz) when there is no space HVAC equipment #10947

mjwitte commented Feb 20, 2025 •

edited

Loading

mjwitte Feb 21, 2025

mjwitte commented Feb 21, 2025

rraustad commented Feb 21, 2025 •

edited

Loading

rraustad commented Feb 21, 2025

rraustad commented Feb 21, 2025

rraustad commented Feb 21, 2025 •

edited

Loading

rraustad Feb 21, 2025

mjwitte Feb 21, 2025

rraustad left a comment

mjwitte left a comment

mjwitte Feb 21, 2025

mjwitte Feb 21, 2025

mjwitte Feb 21, 2025

mjwitte Feb 21, 2025

rraustad Feb 21, 2025

Fix space sizing output (spsz) when there is no space HVAC equipment #10947

Are you sure you want to change the base?

Fix space sizing output (spsz) when there is no space HVAC equipment #10947

Conversation

mjwitte commented Feb 20, 2025 • edited Loading

Pull request overview

Description of the purpose of this PR

Pull Request Author

Reviewer

Choose a reason for hiding this comment

mjwitte commented Feb 21, 2025

rraustad commented Feb 21, 2025 • edited Loading

rraustad commented Feb 21, 2025

rraustad commented Feb 21, 2025

rraustad commented Feb 21, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rraustad left a comment

Choose a reason for hiding this comment

mjwitte left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mjwitte commented Feb 20, 2025 •

edited

Loading

rraustad commented Feb 21, 2025 •

edited

Loading

rraustad commented Feb 21, 2025 •

edited

Loading