Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
titleClick 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.

...

Page Properties
idFeature_PR


Info

Overview table for the owner and an approver of this feature

1.Description

SNICAR-AD Shortwave Radiation for Sea Ice and Land

2.Owner

Cheng Dang (Unlicensed)
3.Created 
4.Equ(error)(tick)
5.Ver(error)(tick)
6.Perf(error)(tick)
7.Val(error)(tick)
8.Approver
9.Approved Date
V2.0Pending



...

Expand
titleClick here for Table of Contents ...


Panel

Table of Contents

Table of Contents





Title: SNICAR-AD Shortwave Radiation for Sea Ice and Land

Requirements and Design

E3SM Cryosphere Group

Date:  


Summary


The purpose goal of this section task is to summarize what capability is to be added to the ACME Ocean and Ice system 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: name-of-requirement-here

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

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: 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?remove the discrepancy of shortwave radiative transfer simulation for snowpacks on sea ice and on land in E3SM. We implement the radiative transfer scheme SNICAR-AD in the sea-ice component MPAS-seaice and the land component ELM for E3SM to predict consistent and improved shortwave radiative properties of snow-covered surfaces.


Requirements

ELM: modify the land shortwave code to include a subroutine that adopts the new radiative transfer algorithm.

MPAS-seaice: modify the sea-ice shortwave radiative transfer code to include a new subroutine that

  1. provides new input files for snow and ice optics adopted by ELM;
  2. expands the shortwave radiative calculation from three to five subdivided solar bands adopted by ELM;
  3. removes empirical adjustment for radiative-effective snow grain size;
  4. adopts a new algorithm to correct for the bias of near-infrared albedo and absorption when solar zenith angles are larger than 75 degrees.


Date last modified: Jun 1st, 2019 


Algorithmic Formulations

Design solution: described in the following article

Dang, C., Zender, C. S., and Flanner, M. G.: Inter-comparison and improvement of 2-stream shortwave radiative transfer models for a unified treatment of cryospheric surfaces in ESMs, The Cryosphere Discuss., https://doi.org/10.5194/tc-2019-22, in review, 2019.

Date last modified: July 1st, 2019
Contributors: Cheng Dang (Unlicensed) Charlie Zender Mark Flanner




Design and Implementation

Implementation: 

In the sea-ice and land shortwave code (ice_shortwace.F90, SnowSnicarMod.F90), we implemented SNICAR_AD that can be turned on/off by configuration toggles in the model namelists.

MPAS-source code: https://github.com/chengdang/MPAS-Model/tree/seaice/cdang_SnicarAD

ELM-source code: https://github.com/chengdang/E3SM/tree/chengdang/lnd/SNICAR_AD


Date last modified: July 1st, 2019

Contributors: Cheng Dang (Unlicensed)




Planned Verification and Unit Testing 

Verification and Unit Testing:

short-desciption-of-testing-here

  • The offline radiative transfer model has been tested against a multi-stream benchmark model. (Dang, C., Zender, C. S., and Flanner, M. G.: Inter-comparison and improvement of 2-stream shortwave radiative transfer models for a unified treatment of cryospheric surfaces in ESMs, The Cryosphere Discuss., https://doi.org/10.5194/tc-2019-22, in review, 2019.)


Date last modified:

  

July 1st, 2019

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?

Cheng Dang (Unlicensed)




Planned Validation Testing 

Validation Testing:

short-desciption-of-testing-here

 


Date last modified: July 1st, 2019
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?

Cheng Dang (Unlicensed)



Planned Performance Testing 

Performance Testing:

short-desciption-of-testing-here

 

The new implementation is not expected to have a significant impact on the computational cost/performance of E3SM.

Date last modified: July 1st, 2019

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?

Contributors: 

(add your name to this list if it does not appear)

Cheng Dang (Unlicensed)