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 3 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

Addition of a MPAS-framework based sea-ice component
2.OwnerAdrian Turner
3.CreatedSeptember 25, 2015
4.Equ(error)
5.Ver(error)
6.Perf(error)
7.Val(error)
8.ApproverTodd Ringler (Unlicensed)
9.Approved Date
 Click here for Table of Contents ...

Table of Contents

 

 

 

Title: MPAS-CICE

Requirements and Design

ACME Ocean-Ice  Group

Date: September 25, 2015 

Summary

The overarching goal here is the reformulation of CICE into the unstructured MPAS framework. Success is the production of a MPAS-CICE model that is equivalent or better in terms of fidelity than the POP-based CICE model.

Requirements

Requirement: CICE 4.0 column physics

Date last modified: 
Contributors: Adrian Turner

MPAS-CICE is required to utilize column physics that is equivalent or better than CICE 4.0.

 

Requirement: CICE 4.0 EVP solver

Date last modified: 
Contributors: Adrian Turner

MPAS-CICE is required to use a constitutive relation that is equivalent or better than the elastic-viscous-plastic (EVP) solver used in CICE 4.0.

 

Requirement: CICE 4.0 velocity solver

Date last modified: 
Contributors: Adrian Turner

MPAS-CICE is required to use a velocity solver that is equivalent or better than that used in CICE 4.0.

 

Requirement: CICE 4.0 transport

Date last modified: 
Contributors: Adrian Turner

MPAS-CICE is required to use a transport scheme that is equivalent or better than that used in CICE 4.0.

Algorithmic Formulations

Design solution: CICE 4.0 column physics

Date last modified: September 25, 2015
Contributors: Adrian Turner and Elizabeth Hunke (Unlicensed)

 

For each 

 

Design solution: CICE 4.0 EVP solver

Date last modified: September 25, 2015
Contributors: Adrian Turner

 

For each 

 

Design solution:  CICE 4.0 velocity solver

Date last modified: September 25, 2015
Contributors: Adrian Turner

 

For each 

 

Design solution: CICE 4.0 transport

Date last modified: September 25, 2015
Contributors: William Lipscomb (Unlicensed)

 

For each 

 

Design and Implementation

Implementation: CICE 4.0 column physics

Date last modified: September 25, 2015
Contributors: Adrian Turner and Elizabeth Hunke (Unlicensed)

 

For each 

 

Implementation: CICE 4.0 EVP solver

Date last modified: September 25, 2015
Contributors: Adrian Turner

 

For each 

 

Implementation CICE 4.0 velocity solver

Date last modified: September 25, 2015
Contributors: Adrian Turner

 

For each 

 

ImplementationCICE 4.0 transport

Date last modified: September 25, 2015
Contributors: William Lipscomb (Unlicensed)

 

For each

Planned Verification and Unit Testing 

Verification and Unit 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?

 

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?

 

 

  • No labels