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.
...
| Expand | |||
|---|---|---|---|
| |||
|
Title:
...
Improved Convective Trigger for the ZM Deep Convection Scheme with the Unrestricted Launch Level (ULL) Method
Requirements and Design
E3SM
...
Watercycle Group
Date:
...
Summary
The
purpose of this section is to summarize what capability is to be added to the ACME Ocean and Ice system through this design process. It should be clear what new code will do that the current code does not. Summarizing the primary challenges with respect to software design and implementation is also appropriate for this section. Finally, this statement should contain general statement with regard to what is “success.”Requirements
Requirement: name-of-requirement-here
Date last modified: // date
Contributors: @ name (add your name to this list if it does not appear)
proposed convective trigger change is to primarily improve E3SM simulated diurnal cycle of precipitation by capturing nocturnal elevated convection through allowing air parcels to launch above boundary layer (BL) (Xie et al. 2019). The Unrestricted Launch Level (ULL) trigger works for searching the source layer, which is determined by the maximum static energy (MSE), for launching air parcel used in the calculation of cloud properties and rainfall intensity. In contrast to the assumption that the maximum MSE layer has to be in the boundary layer in ZM, the ULL trigger does the source layer search from surface to 600hPa. This allows for both surface-driven convection as the default ZM scheme does, and elevated convection that is initially decoupled from the surface.
Requirements
Requirement: Need minor code changes within ZM
Date last modified:
Contributors: Shaocheng Xie, Wuyin Lin, Yi-Chi Wang
(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-hereIn contrast to the assumption that the maximum MSE layer has to be in the boundary layer in the default ZM, the ULL trigger does the source layer search from surface to 600hPa. See more details in Xie et al. 2019.
Date last modified:
// dateContributors: (add your name to this list if it does not appear)
Contributors:Shaocheng Xie, Yi-Chi Wang
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-herePull requests incorporate the
Date last modified:
// date
Contributors:
(add your name to this list if it does not appear)Wuyin Lin
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?
...