Fix #5490 - E+ 25.2.0: Wrap HeatPump:AirToWater #5496

jmarrec · 2025-10-09T23:47:21Z

Pull request overview

Fixes E+ 25.2.0: Wrap HeatPump:AirToWater #5490

This wraps HeatPump:AirToWater into OpenStudio SDK, and it's a major effort.

This object is broken into 5 classes:
- HeatPump:AirToWater (A StraightComponent, though addToNode always return false) which keeps only the top level fields
- HeatPump:AirToWater:Cooling (StraightComponent) and HeatPump:AirToWater:Cooling:SpeedData (ResourceObject)
- HeatPump:AirToWater:Heating (StraightComponent) and HeatPump:AirToWater:Heating:SpeedData (ResourceObject)
There are still a few missing pieces here:
- HeatPump:AirToWater followup PR update test idf EnergyPlus#11251

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: #5490 - E+ 25.2.0: Wrap HeatPump:AirToWater OpenStudio-resources#225
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 · 2025-10-10T18:00:25Z

@jmarrec Per NREL/EnergyPlus#11001, I expected there to be updates in this PR related to the new "Water Loop Type" field on the PlantLoop object. Do we not need that here? Should we still make the field available outside of the context of HeatPump:AirToWater?

yujiex · 2025-10-10T21:14:46Z

@jmarrec Per NREL/EnergyPlus#11001, I expected there to be updates in this PR related to the new "Water Loop Type" field on the PlantLoop object. Do we not need that here? Should we still make the field available outside of the context of HeatPump:AirToWater?

Hi @joseph-robertson this "Water Loop Type" field was used to assign whether the air to water heat pump component is heating or cooling. For the HeatPump:PlantLoop:EIR:Heating and HeatPump:PlantLoop:EIR:Cooling ones, they can know this by the :Heating and :Cooling. But for this object, it has to know from what type of loop it's connected to thus the field is added. It's not used in other objects.

if (state.dataPlnt->PlantLoop(LoopNum).TypeOfWaterLoop == DataPlant::WaterLoopType::HotWater) {
    this_comp.compPtr = EIRPlantLoopHeatPumps::HeatPumpAirToWater::factory(
        state, PlantEquipmentType::HeatPumpAirToWaterHeating, CompNames(CompNum));
    this_comp.Type = PlantEquipmentType::HeatPumpAirToWaterHeating;
    this_comp.TypeOf = "HeatPumpAirToWaterHeating";
} else if (state.dataPlnt->PlantLoop(LoopNum).TypeOfWaterLoop == DataPlant::WaterLoopType::ChilledWater) {
    this_comp.compPtr = EIRPlantLoopHeatPumps::HeatPumpAirToWater::factory(
        state, PlantEquipmentType::HeatPumpAirToWaterCooling, CompNames(CompNum));
    this_comp.Type = PlantEquipmentType::HeatPumpAirToWaterCooling;
    this_comp.TypeOf = "HeatPumpAirToWaterCooling";
}

I'm considering breaking it further into subobjects, but I need to start somewhere while I wait on stakeholder feedback

… yet

…s redundant

…mps and handle Curves properly

Some notes: * I'm considering skipping the ModelObjectList and use extensible groups directly * I'm not sure if I want the SpeedData objects to be unique or shared (I need to switch to ResourceObject in that case I think) * The clone/remove/children need some work

…the Heating/Cooling side

…ild to parent(s)

joseph-robertson

Should we write a new functional test on OS-resources before merging this?

Issue: NREL/OpenStudio#5496 Companion PR: NREL/OpenStudio#5496

…plement top-level autosizedRatedHeating/CoolingCapacity

…apacity: grab it from SQL only if it's the last speed (highest)

…ts the LAST speed too The way Model::autosize/applySizingValues works is that it does it for HVACComponent, and the speed data is not one and we do not want to add an explicit case because none of the speeds should be autosized except the last (highest) one

…ll be gone by 25.2.0 release (will revert then)

Issue: NREL/OpenStudio#5496 Companion PR: NREL/OpenStudio#5496

jmarrec · 2025-11-13T23:57:41Z

Remove Water Loop Type EnergyPlus#11332

jmarrec · 2025-11-13T23:58:09Z

src/energyplus/ForwardTranslator/ForwardTranslatePlantLoop.cpp

