B10: MOSART-Reservoir Lake Design Document

Owned by Renata McCoy
Last updated: Jul 03, 2020
2 min read

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

B10: MOSART-Lake
2.OwnerHongyi Li
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: MOSART-Reservoir Stratification

Requirements and Design

E3SM BGC Group

Date:  

Summary


Requirements

Requirement: name-of-requirement-here


Date last modified: 

Contributors:

Algorithmic Formulations

Design solution:

Date last modified:// date
Contributors: (add your name to this list if it does not appear)

 


Design and Implementation

Implementation:

Date last modified: // date
Contributors: (add your name to this list if it does not appear)


Planned Verification and Unit Testing 

Verification and Unit Testing:  

Date last modified:  
Contributors: (add your name to this list if it does not appear)

 


Planned Validation Testing 

Validation Testing:  

Date last modified:
Contributors: (add your name to this list if it does not appear)


 

Planned Performance Testing 

Performance Testing: 

Date last modified:
Contributors: (add your name to this list if it does not appear)