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 overview 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. |
...
| Page Properties | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
|
- competed...
| Expand | |||
|---|---|---|---|
| |||
|
Title: Version 2 of CLUBB
Requirements and Design
Atmosphere Group
Date: 20190627
Summary
The v1 version of CLUBB left pockets of supersaturation for the microphysics. To mitigate this, the v2 version of CLUBB does CLUBB's saturation adjustment immediately before microphysics when ipdf_call_placement = ipdf_pre_advance_fields.
...
The purpose of this section is to summarize what capability is to be added to the E3SM 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 1: Move saturation adjustment immediately before microphysics
Requirement 2: Add option to enhance gustiness
Requirement 3: Add option to prognose momentum fluxes
Date last modified: // 27 Jun 2019
Contributors: Vince Larson, Brian Griffin (Unlicensed)
Algorithmic Formulations
Design solution:
Date last modified:// 27 Jun 2019
Contributors: Vince Larson, Brian Griffin (Unlicensed)
The prognostic equation for momentum flux is shown in Eqn. (4.7) of CLUBB's tech doc, (Larson 2017). The saturation adjustment and enhanced gustiness are described in code comments.
Design and Implementation
Implementation:
Date last modified: // 27 Jun 2019
Contributors: Vince Larson, Brian Griffin (Unlicensed), Balwinder Singh
The new CLUBB code is available at CLUBB's release page, https://github.com/larson-group/clubb_release/, accessible after registration at https://carson.math.uwm.edu/larson-group/clubb_site/signup/.
CLUBB source code is free to be pulled into E3SMv2 and distributed as it was in E3SMv1.
Planned Verification and Unit Testing
Verification and Unit Testing: Unit tests for CLUBB's PDF closure and conservation of scalars are available.
Date last modified: 27 Jun 2019
Contributors: Vince Larson, Brian Griffin (Unlicensed), Andy Salinger
...
Perhaps these tests could be included in E3SM's standard unit test suite.
Planned Validation Testing
Validation Testing: short-desciption-of-testing-here
Date last modified: 27 Jun 2019
Contributors: Vince Larson, Balwinder Singh
Balwinder show that when CLUBB_v2 flags are reverted as in CLUBB_v1, then the global solutions are similar (within 1 W/m2 of SWCF). However, the new options available in CLUBB_v2 offer opportunities for improvements to global simulations during the tuning process.
Planned Performance Testing
Performance Testing: Tests of E3SM on Cori
Date last modified: 27 Jun 2019
Contributors: Balwinder Singh
Balwinder has found that there is little change in runtime on Cori when CLUBBv2 is used in place of CLUBBv1. This could be improved if performance optimizations to clubb_intr, not included here, were added later.