Plant sizing report and equipment summary fixes #10998

mjwitte · 2025-03-19T20:56:58Z

Pull request overview

Fixes Component Sizing Summary - PlantLoop incorrect table values #10987
Add new function reportSizerStrOutput that allows component sizing to output a string.
For PlantLoop and CondenserLoop change component sizing output:
- Always report sizing values whether autosized or hard-sized
- Change "Sizing option (Coincident/NonCoincident), 1.00000" --> "Sizing Option, NonCoincident".
Fix Table Output, Equipment Summary, PlantLoop or CondenserLoop subtable
- Fix values reported for "Provides Heating", "Provides Cooling", "Maximum Loop Flow Rate", and "Minimum Loop Flow Rate".
- Always report values whether autosized or hard-sized
- Add columns for "Design Supply Temperature", "Design ReturnTemperature", and "Design Capacity".

Pull Request Author

Reviewer

github-actions · 2025-03-19T21:51:03Z

⚠️ Regressions detected on macos-14 for commit `b68abf1`

Regression Summary

EIO: 262
Table Big Diffs: 183
Table String Diffs: 98
Audit: 63
Table Small Diffs: 1

mjwitte · 2025-03-21T18:36:32Z

Here is an initial update to the relevant tables in the Component Sizing Summary for 5ZoneVAV-Pri-SecLoop.idf:

There is also this table in the Equipment Summary report which is somewhat redundant and also needs repairs:

For the component sizing summary:

The reason the table wasn't populating before is that it only reported for values that were actually autosized. The changes at this point force reporting for hard-sized values as well. However, the proper way to do this would be to report both Design Size and User-Specifed values, the way most other components do:
For the coincident/non-coincident field, the reporting functions used for component sizing (BaseSizer::reportSizerOutput, OutputReportPredefined::AddCompSizeTableEntry, and OutputReportTabular::WriteComponentSizing) all expect a numeric value, so wedging in a string value would require some extra effort. It would be easy to move this to the Equipment Summary table instead, even though it's related to sizing, but it's not an autosized value result (which is what Component Sizing is generally supposed to be reporting).
This also applies to Supply Temperature, Return Temperature, and Minimum Loop Flow Rate which are not autosizable inputs.

mjwitte · 2025-04-03T18:16:27Z

Plant loops currently report sizing results only if autosized and don't use the "Design Size" "User-Specified" labels.

 Component Sizing Information, PlantLoop, HOT WATER LOOP, Maximum Loop Flow Rate [m3/s], 5.96451E-004
 Component Sizing Information, PlantLoop, HOT WATER LOOP, Plant Loop Volume [m3], 7.15741E-002

I plan to add the logic to report "Design Size" and "User-Specified" values.

These informationl values that aren't really autosized were added to the "Component Sizing" reporting to support RPD:

 Component Sizing Information, PlantLoop, HOT WATER LOOP, Design Supply Temperature [C], 82.00000
 Component Sizing Information, PlantLoop, HOT WATER LOOP, Design Return Temperature [C], 71.00000
 Component Sizing Information, PlantLoop, HOT WATER LOOP, Sizing option (Coincident/NonCoincident), 1.00000
 Component Sizing Information, PlantLoop, HOT WATER LOOP, Minimum Loop Flow Rate [m3/s], 0.00000
 Component Sizing Information, PlantLoop, HOT WATER LOOP, Design Capacity [W], 27539.63807

I'm planning to move these to the Equipment Summary table reports.

@JasonGlazer @rraustad @EnergyArchmage Please comment if you disagree.

JasonGlazer · 2025-04-09T13:50:15Z

Thanks for working on this.

rraustad · 2025-04-09T14:51:16Z

@mjwitte I am all for reporting data whether autosized or not. The user should not have to search for data that is not in the eio or tables, even though the user entered that data.

However, the proper way to do this would be to report both Design Size and User-Specifed values, the way most other components do

