V25.2.0-IOFreeze: new DX Heating Coil Sizing Ratio fields #5492

joseph-robertson · 2025-10-06T18:10:06Z

Pull request overview

Fixes #ISSUENUMBERHERE (IF THIS IS A DEFECT)

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

…eed (#5492)

ci-commercialbuildings · 2025-10-20T13:27:11Z

CI Results for a86e174:

Ubuntu 24.04:
- OpenStudio-3.10.1-alpha+a86e174561-Ubuntu-24.04-x86_64.deb
- OpenStudio-3.10.1-alpha+a86e174561-Ubuntu-24.04-x86_64.tar.gz
Ubuntu 22.04:
Darwin:
Windows:
Code Coverage:

@joseph-robertson

@joseph-robertson FYI

jmarrec

I suppose adding 2 lines in 3 model gtests would be good, but otherwise this is good to go

(also the optional assignment for non-optional getter in FT, but whatever)

jmarrec · 2025-10-20T13:11:54Z

developer/doc/ReleaseNotes/OpenStudio_Release_Notes_3_10_1_TBD.md

+* [#5492](https://github.com/NREL/OpenStudio/pull/5492) - New DX Heating Coil Sizing Ratio fields
+    * Replaces `Minimum Outdoor Dry-Bulb Temperature for Compressor Operation` with `DX Heating Coil Sizing Ratio` for `AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed`
+    * Deprecated methods for `AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed`:
+        * `minimumOutdoorDryBulbTemperatureforCompressorOperation`
+        * `setMinimumOutdoorDryBulbTemperatureforCompressorOperation`


I don't think you need to deprecate per se, but I'd look for it when I get to the C++ deprecation

Btw, the E+ PR is

New Feature Heat Pump sizing according to ACCA Manual S EnergyPlus#11130

jmarrec · 2025-10-20T13:13:58Z

src/model/ZoneHVACWaterToAirHeatPump.cpp

    setNoLoadSupplyAirFlowRateControlSetToLowSpeed(true);
    autosizeOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded();
    setString(OS_ZoneHVAC_WaterToAirHeatPumpFields::AvailabilityManagerListName, "");
+    setDXHeatingCoilSizingRatio(1.0);


Alright. non opt getter, one setter only, and Ctor defaults the required field

jmarrec · 2025-10-20T13:19:02Z

src/model/AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed.cpp

+  // DEPRECATED
+  double AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed::minimumOutdoorDryBulbTemperatureforCompressorOperation() const {
+    DEPRECATED_AT_MSG(3, 11, 0, "TODO.");
+    return -999;
+  }
+
+  bool AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed::setMinimumOutdoorDryBulbTemperatureforCompressorOperation(
+    double minimumOutdoorDryBulbTemperatureforCompressorOperation) {
+    DEPRECATED_AT_MSG(3, 11, 0, "TODO.");
+    return false;
+  }


Ok, so I reviewed the E+ C++ code for the corresponding PR, and this field was purely unused before.

MinOATCompressorHeating is grabbed from DXHeatingCoilIndex and MinOATCompressorCooling is grabbed from DXCoolingCoilIndex

https://github.com/NREL/EnergyPlus/blob/0befe779fe9721745ba31a65f877cc05905ac6b3/src/EnergyPlus/HVACMultiSpeedHeatPump.cc#L745

Given the former IDD note

N1 , \field Minimum Outdoor Dry-Bulb Temperature for Compressor Operation
\type real
\default -8.0
\units C
\note Needs to match the corresponding minimum outdoor temperature defined
\note in the DX heating coil object.

jmarrec · 2025-10-20T13:32:54Z

src/model/AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed.cpp

+  // DEPRECATED
+  double AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed::minimumOutdoorDryBulbTemperatureforCompressorOperation() const {
+    DEPRECATED_AT_MSG(3, 11, 0, "TODO.");
+    return -999;
+  }
+
+  bool AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed::setMinimumOutdoorDryBulbTemperatureforCompressorOperation(
+    double minimumOutdoorDryBulbTemperatureforCompressorOperation) {
+    DEPRECATED_AT_MSG(3, 11, 0, "TODO.");
+    return false;
+  }


Proposed implementation in 983ee15

jmarrec · 2025-10-20T13:38:36Z

src/model/test/AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed_GTest.cpp

Ideally, since you are touched 4 classes, I'd see 4 model Gtests changes instead of one

jmarrec · 2025-10-20T13:39:34Z

src/model/AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed.cpp

+  // DEPRECATED
+  double AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed::minimumOutdoorDryBulbTemperatureforCompressorOperation() const {
+    // Former v25.1.0 IDD note said this "Needs to match the corresponding minimum outdoor temperature defined in the DX heating coil object"
+    DEPRECATED_AT_MSG(3, 11, 0,
+                      "This field was previously unused and removed in EnergyPlus 25.2.0. Set the Minimum OAT for Compressor Operation on the child "
+                      "DX MultiSpeed Coils if any.");
+    if (auto hc_ = heatingCoil().optionalCast<CoilHeatingDXMultiSpeed>()) {
+      return hc_->minimumOutdoorDryBulbTemperatureforCompressorOperation();
+    }
+    return -1000.0;
+  }
+
+  bool AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed::setMinimumOutdoorDryBulbTemperatureforCompressorOperation(
+    double minimumOutdoorDryBulbTemperatureforCompressorOperation) {
+    DEPRECATED_AT_MSG(3, 11, 0,
+                      "This field was previously unused and removed in EnergyPlus 25.2.0. Set the Minimum OAT for Compressor Operation on the child "
+                      "DX MultiSpeed Coils if any.");
+    if (auto hc_ = heatingCoil().optionalCast<CoilHeatingDXMultiSpeed>()) {
+      return hc_->setMinimumOutdoorDryBulbTemperatureforCompressorOperation(minimumOutdoorDryBulbTemperatureforCompressorOperation);
+    }
+
+    return false;
+  }


@joseph-robertson My proposed implementation here.

I picked -1000.0 because that's what E+ GetMinOATCompressor does.

https://github.com/NREL/EnergyPlus/blob/0befe779fe9721745ba31a65f877cc05905ac6b3/src/EnergyPlus/DXCoils.cc#L15514-L15534

jmarrec · 2025-10-20T13:39:59Z

src/energyplus/ForwardTranslator/ForwardTranslateZoneHVACWaterToAirHeatPump.cpp

+    // DXHeatingCoilSizingRatio
+    if ((value = modelObject.dXHeatingCoilSizingRatio())) {
+      idfObject.setDouble(ZoneHVAC_WaterToAirHeatPumpFields::DXHeatingCoilSizingRatio, value.get());
+    }


Non optional, so shouldn't need to go though an optional and suffer the penalty

…eed (#5492)

joseph-robertson self-assigned this Oct 6, 2025

joseph-robertson added Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. IDDChange labels Oct 6, 2025

joseph-robertson mentioned this pull request Oct 6, 2025

Update to EnergyPlus 25.2.0 #5472

Closed

26 tasks

joseph-robertson marked this pull request as ready for review October 10, 2025 18:44

jmarrec added a commit that referenced this pull request Oct 16, 2025

Add field changes except AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSp…

133c329

…eed (#5492)

Base automatically changed from v25.2.0-IOFreeze to develop October 20, 2025 12:08

joseph-robertson and others added 13 commits October 20, 2025 14:57

Update idds for DX Heating Coil Sizing Ratio fields.

74761db

Update model files for ZoneHVAC, UnitaryHeatPump.

3a4f0da

Update ft files for ZoneHVAC, UnitaryHeatPump.

24c8446

Update vt files for ZoneHVAC, UnitaryHeatPump.

fdfc29b

Formatting.

a55f351

Wrong case in ft files.

fbc5a5b

Add vt tests for DX Heating Coil Sizing Ratio fields.

25592e5

Avoid redefinition in vt test file.

c9dbae2

Fix types in vt test file.

914070f

Update model test file expected values for deprecated method.

14c191b

Typo in vt test folder name.

eada095

Update the release notes.

3acad66

emplace_back + move in VT

a86e174

jmarrec force-pushed the v25.2.0-IOFreeze-dx-coil-ratio branch from 7ef6898 to a86e174 Compare October 20, 2025 13:04

jmarrec added 3 commits October 20, 2025 15:32

Implement the deprecated method

983ee15

@joseph-robertson FYI

Double set in Ctor

7a5e99b

Adjust test

4db4362

jmarrec approved these changes Oct 20, 2025

View reviewed changes

jmarrec merged commit ac70dbc into develop Oct 20, 2025
2 of 6 checks passed

jmarrec deleted the v25.2.0-IOFreeze-dx-coil-ratio branch October 20, 2025 13:43

anchapin pushed a commit that referenced this pull request Nov 30, 2025

Add field changes except AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSp…

d622dd7

…eed (#5492)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

V25.2.0-IOFreeze: new DX Heating Coil Sizing Ratio fields #5492

V25.2.0-IOFreeze: new DX Heating Coil Sizing Ratio fields #5492

Uh oh!

joseph-robertson commented Oct 6, 2025

Uh oh!

ci-commercialbuildings commented Oct 20, 2025 •

edited

Loading

Uh oh!

jmarrec left a comment

Uh oh!

jmarrec Oct 20, 2025

Uh oh!

jmarrec Oct 20, 2025

Uh oh!

jmarrec Oct 20, 2025

Uh oh!

jmarrec Oct 20, 2025

Uh oh!

jmarrec Oct 20, 2025

Uh oh!

jmarrec Oct 20, 2025

Uh oh!

jmarrec Oct 20, 2025

Uh oh!

jmarrec Oct 20, 2025

Uh oh!

jmarrec Oct 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

V25.2.0-IOFreeze: new DX Heating Coil Sizing Ratio fields #5492

V25.2.0-IOFreeze: new DX Heating Coil Sizing Ratio fields #5492

Uh oh!

Conversation

joseph-robertson commented Oct 6, 2025

Pull request overview

Pull Request Author

Review Checklist

Uh oh!

ci-commercialbuildings commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jmarrec left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ci-commercialbuildings commented Oct 20, 2025 •

edited

Loading