Fix #5103 - ElectricEquipmentITEAirCooled / ElectricEquipmentITEAirCooledDefinition - align objects with other SpaceLoads #5105

jmarrec · 2024-03-11T14:22:40Z

Pull request overview

Fixes Deprecate ElectricEquipmentITEAirCooledDefinition's "Watts per Zone Floor Area" and replace with "Watts per Space Floor Area" #5103
All changes are perfectly backward compatible, but I did deprecate 10 methods

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

…r Zone Floor Area" and replace with "Watts per Space Floor Area"

…ition

…cations)

jmarrec · 2024-03-11T14:23:57Z

resources/model/OpenStudio.idd

@@ -4140,7 +4140,7 @@ OS:ElectricEquipment:ITE:AirCooled:Definition,
       \units W
       \ip-units W
       \minimum 0
-  N2 , \field Watts per Zone Floor Area
+  N2 , \field Watts per Space Floor Area


jmarrec · 2024-03-11T14:26:02Z

src/model/ElectricEquipmentITEAirCooled.hpp

+    /** Returns the designLevel if possible based on the underlying data of electricEquipmentITEAirCooledDefinition(). */
+    boost::optional<double> powerPerFloorArea() const;
+    OS_DEPRECATED(3, 8, 0) boost::optional<double> wattsperZoneFloorArea() const;


This is definitely the case for all SpaceLoadInstance objects

jmarrec · 2024-03-11T14:27:08Z

src/model/ElectricEquipmentITEAirCooled.hpp

+    /** Returns the designLevel if possible based on the underlying data of electricEquipmentITEAirCooledDefinition(). */
+    boost::optional<double> designLevel() const;
+    OS_DEPRECATED(3, 8, 0) boost::optional<double> wattsperUnit() const;


That one is debatable I suppose. Lights for eg also doesn't use designLevel but lightingLevel. But I think Lights is wrong, and all SpaceLoadInstance should follow this convention.

jmarrec · 2024-03-11T14:30:11Z

src/model/ElectricEquipmentITEAirCooledDefinition.hpp

+    boost::optional<double> wattsperSpaceFloorArea() const;
+    OS_DEPRECATED(3, 8, 0) boost::optional<double> wattsperZoneFloorArea() const;


This one is a sure thing. Per Zone Floor Area makes no sense.

jmarrec · 2024-03-11T14:30:25Z

src/model/ElectricEquipmentITEAirCooledDefinition.hpp

+    boost::optional<double> designLevel() const;
+    OS_DEPRECATED(3, 8, 0) boost::optional<double> wattsperUnit() const;


Also debatable I suppose, but I stand by it.

jmarrec · 2024-03-11T14:31:12Z

src/model/ElectricEquipmentITEAirCooledDefinition.hpp

+    /** Returns the watts/m^2 represented by this definition, assuming floorArea (m^2) */
+    double getPowerPerFloorArea(double floorArea) const;
+    OS_DEPRECATED(3, 8, 0) double getWattsperZoneFloorArea(double floorArea) const;


jmarrec · 2024-03-11T14:31:29Z

src/model/ElectricEquipmentITEAirCooledDefinition.hpp

+    /** Returns the design level represented by this definition, assuming floorArea (m^2). */
+    double getDesignLevel(double floorArea) const;
+    OS_DEPRECATED(3, 8, 0) double getWattsperUnit(double floorArea) const;


Debatable but I prefer it!

jmarrec · 2024-03-11T14:32:00Z

developer/doc/ReleaseNotes/OpenStudio_Release_Notes_3_8_0_TBD.md

