Fix 8638 chiller condenser recurring warnings #9231

jcyuan2020 · 2022-01-10T19:10:46Z

Pull request overview

Fixes Use recurring error warnings for condenser related chiller (severe) warnings #8638: Address a follow-up issue for chillerheater condenser error messages by using recurring error reporting for ChillerHeater:Absorption:DoubleEffect and ChillerHeater:Absorption:DirectFired.
Also Fixes Clarify how the Deadband Temperature Difference in Water Heaters model is used dependent on Source Side Flow Control Mode #9230: Added documentation clarification for water heater deadband temperature difference's dependency on Source Side Flow Control mode when a source side is connected.

NOTE: ENHANCEMENTS MUST FOLLOW A SUBMISSION PROCESS INCLUDING A FEATURE PROPOSAL AND DESIGN DOCUMENT PRIOR TO SUBMITTING CODE

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

Reviewer

This will not be exhaustively relevant to every PR.

nrel-bot-2 · 2022-02-08T00:20:26Z

@jcyuan2020 @Myoldmopar it has been 28 days since this pull request was last updated.

…r exhaust fired absorption chillerheater.

…s well.

…ication.

…_Condenser_Recurring_Warnings

jmythms · 2022-03-15T17:47:31Z

Starting review.

jmythms · 2022-03-15T17:49:06Z

src/EnergyPlus/ChillerExhaustAbsorption.cc

+                                              // Optional<Real64 const> ReportMaxOf, // Track and report the max of the values passed to this argument
+                                              // Optional<Real64 const> ReportMinOf, // Track and report the min of the values passed to this argument
+                                              // Optional<Real64 const> ReportSumOf, // Track and report the sum of the values passed to this argument
+                                              // std::string const &ReportMaxUnits,  // optional char string (<=15 length) of units for max value
+                                              // std::string const &ReportMinUnits,  // optional char string (<=15 length) of units for min value
+                                              // std::string const &ReportSumUnits   // optional char string (<=15 length) of units for sum value


Is this code for debugging?

These lines were used in the initial experiment; they are now removed.

jmythms · 2022-03-15T17:54:57Z

src/EnergyPlus/ChillerGasAbsorption.cc

