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 | |||
|---|---|---|---|
| |||
|
Title: Interactions with the surface models (
...
light absorbing particles in snow/ice)
Requirements and Design
ACME
...
Atmosphere Group
Date:
Summary
Requirements
Requirement: name-of-requirement-here
Contributors: task is to improve the compatibility between MAM aerosols (in the atmospheric component) and treatment of light-absorbing particles deposited to snow and sea ice (in land and sea ice components), to fix recently identified bugs in calculating snow grain sizes in the released CLM (in ALM as well), and to provide new input files for snow and ice optics are needed for running the model.
Requirements
modify the atmospheric aerosol deposition code to separately treat BC mixed internally within hydrometeors and externally to hydrometeors, and to partition dust into four size bins instead of two
modify the SNICAR code to take size-dependent BC optical properties (i.e., depending on snow grain size and BC particle size) and provide a new lookup table for the optical properties
modify the code in ALM for calculating snow grain size to fix an identified bug
Do the same to the sea ice component to take new size-dependent BC optical properties
Date last modified:
Contributors: Hailong Wang
(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:
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:Contributors:
Algorithmic Formulations
Design solution: described in the following articles:
Date last modified:
Contributors: @Hailong Wang, Mark Flanner
Design and Implementation
Implementation:
Will follow an initial implementation to a developer version of CESM by Mark Flanner.
Date last modified:
Contributors: Hailong Wang (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?
Planned Verification and Unit Testing
Verification and Unit Testing:
short-desciption-of-testing-hereWill evaluate the results of our new implementation against those in Flanner et al. (2012).
Date last modified:
Contributors: Hailong Wang, Yun Qian, Mark Flanner (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?
...