DesignSpecification:ZoneHVAC:Sizing and Sizing:System docs fixes

[joseph-robertson]

Pull request overview

• Fixes some inconsistencies in group-design-objects.tex.

Description of the purpose of this PR

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

[joseph-robertson]

I did some local testing using AirflowNetwork_MultiZone_House_OvercoolDehumid.idf (which contains both AirLoopHVAC:UnitaryHeatCool and Sizing:System objects), and indeed this bugfix seems to do what we want: Nominal Heating Capacity for AirLoopHVAC:UnitaryHeatCool now takes into account Fraction of Autosized Heating Design Capacity, and matches the Design Size Nominal Capacity for Coil:Heating:Fuel.

However, it doesn't appear any of the existing unit or regression tests cover this particular situation. Is local testing enough, or should I introduce a new unit test or sample file?

[mitchute]

A unit tests is probably preferred, though if you're able to modify the AirflowNetwork_MultiZone_House_OvercoolDehumid.idf test file without sacrificing other aspects, then that may also be an option.

[github-actions]

⚠️ Regressions detected on macos-14 for commit 0e3ec30

Regression Summary

• Audit: 1
• EIO: 1
• ESO Big Diffs: 1
• MTR Big Diffs: 1
• Table Big Diffs: 1
• Table String Diffs: 1

• View Results
• Download Regressions

[github-actions]

⚠️ Regressions detected on ubuntu-24.04 for commit 0e3ec30

Regression Summary

• Audit: 1
• EIO: 1
• ESO Big Diffs: 1
• MTR Big Diffs: 1
• Table Big Diffs: 1
• Table String Diffs: 1

• View Results
• Download Regressions

[github-actions]

⚠️ Regressions detected on macos-14 for commit 2e713cf

Regression Summary

• Audit: 1
• EIO: 1
• ESO Big Diffs: 1
• MTR Big Diffs: 1
• Table Big Diffs: 1
• Table String Diffs: 1

• View Results
• Download Regressions

[github-actions]

⚠️ Regressions detected on ubuntu-24.04 for commit 2e713cf

Regression Summary

• Audit: 1
• EIO: 1
• ESO Big Diffs: 1
• MTR Big Diffs: 1
• Table Big Diffs: 1
• Table String Diffs: 1

• View Results
• Download Regressions

[mitchute]

@rraustad @joseph-robertson is everyone happy here?

[rraustad]

Code Integrity check on CppCheck looks unrelated. Otherwise everyone is happy.

[mitchute]

Docs build locally and the other test failures are unrelated. Merging.