Baseboard connected to a plant but omitted from ZoneHVAC:EquipmentList will now throw a Severe error

[rraustad]

Pull request overview

• Fixes Zone equipment object that was omitted from zone equipment list causing cryptic errors #4787

Defect file: 4787-in.idf.txt

Description of the purpose of this PR

Plant components are checked for valid entry and plant equipment that are in a zone also need to list the component in a ZoneHVAC:EquipmentList. This check has been added to the branch integrity checking.

Pull Request Author

• 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
• If adding/removing any output files (e.g., eplustbl.*)
  • Update ..\scripts\Epl-run.bat
  • Update ..\scripts\RunEPlus.bat
  • Update ..\src\EPLaunch\ MainModule.bas, epl-ui.frm, and epl.vbp (VersionComments)
  • Update ...github\workflows\energyplus.py

Reviewer

• 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

[rraustad]

Defect file now terminates the simulation with the following new warnings:

************* Testing Individual Branch Integrity
** Severe  ** CheckBranchEquipInZoneHVACEquipList: Branch = DK_ZWEIG, contains a component of type ZONEHVAC:LOWTEMPERATURERADIANT:CONSTANTFLOW with name = BTKUEHLUNG_1DIM
**   ~~~   ** but that component is not listed in any ZoneHVAC:EquipmentList.
** Severe  ** CheckBranchEquipInZoneHVACEquipList: Branch = DW_ZWEIG, contains a component of type ZONEHVAC:LOWTEMPERATURERADIANT:CONSTANTFLOW with name = BTKUEHLUNG_1DIM
**   ~~~   ** but that component is not listed in any ZoneHVAC:EquipmentList.
** Severe  ** Branch(es) did not pass integrity testing

[rraustad]

Pretty simple check that certain plant components are listed in ZoneHVAC:EquipmentList.

[mitchute]

@rraustad I think this will cause it to exit on the first instance omitted on the branch, but not catch subsequent ones on the same branch. Is that worth dealing with?

[rraustad]

If baseboards are ever in series on a branch, however unlikely I would think that configuration would be, and removing this would also catch that corner-corner case then I will remove this last break. I just didn't think that would ever be the case.

[github-actions]

⚠️ Regressions detected on ubuntu-24.04 for commit 74a7201

Regression Summary

• ESO Small Diffs: 708
• Table Small Diffs: 393
• MTR Small Diffs: 525
• Table String Diffs: 177
• EIO: 397
• JSON Small Diffs: 2
• ZSZ Small Diffs: 71
• Table Big Diffs: 35
• ERR: 15
• MTR Big Diffs: 2
• EDD: 4
• ESO Big Diffs: 10
• SSZ Small Diffs: 13
• JSON Big Diffs: 2

• View Results
• Download Regressions

[mitchute]

Thanks @rraustad