Fix #4699 - E+ 22.2: ZoneHVAC:PackagedTerminal AirConditionner/HeatPump requires a supply air fan operating mode schedule

[jmarrec]

Pull request overview

• Fixes E+ 22.2: ZoneHVAC:PackagedTerminal AirConditionner/HeatPump requires a supply air fan operating mode schedule #4699
• Fixes Broken transition rules for OS:Coil:Heating:Gas:MultiStage #4703

Changes to ZoneHVACPackagedTerminalAirConditioner and ZoneHVACPackagedTerminalHeatPump

API Break

* `ZoneHVACPackagedTerminalAirConditioner` and `ZoneHVACPackagedTerminalHeatPump` have an API-breaking change related to its `supplyAirFanOperatingModeSchedule` getter. It is now a required field that returns `Schedule` instead of `boost::optional<Schedule>`. Method `resetSupplyAirFanOperatingModeSchedule` is also removed.
    * It is set to `alwaysOnDiscreteSchedule` (=Constant) in the Constructor if you provide a `FanConstantVolume` (This is **required** by E+)
    * It is set to `alwaysOffDiscreteSchedule` (=Cycling) in the Constructor if you provide any other fan types (E+ treats a blank schedule as always off)

Unusual Version Translation rules to preserve functionality and Energy Usage

* There are unusual `VersionTranslator` Rules for Packaged Systems (PTAC or PTHP) that use a `FanConstantVolume` and that do not have a `Supply Air Fan Operating Mode Schedule`. In 22.1.0 this would effectively, and mistakenly, function as a cycling fan, but this is now disallowed in E+ 22.2.0. In order to retain a similar functionality and energy usage, the `FanConstantVolume` will be replaced by a `FanSystemModel` with an Always Off Schedule (=cycling fan, similar to a `Fan:OnOff`), mapping inputs such as pressure rise and efficiency appropriately.

Pull Request Author

• Model API Changes / Additions
• Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
• Model API methods are tested (in src/model/test)
• EnergyPlus ForwardTranslator Tests (in src/energyplus/Test)
• If a new object or method, added a test in NREL/OpenStudio-resources: Add Link
• If needed, added VersionTranslation rules for the objects (src/osversion/VersionTranslator.cpp)
• Verified that C# bindings built fine on Windows, partial classes used as needed, etc.
• All new and existing tests passes
• If methods have been deprecated, update rest of code to use the new methods

Labels:

• If change to an IDD file, add the label IDDChange
• If breaking existing API, add the label APIChange
• If deemed ready, add label Pull Request - Ready for CI so that CI builds your PR

Review Checklist

This will not be exhaustively relevant to every PR.

• Perform a Code Review on GitHub
• Code Style, strip trailing whitespace, etc.
• All related changes have been implemented: model changes, model tests, FT changes, FT tests, VersionTranslation, OS App
• Labeling is ok
• 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

[jmarrec]

Using a custom build of E+ on my fork: https://github.com/jmarrec/EnergyPlus/releases/tag/v22.2.0-WithIHGFix

At this point the only failure I have left is the ems_scott.osm and it is due to ZoneMixing mapping to Spaces and EMS usage.

The EUI deviations are wild, but this is because the tests use a Fan:ConstantVolume, and before we didn't set a schedule so it was working as a cycling fan... bummer. I think I'm going to have to modify the tests / baseline lib to include a Schedule of always 1 and run all reg tests backwards in all OS version... geez.

[ci-commercialbuildings]

CI Results for 46881f6:

• Ubuntu 18.04:

  • OpenStudio-3.5.0-alpha+46881f6991-Ubuntu-18.04.deb
  • OpenStudio-3.5.0-alpha+46881f6991-Ubuntu-18.04.tar.gz

• Ubuntu 20.04:

  • OpenStudio-3.5.0-alpha+46881f6991-Ubuntu-20.04.deb
  • OpenStudio-3.5.0-alpha+46881f6991-Ubuntu-20.04.tar.gz
  • perf_test/results.html

• Darwin:

  • OpenStudio-3.5.0-alpha+46881f6991-Darwin-x86_64.dmg
  • OpenStudio-3.5.0-alpha+46881f6991-Darwin-x86_64.tar.gz

• Windows:

  • OpenStudio-3.5.0-alpha+efcc5a07bb-Windows.exe
  • OpenStudio-3.5.0-alpha+efcc5a07bb-Windows.tar.gz

• Code Coverage:

[jmarrec]

I made a modification in NatLabRockies/OpenStudio-resources@9a404be to force an Aways On Supply Air Fan Operating Mode Schedule, and rerun with OS 3.4.0, so I could exclude that.

Looks better.

[jmarrec]

Diff between 3.4.0 PackagedFanOpSch and 3.5.0:

I'm confused by the ptac_othercoils.osm one. Looking into it

[jmarrec]

I don't get why ptac_othercoils.osm is overusing by 30%...

[tijcolem]

"I think I'm going to have to modify the tests / baseline lib to include a Schedule of always 1 and run all reg tests backwards in all OS version... geez". We can deal with this post release if this still needs to happen.

So I ran regression tests on tip of develop and seeing 69 failures which I'm assuming all due to the large EUI diffs you highlighted above? I am re-running the windows as I saw some unit test failures but it could be a build cache issue going on with that. @jmarrec I'll check results but providing windows checks out I'm assuming this is good to merge?

[tijcolem]

@jmarrec The units tests all passed on the Windows runner doing a full build so this is good.