Enhancement of Handling of Rainfall #9177

yujiex · 2021-11-08T21:30:07Z

Pull request overview

The Site:Precipitation values are used in two places in EnergyPlus, namely the rain collector and the roof irrigation. The rain collector, modeled by WaterUse:RainCollector object, is used for harvesting rainwater falling on building surfaces. The rainwater is then sent to a WaterUse:Storage object. Currently, the use of the rain collector object requires the inclusion of a Site:Precipitation object to describe the rates of rainfall. In the green roof module, the soil energy heat released or gained is calculated based on the phase changes of soil water, precipitation heat flux, and heat flux due to vertical transport of water in the soil are ignored. The precipitation value is added to the surface soil moisture variable if a Site:Precipitation schedule exists. In particular, the green roof run-off rate is calculated based on the irrigation rate on top of the precipitation rate.

As local weather stations are providing hourly precipitation for the past decades and the values are being updated in TMY3 data, we propose to modify the logic of using rainfall/liquid precipitation to use the EPW file hourly precipitation data for rain harvesting and green roof when no Site:Precipitation schedule exists. In EPW files, the field of “Liquid Precipitation Depth” holds the amount of liquid precipitation (mm) observed at the indicated time for the period indicated in the liquid precipitation quantity field. Used in EnergyPlus simulation, if this value is not missing, it is used and overrides the “precipitation” flag as rainfall. Conversely, if the precipitation flag shows rain and this field is missing or zero, it is set to 1.5 (mm).

The memo of the WaterUse:RainCollector will be modified to reflect changes in the requirement of a Site:Precipitation schedule.

This feature also fixed a lagging issue of the surface soil moisture calculation, where precipitation value is updated after it is used in moisture calculation. As a result, the moisture calculation uses leftover precipitation from the previous timestep. This feature fixed this issue by moving the precipitation update to WeatherManager, which is executed before the surface soil moisture adds in the precipitation term.

Addresses #4714

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.

- Output:Table:SummaryReports:ReportPeriod -> OutputControl:Table:ReportPeriod - Added a note of the reporting period below tabular tables.

…igin/develop' into enhanceRainfallHandling

yujiex · 2021-11-08T21:41:45Z

Hello @JasonGlazer @Myoldmopar @mjwitte, would you be available to review this rainfall handling PR and provide some feedback? Thanks :)

JasonGlazer · 2021-11-10T12:40:35Z

design/FY2022/enhancement_to_rainfall_handling.md

+## Approach ##
+
+When a *WaterUse:RainCollector* or a RoofIrrigation object is defined without a *Site:Precipitation* object presented, we will use the hourly precipitation value defined in the EPW file instead. When every entry of the liquid precipitation depth is missing in the 8760 hourly period, we will throw a warning and use the precipitation flag to estimate the precipitation quantity (as 1.5mm).
+


I believe many EPW files are from sources where the rain amount is poorly estimated or unknown so I think there should be some protection for users in this case. I would suggest when no Site:precipitation object is present, but WaterUse:RainCollector or RoofIrrigation or ecoroof objects are present, a warning message should be added. The warning message should provide the annual total precipitation that is shown in the EPW file. It would be even better if some guidance was provided in the warning message if this value in the EPW file is reasonable or not. Perhaps normal ranges based on the climate zone or climate type based on the stat file could provide guidance (although this is also often missing) or some other factor from the EPW file could indicate how wet that climate typically is.

Good point. A warning message could be added to indicate the fact that the weather file will be used in RainCollector or RoofIrrigation calculation instead of Site:precipitation. Other warnings could also be included to flag out-of-normal-range rainfall data in the weather file.

Hi @JasonGlazer, I added some descriptions in the approach section about the warning messages when EPW is used in RainCollection or Roof Irrigation calculation and when EPW precipitation data is out of range. The "out of range" is defined as the EPW hourly precipitation value being larger than the state recorded highest 24-hour precipitation, according to this table. I haven't found the hourly extreme yet, so I was considering using this 24-hour one as an initial upper bound. I'll see if I can find the hourly extreme record per state or climate zone and replace this upper bound later.

