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

Land -Ice Add Land Ice Meshes to ACME
2.OwnerMatt Hoffman
3.Created// date
4.Equ(error)
5.Ver(error)
6.Perf(error)
7.Val(error)
8.Approver 
9.Approved Date 
 Click here for Table of Contents ...

Table of Contents

 

 

 

Title: O26_LI Add Land Ice Meshes to ACME

Requirements and Design

ACME Ocean and Ice Group

Date: 2015-9-23 

Summary

ACME will be one of the first climate models to include a fully coupled, dynamic ice sheet component. Meshes appropriate for use with the MPAS-LI model, the ice sheet model component in ACME, will need to be added to ACME for: 1) testing purposes, 2) use in configurations where the ice sheet may be dynamically inactive but coupled thermodynamically to the ocean component, and 3) use in configurations with a fully coupled and active ice sheet model component.

 

Requirements

Requirement: Coarse, uniform resolution meshes for testing

Date last modified: 2015-9-23
Contributors: Matt Hoffman, Stephen Price

Testing of the new ice sheet and climate model coupling in ACME will require inexpensive, coarse, uniform resolution meshes for the land ice model component.

 

Requirement: Variable resolution meshes for static ice sheet configurations

Date last modified: 2015-9-23
Contributors: Matt Hoffman, Stephen Price

Some ACME simulations may choose to have an inactive ice sheet component. In this case, we can still allow for thermodynamic coupling between the ocean and ice sheet (e.g., so that the ocean can circulate under static ice shelves and exchange heat and fresh water fluxes with the ice sheet). This will require variable resolution meshes with intermediate spatial dimensions.

 

Requirement: Variable resolution meshes for active ice sheet configurations

Date last modified: 2015-9-23
Contributors: Matt Hoffman, Stephen Price

Accurate simulation of marine ice sheet dynamics - e.g., retreat and advance of ice sheet grounding lines - requires extremely high spatial grid resolution (>=1km) in limited portions of the computational domain covered by the ice sheet. ACME simulations with an active ice sheet component will require variable resolution meshes that allow for this localized high resolution in order to insure accurate simulations of marine ice sheet evolution.

 

Algorithmic Formulations

Design solution: short-description-of-proposed-solution-here

Date last modified:// date
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: // date
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?

 

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