V25.2.0-IOFreeze: new ZoneHVACIdealLoadsAirSystem fields#5487

joseph-robertson · 2025-09-30T22:44:27Z

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

…previously being translated properly.

ci-commercialbuildings · 2025-10-16T03:25:22Z

CI Results for ae5d8e8:

Ubuntu 24.04:
Ubuntu 22.04:
Darwin:
- OpenStudio-3.10.1-alpha+461f586695-Darwin-x86_64.dmg
- OpenStudio-3.10.1-alpha+461f586695-Darwin-x86_64.tar.gz
Windows:
- OpenStudio-3.10.1-alpha+591129f6c8-Windows.exe
- OpenStudio-3.10.1-alpha+591129f6c8-Windows.tar.gz
Code Coverage:

jmarrec

I'd make the schedules required, but that's just my personal opinion, I don't really care if you don't want to do it.

And reviewer note: there is no VT needed because fields are just added at the end.

jmarrec · 2025-10-20T11:33:53Z

resources/model/OpenStudio.idd

+  A16, \field Design Specification ZoneHVAC Sizing Object Name
+       \note Enter the name of a DesignSpecificationZoneHVACSizing object.
+       \type object-list
+       \object-list DesignSpecificationZoneHVACSizingName


So this is just a reservation because we don't have this object right?

why don't we have it? Isn't it weird that no one asked for it? It was added in E+ V8-2-0

@joseph-robertson I'd like your opinion here please (I'm about to merge anyways)

jmarrec · 2025-10-20T11:35:03Z

resources/model/OpenStudio.idd

+  A17, \field Heating Fuel Efficiency Schedule Name
+       \type object-list
+       \object-list ScheduleNames
+       \note Reference heating fuel efficiency value for converting heating
+       \note ideal loads into fuel energy consumption.
+       \note The minimum schedule value must be greater than 0.0. The maximum value
+       \note depends on the technology, and can exceed 1.0.
+       \note If blank, heating fuel efficiency value is always 1.0.


Suggested change

A17, \field Heating Fuel Efficiency Schedule Name

\type object-list

\object-list ScheduleNames

\note Reference heating fuel efficiency value for converting heating

\note ideal loads into fuel energy consumption.

\note The minimum schedule value must be greater than 0.0. The maximum value

\note depends on the technology, and can exceed 1.0.

\note If blank, heating fuel efficiency value is always 1.0.

A17, \field Heating Fuel Efficiency Schedule Name

\type object-list

\object-list ScheduleNames

\required-field

\note Reference heating fuel efficiency value for converting heating

\note ideal loads into fuel energy consumption.

\note The minimum schedule value must be greater than 0.0. The maximum value

\note depends on the technology, and can exceed 1.0.

\note Defaults to always 1.0.

jmarrec · 2025-10-20T11:35:49Z

resources/model/OpenStudio.idd

+       \key DistrictCooling
+       \key DistrictHeatingWater
+       \key DistrictHeatingSteam
+       \required-field


Ok E+ IDD has DistrictHeatingWater as default

jmarrec · 2025-10-20T11:36:08Z

resources/model/OpenStudio.idd

+  A19, \field Cooling Fuel Efficiency Schedule Name
+       \type object-list
+       \object-list ScheduleNames
+       \note Reference cooling fuel efficiency value for converting cooling
+       \note ideal loads into fuel energy consumption.
+       \note The minimum schedule value must be greater than 0.0. The maximum value
+       \note depends on the technology, and can exceed 1.0.
+       \note If blank, cooling fuel efficiency value is always 1.0.


Same idea, required, default to always On

resources/model/OpenStudio.idd

jmarrec · 2025-10-20T11:38:16Z

src/model/ZoneHVACIdealLoadsAirSystem.hpp

+
+    std::string heatingFuelType() const;
+
+    boost::optional<Schedule> coolingFuelEfficiencySchedule() const;


jmarrec · 2025-10-20T11:38:32Z

src/model/ZoneHVACIdealLoadsAirSystem.hpp


+    bool setHeatingFuelEfficiencySchedule(Schedule& heatingFuelEfficiencySchedule);
+
+    void resetHeatingFuelEfficiencySchedule();


And no reset for either heating or cooling sch

jmarrec · 2025-10-20T11:39:05Z

src/model/ZoneHVACIdealLoadsAirSystem.cpp

+    bool ok = true;
+    ok = setHeatingFuelType("DistrictHeatingWater");
+    OS_ASSERT(ok);
+    ok = setCoolingFuelType("DistrictCooling");
+    OS_ASSERT(ok);


That is Ok per E+ IDD.

I'd make the Heating/Cooling Fuel Efficiency schedule default to alwaysOnContinuous

jmarrec · 2025-10-20T11:39:29Z

src/model/ScheduleTypeRegistry.cpp

+      {"ZoneHVACIdealLoadsAirSystem", "Heating Fuel Efficiency", "heatingFuelEfficiencySchedule", true, "", OptionalDouble(), OptionalDouble()},
+      {"ZoneHVACIdealLoadsAirSystem", "Cooling Fuel Efficiency", "coolingFuelEfficiencySchedule", true, "", OptionalDouble(), OptionalDouble()},