Hi @JasonGlazer, just to confirm. Is it better to throw a warning when using epw in RainCollection or RoofIrrigation calculation, as well as provide a link of this table in the documentation so that users can check the epw precipitation range before feeding it into the simulation? Or should I also include this table in the code and check the rainfall data range according to this table in EnergyPlus? I'm leaning towards the former as there might need some continuous effort in the future to maintain this table up-to-date. Any thoughts?

mjwitte · 2021-11-18T20:12:06Z

I would suggest that annual precipitation be reported in the "Climatic Data Summary" table output. The values could come from the weather.stat file, but it may be better to accumulate a total based on the actual weather data used (including any missing values that are assumed to be 1.5mm). I suppose you could go one step further and report hours of rainfall or make a monthly table, and if a Site:Precipitation object is present, the same statistics could be reported for that instead of from the weather file? Just brainstorming here, but basically suggesting some reporting of precipitation amount would be very useful.

yujiex · 2021-12-06T22:48:15Z

I would suggest that annual precipitation be reported in the "Climatic Data Summary" table output. The values could come from the weather.stat file, but it may be better to accumulate a total based on the actual weather data used (including any missing values that are assumed to be 1.5mm). I suppose you could go one step further and report hours of rainfall or make a monthly table, and if a Site:Precipitation object is present, the same statistics could be reported for that instead of from the weather file? Just brainstorming here, but basically suggesting some reporting of precipitation amount would be very useful.

Thanks for the suggestion. Sorry for the late response. Indeed it will be nice to have some rainfall output so that we can see more clearly the rainfall used in the calculation. I'll add rainfall summary outputs to the "Climatic Data Summary" table.

yujiex · 2021-12-08T00:32:00Z

Note: the ERR diffs are intentional. They are the added warning messages when the .epw precipitation data is used in the rain collector or roof irrigation calculation.

mjwitte · 2022-02-17T19:09:12Z

For the second one, the rain flag is updated every timestep, maybe the warning should also be at the timestep level?

Sure, or maybe just make is a simple one-time warning and add "Further instances of this condition will not be reported."? We've done that with some others. If you like that approch, add a ShowContinueErrorTimeStamp to indicate the time of the warning.

yujiex · 2022-02-17T19:10:42Z

For the second one, the rain flag is updated every timestep, maybe the warning should also be at the timestep level?

Sure, or maybe just make is a simple one-time warning and add "Further instances of this condition will not be reported."? We've done that with some others. If you like that approch, add a ShowContinueErrorTimeStamp to indicate the time of the warning.

Thanks for the pointer. I'll check that out.

yujiex · 2022-02-17T19:17:36Z

For the second one, the rain flag is updated every timestep, maybe the warning should also be at the timestep level?

Sure, or maybe just make is a simple one-time warning and add "Further instances of this condition will not be reported."? We've done that with some others. If you like that approch, add a ShowContinueErrorTimeStamp to indicate the time of the warning.

Thanks for the pointer. I'll check that out.

On second thought, would users want to know how many times this type of overwritten happened? If there are a lot, maybe they want to look into the data?

mjwitte · 2022-02-17T20:35:43Z

src/EnergyPlus/DataWater.hh

@@ -317,6 +329,9 @@ struct DataWaterData : BaseGlobalStruct
    bool AnyWaterSystemsInModel = false;    // control flag set true if any water systems
    bool WaterSystemGetInputCalled = false; // set true once input data gotten.
    bool AnyIrrigationInModel = false;      // control flag set true if irrigation input for ecoroof DJS PSU Dec 2006
+    bool UsePrecipitation = false;          // whether to include the rain fall amount in the actual irrigation amount


This is not used now.

Right, I forgot to modify this header file

mjwitte · 2022-02-17T20:40:07Z

src/EnergyPlus/EcoRoofManager.cc

