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.
...
| Page Properties | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
|
| Expand | |||
|---|---|---|---|
| |||
|
...
Date:
Summary
Requirements
Requirement: name-of-requirement-here
Date last modified: // date
Contributors: @ name (add your name to this list if it does not appear)
Each requirement is to be listed under a ”section” heading, as there will be a one-to-one correspondence between requirements, design, proposed imple- mentation and testing. Requirements should not discuss technical software issues, but rather focus on model capability. To the extent possible, require- ments should be relatively independent of each other, thus allowing a clean design solution, implementation and testing plan.Algorithmic Formulations
Design solution: short-description-of-proposed-solution-here
Date last modified:// date
Contributors: (add your name to this list if it does not appear)
For each requirement, there is a design solution that is intended to meet that requirement. Design solutions can include detailed technical discussions of PDEs, algorithms, solvers and similar, as well as technical discussion of performance issues. In general, this section should steer away from a detailed discussion of low-level software issues such as variable declarations, interfaces and sequencing.
Design and Implementation
Implementation: short-desciption-of-implementation-here
Date last modified: // date
Contributors: (add your name to this list if it does not appear)
This section should detail the plan for implementing the design solution for requirement XXX. In general, this section is software-centric with a focus on software implementation. Pseudo code is appropriate in this section. Links to actual source code are appropriate. Project management items, such as svn branches, timelines and staffing are also appropriate. How do we typeset pseudo code?E3SM BGC system. The new code simulates the advective heat fluxes from ALM into rivers and through the rivers, and heat exchanges between channel water and environments particularly atmosphere. The success of the code would be satisfactory performance evaluated against the observed stream temperature over multiple river gauges. Requirements
Requirement: Implementing riverine heat process description on top of MOSART-water and water management.
Date last modified: 30 Jun 2019
Contributors: Hongyi Li, Ruby Leung
MOSART-heat has been developed and documented in Li et al. (2015) . Generally, MOSART-heat simulates one-way heat fluxes from ELM to rivers, two-way heat fluxes between river water and atmosphere, advective heat fluxes between river channels carried by the water fluxes, and finally the heat balance in river channels.
Li, H.-Y.*, L. Ruby Leung, T. Tesfa, N. Voisin, M. Hejazi, L. Liu, Y. Liu, J. Rice, H. Wu, and X. Yang (2015), Modeling stream temperature in the Anthropocene: An earth system modeling approach, J. Adv. Model. Earth Syst., 7, doi:10.1002/2015MS000471.
Requirement: Evaluation of MOSART-heat.
Date last modified: 30 Jun 2019
Contributors: Hongyi Li, Ruby Leung, Teklu Tesfa
MOSART-heat has been successfully evaluated over the contiguous U.S. against the observed daily stream temperature at over 320 USGS gauges. For details please refer to Li et al. (2015)
Li, H.-Y.*, L. Ruby Leung, T. Tesfa, N. Voisin, M. Hejazi, L. Liu, Y. Liu, J. Rice, H. Wu, and X. Yang (2015), Modeling stream temperature in the Anthropocene: An earth system modeling approach, J. Adv. Model. Earth Syst., 7, doi:10.1002/2015MS000471.
Algorithmic Formulations
Design solution: Riverine heat processes
Date last modified: 30 Jun 2019
Contributors: Hongyi Li, Ruby Leung
This is a completely new capacity added into E3SM/MOSART. All the heat processes are described in a physically-based way. The advective heat fluxes are estimated based on the advective water fluxes including the surface and subsurface runoff from hillslopes into the sub-network channel, from sub-network channel to main channel, and between upstrean/downstream main channels. The temperature of surface runoff is assumed to be equal to the average soil temperature (simulated by ELM) over the top 10cm soil layers. The temperature of subsurface runoff is assumed to be equal to the average soil temperature of those soil layers below the ground water table (simulated by ELM). The temperature of sub-network and main channel water is estimated based on the heat balance, including long-wave and short-wave solar radiation, sensible heat, latent heat and advective heat fluxes etc.
Design and Implementation
Implementation: Implementing riverine heat processes
Date last modified: 30 Jun 2019
Contributors: Ruby Leung, Hongyi Li, Anthony Craig
Planned Verification and Unit Testing
Verification and Unit Testing:
short-desciption-of-testing-hereVerifying MOSART-heat
Date last modified: 03 Sep 2019
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?Hongyi Li, Tian Zhou
Verification is performed by checking the fields that are passed from ELM and EAM to MOSART-heat through the flux coupler. MOSART-heat has been tested and passed the E3SM_developer tests on Compy.
Planned Validation Testing
Validation Testing:
short-desciption-of-testing-hereValidating MOSART-heat
Date last modified: 03 Sep 2019
Contributors: Hongyi Li,
(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?Ruby Leung
MOSART-heat has been validated over the U.S. domain against the observed stream temperature data from USGS gauges (see Li et al., 2015). The global validation against the observations also shows satisfactory results.
Li, H.-Y.*, L. Ruby Leung, T. Tesfa, N. Voisin, M. Hejazi, L. Liu, Y. Liu, J. Rice, H. Wu, and X. Yang (2015), Modeling stream temperature in the Anthropocene: An earth system modeling approach, J. Adv. Model. Earth Syst., 7, doi:10.1002/2015MS000471.
Planned Performance Testing
Performance Testing:
short-desciption-of-testing-hereMOSART-heat performance
Date last modified: 03 Sep 2019
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?Hongyi Li
ELM-MOSART-heat has been run globally w/o water management option on Constance using 144 cores during a historical period 1972-2004. The total running time is ~47 hours with the water management option, and is ~45 hours without it.