[[PageOutline]]
Last edited [[Timestamp]]

[[BR]]

'''Author''' : Gurvan Madec

'''ticket''' : #658

'''Branch''' : [https://forge.ipsl.jussieu.fr/nemo/browser/branches/DEV_r1826_DOC  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

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

   • DYN : add a § for sshwzv 

   • DOM : time stepping strategy (to be completed...)

   • MISC : add the steric effect

   • namlist:  new names changed everywhere

   • ZDF - zdfbfr : document the changes in the treatment of bottom friction

   • 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

   • DOM (time) : add a description of daymod ; introduce the modified LF-AF of Leclair&Madec 2010 ; introduce the Crank-Nicholson scheme ; ...

   • DOM (space): description of istate, domclo, geo2ocean (probably in SBC chapter for the later)

   • LDF : add the mixte laplacian / bilaplacian  (see ticket #659 there : [wiki:ticket/659_mixed_ldfdyn] )

   • ZDF - zdftmx : description of tidal mixing parameterisation

   • ZDF - zdftke : missing the description of new TKE parameter



----


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

||NVTK Tested||'''NA'''||
||Other model configurations||'''NA'''||
||Processor configurations tested||'''NA'''||
||If adding new functionality please confirm that the [[BR]]New code doesn't change results when it is switched off [[BR]]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'''||