Changeset 11435 for NEMO/trunk/doc/latex/NEMO/subfiles/chap_DIU.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_DIU.tex (modified) (6 diffs)

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

@@ -9 +9 @@
 \label{chap:DIU}
 
-\minitoc
+\chaptertoc
 
 
@@ -16 +16 @@
 
 Code to produce an estimate of the diurnal warming and cooling of the sea surface skin
-temperature (skin SST) is found in the DIU directory.  
+temperature (skin SST) is found in the DIU directory.
 The skin temperature can be split into three parts:
 \begin{itemize}
@@ -30 +30 @@
 
 Models are provided for both the warm layer, \mdl{diurnal\_bulk}, and the cool skin, \mdl{cool\_skin}.
-Foundation SST is not considered as it can be obtained either from the main NEMO model
-(\ie from the temperature of the top few model levels) or from some other source.  
+Foundation SST is not considered as it can be obtained either from the main \NEMO\ model
+(\ie\ from the temperature of the top few model levels) or from some other source.
 It must be noted that both the cool skin and warm layer models produce estimates of the change in temperature
 ($\Delta T_{\mathrm{cs}}$ and $\Delta T_{\mathrm{wl}}$) and
 both must be added to a foundation SST to obtain the true skin temperature.
 
-Both the cool skin and warm layer models are controlled through the namelist \ngn{namdiu}:
+Both the cool skin and warm layer models are controlled through the namelist \nam{diu}:
 
 \nlst{namdiu}
@@ -44 +44 @@
   A logical switch for turning on/off both the cool skin and warm layer.
 \item[\np{ln\_diurnal\_only}]
-  A logical switch which if \forcode{.true.} will run the diurnal model without the other dynamical parts of NEMO.
+  A logical switch which if \forcode{.true.} will run the diurnal model without the other dynamical parts of \NEMO.
   \np{ln\_diurnal\_only} must be \forcode{.false.} if \np{ln\_diurnal} is \forcode{.false.}.
 \end{description}
@@ -53 +53 @@
 Initialisation is through the restart file.
 Specifically the code will expect the presence of the 2-D variable ``Dsst'' to initialise the warm layer.
-The cool skin model, which is determined purely by the instantaneous fluxes, has no initialisation variable.  
+The cool skin model, which is determined purely by the instantaneous fluxes, has no initialisation variable.
 
 %===============================================================
@@ -102 +102 @@
 \end{equation}
 where $\zeta=\frac{D_T}{L}$.  It is clear that the first derivative of (\autoref{eq:stab_func_eqn}),
-and thus of (\autoref{eq:ecmwf1}), is discontinuous at $\zeta=0$ (\ie $Q\rightarrow0$ in
+and thus of (\autoref{eq:ecmwf1}), is discontinuous at $\zeta=0$ (\ie\ $Q\rightarrow0$ in
 equation (\autoref{eq:ecmwf2})).