Fix #11156 - WaterThermalTanks's GetWaterThermalTankInput should trap ErrorsFound and throw a FatalError #11172

jmarrec · 2025-08-26T09:09:31Z

Pull request overview

Fix WaterThermalTanks.cc never traps ErrorsFound #11156

Description of the purpose of this PR

The defect file in DevSupport segfaults before fix. After fix it fatals out as expected.

$ $ep_build_rel/Products/energyplus -w $chig_epw -d out-new WaterHeaterStandAlone-Error.idf 
EnergyPlus Starting
EnergyPlus, Version 25.2.0-aa87688ddd, YMD=2025.08.26 11:08
Adjusting Air System Sizing
Adjusting Standard 62.1 Ventilation Sizing
Initializing Simulation
Program terminated: EnergyPlus Terminated--Error(s) Detected.

$ cat out-new/eplusout.err 
Program Version,EnergyPlus, Version 25.2.0-aa87688ddd, YMD=2025.08.26 11:08,
   ** Warning ** Version: in IDF="25.1" not the same as expected="25.2"
   ** Warning ** Version: in IDF="25.1" not the same as expected="25.2"
   ** Severe  ** getWaterHeaterMixedInputs: WaterHeater:Mixed = MIXED GAS TANK
   **   ~~~   ** Setpoint Temperature Schedule Name = HOT WATER XYZ SETPOINT TEMP SCHEDULE, item not found.
   **  Fatal  ** GetWaterThermalTankInput: Errors found in processing Water Thermal Tank input.
   ...Summary of Errors that led to program termination:
   ..... Reference severe error count=1
   ..... Last severe error=getWaterHeaterMixedInputs: WaterHeater:Mixed = MIXED GAS TANK
   ************* Warning:  Node connection errors not checked - most system input has not been read (see previous warning).
   ************* Fatal error -- final processing.  Program exited before simulations began.  See previous error messages.
   ************* EnergyPlus Warmup Error Summary. During Warmup: 0 Warning; 0 Severe Errors.
   ************* EnergyPlus Sizing Error Summary. During Sizing: 0 Warning; 0 Severe Errors.
   ************* EnergyPlus Terminated--Fatal Error Detected. 2 Warning; 1 Severe Errors; Elapsed Time=00hr 00min  0.08sec

Pull Request Author

Reviewer

…Input

…t doesn't fatal due to missing zone ``` + ** Severe ** WaterHeater:HeatPump:PumpedCondenser=\"HPWHPUMPED\", not found + ** ~~~ ** Inlet Air Zone Name=\"ZONE1\". + ** Severe ** WaterHeater:HeatPump:WrappedCondenser=\"HPWHWRAPPED\", not found + ** ~~~ ** Inlet Air Zone Name=\"ZONE1\". + ** Severe ** WaterHeater:Mixed = HPWHPUMPED MIXED TANK: Ambient Temperature Zone not found = ZONE1 + ** Severe ** WaterHeater:Stratified = HPWHWRAPPED STRATIFIED TANK: Ambient Temperature Zone not found = ZONE1 + ** Severe ** WaterHeater:HeatPump:PumpedCondenser = HPWHPUMPED: + ** ~~~ ** ZoneHVAC:EquipmentList and ZoneHVAC:EquipmentConnections objects are required when Inlet Air Configuration is either ZoneAirOnly or ZoneAndOutdoorAir. + ** Severe ** WaterHeater:HeatPump:WrappedCondenser = HPWHWRAPPED: + ** ~~~ ** ZoneHVAC:EquipmentList and ZoneHVAC:EquipmentConnections objects are required when Inlet Air Configuration is either ZoneAirOnly or ZoneAndOutdoorAir. + ** Fatal ** GetWaterThermalTankInput: Errors found in processing Water Thermal Tank input ```

jmarrec · 2025-08-26T09:09:42Z

src/EnergyPlus/WaterThermalTanks.cc

 }

-bool GetWaterThermalTankInput(EnergyPlusData &state)
+void GetWaterThermalTankInput(EnergyPlusData &state)


jmarrec · 2025-08-26T09:09:48Z

src/EnergyPlus/WaterThermalTanks.cc

