W3 Water management and flood inundation Design Document

Owned by Renata McCoy
Last updated: Jul 15, 2019 by Tian Zhou
4 min read

The Design Document page provides a description of the algorithms, implementation and planned testing including unit, verification, validation and performance testing. Please read  Step 1.3 Performance Expectations that explains feature documentation requirements from the performance group point of view. 

Design Document

 Click here for instructions to fill up the table below ......

The first table in Design Document gives overview of this document, from this info the Design Documents Overview page is automatically created.

In the overview table below 4.Equ means Equations and Algorithms, 5.Ver means Verification, 6.Perf - Performance, 7. Val - Validation

  • Equations: Document the equations that are being solved and describe algorithms
  • Verification Plans: Define tests that will be run to show that implementation is correct and robust. Involve unit tests to cover range of inputs as well as benchmarks.
  • Performance expectations: Explain the expected performance impact from this development
  • Validation Plans: Document what process-based, stand-alone component, and coupled model runs will be performed, and with what metrics will be used to assess validity

Use the symbols below (copy and paste) to indicate if the section is in progress or done or not started.

In the table below 4.Equ means Equations and Algorithms, 5.Ver means Verification, 6.Perf - Performance, 7. Val - Validation,   (tick) - competed, (warning) - in progress, (error) - not done


Overview table for the owner and an approver of this feature

1.Description

This is a descriptive long title
2.Owner
3.Created
4.Equ(tick)
5.Ver(tick)
6.Perf(tick)
7.Val(warning)
8.Approver
9.Approved Date
V2.0
 Click here for Table of Contents ...

Table of Contents




Title: E3SM Water management and flood inundation 

Requirements and Design

E3SM Watercycle Group

Date:    

Summary

This document summarizes the new water management and inundation features to be added to the MOSART component of E3SM. The development of the two new features were led by Nathalie Voisin (Unlicensed) (for WM) and Xiangyu Luo (for inundation) and were merged to one single branch by Anthony Craig when they were coupled with E3SM. It is very hard to separate the two features so they are bundled together as one PR by Tian Zhou. The water management capability (WM) regulates the river streamflow through the representation of spatially distributed water extractions for irrigation as well as flow regulations at dams. Each dam’s operating rules are determined based on historical long-term mean monthly inflow simulated by the models, reservoir characteristics, and reservoir purposes. The flood inundation capability creates a floodplain along the river channel which represents the flood processes when the river water exceeds the capacity of the channel.


Requirements

Requirement 1: Implement the water management (WM) capability to MOSART

Date last modified:    
Contributors: Nathalie Voisin (Unlicensed) Hongyi Li Tian Zhou Anthony Craig Ruby Leung

Requirement 2: Implement the inundation capability to MOSART

Date last modified:    
Contributors: Xiangyu Luo Hongyi Li Tian Zhou Anthony Craig Ruby Leung


Algorithmic Formulations

Requirment 1: In MOSART-WM, water will be extracted from the river channel and upstream reservoir storage to fulfill the water demand calculated by ELM or provided by an external demand term. The location of the reservoirs and the dependency of the water allocation to each reservoir are mapped on the river network. The dam operation follows a generic rule which is determined based on historical long-term mean monthly inflow , reservoir characteristics, and reservoir purposes (flood control, irrigation, combination of flood control and irrigation, and other).  For detailed description of the algorithm, see Voisin et. al. 2013.

Voisin, N., Li, H. Y., Ward, D., Huang, M., Wigmosta, M., & Leung, L. R. (2013). On an improved sub-regional water resources management representation for integration into earth system models. Hydrology and Earth System Sciences, 17, 3605-3622. doi:10.5194/hess-17-3605-2013

Date last modified:  
Contributors: (Nathalie Voisin (Unlicensed), Ruby Leung )


Requirment 2: In MOSART-inundation, water will enter the floodplain when the water storage exceeds the channel storage defined by the channel geometry. The fraction of the inundation of each gridcell depends on the area-elevation relationship defined by an elevation profile of the gridcell.  For detailed description of the algorithm, see Luo et. al. 2017.

Luo, X., Li, H. Y., Ruby Leung, L., Tesfa, T. K., Getirana, A., Papa, F., & Hess, L. L. (2017). Modeling surface water dynamics in the Amazon Basin using MOSART-Inundation v1.0: Impacts of geomorphological parameters and river flow representation. Geoscientific Model Development, 10, 1233-1259. doi:10.5194/gmd-10-1233-2017

Date last modified:  
Contributors: (Xiangyu Luo, Ruby Leung )

Design and Implementation

Implementation: 

The source code of both features are located in the MOSART component directory. 

Date last modified:   
Contributors: (add your name to this list if it does not appear)


Planned Verification and Unit Testing 

Verification and Unit Testing: short-desciption-of-testing-here

Date last modified:  
Contributors: (add your name to this list if it does not appear)


How will XXX be tested? i.e. how will be we know when we have met requirement XXX. Will these unit tests be included in the ongoing going forward?

Planned Validation Testing 

Validation Testing: short-desciption-of-testing-here

Date last modified:
Contributors: (add your name to this list if it does not appear)


How will XXX be tested? What observational or other dataset will be used?  i.e. how will be we know when we have met requirement XXX. Will these unit tests be included in the ongoing going forward?

Planned Performance Testing 

Performance Testing: short-desciption-of-testing-here

Date last modified:
Contributors: (add your name to this list if it does not appear)


How will XXX be tested? i.e. how will be we know when we have met requirement XXX. Will these unit tests be included in the ongoing going forward?