ScheduleDay: new timeseries method and interpolation options

[joseph-robertson]

Pull request overview

• Fixes ScheduleDay::getValue applies interpolation differently than EnergyPlus #5001.

A new timeSeries() method for returning vectors of times and values given the number of timesteps per hour integer from the Timestep object.

Align the OS and E+ IDDs. The "Interpolate to Timestep" field is now "No", "Average", or "Linear" (i.e., a Breaking Change). The behavior of:

• "Linear" is unchanged (i.e., still LinearInterp)
• "No" is HoldNextInterp, and
• "Average" is a new AverageInterp interpolation on schedule values given the simulation timestep

Update the FT to write the correct method, not just "Average" as it was before.

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

[joseph-robertson]

This returns timeseries with timestamps (i.e., a DateTimeVector) that align with the Timestep object. The values returned (i.e., a Vector) correspond to the "Interpolate to Timestep" choice.

[jmarrec]

@joseph-robertson Thanks for addressing some of the review comments.

I'm still not happy about getValue, and maybe we should open a ticket to revisit the getValue and avoid recomputing the entire day, but maybe not.

Anyways, if CI is happy with this, we can merge.

[jmarrec]

/srv/jenkins/openstudio/docker-volumes/ubuntu-2004/Openstudio/src/utilities/data/Vector.cpp:103:7: error: ‘OS_ASSERT’ was not declared in this scope; did you mean ‘BOOST_ASSERT’?

fixed in 012f076

[ci-commercialbuildings]

CI Results for 7493115:

• Ubuntu 20.04:

  • OpenStudio-3.8.0-beta+7493115cf7-Ubuntu-20.04-x86_64.deb
  • OpenStudio-3.8.0-beta+7493115cf7-Ubuntu-20.04-x86_64.tar.gz

• Ubuntu 22.04:

  • OpenStudio-3.8.0-beta+7493115cf7-Ubuntu-22.04-x86_64.deb
  • OpenStudio-3.8.0-beta+7493115cf7-Ubuntu-22.04-x86_64.tar.gz

• Darwin:

  • OpenStudio-3.8.0-beta+7493115cf7-Darwin-x86_64.dmg
  • OpenStudio-3.8.0-beta+7493115cf7-Darwin-x86_64.tar.gz

• Windows:

• Code Coverage: