Addresses #5227, updates to Controller:OutdoorAir #5237

joseph-robertson · 2024-08-16T20:19:34Z

Pull request overview

Fixes controller outdoorair object #5227.

Checklist:

clean up getters and setters, and update RT, for:
- HumidistatControlZoneName
- ElectronicEnthalpyLimitCurveName
- MinimumOutdoorAirScheduleName
- MinimumFractionofOutdoorAirScheduleName
- MaximumFractionofOutdoorAirScheduleName
- TimeofDayEconomizerControlScheduleName
update FT for:
- HumidistatControlZone
- ElectronicEnthalpyLimitCurve

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

…Zone.

…l humidistat.

src/model/ControllerOutdoorAir.hpp

src/model/ControllerOutdoorAir_Impl.hpp

src/model/ControllerOutdoorAir.cpp

src/model/ControllerOutdoorAir_Impl.hpp

src/model/ControllerOutdoorAir.cpp

src/energyplus/ForwardTranslator/ForwardTranslateControllerOutdoorAir.cpp

src/model/ControllerOutdoorAir.cpp

…ontrol setter.

joseph-robertson · 2024-10-08T21:46:53Z

resources/model/OpenStudio.idd

@@ -22427,15 +22427,15 @@ OS:Controller:OutdoorAir,
       \note This field is only used when the field High Humidity Control = Yes.
       \type real
       \minimum> 0
-       \default 1.0
+       \required-field


Making this required. Updating ctor to set to 1.0. Requires vt.

joseph-robertson · 2024-10-08T21:47:00Z

resources/model/OpenStudio.idd

  A19, \field Control High Indoor Humidity Based on Outdoor Humidity Ratio
       \note If No is selected, the outdoor air flow rate is modified any time indoor relative
       \note humidity is above the humidistat setpoint. If Yes is selected, the outdoor air
       \note flow rate is modified any time the indoor relative humidity is above the humidistat
       \note setpoint and the outdoor humidity ratio is less than the indoor humidity ratio.
       \note This field is only used when the field High Humidity Control = Yes.
       \type choice
-       \default Yes
+       \required-field


Making this required. Updating ctor to set to "Yes". Requires vt.

joseph-robertson · 2024-10-08T21:48:20Z

src/model/ControllerOutdoorAir.cpp

-      return retVal;
+    bool ControllerOutdoorAir_Impl::setHumidistatControlZone(const ThermalZone& thermalZone) {
+      bool result = setPointer(OS_Controller_OutdoorAirFields::HumidistatControlZoneName, thermalZone.handle());
+      result = result && setString(OS_Controller_OutdoorAirFields::HighHumidityControl, "Yes");


Only setHumidistatControlZone can set HighHumidityControl to "Yes".

joseph-robertson · 2024-10-08T21:48:41Z

src/model/ControllerOutdoorAir.cpp

-      }
+    void ControllerOutdoorAir_Impl::resetHumidistatControlZone() {
+      bool result = setString(OS_Controller_OutdoorAirFields::HumidistatControlZoneName, "");
+      result = result && setString(OS_Controller_OutdoorAirFields::HighHumidityControl, "No");


Only resetHumidistatControlZone can set HighHumidityControl to "No".

joseph-robertson · 2024-10-08T21:50:01Z

src/energyplus/ForwardTranslator/ForwardTranslateControllerOutdoorAir.cpp

+      } else {
+        LOG(Warn, modelObject.briefDescription() << " has a humidistat control zone " << zone_->nameString()
+                                                 << " without a zone control humidistat; humidistat control zone field will not be translated");
+        idfObject.setString(openstudio::Controller_OutdoorAirFields::HighHumidityControl, "No");


HumidistatControlZoneName is required when HighHumidityControl is "Yes"; so if we can't set HumidistatControlZoneName, then HighHumidityControl must be set to "No".

joseph-robertson · 2024-10-08T22:48:17Z

src/model/ControllerOutdoorAir.hpp


-    boost::optional<double> getHighHumidityOutdoorAirFlowRatio() const;
+    double getHighHumidityOutdoorAirFlowRatio() const;


Breaking change since now required.

joseph-robertson · 2024-10-08T22:48:21Z

src/model/ControllerOutdoorAir.hpp

    bool setHighHumidityOutdoorAirFlowRatio(double v);

-    boost::optional<bool> getControlHighIndoorHumidityBasedOnOutdoorHumidityRatio() const;
+    bool getControlHighIndoorHumidityBasedOnOutdoorHumidityRatio() const;


Breaking change since now required.

I'm fine with the API break, because I can't see it being used in the primary gems anyways.

Should add this to the TBD release notes ideally so we don't forget about it. And tag it with "APIChange"

(We could have deprecated the getControlXXX.... and replaced with a controlXXX getter.)

…andoc config

…pdate to E+ 24.2.0a)