+                if (this->lCondWaterMassFlowRate_Index == 0) {
+                    ShowSevereError(state, "CalcGasAbsorberChillerModel: Condenser flow = 0, for Gas Absorber Chiller=" + this->Name);
+                    ShowContinueErrorTimeStamp(state, "");
+                    // ShowFatalError(state, "Program Terminates due to previous error condition.");


I think this ShowFatalError(state, "Program Terminates... line can be deleted safely now, right?

True. I think it was left as a comment from previous change somehow deliberately, considering that there are a few places in the code (also spotted in a couple places in the older code) that the developers massaged a little bit on whether to call the fatal error. So I would probably leave it as is, or a "special" note here.

Got it. 👍🏽

jmythms · 2022-03-15T18:19:35Z

src/EnergyPlus/ChillerExhaustAbsorption.cc

+                                                  ": Condenser flow rate = 0 sever error warning continues...", // Message automatically written to
+                                                                                                                // "error file" at end of simulation


sever - typo. Also consider using format():

ShowRecurringSevereErrorAtEnd(state, format("CalcExhaustAbsorberChillerModel: Condenser flow = 0, for Exhaust Absorber Chiller={}: " "Condenser flow rate = 0 severe error warning continues... {}", this->Name, this->lCondWaterMassFlowRate_Index));

Thanks! This has now been corrected and the "format" style is used.

Awesome 👍🏽

jmythms · 2022-03-15T18:24:06Z

tst/EnergyPlus/unit/ChillerExhaustAbsorption.unit.cc

+    EXPECT_EQ(state->dataErrTracking->LastSevereError,
+              "CalcExhaustAbsorberChillerModel: Condenser flow = 0, for Exhaust Absorber Chiller=EXH CHILLER");


This line passes with the current develop branch code, was that the expected behavior?

Yes, it is part of the expected behavior (and also required) for testing these error messages. I am also considering adding one check for "at end" part that you suggested.

jmythms · 2022-03-15T18:27:45Z

src/EnergyPlus/ChillerGasAbsorption.cc

+                                                  ": Condenser flow rate = 0 sever error warning continues...", // Message automatically written to
+                                                                                                                // "error file" at end of simulation


"sever" typo here as well.

Thanks--this has now been corrected as well.

jmythms · 2022-03-15T18:51:29Z

doc/input-output-reference/src/overview/group-water-heaters.tex

+The delta temperature difference {[}$\Delta{^\circ}C${]} between the setpoint and the ``cut-in'' temperature at which the heater will turn on. In other words, the ``cut-in'' temperature is Setpoint -- Deadband.
+
+One note here is that if a source side connection exists, how this \emph{Deadband Temperature Difference} is used is dependent on the ``\emph{Source Side Flow Control Mode}''{[}\ref{field-source-side-flow-control-mode}{]} choice. If \emph{Source Side Flow Control Mode} is \emph{IndirectHeatPrimarySetpoint} or
+\emph{IndirectHeatAlternateSetpoint}, the targedted ``cut-in'' temperature is the related Setpoint -- Deadband as described above. However, when the \emph{Source Side Flow Control Mode} setting is \emph{StorageTank}, the deadband is not used in getting the ``cut-in'' temperature---so in this case it is just directly using the correponding Setpoint temperature without subtracting off the Deadband Temperature Difference.


targeted, corresponding - typos.

Corrected now.

jmythms · 2022-03-15T18:52:18Z

doc/input-output-reference/src/overview/group-water-heaters.tex

+The delta temperature difference {[}$\Delta{^\circ}C${]} between the set point and the ``cut-in'' temperature at which Heater 2 will turn on. In other words, the ``cut-in'' temperature is Set Point -- Deadband.
+
+One note here is that if a source side connection exists, how this \emph{Deadband Temperature Difference} is used is dependent on the ``\emph{Source Side Flow Control Mode}''{[}\ref{field-source-side-flow-control-mode}{]} choice. If \emph{Source Side Flow Control Mode} is \emph{IndirectHeatPrimarySetpoint} or
+\emph{IndirectHeatAlternateSetpoint}, the targedted ``cut-in'' temperature is the related Setpoint -- Deadband as described above. However, when the \emph{Source Side Flow Control Mode} setting is \emph{StorageTank}, the deadband is not used in getting the ``cut-in'' temperature---so in this case it is just directly using the correponding Setpoint temperature without subtracting off the Deadband Temperature Difference.


targeted, corresponding - typos.

Thanks--corrected now with a couple of additional minor changes.

I've rebuilt the docs locally. Looks good! Nice catch with correcting the reference. 👍🏽

jmythms · 2022-03-15T19:04:23Z

tst/EnergyPlus/unit/ChillerExhaustAbsorption.unit.cc

+    EXPECT_EQ(state->dataErrTracking->TotalSevereErrors, 3);
+    EXPECT_EQ(state->dataErrTracking->LastSevereError,
+              "CalcExhaustAbsorberChillerModel: Condenser flow = 0, for Exhaust Absorber Chiller=EXH CHILLER");
+
+    thisChillerHeater.calcChiller(*state, loadinput);
+    EXPECT_EQ(state->dataErrTracking->TotalSevereErrors, 5);
+    EXPECT_EQ(state->dataErrTracking->LastSevereError,
+              "SetComponentFlowRate: trapped plant loop index = 0, check component with inlet node named=EXH CHILLER CONDENSER INLET NODE");


Also, the tests pass when the ChillerGasAbsorption files are same as develop, should we add a test for ChillerGasAbsorption as well?

I would probably save a repeated unit test on that if possible, considering these two types of chillerheaters follow similar (or actually the same) error reporting logic regarding the condenser flows.

Got it 👍🏽

jmythms · 2022-03-15T19:05:08Z

tst/EnergyPlus/unit/ChillerExhaustAbsorption.unit.cc

+    auto &thisChillerHeater = state->dataChillerExhaustAbsorption->ExhaustAbsorber(1);
+
+    Real64 loadinput = -5000.0;
+    bool runflaginput = true;


This runflaginput variable is unused.

Thanks--will deal with while trying adding the "at end" error message check in unit test.

jmythms · 2022-03-15T19:23:08Z

Verified building documentation.

jmythms · 2022-03-15T20:00:13Z

src/EnergyPlus/ChillerExhaustAbsorption.cc

+                ShowRecurringSevereErrorAtEnd(state,
+                                              "CalcExhaustAbsorberChillerModel: Condenser flow = 0, for Exhaust Absorber Chiller=" + this->Name +
+                                                  ": Condenser flow rate = 0 sever error warning continues...", // Message automatically written to
+                                                                                                                // "error file" at end of simulation


Also, I think it would be good if the unit test could test this ShowRecurringSevereErrorAtEnd, since that was the main point mentioned in issue 8638.

Agree--I will try adding a check on this.

…_Condenser_Recurring_Warnings

…t updates.

…bout the unit test.

jmythms · 2022-03-17T00:57:18Z

Thank you for the corrections. I am happy with it when this ShowRecurringSevereErrorAtEnd error test has been added. 👍🏽

jcyuan2020 · 2022-03-17T07:49:48Z

Thank you for the corrections. I am happy with it when this ShowRecurringSevereErrorAtEnd error test has been added. 👍🏽

Thanks--the ShowRecurringSevereErrorAtEnd() results are actually checked in the last update. This "show at end" function actually just stores the sorted error message contents and counts in an array without actually printing out for now. The storage contents for this recurring condenser flow rate one are checked via the following lines in this commit and the outcomes are expected:


    EXPECT_EQ(state->dataErrTracking->RecurringErrors(1).Count, 1);
    EXPECT_EQ(state->dataErrTracking->RecurringErrors(1).Message,
              " ** Severe  ** CalcExhaustAbsorberChillerModel: Condenser flow = 0, for Exhaust Absorber Chiller=EXH CHILLER: Condenser flow rate = 0 "
              "severe error warning continues...");

and

    EXPECT_EQ(state->dataErrTracking->RecurringErrors(1).Count, 2);
    EXPECT_EQ(state->dataErrTracking->RecurringErrors(1).Message,
              " ** Severe  ** CalcExhaustAbsorberChillerModel: Condenser flow = 0, for Exhaust Absorber Chiller=EXH CHILLER: Condenser flow rate = 0 "
              "severe error warning continues...");

jmythms · 2022-03-17T15:05:43Z

Thank you for explaining and for all the changes. This looks good from my end.

…_Condenser_Recurring_Warnings

mjwitte

Tested with some example files. The recurring errors work as advertised.

…hiller_Condenser_Recurring_Warnings

jcyuan2020 added Defect Includes code to repair a defect in EnergyPlus Documentation Related primarily on the LaTeX-based EnergyPlus documentation labels Jan 10, 2022

mjwitte added this to the EnergyPlus 22.1 milestone Feb 8, 2022

jcyuan2020 added 5 commits March 2, 2022 10:40

Change to recurring condenser flow rate low severe warning message fo…

e554297

…r exhaust fired absorption chillerheater.

Add recurring severe error message for gas absorption chillerheater a…

5a400dc

…s well.

Water tank mixed Deadband Temperature Difference documentation clarif…

b60d565

…ication.

Water heater stratified documentation clarification as well.

5ba563c

Add unit test for recurring warning messages.

f320baa

jcyuan2020 force-pushed the fix-8638_Chiller_Condenser_Recurring_Warnings branch from e18d5dd to f320baa Compare March 2, 2022 18:18

CLang formatting.

e4743f9

jcyuan2020 marked this pull request as ready for review March 2, 2022 18:29

Merge remote-tracking branch 'upstream/develop' into fix-8638_Chiller…

163b21f

…_Condenser_Recurring_Warnings

jmythms reviewed Mar 15, 2022

View reviewed changes

jcyuan2020 added 4 commits March 16, 2022 01:45

Merge remote-tracking branch 'upstream/develop' into fix-8638_Chiller…

e18651d

…_Condenser_Recurring_Warnings

Address comments for chillerheater condenser code.

3de5110

Address review comments water heater deadband temperature TeX documen…

8424689

…t updates.

Add AtEnd recurring error message check and address review comments a…

c727c5e

…bout the unit test.

Merge remote-tracking branch 'upstream/develop' into fix-8638_Chiller…

5ac42d0

…_Condenser_Recurring_Warnings

mjwitte approved these changes Mar 17, 2022

View reviewed changes

Merge remote-tracking branch 'remotes/origin/develop' into fix-8638_C…

a78eaeb

…hiller_Condenser_Recurring_Warnings

mjwitte merged commit bb4a584 into NREL:develop Mar 18, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix 8638 chiller condenser recurring warnings #9231

Fix 8638 chiller condenser recurring warnings #9231

jcyuan2020 commented Jan 10, 2022 •

edited by mjwitte

Loading

nrel-bot-2 commented Feb 8, 2022

jmythms commented Mar 15, 2022

jmythms Mar 15, 2022

jcyuan2020 Mar 16, 2022

jmythms Mar 16, 2022

jmythms Mar 15, 2022 •

edited

Loading

jcyuan2020 Mar 16, 2022

jmythms Mar 16, 2022

jmythms Mar 15, 2022

jcyuan2020 Mar 16, 2022

jmythms Mar 16, 2022

jmythms Mar 15, 2022

jcyuan2020 Mar 16, 2022

jmythms Mar 15, 2022

jcyuan2020 Mar 16, 2022

jmythms Mar 16, 2022

jmythms Mar 15, 2022

jcyuan2020 Mar 16, 2022

jmythms Mar 16, 2022

jmythms Mar 15, 2022

jcyuan2020 Mar 16, 2022

jmythms Mar 17, 2022

jmythms Mar 15, 2022 •

edited

Loading

jcyuan2020 Mar 16, 2022

jmythms Mar 17, 2022

jmythms Mar 15, 2022 •

edited

Loading

jcyuan2020 Mar 16, 2022

jmythms commented Mar 15, 2022

jmythms Mar 15, 2022

jcyuan2020 Mar 16, 2022

jmythms commented Mar 17, 2022

jcyuan2020 commented Mar 17, 2022

jmythms commented Mar 17, 2022

mjwitte left a comment

		": Condenser flow rate = 0 sever error warning continues...", // Message automatically written to
		// "error file" at end of simulation

		EXPECT_EQ(state->dataErrTracking->LastSevereError,
		"CalcExhaustAbsorberChillerModel: Condenser flow = 0, for Exhaust Absorber Chiller=EXH CHILLER");

Fix 8638 chiller condenser recurring warnings #9231

Fix 8638 chiller condenser recurring warnings #9231

Conversation

jcyuan2020 commented Jan 10, 2022 • edited by mjwitte Loading

Pull request overview

Pull Request Author

Reviewer

nrel-bot-2 commented Feb 8, 2022

jmythms commented Mar 15, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmythms Mar 15, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmythms Mar 15, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmythms Mar 15, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmythms commented Mar 15, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmythms commented Mar 17, 2022

jcyuan2020 commented Mar 17, 2022

jmythms commented Mar 17, 2022

mjwitte left a comment

Choose a reason for hiding this comment

jcyuan2020 commented Jan 10, 2022 •

edited by mjwitte

Loading

jmythms Mar 15, 2022 •

edited

Loading

jmythms Mar 15, 2022 •

edited

Loading

jmythms Mar 15, 2022 •

edited

Loading