+        } else { // no schedule
+            if (state.dataWaterData->RainFall.ModeID == DataWater::RainfallMode::EPWPrecipitation) {
+                // irrigation is just the rain amount
+                state.dataEcoRoofMgr->CurrentIrrigation = state.dataEcoRoofMgr->CurrentPrecipitation; // units of m
+                state.dataWaterData->Irrigation.ActualAmount = state.dataEcoRoofMgr->CurrentIrrigation;
+            }


This should not be here. Precipitation is added above.

The irrigation never operates in EcoroofOrlando (Environment:Green Roof Cumulative Irrigation Depth m is always zero, in develop and in this branch). Let's not change that here, but we should do a followup PR to make this a better example file (with the same changes in EcoroofOrlando_NoSitePrec).

Right, I got confused earlier, CurrentIrrigation should not add precipitation.

mjwitte · 2022-02-17T20:43:04Z

src/EnergyPlus/WaterManager.cc

@@ -713,6 +724,14 @@ namespace WaterManager {

            } // NumIrrigation ==1

+            if (state.dataWaterData->RainFall.ModeID == DataWater::RainfallMode::EPWPrecipitation) {
+                ShowRecurringWarningErrorAtEnd(


ShowWarningError (not at end)

mjwitte · 2022-02-17T20:45:28Z

src/EnergyPlus/WeatherManager.cc

+                                state.dataWaterData->RainFall.CurrentRate,
+                                OutputProcessor::SOVTimeStepType::System,
+                                OutputProcessor::SOVStoreType::Average,
+                                "Site:Precipitation");


This should be "Environment" here and in the next one. Would you agree? Because these are now the actual environment values whether Site:Precipitation is used or not.

True. I will make them "Environment".

mjwitte

Almost there. Thanks for all of the changes and reversals.

Looking at 5ZoneWaterSystems, something seems amiss with Site Precipitation Depth. For example, on 01/03 hour 22, the values with develop are 0.0001616 but with this branch, it's 0.0003232. The sum over the year goes from 0.749 to 1.282. Since this file has Site:Precipitation, I would expect these to be unchanged.

mjwitte · 2022-02-17T21:34:32Z

doc/input-output-reference/src/overview/group-location-climate-weather-file-access.tex

@@ -1831,6 +1847,13 @@ \subsubsection{Inputs}\label{inputs-23-002}

 Name of a schedule defined elsewhere that describes the rate of irrigation. The values in this schedule are the average rate of irrigation in meters per hour.

+\paragraph{Field: Use Precipitation}\label{field-use-precipitation}


This needs to be deleted.

Thanks for spotting this, I just deleted the "Use Precipitation" related documentation.

yujiex · 2022-02-18T00:28:54Z

I'll look

I add the following output variable in idf and compared the eplusout.csv

Output:Variable,*,Site Precipitation Depth,hourly;
The following is what I see (the second column is the develop branch, the third column is this feature branch). Strangely develop branch shows zero for 01/03 all day. I'll try to do a fresh clone and redo the comparison.

From the idf, the site:precipitation schedule value should be like this, which is not the case for the feature branch. I'll debug this part as well.

    Through: 1/3,            !- Field 11
    For: AllDays,            !- Field 12
    Until: 3:00,0.000696148, !- Field 13
    Until: 11:00,0,          !- Field 15
    Until: 13:00,0.000696148,!- Field 17
    Until: 15:00,0,          !- Field 19
    Until: 16:00,0.000696148,!- Field 21
    Until: 21:00,0,          !- Field 23
    Until: 22:00,0.000696148,!- Field 25
    Until: 24:00,0,          !- Field 27

…dling

mjwitte · 2022-02-18T19:36:01Z

src/EnergyPlus/WeatherManager.cc

@@ -2292,6 +2309,27 @@ namespace WeatherManager {
        if (state.dataEnvrn->EMSBeamSolarRadOverrideOn) state.dataEnvrn->BeamSolarRad = state.dataEnvrn->EMSBeamSolarRadOverrideValue;
        state.dataEnvrn->LiquidPrecipitation =
            state.dataWeatherManager->TodayLiquidPrecip(state.dataGlobal->TimeStep, state.dataGlobal->HourOfDay) / 1000.0; // convert from mm to m
+        if (state.dataEnvrn->RunPeriodEnvironment) {


I wonder if this line should include && !Warmup ?

I'll add it in the && !Warmup. This part is used in reporting the precipitation-related quantities during the actual simulation period in the HTML tabular report. It should not include the warmup period.

mjwitte

Confirmed that Precipitation Depth values are as expected now in 5ZoneWaterSystems. Will wait for CI to report back in bright green, then merge.

yujiex · 2022-02-18T22:00:18Z

Confirmed that Precipitation Depth values are as expected now in 5ZoneWaterSystems. Will wait for CI to report back in bright green, then merge.

Fingers crossed

yujiex · 2022-02-19T00:57:40Z

The current diffs in 5ZoneWaterSystems.idf seems to be from the change in the idf file in this branch 5ZoneWaterSystems.idf.

yujiex · 2022-02-19T04:07:19Z

The math and table diffs in EcoroofOrlando is due to the lagging issue in the develop branch.
I tried adding the following to mimic the lagging behavior, then the diffs are gone.

mjwitte · 2022-02-19T16:43:34Z

Not sure why the CI comments for 1a3478f are not showing here, but they're all good. Merging.

yujiex · 2022-02-21T01:03:12Z

Not sure why the CI comments for 1a3478f are not showing here, but they're all good. Merging.

Thanks, @mjwitte :) Glad it all run through well. Thanks for all the help and guidance

yujiex added 6 commits October 28, 2021 13:06

Draft of enhancement to resilience metrics NFP

43c6d86

Resolve image link and reference new line

42d898f

Change output obj name, add report period in table footnote

3ceeb67

- Output:Table:SummaryReports:ReportPeriod -> OutputControl:Table:ReportPeriod - Added a note of the reporting period below tabular tables.

Add begin and end year fields in *:ReportPeriod

e702d98

First draft NFP: enhancement to rainfall handling

b159e0a

Get updates from the develop branch. Merge remote-tracking branch 'or…

79758d8

…igin/develop' into enhanceRainfallHandling

yujiex added NewFeature Includes code to add a new feature to EnergyPlus IDDChange Code changes impact the IDD file (cannot be merged after IO freeze) labels Nov 8, 2021

yujiex requested a review from JasonGlazer November 8, 2021 22:10

yujiex assigned yujiex and xuanluo113 Nov 8, 2021

yujiex added this to the EnergyPlus 2022.1 milestone Nov 8, 2021

xuanluo113 linked an issue Nov 8, 2021 that may be closed by this pull request

Rainfall is handled differently between weather file values and Site:Precipitation water manager values. (CR #9382) #4153

Closed

yujiex removed a link to an issue Nov 8, 2021

Rainfall is handled differently between weather file values and Site:Precipitation water manager values. (CR #9382) #4153

Closed

yujiex linked an issue Nov 8, 2021 that may be closed by this pull request

Rainfall is handled differently between weather file values and Site:Precipitation water manager values. (CR #9382) #4153

Closed

xuanluo113 linked an issue Nov 8, 2021 that may be closed by this pull request

Rainfall in EnergyPlus #4714

Closed

JasonGlazer reviewed Nov 10, 2021

View reviewed changes

Add warming message for EPW precipitation used in calc.

1ba1e6e

yujiex added 4 commits December 1, 2021 12:20

Overwrite RainFall.CurrentRate when no site:prec but >0 epw rain

0fb47ea

Use epw precip when site:prec not exist in roofIrrigation

a4b5edf

Unit test water collector with epw rain

86aed02

Added warning msg, check for rain flag

8b9657a

yujiex added 2 commits December 7, 2021 16:03

Correct unit of measure of default rain depth to meter

d8f191c

Unit test for roof irrigation

d26b058

yujiex added 2 commits December 7, 2021 17:02

clang-format

df2ce36

NFP md update description of warning msg and precipitation reporting

7eaeb0d

Remove "Use Precipitation" in RoofIrrigation

046ed1f

clang-format

208339d

mjwitte reviewed Feb 17, 2022

View reviewed changes

yujiex added 4 commits February 17, 2022 13:15

Change recuring warning to warning

3d418dd

Change curRate & curAmount output to "Environment"

87db0eb

CurrentIrrigation should not add in precipitation

9828ac3

clang-format

fd3b26d

mjwitte reviewed Feb 17, 2022

View reviewed changes

Remove "Use Precipitation" related doc

f013e09

yujiex added 3 commits February 18, 2022 10:10

Site Prec Rate,depth SetOutputVar time res changed to zone

613be65

clang-format

9224f2b

Merge remote-tracking branch 'origin/develop' into enhanceRainfallHan…

c05b851

…dling

mjwitte reviewed Feb 18, 2022

View reviewed changes

Use runperiodEnvrn and !Warmup for prec monthly table quantities

95d70ae

mjwitte mentioned this pull request Feb 18, 2022

Material:RoofVegetation output Green Roof Cumulative Precipitation Depth is suspect #9282

Closed

3 tasks

Add init to TimeStepZoneSec in unit test

1a3478f

mjwitte approved these changes Feb 18, 2022

View reviewed changes

mjwitte merged commit d48b30c into develop Feb 19, 2022

mjwitte deleted the enhanceRainfallHandling branch February 19, 2022 16:43

mjwitte mentioned this pull request Feb 21, 2022

Rainfall is handled differently between weather file values and Site:Precipitation water manager values. (CR #9382) #4153

Closed

yujiex mentioned this pull request Feb 22, 2022

Fix Rainfall is handled differently between weather file values and Site:Precipitation water manager values #4153 #9290

Merged

20 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhancement of Handling of Rainfall #9177

Enhancement of Handling of Rainfall #9177

yujiex commented Nov 8, 2021 •

edited by mjwitte

Loading

yujiex commented Nov 8, 2021

JasonGlazer Nov 10, 2021 •

edited

Loading

yujiex Nov 10, 2021

yujiex Nov 11, 2021

yujiex Nov 12, 2021

mjwitte commented Nov 18, 2021

yujiex commented Dec 6, 2021

yujiex commented Dec 8, 2021

mjwitte commented Feb 17, 2022

yujiex commented Feb 17, 2022

yujiex commented Feb 17, 2022

mjwitte Feb 17, 2022

yujiex Feb 17, 2022

mjwitte Feb 17, 2022

mjwitte Feb 17, 2022

yujiex Feb 17, 2022

mjwitte Feb 17, 2022

mjwitte Feb 17, 2022

yujiex Feb 17, 2022

mjwitte left a comment

mjwitte Feb 17, 2022

yujiex Feb 17, 2022

yujiex commented Feb 18, 2022

mjwitte Feb 18, 2022

yujiex Feb 18, 2022

mjwitte left a comment

yujiex commented Feb 18, 2022

yujiex commented Feb 19, 2022

yujiex commented Feb 19, 2022

mjwitte commented Feb 19, 2022

yujiex commented Feb 21, 2022

		## Approach ##

		When a WaterUse:RainCollector or a RoofIrrigation object is defined without a Site:Precipitation object presented, we will use the hourly precipitation value defined in the EPW file instead. When every entry of the liquid precipitation depth is missing in the 8760 hourly period, we will throw a warning and use the precipitation flag to estimate the precipitation quantity (as 1.5mm).

		@@ -1831,6 +1847,13 @@ \subsubsection{Inputs}\label{inputs-23-002}

		Name of a schedule defined elsewhere that describes the rate of irrigation. The values in this schedule are the average rate of irrigation in meters per hour.

		\paragraph{Field: Use Precipitation}\label{field-use-precipitation}

Enhancement of Handling of Rainfall #9177

Enhancement of Handling of Rainfall #9177

Conversation

yujiex commented Nov 8, 2021 • edited by mjwitte Loading

Pull request overview

Pull Request Author

Reviewer

yujiex commented Nov 8, 2021

JasonGlazer Nov 10, 2021 • 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

mjwitte commented Nov 18, 2021

yujiex commented Dec 6, 2021

yujiex commented Dec 8, 2021

mjwitte commented Feb 17, 2022

yujiex commented Feb 17, 2022

yujiex commented Feb 17, 2022

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

mjwitte left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yujiex commented Feb 18, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mjwitte left a comment

Choose a reason for hiding this comment

yujiex commented Feb 18, 2022

yujiex commented Feb 19, 2022

yujiex commented Feb 19, 2022

mjwitte commented Feb 19, 2022

yujiex commented Feb 21, 2022

yujiex commented Nov 8, 2021 •

edited by mjwitte

Loading

JasonGlazer Nov 10, 2021 •

edited

Loading