Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 4 commits into from
Mar 22, 2024

Conversation

jmarrec
Copy link
Collaborator

@jmarrec jmarrec commented Mar 11, 2024

Pull request overview

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 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 jmarrec self-assigned this Mar 11, 2024
@@ -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
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IDD change

Comment on lines 116 to 118
/** 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;
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is definitely the case for all SpaceLoadInstance objects

Comment on lines +112 to +114
/** 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;
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment on lines +71 to +72
boost::optional<double> wattsperSpaceFloorArea() const;
OS_DEPRECATED(3, 8, 0) boost::optional<double> wattsperZoneFloorArea() const;
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment on lines +68 to +69
boost::optional<double> designLevel() const;
OS_DEPRECATED(3, 8, 0) boost::optional<double> wattsperUnit() const;
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also debatable I suppose, but I stand by it.

Comment on lines +202 to +204
/** 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;
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✔️

Comment on lines +198 to +200
/** 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;
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Debatable but I prefer it!

Comment on lines +78 to +88
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
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator

@joseph-robertson joseph-robertson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one minor comment, otherwise LGTM.


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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Returns the powerPerFloorArea if possible ..."?

@jmarrec jmarrec merged commit 800d735 into develop Mar 22, 2024
@jmarrec jmarrec deleted the 5103-ITEAirCooled_eq_update branch March 22, 2024 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIChange A motivated non-backward compatible change that breaks the existing API and needs to be communicated component - Model Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge.
Projects
None yet
3 participants