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 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. |
In the table below, 4.Equ means Equations and Algorithms, 5.Ver means Verification, 6.Perf - Performance, 7. Val - Validation, - completed, - in progress, - not done
HTML Comment |
---|
- |
...
completed, - in progress, - not done |
Page Properties | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
|
Expand | |||
---|---|---|---|
| |||
|
Title: Interactions with the surface models (Sea Spray, DMS)
Requirements and Design
ACME
...
Atmosphere 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:
Contributors: (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: (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?
new v1 capability will read in netCDF files containing ocean surface distributions of marine macromolecules (lipids, polysaccharides, and proteins) and produce emissions of a single marine organic aerosol species within MAM4, adding 3 advected tracers to the model.
Requirements
Requirement 1: Calculation of marine organic emissions from offline fields produced from marine biogeochemistry models
Date last modified:
Contributors: Susannah Burrows, Scott Elliott (Unlicensed), Richard Easter (Unlicensed)
Algorithmic Formulations
Design solution 1a: Formulation of relationship between ocean surface organic concentrations and organic mass fraction of emitted sea spray aerosol
Date last modified: Paper published Dec 2014
Contributors: Susannah Burrows, Scott Elliott (Unlicensed), Phil Rasch (pnl.gov)
See Burrows et al., 2014, ACP.
Burrows, S. M., Ogunro, O., Frossard, A. A., Russell, L. M., Rasch, P. J., and Elliott, S. M.: A physically based framework for modeling the organic fractionation of sea spray aerosol from bubble film Langmuir equilibria, Atmos. Chem. Phys., 14, 13601-13629, doi:10.5194/acp-14-13601-2014, 2014.
Design solution 1b: Formulation of assumed relationships between marine organic mass fraction and particle size and mixing state
Date last modified: Aug 2015
Contributors: Susannah Burrows
Some initial testing is documented here: /wiki/spaces/ATM/pages/32374899.
For an initial implementation, organic mass fraction calculated according to Burrows et al (2014) will be assumed to apply directly to Aitken mode and accumulation mode aerosol. Emissions within MAM4 will be implemented as a default configuration, with all marine organics combined into a single species, adding 3 advected tracers to the MAM4 scheme. A switch/parameter will be implemented to control mixing state (internal/external) of accumulation mode emissions.
Design and Implementation
Implementation 1a: Implementation of Burrows et al. 2014 marine organic aerosol emissions with MAM9 aerosols
Date last modified: 09/15/2015
Contributors: Susannah Burrows, Richard Easter (Unlicensed), Xiaohong Liu
New emissions formulation will be implemented within seasalt_model.F90. Organic mass fraction of emitted aerosol will be calculated using static netCDF files describing the distribution of organic molecules in surface ocean water, provided as netCDF files. The distributions will be obtained from low-resolution ACME ocean BGC simulations if available; otherwise, older distributions from POP simulations will be used. Emitted aerosol mass and number will be added to modes 1 (accumulation), 2 (Aitken) and 4 (primary organic), and emitted sea salt mass will be reduced if appropriate (depending on mixing state).
Implementation 1b: Implementation of alternate marine organic aerosol emissions parameterizations
Date last modified: 09/15/2015
Contributors: Susannah Burrows
PR issued containing implementations 1a and 1b:
PR location: https://github.com/ACME-Climate/ACME/pull/415
Planned Verification and Unit Testing
Verification and Unit Testing:
short-desciption-of-testing-hereTesting of marine sea spray organic matter code
Date last modified:
Contributors: Susannah Burrows,
(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?
Richard Easter (Unlicensed)
We will confirm that aerosol budgets are accurate and that emissions (as written to history files) are as expected from offline calculations.
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?
Susannah Burrows, Scott Elliott (Unlicensed)
We will compare atmospheric aerosol concentrations against a small observational dataset that we have assembled (and to which we will add more data if needed).
Planned Performance Testing
Performance Testing:
short-desciption-of-testing-hereTesting performance
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?
Susannah Burrows
The new implementation will add 3 additional (advected) tracers to MAM4, so it will result in a modest increase in computational time. The history files will be increased by 5 new 3-D fields, and 3 new 2-D (emission flux) fields.