+For a list of deprecated and removed methods, please refer to [deprecated_methods.csv](../../ruby/deprecated_methods.csv)
+
+* [#TDB]() - Update to EnergyPlus 24.1.0
+
+* [#5099](https://github.com/NREL/OpenStudio/pull/5099) - HeatExchangerAirToAirSensibleAndLatent changes for effectiveness
+    * To conform to E+ 24.1.0, where "Sensible/Latent Effectiveness at 75% Heating/Cooling" numeric fields have been replaced with a curve, the numeric getters / setters are now deprecated in favor of the new curves getters / setters: `sensibleEffectivenessofHeatingAirFlowCurve`, `latentEffectivenessofHeatingAirFlowCurve`, `sensibleEffectivenessofCoolingAirFlowCurve`, `latentEffectivenessofCoolingAirFlowCurve`
+    * The constructor will no longer assign an effectiveness at 75% and assume a constant effectiveness. A helper method `bool assignHistoricalEffectivenessCurves()` is provided to create and assign 4 `TableLookup`s that will match the pre E+ 24.1.0 defaults for Sensible/Latent Effectiveness at 75% Heating/Cooling airflow
+* [#5105](https://github.com/NREL/OpenStudio/pull/5105) - ElectricEquipmentITEAirCooled / ElectricEquipmentITEAirCooledDefinition - align objects with other SpaceLoads
+    * A number of methods have been renamed (and the old ones deprecated) to conform to the API for other `SpaceLoadInstance` / `SpaceLoadDefinition` objects
+    * Mostly `getWattsperUnit` is changed to `getDesignLevel` and `getWattsperZoneFloorArea` is changed to `getPowerPerFloorArea`
+    * Refer to [deprecated_methods.csv](../../ruby/deprecated_methods.csv) for the complete list


Release notes, including for v24.1.0-IOFreeze: HeatExchangerAirToAirSensibleAndLatent #5099

jmarrec · 2024-03-11T14:32:28Z

developer/ruby/deprecated_methods.csv

Updated the deprecated_methods.csv for this PR + any missing ones before

ci-commercialbuildings · 2024-03-11T14:54:40Z

CI Results for 680da5d:

Ubuntu 20.04:
Ubuntu 22.04:
- OpenStudio-3.8.0+680da5dbaf-Ubuntu-22.04-x86_64.deb
- OpenStudio-3.8.0+680da5dbaf-Ubuntu-22.04-x86_64.tar.gz
Darwin:
- OpenStudio-3.8.0+680da5dbaf-Darwin-x86_64.dmg
- OpenStudio-3.8.0+680da5dbaf-Darwin-x86_64.tar.gz
Windows:
- OpenStudio-3.8.0+680da5dbaf-Windows.exe
- OpenStudio-3.8.0+680da5dbaf-Windows.tar.gz
Code Coverage:

joseph-robertson

Just one minor comment, otherwise LGTM.

joseph-robertson · 2024-03-12T16:40:14Z

src/model/ElectricEquipmentITEAirCooled.hpp


-    boost::optional<double> wattsperZoneFloorArea() const;
+    /** Returns the designLevel if possible based on the underlying data of electricEquipmentITEAirCooledDefinition(). */


"Returns the powerPerFloorArea if possible ..."?

src/model/ElectricEquipmentITEAirCooled.hpp

jmarrec added 3 commits March 11, 2024 12:47

#5103 - Deprecate ElectricEquipmentITEAirCooledDefinition's "Watts pe…

f83ec48

…r Zone Floor Area" and replace with "Watts per Space Floor Area"

Rename methods to align with other SpaceLoadInstance / SpaceLoadDefin…

6e6f598

…ition

Update deprecated methods and release notes (including previous depre…

680da5d

…cations)

jmarrec added component - Model Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. APIChange A motivated non-backward compatible change that breaks the existing API and needs to be communicated labels Mar 11, 2024

jmarrec self-assigned this Mar 11, 2024

jmarrec commented Mar 11, 2024

View reviewed changes

jmarrec requested review from joseph-robertson and kbenne March 11, 2024 14:32

joseph-robertson reviewed Mar 12, 2024

View reviewed changes

jmarrec commented Mar 22, 2024

View reviewed changes

src/model/ElectricEquipmentITEAirCooled.hpp Outdated Show resolved Hide resolved

Update src/model/ElectricEquipmentITEAirCooled.hpp [skip ci]

918e572

jmarrec merged commit 800d735 into develop Mar 22, 2024

jmarrec deleted the 5103-ITEAirCooled_eq_update branch March 22, 2024 10:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #5103 - ElectricEquipmentITEAirCooled / ElectricEquipmentITEAirCooledDefinition - align objects with other SpaceLoads #5105

Fix #5103 - ElectricEquipmentITEAirCooled / ElectricEquipmentITEAirCooledDefinition - align objects with other SpaceLoads #5105

jmarrec commented Mar 11, 2024

jmarrec Mar 11, 2024

jmarrec Mar 11, 2024

jmarrec Mar 11, 2024

jmarrec Mar 11, 2024

jmarrec Mar 11, 2024

jmarrec Mar 11, 2024

jmarrec Mar 11, 2024

jmarrec Mar 11, 2024

jmarrec Mar 11, 2024

ci-commercialbuildings commented Mar 11, 2024 •

edited

Loading

joseph-robertson left a comment

joseph-robertson Mar 12, 2024

		boost::optional<double> wattsperSpaceFloorArea() const;
		OS_DEPRECATED(3, 8, 0) boost::optional<double> wattsperZoneFloorArea() const;

		boost::optional<double> designLevel() const;
		OS_DEPRECATED(3, 8, 0) boost::optional<double> wattsperUnit() const;


		boost::optional<double> wattsperZoneFloorArea() const;
		/** Returns the designLevel if possible based on the underlying data of electricEquipmentITEAirCooledDefinition(). */

Fix #5103 - ElectricEquipmentITEAirCooled / ElectricEquipmentITEAirCooledDefinition - align objects with other SpaceLoads #5105

Fix #5103 - ElectricEquipmentITEAirCooled / ElectricEquipmentITEAirCooledDefinition - align objects with other SpaceLoads #5105

Conversation

jmarrec commented Mar 11, 2024

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ci-commercialbuildings commented Mar 11, 2024 • edited Loading

joseph-robertson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ci-commercialbuildings commented Mar 11, 2024 •

edited

Loading