+    if (ErrorsFound) {
+        ShowFatalError(state, format("GetWaterThermalTankInput: Errors found in processing Water Thermal Tank input."));
+    }


jmarrec · 2025-08-26T09:10:31Z

tst/EnergyPlus/unit/WaterThermalTanks.unit.cc

    state->dataEnvrn->StdRhoAir = 1.0;

-    ASSERT_FALSE(WaterThermalTanks::GetWaterThermalTankInput(*state));
+    WaterThermalTanks::GetWaterThermalTankInput(*state);


No need to wrap into "EXPECT_NO_THROW". We just rely on gtest catching the exception if needed. This is what we do in most tests right now

Yep, let it fail if it's gonna fail.

jmarrec · 2025-08-26T09:11:46Z

tst/EnergyPlus/unit/WaterThermalTanks.unit.cc

+    DataZoneEquipment::GetZoneEquipmentData(*state);
+    ASSERT_FALSE(ErrorsFound);


Missing call to GetZoneEquipmentData here, GetWaterThermalTankInput would eventually complain that ZoneEquipConfig isn't allocated

EnergyPlus/src/EnergyPlus/WaterThermalTanks.cc

Lines 1974 to 1976 in acf7908

if ((HPWH.InletAirConfiguration == WTTAmbientTemp::TempZone || HPWH.InletAirConfiguration == WTTAmbientTemp::ZoneAndOA) &&

HPWH.AmbientTempZone > 0) {

if (allocated(state.dataZoneEquip->ZoneEquipConfig)) {

You need to remove the format from the new fatal at WaterThermalTanks.cc line 4906 so you might as well also remove line 1052 above since it doesn't do anything (i.e., GetZoneEquipmentData doesn't have the ErrorsFound argument so of course ErrorsFound is still false). Other than that this is good to go.

jmarrec · 2025-08-26T09:12:09Z

tst/EnergyPlus/unit/WaterThermalTanks.unit.cc

+    EXPECT_THROW(WaterThermalTanks::GetWaterThermalTankInput(*state), EnergyPlus::FatalError);

-    std::string const error_string =
-        delimited_string({"   ** Warning ** ProcessScheduleInput: Schedule:Constant = DUMMYSCH",
-                          "   **   ~~~   ** Schedule Type Limits Name is empty.",
-                          "   **   ~~~   ** Schedule will not be validated.",
-                          "   ** Severe  ** WaterHeater:HeatPump:PumpedCondenser=\"ZONE4HEATPUMPWATERHEATER\":",
-                          "   **   ~~~   ** When Inlet Air Configuration=\"OUTDOORAIRONLY\".",
-                          "   **   ~~~   ** Outdoor Air Node Name and Exhaust Air Node Name must be specified.",
-                          "   ** Severe  ** WaterHeater:HeatPump:PumpedCondenser=\"ZONE4HEATPUMPWATERHEATER\":",
-                          "   **   ~~~   ** Heat pump water heater fan outlet node name does not match next connected component.",
-                          "   **   ~~~   ** Fan outlet node name = ZONE4AIRINLETNODE"});
+    std::string const error_string = delimited_string({
+        "   ** Warning ** ProcessScheduleInput: Schedule:Constant = DUMMYSCH",
+        "   **   ~~~   ** Schedule Type Limits Name is empty.",
+        "   **   ~~~   ** Schedule will not be validated.",
+        "   ** Severe  ** WaterHeater:HeatPump:PumpedCondenser=\"ZONE4HEATPUMPWATERHEATER\":",
+        "   **   ~~~   ** When Inlet Air Configuration=\"OUTDOORAIRONLY\".",
+        "   **   ~~~   ** Outdoor Air Node Name and Exhaust Air Node Name must be specified.",
+        "   ** Severe  ** WaterHeater:HeatPump:PumpedCondenser=\"ZONE4HEATPUMPWATERHEATER\":",
+        "   **   ~~~   ** Heat pump water heater fan outlet node name does not match next connected component.",
+        "   **   ~~~   ** Fan outlet node name = ZONE4AIRINLETNODE",
+        "   **  Fatal  ** GetWaterThermalTankInput: Errors found in processing Water Thermal Tank input.",
+        "   ...Summary of Errors that led to program termination:",
+        "   ..... Reference severe error count=2",
+        "   ..... Last severe error=WaterHeater:HeatPump:PumpedCondenser=\"ZONE4HEATPUMPWATERHEATER\":",
+    });


HPWHOutdoorAirMissingNodeNameWarning: change to capture the FatalError

This is fine, although in the future if you want to just match some small portion of it and not worry about the ERR formatting, you can use compare_err_stream_substring... :)