I think the EIR chiller data shows user-specified only when hard-sized, or if no plant sizing is performed (i.e., the tables are dynamic). If autosized then the user-specified column would not show up? I don't see where user-specified comes from for autosized inputs. I searched for "User-Specified Reference Chilled Water Flow Rate" and only found it here and in the err file if difference > 10%.

        if (this->EvapVolFlowRateWasAutoSized) {
            this->EvapVolFlowRate = tmpEvapVolFlowRate;
            if (state.dataPlnt->PlantFinalSizesOkayToReport) {
                BaseSizer::reportSizerOutput(
                    state, "Chiller:Electric:EIR", this->Name, "Design Size Reference Chilled Water Flow Rate [m3/s]", tmpEvapVolFlowRate);
            }

        } else { // Hard-size with sizing data
            if (this->EvapVolFlowRate > 0.0 && tmpEvapVolFlowRate > 0.0) {
                Real64 EvapVolFlowRateUser = this->EvapVolFlowRate;
                if (state.dataPlnt->PlantFinalSizesOkayToReport) {
                    BaseSizer::reportSizerOutput(state,
                                                 "Chiller:Electric:EIR",
                                                 this->Name,
                                                 "Design Size Reference Chilled Water Flow Rate [m3/s]",
                                                 tmpEvapVolFlowRate,
                                                 "User-Specified Reference Chilled Water Flow Rate [m3/s]",
                                                 EvapVolFlowRateUser);

    if (!this->EvapVolFlowRateWasAutoSized && state.dataPlnt->PlantFinalSizesOkayToReport && (this->EvapVolFlowRate > 0.0)) {
        BaseSizer::reportSizerOutput(
            state, "Chiller:Electric:EIR", this->Name, "User-Specified Reference Chilled Water Flow Rate [m3/s]", this->EvapVolFlowRate);
    }

EnergyArchmage · 2025-04-09T17:30:38Z

Reporting plant loop Design Capacity regardless of autosizing is a good idea.

I guess moving reports to Equipment Summary table means they no longer also show up in the EIO as they do when called as Component Sizing Information? If so, that is a drawback for us developers and anyone who prefers the EIO text for easy diff'ing.

mjwitte · 2025-04-09T17:53:48Z

Reporting plant loop Design Capacity regardless of autosizing is a good idea.

I guess moving reports to Equipment Summary table means they no longer also show up in the EIO as they do when called as Component Sizing Information? If so, that is a drawback for us developers and anyone who prefers the EIO text for easy diff'ing.

Maybe I'm being too much of a purist about what constitutes "component sizing" results and what doesn't. Perhaps I should leave things where they are and just make sure the values always get reported as a sizing result (whether autosized, or hard-sized, or calculated e.g. Design Capacity) and let these continue to report as a component sizing result without indicating "Design Size or User-Specified".
And possibly duplicate some values in the Equipment Summary?
Where would you like to see "Conicident/NonCoincident"? I could extend the report sizing functions to accept a string value, or simply move this to the equipment summary table.

EnergyArchmage · 2025-04-09T18:33:51Z

I could extend the report sizing functions to accept a string value

This would be really useful I think. I have wanted this for a while; perfect for Coincident/NonCoincident reporting.

github-actions · 2025-04-09T22:37:41Z

⚠️ Regressions detected on macos-14 for commit `397edc6`

Regression Summary

Audit: 794
EIO: 262
Table Big Diffs: 183
Table String Diffs: 98
Table Small Diffs: 1

Myoldmopar · 2025-04-10T19:44:35Z

@mjwitte now that the plant location and other PRs have been merged, do you want to pull develop in and update this branch with those changes? It doesn't show conflicted, so you might not actually have to, but I can't tell immediately. It does need clang formatting it looks like anyway. Let me know if you want me to do anything here.

mjwitte · 2025-04-10T19:48:09Z

@Myoldmopar Thanks. There's more actual work to do here, and this doesn't really overlap with the plantloc work, because this PR is at the plant-loop level so plantloc doesn't even apply, duh.

github-actions · 2025-04-17T21:49:54Z

⚠️ Regressions detected on macos-14 for commit `4639552`

Regression Summary

Audit: 794
EIO: 387
Table Big Diffs: 170
Table String Diffs: 87
Table Small Diffs: 1

github-actions · 2025-06-03T21:03:55Z

⚠️ Regressions detected on macos-14 for commit `2b4f752`

Regression Summary

Audit: 794
Table Big Diffs: 736
EIO: 446
Table String Diffs: 366

github-actions · 2025-06-05T21:09:01Z

⚠️ Regressions detected on macos-14 for commit `714fb06`

Regression Summary

Audit: 796
Table Big Diffs: 738
EIO: 446
Table String Diffs: 230

github-actions · 2025-06-06T18:42:39Z

⚠️ Regressions detected on macos-14 for commit `9a24edf`

Regression Summary

Audit: 796
Table Big Diffs: 738
EIO: 446
Table String Diffs: 230

mjwitte · 2025-06-19T20:39:19Z

@JasonGlazer @rraustad @EnergyArchmage

Here are some final sample outputs. For 5ZoneVAV-Pri-SecLoop which has Sizing:Plant objects:
Component Sizing report

Equipment Summary report

For CoolingTower.idf which does not have Sizing:Plant objects, so supply and return temps and resulting capacity are unknown:
Component Sizing report

Equipment Summary report

mjwitte · 2025-06-19T20:41:29Z

The reasons for diffs are noted in the output rules here

rraustad · 2025-06-19T20:48:40Z

@mjwitte those tables look good.

Myoldmopar

Very good stuff here. The new functions in the sizer code and the sql code are good, and lots of little cleanups along the way. I resolved the minor conflict, and this should be good to go in.

Myoldmopar · 2025-07-16T20:45:05Z

src/EnergyPlus/DataSizing.hh

-        int NumTimeStepsInAvg = 0;                           // number of zone timesteps in the averaging window for coincident plant flow
-        int SizingFactorOption = 0;                          // option for what sizing factor to apply
+        DataSizing::SizingConcurrence ConcurrenceOption =
+            DataSizing::SizingConcurrence::NonCoincident; // sizing option for coincident or noncoincident (default)


Myoldmopar · 2025-07-16T20:45:27Z

src/EnergyPlus/Autosizing/Base.cc


+void BaseSizer::reportSizerStrOutput(
+    EnergyPlusData &state, std::string_view CompType, std::string_view CompName, std::string_view VarDesc, std::string_view VarValue)
+{


No need for the optional parameters I guess? That's fine with me for sure.

Myoldmopar · 2025-07-16T20:47:25Z

src/EnergyPlus/Plant/Component.hh

+        DataPlant::CtrlType::CoolingOp, //	"HeatPump:PlantLoop:EIR:Cooling"
+        DataPlant::CtrlType::HeatingOp, //	"HeatPump:PlantLoop:EIR:Heating"
+        DataPlant::CtrlType::HeatingOp  //   "DistrictHeating:Steam"
+    };


I have feelings about another list of things allocated to the same size as the others, but I will stop talking now.

Myoldmopar · 2025-07-16T20:47:51Z

src/EnergyPlus/SQLiteProcedures.cc

+        sqliteStepCommand(m_componentSizingInsertStmt);
+        sqliteResetCommand(m_componentSizingInsertStmt);
+    }
+}


github-actions · 2025-07-16T21:36:28Z

⚠️ Regressions detected on macos-14 for commit `3540fe8`

Regression Summary

Audit: 796
Table Big Diffs: 738
EIO: 446
Table String Diffs: 230

github-actions · 2025-07-31T18:08:56Z

⚠️ Regressions detected on macos-14 for commit `5b43c61`

Regression Summary

Audit: 796
Table Big Diffs: 738
EIO: 446
Table String Diffs: 230

nrel-bot-2c · 2025-08-30T00:55:26Z

@Myoldmopar @mjwitte @Myoldmopar it has been 29 days since this pull request was last updated.

github-actions · 2025-09-06T16:18:48Z

⚠️ Regressions detected on macos-14 for commit `b53c830`

Regression Summary

Audit: 796
Table Big Diffs: 738
EIO: 446
Table String Diffs: 230

github-actions · 2025-09-06T16:32:22Z

⚠️ Regressions detected on ubuntu-24.04 for commit `b53c830`

Regression Summary

Audit: 799
Table Big Diffs: 740
EIO: 446
Table String Diffs: 230

github-actions · 2025-09-09T15:56:48Z

⚠️ Regressions detected on macos-14 for commit `4b49092`

Regression Summary

Audit: 796
Table Big Diffs: 738
EIO: 446
Table String Diffs: 230

github-actions · 2025-09-09T16:00:13Z

⚠️ Regressions detected on ubuntu-24.04 for commit `4b49092`

Regression Summary

Audit: 799
Table Big Diffs: 740
EIO: 446
Table String Diffs: 230

mjwitte · 2025-09-09T21:06:38Z

This was previously approved by @Myoldmopar and CI diffs are as expected, merging.

Initial plant sizing report fixes

87b8e10

mjwitte added the Defect Includes code to repair a defect in EnergyPlus label Mar 19, 2025

mjwitte added this to the EnergyPlus 25.1 milestone Mar 19, 2025

mjwitte modified the milestones: EnergyPlus 25.1, EnergyPlus 25.2 IO Freeze Mar 20, 2025

mjwitte changed the title ~~Initial plant sizing report fixes~~ Plant sizing report fixes Mar 21, 2025

Merge remote-tracking branch 'remotes/origin/develop' into rpdTables2

2bec41a

mjwitte added 2 commits April 7, 2025 14:44

Merge remote-tracking branch 'remotes/origin/develop' into rpdTables2

5873e5a

Move some items to Equipment Summary

7e4962c

mjwitte added 2 commits April 9, 2025 15:56

Merge remote-tracking branch 'remotes/origin/develop' into rpdTables2

d4d94af

Shortcuts etc

a90c372

format

f2e6960

mjwitte added 4 commits April 17, 2025 12:03

Merge remote-tracking branch 'remotes/origin/develop' into rpdTables2

297f41a

More plant sizing updates, dup some values in Equipment Summary

b40df49

Use SizingConcurrence enum

f3b9dc1

Use SizingConcurrence enum

fac4e25

mjwitte added 2 commits April 21, 2025 14:47

Add comp sizing string value reporting

81e9d68

format

a7dee19

mjwitte added 2 commits June 5, 2025 13:07

Merge remote-tracking branch 'remotes/origin/develop' into rpdTables2

6b76edc

Report NonCoincident if no plant sizing object

ac6d897

Output Rules

c803907

Myoldmopar self-assigned this Jul 2, 2025

mjwitte added the RPD label Jul 7, 2025

Merge develop, resolve conflict

91345b7

Myoldmopar approved these changes Jul 16, 2025

View reviewed changes

mjwitte added the OutputChange Code changes output in such a way that it cannot be merged after IO freeze label Jul 31, 2025

Merge remote-tracking branch 'remotes/origin/develop' into rpdTables2

9fa4737

mjwitte mentioned this pull request Aug 13, 2025

Correction of Return Temperature Output for Cooling Plant Loops and Condenser Loops in EIO Sizing Output #11146

Merged

20 tasks

mjwitte added 3 commits September 6, 2025 09:36

Merge remote-tracking branch 'remotes/origin/develop' into rpdTables2

70c66b8

Move to switch and fix steam

7fc02d6

Add default case - invalid and num were flagged as missing

124921b

PlantManager_CheckPlantEquipmentCtrlType unit test

99eef95

mjwitte merged commit 2745db9 into develop Sep 9, 2025
7 of 8 checks passed

mjwitte deleted the rpdTables2 branch September 9, 2025 21:06

Plant sizing report and equipment summary fixes #10998

Plant sizing report and equipment summary fixes #10998

Uh oh!

Conversation

mjwitte commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull request overview

Pull Request Author

Reviewer

Uh oh!

github-actions bot commented Mar 19, 2025

⚠️ Regressions detected on macos-14 for commit b68abf1

Uh oh!

mjwitte commented Mar 21, 2025

Uh oh!

mjwitte commented Apr 3, 2025

Uh oh!

JasonGlazer commented Apr 9, 2025

Uh oh!

rraustad commented Apr 9, 2025

Uh oh!

EnergyArchmage commented Apr 9, 2025

Uh oh!

mjwitte commented Apr 9, 2025

Uh oh!

EnergyArchmage commented Apr 9, 2025

Uh oh!

github-actions bot commented Apr 9, 2025

⚠️ Regressions detected on macos-14 for commit 397edc6

Uh oh!

Myoldmopar commented Apr 10, 2025

Uh oh!

mjwitte commented Apr 10, 2025

Uh oh!

github-actions bot commented Apr 17, 2025

⚠️ Regressions detected on macos-14 for commit 4639552

Uh oh!

github-actions bot commented Jun 3, 2025

⚠️ Regressions detected on macos-14 for commit 2b4f752

Uh oh!

github-actions bot commented Jun 5, 2025

⚠️ Regressions detected on macos-14 for commit 714fb06

Uh oh!

github-actions bot commented Jun 6, 2025

⚠️ Regressions detected on macos-14 for commit 9a24edf

Uh oh!

mjwitte commented Jun 19, 2025

Uh oh!

mjwitte commented Jun 19, 2025

Uh oh!

rraustad commented Jun 19, 2025

Uh oh!

Myoldmopar left a comment

Choose a reason for hiding this comment

Uh oh!

Myoldmopar Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

Myoldmopar Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

Myoldmopar Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

Myoldmopar Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jul 16, 2025

⚠️ Regressions detected on macos-14 for commit 3540fe8

Uh oh!

github-actions bot commented Jul 31, 2025

⚠️ Regressions detected on macos-14 for commit 5b43c61

Uh oh!

nrel-bot-2c commented Aug 30, 2025

Uh oh!

github-actions bot commented Sep 6, 2025

⚠️ Regressions detected on macos-14 for commit b53c830

Uh oh!

github-actions bot commented Sep 6, 2025

⚠️ Regressions detected on ubuntu-24.04 for commit b53c830

mjwitte commented Mar 19, 2025 •

edited

Loading

⚠️ Regressions detected on macos-14 for commit `b68abf1`

⚠️ Regressions detected on macos-14 for commit `397edc6`

⚠️ Regressions detected on macos-14 for commit `4639552`

⚠️ Regressions detected on macos-14 for commit `2b4f752`

⚠️ Regressions detected on macos-14 for commit `714fb06`

⚠️ Regressions detected on macos-14 for commit `9a24edf`

⚠️ Regressions detected on macos-14 for commit `3540fe8`

⚠️ Regressions detected on macos-14 for commit `5b43c61`

⚠️ Regressions detected on macos-14 for commit `b53c830`

⚠️ Regressions detected on ubuntu-24.04 for commit `b53c830`

⚠️ Regressions detected on macos-14 for commit `4b49092`

⚠️ Regressions detected on ubuntu-24.04 for commit `4b49092`