+    // Water Loop Type
+    // TODO JM 2025-11-13: This field should never have been added to 25.2.0, so it is purposefully NOT wrapped in the model namespace
+    // MJW is looking into removing it today, will assess later
+    ComponentType waterLoopType = plantLoop.componentType();
+    if (waterLoopType == ComponentType::Heating) {
+      idfObject.setString(PlantLoopFields::WaterLoopType, "HotWater");
+    } else if (waterLoopType == ComponentType::Cooling) {
+      idfObject.setString(PlantLoopFields::WaterLoopType, "ChilledWater");
+    } else if (waterLoopType == ComponentType::None) {
+      idfObject.setString(PlantLoopFields::WaterLoopType, "None");
+    } else if (waterLoopType == ComponentType::Both) {
+      if (!plantLoop.supplyComponents(IddObjectType::OS_HeatPump_AirToWater_Cooling).empty()) {
+        idfObject.setString(PlantLoopFields::WaterLoopType, "ChilledWater");
+      } else if (!plantLoop.supplyComponents(IddObjectType::OS_HeatPump_AirToWater_Heating).empty()) {
+        idfObject.setString(PlantLoopFields::WaterLoopType, "HotWater");
+      }
+    }
+


Remove/revert depending on:

Remove Water Loop Type EnergyPlus#11332

jmarrec · 2025-11-13T23:58:40Z

src/energyplus/ForwardTranslator.cpp

+      case openstudio::IddObjectType::OS_HeatPump_AirToWater_Cooling: {
+        // no-op, just Log a Trace message
+        LOG(Trace, "HeatPumpAirToWaterCooling is not translated by itself but in the parent HeatPumpAirToWater");
+        break;
+      }
+      case openstudio::IddObjectType::OS_HeatPump_AirToWater_Heating: {
+        // no-op, just Log a Trace message
+        LOG(Trace, "HeatPumpAirToWaterHeating is not translated by itself but in the parent HeatPumpAirToWater");
+        break;
+      }


Avoid "Unknown IddObjectType" warning

jmarrec · 2025-11-13T23:58:56Z

src/model/HeatPumpAirToWater.cpp

