Optimize TableEntry Handling by amirroth · Pull Request #11469 · NatLabRockies/EnergyPlus

amirroth · 2026-03-15T17:44:24Z

This PR optimizes TableEntry handling by storing entries in table-specific lists instead of a single global list. When printing out tables, each entry has to be traversed only once rather than once per table. Unique rows are also tracked on a per-table basis.

To enable this, SetPredefinedTables was moved to init_constant_state(). This broke a unit test which checked that the Standard 62.1 was not being printed out if sizing was not done. This logic was implemented by not initializing the table constants if Sizing was off, but that's not the way to do something like this. The unit test is partially disabled for now.

amirroth

Simple walk through.

amirroth · 2026-03-15T17:46:15Z

src/EnergyPlus/OutputReportPredefined.cc

        s->pdchSHGSHtOtherRem = newPreDefColumn(state, s->pdstSHGSpkHt, "Opaque Surface Conduction and Other Heat Removal [W]");

        // Standard62Report
-        if (state.dataGlobal->DoZoneSizing || state.dataGlobal->DoSystemSizing) {


Don't condition constant initialization based on flags. Initialize always and use the flags to condition display later.

amirroth · 2026-03-15T17:47:36Z

src/EnergyPlus/OutputReportPredefined.cc

-        // SUBROUTINE PARAMETER DEFINITIONS:
+        assert(columnIndex > 0 && columnIndex <= state.dataOutRptPredefined->numColumnTag);
+        auto &column = state.dataOutRptPredefined->columnTag(columnIndex);
+        auto &table = state.dataOutRptPredefined->subTable(column.indexSubTable);


Store entries in table-specific lists.

amirroth · 2026-03-15T17:48:12Z

src/EnergyPlus/OutputReportPredefined.cc

+        auto &table = state.dataOutRptPredefined->subTable(column.indexSubTable);
+
+        for (int i = 1; i <= table.numEntries; ++i) {
+            if (table.entries(i).indexColumn == columnIndex && table.entries(i).objectName == objName) {


Search entries only from the appropriate table.

amirroth · 2026-03-15T17:48:41Z

src/EnergyPlus/OutputReportPredefined.hh

+        int numEntries;
+        int sizeEntries; 
+
+        Array1D<TableEntryType> entries;


Table-specific entry lists.

amirroth · 2026-03-15T17:49:10Z

src/EnergyPlus/OutputReportTabular.cc


    for (auto &currentStyle : ort->tabularReportPasses) {

-        // loop through the entries and associate them with the subtable and create


We will do this on a per-table basis below.

amirroth · 2026-03-15T17:50:01Z

src/EnergyPlus/OutputReportTabular.cc

                            }
                        }
+
+                        int curNumRows = numUniqueObjectNames;


Number of rows equals number of unique objects.

amirroth · 2026-03-15T17:50:51Z

src/EnergyPlus/OutputReportTabular.cc

+                            }
+
+                            // determine what row the current entry is in
+                            int const rowCurrent = entry.uniqueObjName;


Indentation has changed, that is all.

amirroth · 2026-03-15T17:51:30Z

tst/EnergyPlus/unit/OutputReportTabular.unit.cc


 TEST_F(EnergyPlusFixture, OutputReportTabularTest_PredefinedTableRowMatchingTest)
 {
-


This is being called by init_constant_state().

amirroth · 2026-03-15T17:52:21Z

src/EnergyPlus/OutputReportPredefined.hh


    void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
    {
+        OutputReportPredefined::SetPredefinedTables(state);


Call SetPredefinedTables() here.

amirroth · 2026-03-15T17:54:18Z

tst/EnergyPlus/unit/OutputReportTabular.unit.cc

+    // Do this some other way, whether or not a report is used should not depend on whether or not it is defined

-    GetInputOutputTableSummaryReports(*state);
+    // auto &reportNameArray = state->dataOutRptPredefined->reportName;


Disable this part of the unit test (for now?). Maybe do this via an #ifdef DISABLED.

github-actions · 2026-03-15T18:20:48Z

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

Regression Summary

Audit: 814
Table String Diffs: 11

github-actions · 2026-03-15T18:32:20Z

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

Regression Summary

Audit: 810
Table String Diffs: 11

github-actions · 2026-03-16T00:06:50Z

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

Regression Summary

Audit: 810

github-actions · 2026-03-16T00:07:47Z

⚠️ Regressions detected on ubuntu-24.04 for commit `5a476ca`

Regression Summary

Audit: 814

github-actions · 2026-03-16T15:32:23Z

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

Regression Summary

Audit: 810

github-actions · 2026-03-16T15:33:31Z

⚠️ Regressions detected on ubuntu-24.04 for commit `2caf4af`

Regression Summary

Audit: 814

mitchute · 2026-03-18T16:58:18Z

I've tested this locally and am seeing that for files with no system sizing (ASIHPMixedTank.idf, for example), the 62.1 table entries appear in the .htm file, but they are blank. Whereas in the baseline branch, they do not appear at all, which I think is consistent with what you described regarding the unit test. Hence some of the very large .audit file diffs.

  sizeReportName=         100
- numReportName=          18
+ numReportName=          19
  sizeSubTable=         200
- numSubTable=         105
+ numSubTable=         113
  sizeColumnTag=        1600
- numColumnTag=         968
- sizeTableEntry=        6400
+ numColumnTag=        1053
+ sizeTableEntry=        7900
  numTableEntry=        3248

For files with system sizing (5ZoneAirCooledConvCoeff.idf), I am still seeing very large .audit file diffs, but the .htm files show no numerical diffs (though the entries are reordered in some cases).

-  sizeTableEntry=        6400
+  sizeTableEntry=        11200

amirroth · 2026-03-18T18:18:00Z

I've tested this locally and am seeing that for files with no system sizing (ASIHPMixedTank.idf, for example), the 62.1 table entries appear in the .htm file, but they are blank. Whereas in the baseline branch, they do not appear at all, which I think is consistent with what you described regarding the unit test. Hence some of the very large .audit file diffs.
  sizeReportName=         100
- numReportName=          18
+ numReportName=          19
  sizeSubTable=         200
- numSubTable=         105
+ numSubTable=         113
  sizeColumnTag=        1600
- numColumnTag=         968
- sizeTableEntry=        6400
+ numColumnTag=        1053
+ sizeTableEntry=        7900
  numTableEntry=        3248
For files with system sizing (5ZoneAirCooledConvCoeff.idf), I am still seeing very large .audit file diffs, but the .htm files show no numerical diffs (though the entries are reordered in some cases).
-  sizeTableEntry=        6400
+  sizeTableEntry=        11200

The audit files diffs don't really matter. Especially the ones having to do with sizes of lists as opposed to number of entries. The blank table is a problem, but it needs a different solution than what was previously used. I can try to come up with something, or maybe @JasonGlazer has an idea.

rraustad · 2026-03-18T18:51:37Z

I've tested this locally and am seeing that for files with no system sizing (ASIHPMixedTank.idf, for example), the 62.1 table
entries appear in the .htm file, but they are blank. Whereas in the baseline branch, they do not appear at all, which I think
is consistent with what you described regarding the unit test. Hence some of the very large .audit file diffs.

See old and new line 1450 of OutputReportPredefined.cc, these tables are now created regardless if sizing is selected.

    if (state.dataGlobal->DoZoneSizing || state.dataGlobal->DoSystemSizing) {

rraustad · 2026-04-08T12:47:02Z

src/EnergyPlus/OutputReportPredefined.cc

-            s->pdchS62shdEvz = newPreDefColumn(state, s->pdstS62sysHeatDes, "Zone Ventilation Efficiency - Evz-min");
-        }
-
+        //        if (state.dataGlobal->DoZoneSizing || state.dataGlobal->DoSystemSizing) {


This line is the reason the tables are now present and blank.

Initial commit

71841c7

amirroth added Refactoring Includes code changes that don't change the functionality of the program, just perform refactoring NotIDDChange Code does not impact IDD (can be merged after IO freeze) labels Mar 15, 2026

amirroth added this to the EnergyPlus 26.1 milestone Mar 15, 2026

amirroth commented Mar 15, 2026

View reviewed changes

SI/IP fix

4388e7d

Fix unit test

c553c89

amirroth marked this pull request as draft March 30, 2026 13:45

amirroth self-assigned this Mar 30, 2026

rraustad reviewed Apr 8, 2026

View reviewed changes


		for (auto &currentStyle : ort->tabularReportPasses) {

		// loop through the entries and associate them with the subtable and create


		TEST_F(EnergyPlusFixture, OutputReportTabularTest_PredefinedTableRowMatchingTest)
		{

Conversation

amirroth commented Mar 15, 2026

Uh oh!

amirroth 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!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 15, 2026

⚠️ Regressions detected on ubuntu-24.04 for commit d667b96

Uh oh!

github-actions bot commented Mar 15, 2026

⚠️ Regressions detected on macos-14 for commit d667b96

Uh oh!

github-actions bot commented Mar 16, 2026

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

Uh oh!

github-actions bot commented Mar 16, 2026

⚠️ Regressions detected on ubuntu-24.04 for commit 5a476ca

Uh oh!

github-actions bot commented Mar 16, 2026

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

Uh oh!

github-actions bot commented Mar 16, 2026

⚠️ Regressions detected on ubuntu-24.04 for commit 2caf4af

Uh oh!

mitchute commented Mar 18, 2026

Uh oh!

amirroth commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rraustad commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

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

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

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

⚠️ Regressions detected on ubuntu-24.04 for commit `5a476ca`

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

⚠️ Regressions detected on ubuntu-24.04 for commit `2caf4af`

amirroth commented Mar 18, 2026 •

edited

Loading

rraustad commented Mar 18, 2026 •

edited

Loading