jmarrec · 2025-08-26T09:12:38Z

tst/EnergyPlus/unit/WaterThermalTanks.unit.cc

+        "  OutdoorAirOnly,          !- Inlet Air Configuration",
+        "  ,                        !- Air Inlet Node Name",
+        "  ,                        !- Air Outlet Node Name",
+        "  HPWHPumped Air Inlet Node, !- Outdoor Air Node Name",
+        "  HPWHPumped Air Outlet Node,!- Exhaust Air Node Name",


HPWH_Both_Pumped_and_Wrapped_InputProcessing: change to Outdoors so it doesn't fatal due to missing zone

Initial err stream

+ ** Severe ** WaterHeater:HeatPump:PumpedCondenser=\"HPWHPUMPED\", not found + ** ~~~ ** Inlet Air Zone Name=\"ZONE1\". + ** Severe ** WaterHeater:HeatPump:WrappedCondenser=\"HPWHWRAPPED\", not found + ** ~~~ ** Inlet Air Zone Name=\"ZONE1\". + ** Severe ** WaterHeater:Mixed = HPWHPUMPED MIXED TANK: Ambient Temperature Zone not found = ZONE1 + ** Severe ** WaterHeater:Stratified = HPWHWRAPPED STRATIFIED TANK: Ambient Temperature Zone not found = ZONE1 + ** Severe ** WaterHeater:HeatPump:PumpedCondenser = HPWHPUMPED: + ** ~~~ ** ZoneHVAC:EquipmentList and ZoneHVAC:EquipmentConnections objects are required when Inlet Air Configuration is either ZoneAirOnly or ZoneAndOutdoorAir. + ** Severe ** WaterHeater:HeatPump:WrappedCondenser = HPWHWRAPPED: + ** ~~~ ** ZoneHVAC:EquipmentList and ZoneHVAC:EquipmentConnections objects are required when Inlet Air Configuration is either ZoneAirOnly or ZoneAndOutdoorAir. + ** Fatal ** GetWaterThermalTankInput: Errors found in processing Water Thermal Tank input

src/EnergyPlus/WaterThermalTanks.cc

rraustad

Good to go.

Myoldmopar

Nice.

Myoldmopar · 2025-09-04T00:40:16Z

tst/EnergyPlus/unit/WaterThermalTanks.unit.cc

    state->dataEnvrn->StdRhoAir = 1.0;

-    ASSERT_FALSE(WaterThermalTanks::GetWaterThermalTankInput(*state));
+    WaterThermalTanks::GetWaterThermalTankInput(*state);


Yep, let it fail if it's gonna fail.

Myoldmopar · 2025-09-04T00:41:16Z

tst/EnergyPlus/unit/WaterThermalTanks.unit.cc

+    EXPECT_THROW(WaterThermalTanks::GetWaterThermalTankInput(*state), EnergyPlus::FatalError);

