New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
ticket/0658_DOC – NEMO
wiki:ticket/0658_DOC

Version 13 (modified by gm, 14 years ago) (diff)

--

      1. Description
      2. Missing points
      3. Testing
      4. Bit Comparability
      5. System Changes
      6. Resources
      7. IPR issues

Last edited Timestamp?


Author : Gurvan Madec

ticket : #658

Branch : DEV_r1826_DOC

Description

Phasing between the ocean engine (OPA) documentation and the actual trunk source code (revision 1826)

  • NEMO_tex : add a \ifile command to generate an index of NetCDF Input files
  • NEMO_book.tex :
  • cosmetic changes in the cover page
  • addition of the NEMO team as autor
  • Add hyperlink in the pdf document (thanks to George Nurser
  • add math_abbrev.sty to simplify the mathematical expressions
  • change T-point into t-point and e3T into e3t everywhere
  • Namelist : introduce the new namelist names and their associated variable names (almost all Chapters involved)
  • suppression of the rigid lid option : update of Chap_Model_Basics, DOM, DYN, MISC...
  • STP : creation of this chapter about the time stepping strategy and add the Modified Leap-Frog documentation
  • DYN : add a § for sshwzv
  • MISC : add the steric effect (AR5 diagnostics)
  • namlist: new names changed everywhere
  • ZDF
  • zdfbfr : document the changes in the treatment of bottom friction
  • zdftmx : description of tidal mixing parameterisation including ITF specific treatment
  • zdftke : add the description of the updated momentum / TKE interactions
  • Annex : update the 4 appendix (from A to D), including the update of the variable naming rules (namelist variables and structures) in App.D.

Missing points

  • Chap_Model_Basics : addition of generalised coordinate, ALE, z, z*, s and z-tilde (in relation with Appendix A).
  • DOM : idea: split this chapter in two: Time Domain and Space Domain
  • STP (time) : add a description of daymod ; introduce the Crank-Nicholson scheme ; ...
  • DOM : description of istate, domclo, geo2ocean (probably in SBC chapter for the later)
  • TRA : update trabbl documentation (phasing with the new formulation...)
  • ZDF : zdftke : missing the description of new TKE parameter

Testing

Testing could consider (where appropriate) other configurations in addition to NVTK].

NVTK TestedNA
Other model configurationsNA
Processor configurations testedNA
If adding new functionality please confirm that the
New code doesn't change results when it is switched off
and ''works'' when switched on		NA
  • No run test required, only the DOC directory is modified, not the source code.

Bit Comparability

Does this change preserve answers in your tested standard configurations (to the last bit) ?YES
Does this change bit compare across various processor configurations. (1xM, Nx1 and MxN are recommended)YES
Is this change expected to preserve answers in all possible model configurations?YES
Is this change expected to preserve all diagnostics? YES

System Changes

Does your change alter namelists?NO
Does your change require a change in compiler options?NO

Resources

unchanged

IPR issues

Has the code been wholly (100%) produced by NEMO developers staff working exclusively on NEMO?'''YES