jmarrec · 2024-10-09T08:36:32Z

developer/doc/ReleaseNotes/OpenStudio_Release_Notes_3_8_0_20240508.md

I adjusted the 3.8.0 release notes .md and generated the PDF.

@DavidGoldwasser @wenyikuang We've been historically doing this for every release. The format is much better than what's displayed on the 3.8.0 release https://github.com/NREL/OpenStudio/releases/v3.8.0 which in this specific case is purely the automated github changelog, not even sorted by importance or removing the Developer issues.

Can you please advise whether we keep doing this going forward?

If so, friendly reminder to everyone that we should keep the habit of populating the TDB release notes with major changes at least, and to remind to produce the Release Notes at release time.

If not, we should at least clean and reorganize the automatically generated Github changelog on the release page.

jmarrec · 2024-10-09T08:38:22Z

developer/doc/ReleaseNotes/OpenStudio_Release_Notes_3_9_0_TBD.md

+* [#5242](https://github.com/NREL/OpenStudio/pull/5242) - Update to EnergyPlus v24.2.0a
+    * To see the full list of additions and changes, refer to the issue [#5240](https://github.com/NREL/OpenStudio/issues/5240)
+
+* [#5237](https://github.com/NREL/OpenStudio/pull/5237) - Updates to Controller:OutdoorAir
+    * This PR implements the fields `Humidistat Control Zone Name` and `Electronic Enthalpy Limit Curve`
+    * `ControllerOutdoorAir` has two API-breaking changes for `High Humidity Outdoor Air Flow Ratio` and `Control High Indoor Humidity Based on Outdoor Humidity Ratio`. These fields are now-required, so the getters no longer return an optional
+        * `getHighHumidityOutdoorAirFlowRatio` (`boost::optional<double>` to `double`)
+        * `getControlHighIndoorHumidityBasedOnOutdoorHumidityRatio` (`boost::optional<bool>` to `bool`)


Start a 3.9.0 release notes with this API break and Update to EnergyPlus v24.2.0a #5242

jmarrec · 2024-10-09T08:38:42Z

developer/doc/ReleaseNotes/ReleaseNotes_template.md

+---
+# This YAML header controls the pandoc (via TeX) to PDF settings
+# To convert the markdown to pdf, do `pandoc release_notes.md -o release_notes.pdf`
+title:  'OpenStudio Release Notes - @VERSION@'
+author:
+- National Renewable Energy Laboratory
+colorlinks: true
+linkcolor: blue
+urlcolor: Mahogany
+toccolor: gray
+geometry:
+- margin=1in
+---


I also adjusted the Release_Notes template.md to conform to latest format, and added some quick pandoc settings to set the title, margin and colors. And most importantly, a reminder of how to generate the PDF from the Markdown file.

src/model/ControllerOutdoorAir.cpp

ci-commercialbuildings · 2024-10-09T16:31:22Z

CI Results for 330ad0c:

Ubuntu 20.04:
Ubuntu 22.04:
- OpenStudio-3.8.0+330ad0c9fa-Ubuntu-22.04-x86_64.deb
- OpenStudio-3.8.0+330ad0c9fa-Ubuntu-22.04-x86_64.tar.gz
Darwin:
- OpenStudio-3.8.0+330ad0c9fa-Darwin-x86_64.dmg
- OpenStudio-3.8.0+330ad0c9fa-Darwin-x86_64.tar.gz
Windows:
Code Coverage:

joseph-robertson added 4 commits August 16, 2024 13:06

Add humidistat control zone getters and setters.

e4e6558

Update ft and rt for humidistat control zone.

b9a8c14

Add a model test.

7f2a379

Formatting.

07f5034

joseph-robertson added severity - Normal Bug component - Model component - IDF Translation Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. labels Aug 16, 2024

joseph-robertson self-assigned this Aug 16, 2024

joseph-robertson added 4 commits August 16, 2024 14:05

Add electronic enthalpy limit curve getters and setters.

ba9bc10

Update ft and rt for curves and schedules.

6f7f67b

Formatting.

3f249dc

Clean up.

4c58131

joseph-robertson mentioned this pull request Aug 19, 2024

Addresses #5227, updates to Controller:OutdoorAir NREL/OpenStudio-resources#208

Draft

26 tasks

joseph-robertson added 2 commits August 19, 2024 11:16

Deprecate setHighHumidityControl and instead use setHumidistatControl…

f1c8943

…Zone.

Update ft for checking that humidistat control zone has a zone contro…

5d7a6bf

…l humidistat.

joseph-robertson marked this pull request as ready for review October 3, 2024 16:37

joseph-robertson requested a review from jmarrec October 3, 2024 16:37

jmarrec reviewed Oct 4, 2024

View reviewed changes

joseph-robertson added 8 commits October 4, 2024 09:32

Clean up getters, ft, and model tests.

5d20d04

Remove remaining extra getXXX methods.

4293bd4

Clean up cpp file.

96e3ca8

Fix typos in rt file.

936ae1f

More typos, and update rt.

009e003

Typos in model test.

4e54e88

Clean up old bool get methods.

34fdbb3

Fix setting high humidity control to Yes or No based on other fields.

199d8ee

joseph-robertson commented Oct 7, 2024

View reviewed changes

src/model/ControllerOutdoorAir.cpp Show resolved Hide resolved

joseph-robertson requested a review from jmarrec October 7, 2024 16:51

jmarrec reviewed Oct 8, 2024

View reviewed changes

joseph-robertson added 4 commits October 8, 2024 12:35

Make other humidity fields required, add vt, and deprecate humidity c…

325ef2d

…ontrol setter.

Formatting.

1202392

Typos in model test file.

457dae1

Update model and vt test files.

f3b874f

joseph-robertson commented Oct 8, 2024

View reviewed changes

joseph-robertson requested a review from jmarrec October 8, 2024 22:00

Remove optional from newly required fields and break getters.

26520c9

joseph-robertson commented Oct 8, 2024

View reviewed changes

Typo in cpp file.

8790298

jmarrec added the APIChange A motivated non-backward compatible change that breaks the existing API and needs to be communicated label Oct 9, 2024

jmarrec added 2 commits October 9, 2024 10:20

Make the 3.8.0 release notes + update template with YAML header for p…

c36adbe

…andoc config

Start a 3.9.0 release Notes and add the API break in there (and the u…

1430a0e

…pdate to E+ 24.2.0a)

jmarrec force-pushed the controller-outdoorair-updates branch from f88f19c to 1430a0e Compare October 9, 2024 08:37

jmarrec reviewed Oct 9, 2024

View reviewed changes

jmarrec approved these changes Oct 9, 2024

View reviewed changes

jmarrec requested changes Oct 9, 2024

View reviewed changes

src/model/ControllerOutdoorAir.cpp Show resolved Hide resolved

joseph-robertson added 2 commits October 9, 2024 08:57

Clean up and fix ctor.

622a258

Update and fix vt tests.

330ad0c

joseph-robertson merged commit f63cae5 into develop Oct 9, 2024
3 of 6 checks passed

joseph-robertson deleted the controller-outdoorair-updates branch October 9, 2024 18:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Addresses #5227, updates to Controller:OutdoorAir #5237

Addresses #5227, updates to Controller:OutdoorAir #5237

joseph-robertson commented Aug 16, 2024 •

edited

Loading

joseph-robertson Oct 8, 2024

joseph-robertson Oct 8, 2024

joseph-robertson Oct 8, 2024

joseph-robertson Oct 8, 2024

joseph-robertson Oct 8, 2024

joseph-robertson Oct 8, 2024

joseph-robertson Oct 8, 2024

jmarrec Oct 9, 2024 •

edited

Loading

jmarrec Oct 9, 2024 •

edited

Loading

jmarrec Oct 9, 2024

jmarrec Oct 9, 2024

ci-commercialbuildings commented Oct 9, 2024 •

edited

Loading


		boost::optional<double> getHighHumidityOutdoorAirFlowRatio() const;
		double getHighHumidityOutdoorAirFlowRatio() const;

Addresses #5227, updates to Controller:OutdoorAir #5237

Addresses #5227, updates to Controller:OutdoorAir #5237

Conversation

joseph-robertson commented Aug 16, 2024 • edited Loading

Pull request overview

Pull Request Author

Review Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmarrec Oct 9, 2024 • edited Loading

Choose a reason for hiding this comment

jmarrec Oct 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ci-commercialbuildings commented Oct 9, 2024 • edited Loading

joseph-robertson commented Aug 16, 2024 •

edited

Loading

jmarrec Oct 9, 2024 •

edited

Loading

jmarrec Oct 9, 2024 •

edited

Loading

ci-commercialbuildings commented Oct 9, 2024 •

edited

Loading