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 | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
|
...
E3SM Group_name (for example Watercycle) Water Cycle
Date:
...
Summary
The convective gravity wave (GW) source parameterization in large part controls the stratospheric quasi-biennial oscillation (QBO). In E3SM, v1 the QBO is too strong and too fast. We have made modifications to parameters in the GW parameterization that improve the representation of the QBO in terms of the period and amplitude.
Requirements
Requirement:
name-of-requirement-hereMinor changes to source and namelist
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?Wuyin Lin, Jadwiga (Yaga) Richter (Unlicensed)
Algorithmic Formulations
Design solution: All the code mods that are required are as follows:
real(r8), parameter :: CF = 12.5_r8
and in user_nl_cam
effgw_beres = 0.35
Date last modified:
Contributors: Jadwiga (Yaga) Richter (Unlicensed) Chih-Chieh-Jack Chen Wuyin Lin
Design and Implementation
Implementation:
Transfer above parameters to code
Date last modified:
Contributors: Jadwiga (Yaga) Richter (Unlicensed) Wuyin Lin
Planned Verification and Unit Testing
Verification and Unit Testing:
short-desciption-of-testing-hereDate last modified:
Contributors:
(add your name to this list if it does not appear)Wuyin Lin
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-here30 yrs AMIP and coupled simulations: comparisons of QBO in simulations with above parameter changes in E3SMv1 (already ran and submitted for publication);
Evaluation of resolved wave spectra. Need to have daily means of: PRECT, OMEGA500, FLUT, U200, and U850 in output.
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?Jadwiga (Yaga) Richter (Unlicensed)
Planned Performance Testing
Performance Testing:
short-desciption-of-testing-hereDate 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?Jadwiga (Yaga) Richter (Unlicensed) Wuyin Lin
Performance of the code should not be affected. Only parameter changes. Timings can be compared to previous runs.