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
Expand | ||
---|---|---|
| ||
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
Use the symbols below (copy and paste) to indicate if the section is in progress or done or not started. |
...
Page Properties | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
|
...
Expand | |||
---|---|---|---|
| |||
|
Title: Plant Hydraulics
Requirements and Design
E3SM Watercycle Group
Date:
Summary
Requirements
Requirement: name-of-requirement-here
The PHS model needs to conform to the big leaf model. A new namelist variable "use_hydrstress" is added to trigger this capability. This capability also requires an updated clm_params parameter file.
Date last modified:
// dateContributors: @ 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.
Contributors: Yilin Fang Ruby Leung
Algorithmic Formulations
The algorithm follows the approach in Kennedy et al. (2019), which solves vegetation water potential in the root, stem, and sunlit leaf and shaded leaf. Water stress factor BTRAN is a function of leaf water potential instead of the soil matric potential. Four steady state equations (continuity of fluxes) are solved given transpiration and soil matric potentials in each soil layer as boundary conditions.
Equations can be found in Kennedy et al. (2019).
Figure 1. Plant hydraulic circuit analog schematic (Kennedy et al., 2019)
Reference:
Kennedy, D., S. Swenson, K. W. Oleson, D. M. Lawrence, R. Fisher, A. C. L. da Costa, and P. Gentine (2019), Implementing Plant Hydraulics in the Community Land Model, Version 5, J Adv Model Earth Sy, 11(2), 485-513, doi:10.1029/2018MS001500.
Design solution:
short-description-of-proposed-solution-hereDate 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 sequencingSolution follows Kennedy et al.
Design and Implementation
Implementation:
short-desciption-of-implementation-hereDate last modified: // date
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)
Unit testing will be added for certain PHS subroutines, such as plc that calculates the vulnerability curveThe E3SM Developers test suite was used to make unit testing with PHS model turned off. In addition, the code will be submitted for expert review on the process of PR.
The PHS will be tested against the point simulation published in Kennedy et al. (2019).
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)
he The PHS will be tested against the point simulation published in Kennedy et al. (2019)validated using point and global simulation.
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)
Global simulation will
XXXbe 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?for performance.