Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

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

 Click here for instructions to fill up the table below ......

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

  • Equations: Document the equations that are being solved and describe algorithms
  • Verification Plans: Define tests that will be run to show that implementation is correct and robust. Involve unit tests to cover range of inputs as well as benchmarks.
  • Performance expectations: Explain the expected performance impact from this development
  • Validation Plans: Document what process-based, stand-alone component, and coupled model runs will be performed, and with what metrics will be used to assess validity

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,   (tick) - competed, (warning) - in progress, (error) - not done


Overview table for the owner and an approver of this feature

1.Description

Ozone (O3v2) with tropospheric loss in the lowermost a few layers
2.OwnerQi Tang
3.Created
4.Equ(error)
5.Ver(error)
6.Perf(error)
7.Val(error)
8.Approver
9.Approved Date
V2.0
 Click here for Table of Contents ...

Table of Contents




Title: Improved ozone (O3v2) with tropospheric loss in the lowermost a few layers

Requirements and Design

E3SM Watercycle Group

Date:    

Summary

The redesigned ozone (O3v2) and algorithms are compatible with and expect the addition of fully interactive tropospheric chemistry that is planned for E3SM V3. It adds the tropospheric ozone loss in the lowermost a few layers (currently set to 4) and removes the resetting to ozone climatology in the troposphere. This changes enables more realistic tropopause changes for simulations such as 4x CO2 and future projections. It also allows us to diagnose the stratosphere troposphere exchange of ozone fluxes, which provide important information about the quality of stratospheric simulations.

Requirements

Requirement: minor changes in the Linoz module and some related physics code

Date last modified:  
Contributors: Qi TangJuno Hsu (Unlicensed)Michael J Prather


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: Add the ozone e-folding decay to 30 ppb with a 2-day e-folding time. Turn off the resetting to climatology ozone in the troposphere and ozone dry deposition.

Date last modified:  
Contributors: Qi TangJuno Hsu (Unlicensed)Michael J Prather


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: Pull requests implemented O3v2 (https://github.com/E3SM-Project/E3SM/pull/3047)

Date last modified:  
Contributors: Qi TangJuno Hsu (Unlicensed)Michael J Prather


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: 5-year and 20-year tests

Date last modified:  
Contributors: Qi TangJuno Hsu (Unlicensed)Michael J Prather


A 5-year test with O3v2 was done and compared with the 5-year control run with the ozone in E3SMv1. The climate of these two runs are very similar. The O3v2 tropospheric loss looks reasonable and shows signs of approaching a stable state. An extended 20-year test confirmed that the O3v2 was implemented correctly and produced expected results.

Planned Validation Testing 

Validation Testing: 20-year test and 4x CO2 simulation

Date last modified:  
Contributors: Qi Tang


The 20-year simulation was complete (as mentioned above). It verifies that the code is implemented correctly and the results are reasonable. A 4x CO2 is planned to verify the O3v2 with larger perturbations and examine the climate sensitivity changes.

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?



  • No labels