Fix #10899 - Output:Table:Monthly: SumOrAverageDuringHoursShown doesn't follow previous variable

[jmarrec]

Pull request overview

• Fixes Output:Table:Monthly: SumOrAverageDuringHoursShown doesn't follow previous variable #10899

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

• Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
• Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
• Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
• Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
• If any diffs are expected, author must demonstrate they are justified using plots and descriptions
• If changes fix a defect, the fix should be demonstrated in plots and descriptions
• If any defect files are updated to a more recent version, upload new versions here or on DevSupport
• If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
• If structural output changes, add to output rules file and add OutputChange label
• If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

This will not be exhaustively relevant to every PR.

• Perform a Code Review on GitHub
• If branch is behind develop, merge develop and build locally to check for side effects of the merge
• If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
• If feature, test running new feature, try creative ways to break it
• CI status: all green or justified
• Check that performance is not impacted (CI Linux results include performance check)
• Run Unit Test(s) locally
• Check any new function arguments for performance impacts
• Verify IDF naming conventions and styles, memos and notes and defaults
• If new idf included, locally check the err file and other outputs

[jmarrec]

Unrelated, but started by adding a getEnumValues call to replace a big if-else (1/2)

[jmarrec]

Unrelated, but started by adding a getEnumValues call to replace a big if-else (2/2)

[jmarrec]

This is because the previous chain was

for (int jField = 2; jField <= NumAlphas; jField += 2) {
    if (AlphArray(jField).empty())  {
        ShowWarningError(...);
    }
    AggType curAggType= ...;
    if (!AlphArray(jField).empty()) {
        AddMonthlyFieldSetInput(state, curTable, AlphArray(jField), "", curAggType);
    }
}

I just simplified it (if the field is blank and is going to be ignored, there's not really a good value addition of checking the AggType is valid anyways):

for (int jField = 2; jField <= NumAlphas; jField += 2) {
    if (AlphArray(jField).empty())  {
        ShowWarningError(...);
        continue;
    }

    AggType curAggType= ...;
    AddMonthlyFieldSetInput(state, curTable, AlphArray(jField), "", curAggType);
}

[jmarrec]

sentinal variable to know when to break the for loop

[jmarrec]

The issue was that an if else ladder inside a loop was incorrectly refactored to a switch case:

This was the original thing

for (int i = ....) {
  SELECT_CASE_var = XXXX
  if (SELECT_CASE_var == blabla) {
    break; // THIS BREAKS THE FOR LOOP
   } else ...
}

The refactor:

for (int i = ....) {
  switch (XXX) {
  case blabla:
    break; // THIS DO NOT BREAK THE FOR LOOP, it just prevents other `case`s to be processed (fallthrough)
  }
  ...
 }

[jmarrec]

test input data, mimics the defect file in #10899

[jmarrec]

I'm going to be checking:

• VariableToBeSummedDuringHourShown when Condition A
• VariableToBeSummedDuringHourShown when Condition is not(A)
• VariableToBeSummedDuringHourShown with no condition

[jmarrec]

It already goes sideways before fix here.

You expect colValueWhenConditionNotA to be zero, yet it's 1.0 here.

Full test output before fix

[ RUN      ] EnergyPlusFixture.OutputReportTabularMonthly_HandleMultipleDuringHoursShown
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/OutputReportTabular.unit.cc:13785: Failure
Expected equality of these values:
  0.0
    Which is: 0
  ort->MonthlyColumns(colValueWhenConditionNotA).reslt(12)
    Which is: 1
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/OutputReportTabular.unit.cc:13795: Failure
Expected equality of these values:
  0.0
    Which is: 0
  ort->MonthlyColumns(colValueWhenConditionNotA).reslt(12)
    Which is: 2
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/OutputReportTabular.unit.cc:13805: Failure
Expected equality of these values:
  1.0
    Which is: 1
  ort->MonthlyColumns(colValueWhenConditionNotA).reslt(12)
    Which is: 3
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/OutputReportTabular.unit.cc:13815: Failure
Expected equality of these values:
  2.0
    Which is: 2
  ort->MonthlyColumns(colValueWhenConditionNotA).reslt(12)
    Which is: 4
/home/julien/Software/Others/EnergyPlus/tst/EnergyPlus/unit/OutputReportTabular.unit.cc:13824: Failure
Expected equality of these values:
  2.0
    Which is: 2
  ort->MonthlyColumns(colValueWhenConditionNotA).reslt(12)
    Which is: 5
[  FAILED  ] EnergyPlusFixture.OutputReportTabularMonthly_HandleMultipleDuringHoursShown (2280 ms)

[jmarrec]

• Using the defect file provided for in Output:Table:Monthly: SumOrAverageDuringHoursShown doesn't follow previous variable #10899

https://github.com/NREL/EnergyPlusDevSupport/blob/master/DefectFiles/10000s/10899/GA_SF_CZ2AWH_gasfurnace_heatedbsmt_IECC_2021_no.idf