Versions Compared

Old Version 3

changes.mady.by.user Mark Taylor

Saved on

compared with

New Version 4

changes.mady.by.user Mark Taylor

Saved on

Key

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

...

The purpose of this section 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

Date last modified:

// date

  
Contributors: 

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

Peter Bosler, Andrew Bradley, Oksana Guba , Mark Taylor, Andrew Steyer (Unlicensed), Paul Ullrich

The formulation of the nonhydrostatic equations is documented in a journal paper to be submitted to JAMES:  https://www.overleaf.com/read/bqycjpqjthnc

The SL transport algorithm is documented in two recently accepted CISC papers:   


Design and Implementation

Implementation: short-desciption-of-implementation-here

Date last modified:   
Contributors: 

// 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?


The code has been implemented in the HOMME dynamical core as a non-default compile time option:   https://github.com/E3SM-Project/E3SM/tree/master/components/homme
The NH dycore is build by specifying the "theta-l" target, as opposed to the default "preqx" target.   The "theta-l" model reuses much of the existing E3SM code, with all new code specific to "theta-l" placed in the  https://github.com/E3SM-Project/E3SM/tree/master/components/homme/src/theta-l directory.  
The SL transport algorithm is turned on via  The SL transport algorithm is turned on via namelist options.  COMPSETS will be created that use the recommended options with the PR submitted with this design document.  


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?


...