+      return getAutosizedValue("Design Size Rated Air Volume Flow Rate in Heating Mode", "m3/s");
    }

    boost::optional<double> HeatPumpAirToWater_Impl::autosizedRatedWaterFlowRateinHeatingMode() const {
-      return getAutosizedValue("Design Size Load Side Volume Flow Rate", "m3/s", "HeatPump:AirToWater:Heating");
+      return getAutosizedValue("Design Size Rated Water Volume Flow Rate in Heating Mode", "m3/s");
    }

    boost::optional<double> HeatPumpAirToWater_Impl::autosizedRatedAirFlowRateinCoolingMode() const {
-      return getAutosizedValue("Design Size Source Side Volume Flow Rate", "m3/s", "HeatPump:AirToWater:Cooling");
+      return getAutosizedValue("Design Size Rated Air Volume Flow Rate in Cooling Mode", "m3/s");
    }

    boost::optional<double> HeatPumpAirToWater_Impl::autosizedRatedWaterFlowRateinCoolingMode() const {
-      return getAutosizedValue("Design Size Load Side Volume Flow Rate", "m3/s", "HeatPump:AirToWater:Cooling");
+      return getAutosizedValue("Design Size Rated Water Volume Flow Rate in Cooling Mode", "m3/s");
+    }
+
+    boost::optional<double> HeatPumpAirToWater_Impl::autosizedRatedHeatingCapacity() const {
+      return getAutosizedValue("Design Size Rated Heating Capacity", "W");
+    }
+
+    boost::optional<double> HeatPumpAirToWater_Impl::autosizedRatedCoolingCapacity() const {
+      return getAutosizedValue("Design Size Rated Cooling Capacity", "W");


Update SQL queries

jmarrec · 2025-11-13T23:59:22Z

src/model/HeatPumpAirToWaterCooling.cpp

+    boost::optional<double> HeatPumpAirToWaterCooling_Impl::autosizedRatedCoolingCapacity() const {
+      boost::optional<double> result;
+      if (auto awhp_ = heatPumpAirToWater()) {
+        result = awhp_->autosizedRatedCoolingCapacity();
+      }
+      return result;
+    }


The Cooling (/Heating) component queries the AWHP to get the SQL value

jmarrec · 2025-11-14T00:00:01Z

src/model/HeatPumpAirToWaterCooling.cpp

+      auto speeds = this->speeds();
+      if (!speeds.empty()) {
+        speeds.back().autosize();  // Only need/can autosize the last (highest) speed
+      }


in autosize, this is weird, but I autosize the last speed.

The way Model::autosize/applySizingValues works is that it does it for HVACComponent, and the speed data is not one and we do not want to add an explicit case because none of the speeds should be autosized except the last (highest) one

jmarrec · 2025-11-14T00:00:19Z

src/model/HeatPumpAirToWaterCooling.cpp

+      if (boost::optional<double> val_ = autosizedRatedCoolingCapacity()) {
+        auto speeds = this->speeds();
+        if (!speeds.empty()) {
+          speeds.back().setRatedCoolingCapacity(*val_);  // Only need/can autosize the last (highest) speed
+        }
+      }


Same in applySizingValue

jmarrec · 2025-11-14T00:00:51Z

src/model/HeatPumpAirToWaterCoolingSpeedData.cpp

+      boost::optional<double> result;
+      auto awhp_ccs = heatPumpAirToWaterCoolings();
+      if (awhp_ccs.empty()) {
+        return result;
+      }
+      size_t n_found = 0;
+      for (const auto& awhp_cc : awhp_ccs) {
+        // Check needed because could be the booster speed
+        if (awhp_cc.speeds().empty()) {
+          continue;
+        }
+        // It has to be the last speed
+        if (awhp_cc.speeds().back().handle() != this->handle()) {
+          continue;
+        }
+        if (n_found == 0) {
+          // Setting the first one only
+          result = awhp_cc.autosizedRatedCoolingCapacity();
+        }
+        ++n_found;
+      }
+      if (n_found > 1) {
+        LOG(Warn, briefDescription() << " is used as the highest speed in multiple HeatPumpAirToWaterCooling objects, "
+                                        "returning the autosized value from the first one only.");
+      }
+
+      return result;


HeatPumpAirToWaterCoolingSpeedData_Impl::autosizedRatedCoolingCapacity

We only grab it from sql if it's the LAST speed

jmarrec · 2025-11-14T00:06:17Z

This is pretty much ready, except there are moving pieces on E+ side:

Remove Water Loop Type EnergyPlus#11332
- If that merges I need to revert one commit

But I got the OpenStudio-resources tests ready (new rb + python tests, and add it to autosize_hvac)

…490_HeatPumpAirToWater

…field will be gone by 25.2.0 release (will revert then)" This reverts commit 71a7c62.

NREL/EnergyPlus#11332

ci-commercialbuildings · 2025-11-14T13:53:03Z

CI Results for 595d469:

Ubuntu 24.04:
- OpenStudio-3.11.0-alpha+595d469983-Ubuntu-24.04-x86_64.deb
- OpenStudio-3.11.0-alpha+595d469983-Ubuntu-24.04-x86_64.tar.gz
Ubuntu 22.04:
Darwin:
- OpenStudio-3.11.0-alpha+595d469983-Darwin-x86_64.dmg
- OpenStudio-3.11.0-alpha+595d469983-Darwin-x86_64.tar.gz
Windows:
- OpenStudio-3.11.0-alpha+595d469983-Windows.exe
- OpenStudio-3.11.0-alpha+595d469983-Windows.tar.gz
Code Coverage:

Issue: NREL/OpenStudio#5496 Companion PR: NREL/OpenStudio#5496

jmarrec self-assigned this Oct 9, 2025

jmarrec added Enhancement Request component - HVAC component - Model component - IDF Translation labels Oct 9, 2025

jmarrec requested a review from joseph-robertson October 9, 2025 23:49

jmarrec changed the base branch from develop to v25.2.0-IOFreeze October 9, 2025 23:50

jmarrec mentioned this pull request Oct 20, 2025

Update/Create internal Guidelines for developpers #5501

Open

5 tasks

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

jmarrec added 19 commits October 22, 2025 14:03

Naive add HeatPump:AirToWater IDDs

e1e512c

Make required-field + break speed data into subobjects

10bb8c4

I'm considering breaking it further into subobjects, but I need to start somewhere while I wait on stakeholder feedback

WIP wrapping HeatPumpAirToWaterHeatingSpeedData

68e51d1

GenerateClass: allow generating stubs even if didn't build openstudio…

029bcc3

… yet

register ctor and swig

d22527a

Tweak for clone/remove etc

59ccbce

Fixup nasty side effect of removing passed curves in ctor

5d3fdbd

Implement HeatPumpAirToWaterCoolingSpeedData the same way

9941697

Move Min PLR field outside of heating input

65aa931

Prototype subobjects: OS:HeatPump:AirToWater:Heating/Cooling

dfa12e3

Remove the " in Heating Mode" (/Cooling) suffix from the objects, it'…

a477ed9

…s redundant

GenerateClass: improve to add the virtual overrides needed for HVACCo…

6643ef2

…mps and handle Curves properly

Start testing

71873fd

Correct casing of UnivariateFunctions

3b25f89

Wrap HeatPump:AirToWater, add missing ConnectionObject reference for …

3eb7cb0

…the Heating/Cooling side

Make SpeedData be ResourceObject

aef90f0

Implement containingHVACComponent + convenience methods to go from ch…

303af7c

…ild to parent(s)

Forgot to swig HeatPumpAirToWaterCooling

6df9e34

joseph-robertson added 2 commits October 24, 2025 10:49

Merge branch 'develop' into v25.2.0-IOFreeze-5490_HeatPumpAirToWater

220de74

Merge branch 'develop' into v25.2.0-IOFreeze-5490_HeatPumpAirToWater

35b9eb8

joseph-robertson reviewed Nov 12, 2025

View reviewed changes

Merge branch 'develop' into v25.2.0-IOFreeze-5490_HeatPumpAirToWater

c864d8d

jmarrec added a commit to NREL/OpenStudio-resources that referenced this pull request Nov 13, 2025

Initial test for #5490 - fails to to Water Loop Type field right now

5e82de6

Issue: NREL/OpenStudio#5496 Companion PR: NREL/OpenStudio#5496

jmarrec added the Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. label Nov 13, 2025

jmarrec mentioned this pull request Nov 13, 2025

#5490 - E+ 25.2.0: Wrap HeatPump:AirToWater NREL/OpenStudio-resources#225

Merged

26 tasks

jmarrec force-pushed the v25.2.0-IOFreeze-5490_HeatPumpAirToWater branch from 00ea1c6 to 42fe449 Compare November 13, 2025 16:44

jmarrec added 7 commits November 14, 2025 00:54

Update SQL queries

177fab2

Implement top-level autosizedRatedHeating/CoolingCapacity

e09420b

Implement HeatPumpAirToWaterCooling/Heating convenience method for Im…

82c8631

…plement top-level autosizedRatedHeating/CoolingCapacity

HeatPumpAirToWaterCooling(/Heating)-SpeedData: autosizedRatedCoolingC…

606fb81

…apacity: grab it from SQL only if it's the last speed (highest)

Avoid "Unknown IddObjectType" warning

421296e

Temporary (?): Fill PlantLoop's Water Loop Type: hoping this field wi…

71a7c62

…ll be gone by 25.2.0 release (will revert then)

jmarrec force-pushed the v25.2.0-IOFreeze-5490_HeatPumpAirToWater branch from 42fe449 to 71a7c62 Compare November 13, 2025 23:54

jmarrec added a commit to NREL/OpenStudio-resources that referenced this pull request Nov 13, 2025

Initial test for #5490 - fails to to Water Loop Type field right now

8b1a181

Issue: NREL/OpenStudio#5496 Companion PR: NREL/OpenStudio#5496

jmarrec commented Nov 14, 2025

View reviewed changes

jmarrec added 5 commits November 14, 2025 01:06

Merge remote-tracking branch 'origin/develop' into v25.2.0-IOFreeze-5…

e1e03e8

…490_HeatPumpAirToWater

Merge remote-tracking branch 'origin/develop' into v25.2.0-IOFreeze-5…

bd4f9de

…490_HeatPumpAirToWater

Revert "Temporary (?): Fill PlantLoop's Water Loop Type: hoping this …

a31240e

…field will be gone by 25.2.0 release (will revert then)" This reverts commit 71a7c62.

Remove "Water Loop Type" from ProposedE+.idd

fb97ea3

NREL/EnergyPlus#11332

size_t to unsigned conversion error on MSVC

595d469

jmarrec added a commit to NREL/OpenStudio-resources that referenced this pull request Nov 14, 2025

Initial test for #5490 - fails to to Water Loop Type field right now

f26ab2f

Issue: NREL/OpenStudio#5496 Companion PR: NREL/OpenStudio#5496

jmarrec merged commit 1384a7d into develop Nov 14, 2025
3 of 6 checks passed

jmarrec deleted the v25.2.0-IOFreeze-5490_HeatPumpAirToWater branch November 14, 2025 15:48

joseph-robertson mentioned this pull request Dec 18, 2025

Update to EnergyPlus 25.2.0 #5472

Closed

26 tasks

Fix #5490 - E+ 25.2.0: Wrap HeatPump:AirToWater #5496

Fix #5490 - E+ 25.2.0: Wrap HeatPump:AirToWater #5496

Uh oh!

Conversation

jmarrec commented Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull request overview

Pull Request Author

Review Checklist

Uh oh!

joseph-robertson commented Oct 10, 2025

Uh oh!

yujiex commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joseph-robertson left a comment

Choose a reason for hiding this comment

Uh oh!

jmarrec commented Nov 13, 2025

Uh oh!

jmarrec Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

jmarrec Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

jmarrec Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

jmarrec Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

jmarrec Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

jmarrec Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

jmarrec Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

jmarrec commented Nov 14, 2025

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jmarrec commented Oct 9, 2025 •

edited

Loading

yujiex commented Oct 10, 2025 •

edited

Loading

ci-commercialbuildings commented Nov 14, 2025 •

edited

Loading