-    std::string const error_string =
-        delimited_string({"   ** Warning ** ProcessScheduleInput: Schedule:Constant = DUMMYSCH",
-                          "   **   ~~~   ** Schedule Type Limits Name is empty.",
-                          "   **   ~~~   ** Schedule will not be validated.",
-                          "   ** Severe  ** WaterHeater:HeatPump:PumpedCondenser=\"ZONE4HEATPUMPWATERHEATER\":",
-                          "   **   ~~~   ** When Inlet Air Configuration=\"OUTDOORAIRONLY\".",
-                          "   **   ~~~   ** Outdoor Air Node Name and Exhaust Air Node Name must be specified.",
-                          "   ** Severe  ** WaterHeater:HeatPump:PumpedCondenser=\"ZONE4HEATPUMPWATERHEATER\":",
-                          "   **   ~~~   ** Heat pump water heater fan outlet node name does not match next connected component.",
-                          "   **   ~~~   ** Fan outlet node name = ZONE4AIRINLETNODE"});
+    std::string const error_string = delimited_string({
+        "   ** Warning ** ProcessScheduleInput: Schedule:Constant = DUMMYSCH",
+        "   **   ~~~   ** Schedule Type Limits Name is empty.",
+        "   **   ~~~   ** Schedule will not be validated.",
+        "   ** Severe  ** WaterHeater:HeatPump:PumpedCondenser=\"ZONE4HEATPUMPWATERHEATER\":",
+        "   **   ~~~   ** When Inlet Air Configuration=\"OUTDOORAIRONLY\".",
+        "   **   ~~~   ** Outdoor Air Node Name and Exhaust Air Node Name must be specified.",
+        "   ** Severe  ** WaterHeater:HeatPump:PumpedCondenser=\"ZONE4HEATPUMPWATERHEATER\":",
+        "   **   ~~~   ** Heat pump water heater fan outlet node name does not match next connected component.",
+        "   **   ~~~   ** Fan outlet node name = ZONE4AIRINLETNODE",
+        "   **  Fatal  ** GetWaterThermalTankInput: Errors found in processing Water Thermal Tank input.",
+        "   ...Summary of Errors that led to program termination:",
+        "   ..... Reference severe error count=2",
+        "   ..... Last severe error=WaterHeater:HeatPump:PumpedCondenser=\"ZONE4HEATPUMPWATERHEATER\":",
+    });


This is fine, although in the future if you want to just match some small portion of it and not worry about the ERR formatting, you can use compare_err_stream_substring... :)

Myoldmopar · 2025-09-04T00:46:06Z

All happy here with develop pulled in. Thanks @jmarrec

jmarrec added 5 commits August 26, 2025 10:42

Fix #11156 - Throw a FatalError if ErrorsFound if GetWaterThermalTank…

c3bb292

…Input

Simple test adjusts: rely on gtest capturing the segfault if any.

42b3da5

HPWSizing: missing call to GetZoneEquipmentData

93e90c4

HPWHOutdoorAirMissingNodeNameWarning: change to capture fatalerror

df34056

jmarrec requested a review from Myoldmopar August 26, 2025 09:09

jmarrec self-assigned this Aug 26, 2025

jmarrec added Defect Includes code to repair a defect in EnergyPlus NotIDDChange Code does not impact IDD (can be merged after IO freeze) labels Aug 26, 2025

jmarrec commented Aug 26, 2025

View reviewed changes

jmarrec commented Aug 27, 2025

View reviewed changes

src/EnergyPlus/WaterThermalTanks.cc Outdated Show resolved Hide resolved

jmarrec added 2 commits August 27, 2025 12:25

Remove useless format

4c50a6b

Remove a useless asssert in test

2699418

rraustad approved these changes Aug 27, 2025

View reviewed changes

Myoldmopar approved these changes Sep 4, 2025

View reviewed changes

Myoldmopar merged commit 58430fc into develop Sep 4, 2025
9 checks passed

Myoldmopar deleted the 11156_GetWaterThermalTankInput_ErrorsFound branch September 4, 2025 00:46

		DataZoneEquipment::GetZoneEquipmentData(*state);
		ASSERT_FALSE(ErrorsFound);

	if ((HPWH.InletAirConfiguration == WTTAmbientTemp::TempZone \|\| HPWH.InletAirConfiguration == WTTAmbientTemp::ZoneAndOA) &&
	HPWH.AmbientTempZone > 0) {
	if (allocated(state.dataZoneEquip->ZoneEquipConfig)) {

Fix #11156 - WaterThermalTanks's GetWaterThermalTankInput should trap ErrorsFound and throw a FatalError #11172

Fix #11156 - WaterThermalTanks's GetWaterThermalTankInput should trap ErrorsFound and throw a FatalError #11172

Uh oh!

Conversation

jmarrec commented Aug 26, 2025 • edited by rraustad Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull request overview

Description of the purpose of this PR

Pull Request Author

Reviewer

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!

rraustad left a comment

Choose a reason for hiding this comment

Uh oh!

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

Myoldmopar commented Sep 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

jmarrec commented Aug 26, 2025 •

edited by rraustad

Loading