Changeset 11435 for NEMO/trunk/doc/latex/NEMO/subfiles/chap_ASM.tex

Timestamp:

2019-08-14T14:45:08+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Various corrections on chapters

Cleaning the indexes by fixing/removing wrong entries (or appending a ? to unknown items) and
improve the classification with new index definitions for CPP keys and namelist blocks:

• from \key{...} cmd, key_ prefix no longer precedes the index entry
• namelist block declaration moves from \ngn{nam...} to \nam{...} (i.e. \ngn{namtra\_ldf} -> \nam{tra\_ldf}) The expected prefix nam is added to the printed word but not the index entry.

Now we have indexes with a better sorting instead of all CPP keys under 'K' and namelists blocks under 'N'.

Fix missing space issues with alias commands by adding a trailing backslash (\NEMO\, \ie\, \eg\, ...).
There is no perfect solution for this, and I prefer not using a particular package to solve it.

Review the initial LaTeX code snippet for the historic changes in chapters

Finally, for readability and future diff visualisations, please avoid writing paragraphs with continuous lines.
Break the lines around 80 to 100 characters long

File:

• NEMO/trunk/doc/latex/NEMO/subfiles/chap_ASM.tex (modified) (6 diffs)

NEMO/trunk/doc/latex/NEMO/subfiles/chap_ASM.tex

@@ -8 +8 @@
 \label{chap:ASM}
 
-\minitoc
+\chaptertoc
 
 \vfill
@@ -15 +15 @@
 \begin{tabular}{l||l|m{0.65\linewidth}}
     Release   & Author        & Modifications \\
-    {\em 4.0} & {\em D. J. Lea} & {\em \NEMO 4.0 updates}  \\
+    {\em 4.0} & {\em D. J. Lea} & {\em \NEMO\ 4.0 updates}  \\
     {\em 3.4} & {\em D. J. Lea, M. Martin, K. Mogensen, A. Weaver} & {\em Initial version}  \\
 \end{tabular}
@@ -26 +26 @@
 These are read into the model from a NetCDF file which may be produced by separate data assimilation code.
 The code can also output model background fields which are used as an input to data assimilation code.
-This is all controlled by the namelist \textit{\ngn{nam\_asminc} }.
+This is all controlled by the namelist \nam{\_asminc}.
 There is a brief description of all the namelist options provided.
 To build the ASM code \key{asminc} must be set.
@@ -101 +101 @@
 
 It is quite challenging for data assimilation systems to provide non-divergent velocity increments.
-Applying divergent velocity increments will likely cause spurious vertical velocities in the model. This section describes a method to take velocity increments provided to \NEMO ($u^0_I$ and $v^0_I$) and adjust them by the iterative application of a divergence damping operator. The method is also described in \citet{dobricic.pinardi.ea_OS07}.
+Applying divergent velocity increments will likely cause spurious vertical velocities in the model. This section describes a method to take velocity increments provided to \NEMO\ ($u^0_I$ and $v^0_I$) and adjust them by the iterative application of a divergence damping operator. The method is also described in \citet{dobricic.pinardi.ea_OS07}.
 
 In iteration step $n$ (starting at $n=1$) new estimates of velocity increments $u^{n}_I$ and $v^{n}_I$ are updated by:
@@ -134 +134 @@
 \citep{talagrand_JAS72, dobricic.pinardi.ea_OS07}.
 Diffusion coefficients are defined as $A_D = \alpha e_{1t} e_{2t}$, where $\alpha = 0.2$.
-The divergence damping is activated by assigning to \np{nn\_divdmp} in the \textit{nam\_asminc} namelist
+The divergence damping is activated by assigning to \np{nn\_divdmp} in the \nam{\_asminc} namelist
 a value greater than zero.
 This specifies the number of iterations of the divergence damping. Setting a value of the order of 100 will result in a significant reduction in the vertical velocity induced by the increments.
@@ -144 +144 @@
 \label{sec:ASM_details}
 
-Here we show an example \ngn{nam\_asminc} namelist and the header of an example assimilation increments file on
+Here we show an example \nam{\_asminc} namelist and the header of an example assimilation increments file on
 the ORCA2 grid.