continus = true, seems about right!

jmarrec · 2025-10-20T11:40:06Z

src/energyplus/Test/ZoneHVACIdealLoadsAirSystem_GTest.cpp

thanks for this

jmarrec · 2025-10-22T10:44:26Z

Ok I'm going to ignore the fact that I'd like the schedules required, the object has an optional Availability Schedule already, so at least it's somewhat consistent.

jmarrec · 2025-10-22T11:34:19Z

resources/model/OpenStudio.idd

       \minimum 0.0
       \maximum 1.0
       \default 0.65
+  A16, \field Design Specification ZoneHVAC Sizing Object Name


I had missed the fact that the field above is broken

- N11; \field Latent Heat Recovery Effectiveness + N11, \field Latent Heat Recovery Effectiveness

Hotfixed on develop on 1a3696b

#5487 (review)

… has no harcoded DSOA Follow up would be: * #5504

Hotfix #5487 - Translate the Zone DSOA if ZoneHVACIdealLoadsAirSystem has no harcoded DSOA

#5487 (review)

… has no harcoded DSOA Follow up would be: * #5504

joseph-robertson added 4 commits September 30, 2025 15:42

Update the idd for new ZoneHVAC:IdealLoadsAirSystem fields.

a5baa46

Update model files and schedule type registry.

ec1e1a1

Update the ft file.

3925401

Formatting.

7fba79e

joseph-robertson self-assigned this Sep 30, 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 Sep 30, 2025

joseph-robertson mentioned this pull request Sep 30, 2025

Update to EnergyPlus 25.2.0 #5472

Closed

26 tasks

joseph-robertson added 8 commits September 30, 2025 16:59

Update rt and model test files.

ea8e1a4

Add new ft test file for ZoneHVACIdealLoadsAirSystem.

0627036

Formatting.

1e058c8

Missing includes in ft test file.

d0649be

Fix expected values in ft test file.

fc2e5dc

Follow AirTerminalDualDuctVAV ft of dsoa, as it appears dsoa was not …

bfecdaf

…previously being translated properly.

Include ProgressBar hpp (?).

d84f157

Typo in ft file.

01a1393

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

joseph-robertson added 2 commits October 15, 2025 14:53

Merge branch 'v25.2.0-IOFreeze' into v25.2.0-IOFreeze-ideal

0e30ee6

Update output variable names per OutputChanges.

ae5d8e8

jmarrec reviewed Oct 20, 2025

View reviewed changes

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

jmarrec merged commit adf7263 into develop Oct 22, 2025
0 of 4 checks passed

jmarrec deleted the v25.2.0-IOFreeze-ideal branch October 22, 2025 10:44

jmarrec reviewed Oct 22, 2025

View reviewed changes

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

Hotfix #5487 - broken IDD

1a3696b

#5487 (review)

jmarrec mentioned this pull request Oct 23, 2025

ZoneHVACIdealLoadsAirSystem: Design Specification Outdoor Air field should be replaced by Control For Outdoor Air #5504

Open

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

Hotfix #5487 - Translate the Zone DSOA if ZoneHVACIdealLoadsAirSystem…

abc8dd9

… has no harcoded DSOA Follow up would be: * #5504

jmarrec mentioned this pull request Oct 23, 2025

Hotfix #5487 - Translate the Zone DSOA if ZoneHVACIdealLoadsAirSystem has no harcoded DSOA #5505

Merged

19 tasks

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

Merge pull request #5505 from NREL/ideal_dsoa

fdb1047

Hotfix #5487 - Translate the Zone DSOA if ZoneHVACIdealLoadsAirSystem has no harcoded DSOA

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

Hotfix #5487 - broken IDD

45d5e56

#5487 (review)

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

Hotfix #5487 - Translate the Zone DSOA if ZoneHVACIdealLoadsAirSystem…

10a537b

… has no harcoded DSOA Follow up would be: * #5504


		std::string heatingFuelType() const;

		boost::optional<Schedule> coolingFuelEfficiencySchedule() const;


		bool setHeatingFuelEfficiencySchedule(Schedule& heatingFuelEfficiencySchedule);

		void resetHeatingFuelEfficiencySchedule();

		{"ZoneHVACIdealLoadsAirSystem", "Heating Fuel Efficiency", "heatingFuelEfficiencySchedule", true, "", OptionalDouble(), OptionalDouble()},
		{"ZoneHVACIdealLoadsAirSystem", "Cooling Fuel Efficiency", "coolingFuelEfficiencySchedule", true, "", OptionalDouble(), OptionalDouble()},

Conversation

joseph-robertson commented Sep 30, 2025

Pull request overview

Pull Request Author

Review Checklist

Uh oh!

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

Uh oh!

Uh oh!

jmarrec left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

jmarrec commented Oct 22, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ci-commercialbuildings commented Oct 16, 2025 •

edited

Loading

jmarrec left a comment •

edited

Loading