Changeset 11578 for NEMO/trunk/doc/latex/NEMO/subfiles/chap_DIA.tex

Timestamp:

2019-09-19T19:44:36+02:00 (5 years ago)

Author:

nicolasmartin

Message:

New LaTeX commands \nam and \np to mention namelist content (step 2)
So far so good, the manual compiles successfully 4 times and everything seems in its right place

File:

• NEMO/trunk/doc/latex/NEMO/subfiles/chap_DIA.tex (modified) (10 diffs)

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

@@ -1323 +1323 @@
 
 Some metadata that may significantly increase the file size (horizontal cell areas and vertices) are controlled by
-the namelist parameter \np{ln_cfmeta}{ln\_cfmeta} in the \nam{run} namelist.
+the namelist parameter \np{ln_cfmeta}{ln\_cfmeta} in the \nam{run}{run} namelist.
 This must be set to true if these metadata are to be included in the output files.
 
@@ -1345 +1345 @@
 most analysis codes can be relinked simply with the new libraries and will then read both NetCDF3 and NetCDF4 files.
 \NEMO\ executables linked with NetCDF4 libraries can be made to produce NetCDF3 files by
-setting the \np{ln_nc4zip}{ln\_nc4zip} logical to false in the \nam{nc4} namelist:
+setting the \np{ln_nc4zip}{ln\_nc4zip} logical to false in the \nam{nc4}{nc4} namelist:
 
 %------------------------------------------namnc4----------------------------------------------------
@@ -1438 +1438 @@
 
 When \key{iomput} is activated with \key{netcdf4} chunking and compression parameters for fields produced via
-\rou{iom\_put} calls are set via an equivalent and identically named namelist to \nam{nc4} in
+\rou{iom\_put} calls are set via an equivalent and identically named namelist to \nam{nc4}{nc4} in
 \textit{xmlio\_server.def}.
-Typically this namelist serves the mean files whilst the \nam{nc4} in the main namelist file continues to
+Typically this namelist serves the mean files whilst the \nam{nc4}{nc4} in the main namelist file continues to
 serve the restart files.
 This duplication is unfortunate but appropriate since, if using io\_servers, the domain sizes of
@@ -1449 +1449 @@
 %       Tracer/Dynamics Trends
 % -------------------------------------------------------------------------------------------------------------
-\section[Tracer/Dynamics trends (\forcode{&namtrd})]{Tracer/Dynamics trends (\protect\nam{trd})}
+\section[Tracer/Dynamics trends (\forcode{&namtrd})]{Tracer/Dynamics trends (\protect\nam{trd}{trd})}
 \label{sec:DIA_trd}
 
@@ -1464 +1464 @@
 \mdl{trddyn} and/or \mdl{trdtra} modules (see TRD directory) just after their computation
 (\ie\ at the end of each \textit{dyn....F90} and/or \textit{tra....F90} routines).
-This capability is controlled by options offered in \nam{trd} namelist.
+This capability is controlled by options offered in \nam{trd}{trd} namelist.
 Note that the output are done with XIOS, and therefore the \key{iomput} is required.
 
-What is done depends on the \nam{trd} logical set to \forcode{.true.}:
+What is done depends on the \nam{trd}{trd} logical set to \forcode{.true.}:
 
 \begin{description}
@@ -1513 +1513 @@
 The on-line computation of floats advected either by the three dimensional velocity field or constraint to
 remain at a given depth ($w = 0$ in the computation) have been introduced in the system during the CLIPPER project.
-Options are defined by \nam{flo} namelist variables.
+Options are defined by \nam{flo}{flo} namelist variables.
 The algorithm used is based either on the work of \cite{blanke.raynaud_JPO97} (default option),
 or on a $4^th$ Runge-Hutta algorithm (\np{ln_flork4}{ln\_flork4}\forcode{=.true.}).
@@ -1572 +1572 @@
 } \\
 
-\np{jpnfl} is the total number of floats during the run.
+\np{jpnfl}{jpnfl} is the total number of floats during the run.
 When initial positions are read in a restart file (\np{ln_rstflo}{ln\_rstflo}\forcode{=.true.} ),
-\np{jpnflnewflo} can be added in the initialization file.
+\np{jpnflnewflo}{jpnflnewflo} can be added in the initialization file.
 
 \subsubsection{Output data}
@@ -1631 +1631 @@
 % - \np{nb_ana}{nb\_ana}     is the number of harmonics to analyse
 
- - \np{tname}       is an array with names of tidal constituents to analyse
-
- \np{nit000_han}{nit000\_han} and \np{nitend_han}{nitend\_han} must be between \np{nit000} and \np{nitend} of the simulation.
+ - \np{tname}{tname}       is an array with names of tidal constituents to analyse
+
+ \np{nit000_han}{nit000\_han} and \np{nitend_han}{nitend\_han} must be between \np{nit000}{nit000} and \np{nitend}{nitend} of the simulation.
  The restart capability is not implemented.
 
@@ -2035 +2035 @@
 
 In \mdl{diaptr} when \np{ln_diaptr}{ln\_diaptr}\forcode{=.true.}
-(see the \nam{ptr} namelist below) can be computed on-line the poleward heat and salt transports,
+(see the \nam{ptr}{ptr} namelist below) can be computed on-line the poleward heat and salt transports,
 their advective and diffusive component, and the meriodional stream function .
 When \np{ln_subbas}{ln\_subbas}\forcode{=.true.}, transports and stream function are computed for the Atlantic, Indian,
@@ -2109 +2109 @@
 Values greater than 1 indicate that information is propagated across more than one grid cell in a single time step.
 
-The variables can be activated by setting the \np{nn_diacfl}{nn\_diacfl} namelist parameter to 1 in the \nam{ctl} namelist.
+The variables can be activated by setting the \np{nn_diacfl}{nn\_diacfl} namelist parameter to 1 in the \nam{ctl}{ctl} namelist.
 The diagnostics will be written out to an ascii file named cfl\_diagnostics.ascii.
 In this file the maximum value of $C_u$, $C_v$, and $C_w$ are printed at each timestep along with the coordinates of