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_book.tex :

cosmetic changes in the cover page

add a \ifile command to generate an index of NetCDF Input files

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

• All .txt files:

change T-point into t-point and e3T into e3t everywhere

Namelist : introduce the new namelist names and their associated variable names, new names changed everywhere (NB: to be redone when updating the namelist in v3.3)

• suppression of the rigid lid option : update of Chap_Model_Basics, DOM, DYN, MISC...

• DOM : split this chapter in two: Time Domain (STP) and Space Domain (DOM)

• STP : creation of this chapter : time stepping strategy and add the Modified Leap-Frog documentation

• TRA :

update trabbl documentation (phasing with the new formulation...)

update tranxt (MLF)

update tra_sbc (MLF + description of the forcing tendency)

• DYN :

add a § for sshwzv

update the UBS presentation

• LDF : add the mixed lap-bilap doc (see https://forge.ipsl.jussieu.fr/nemo/wiki/ticket/659_mixed_ldfdyn)

• SBC :

add the diurnal cycle (see #730)

start to update the runoff part (see https://forge.ipsl.jussieu.fr/nemo/wiki/ticket/465_Rivers)

• MISC : add the steric effect (AR5 diagnostics)

• 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

• OBS & ASM : create the 2 chapters

• Annex : update the 4 appendix (from A to D)

update and correct errors in the energetic consistency demonstration

the variable naming rules (namelist variables and structures added) in App.D.

Add the Griffies operator Doc as a apprendix

---

Missing points

• Chap_Model_Basics : addition of generalised coordinate, ALE, z, z*, s and z-tilde (in relation with Appendix A).

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

• ZDF : zdftke : missing the description of new TKE parameters

• SBC and DYN : add a doc on the atmospheric pressure

---

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