Changeset 11582 for NEMO/trunk/doc/latex/NEMO/subfiles/apdx_DOMAINcfg.tex

Timestamp:

2019-09-20T11:44:31+02:00 (5 years ago)

Author:

nicolasmartin

Message:

New LaTeX commands \nam and \np to mention namelist content (step 2)
Finally convert \forcode{...} following \np{}{} into optional arg of the new command \np[]{}{}

File:

• NEMO/trunk/doc/latex/NEMO/subfiles/apdx_DOMAINcfg.tex (modified) (11 diffs)

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

@@ -1 +1 @@
 \documentclass[../main/NEMO_manual]{subfiles}
+
+\onlyinsubfile{\makeindex}
 
 \begin{document}
@@ -55 +57 @@
 
 \begin{description}
- \item[\np{jphgr_mesh}{jphgr\_mesh}=0]  The most general curvilinear orthogonal grids.
+ \item[{\np{jphgr_mesh}{jphgr\_mesh}=0}]  The most general curvilinear orthogonal grids.
   The coordinates and their first derivatives with respect to $i$ and $j$ are provided
   in a input file (\ifile{coordinates}), read in \rou{hgr\_read} subroutine of the domhgr module.
   This is now the only option available within \NEMO\ itself from v4.0 onwards.
-\item[\np{jphgr_mesh}{jphgr\_mesh}=1 to 5] A few simple analytical grids are provided (see below).
+\item[{\np{jphgr_mesh}{jphgr\_mesh}=1 to 5}] A few simple analytical grids are provided (see below).
   For other analytical grids, the \mdl{domhgr} module (\texttt{DOMAINcfg} variant) must be
   modified by the user. In most cases, modifying the \mdl{usrdef\_hgr} module of \NEMO\ is
@@ -136 +138 @@
 
 It is possible to define a simple regular vertical grid by giving zero stretching
-(\np{ppacr}{ppacr}\forcode{ = 0}).  In that case, the parameters \jp{jpk} (number of $w$-levels)
+(\np[=0]{ppacr}{ppacr}).  In that case, the parameters \jp{jpk} (number of $w$-levels)
 and \np{pphmax}{pphmax} (total ocean depth in meters) fully define the grid.
 
@@ -152 +154 @@
 top and bottom with a smooth hyperbolic tangent transition in between (\autoref{fig:DOMCFG_zgr}).
 
-A double hyperbolic tangent version (\np{ldbletanh}{ldbletanh}\forcode{ = .true.}) is also available
+A double hyperbolic tangent version (\np[=.true.]{ldbletanh}{ldbletanh}) is also available
 which permits finer control and is used, typically, to obtain a well resolved upper ocean
 without compromising on resolution at depth using a moderate number of levels.
@@ -170 +172 @@
 \end{gather}
 
-If the ice shelf cavities are opened (\np{ln_isfcav}{ln\_isfcav}\forcode{ = .true.}), the definition
+If the ice shelf cavities are opened (\np[=.true.]{ln_isfcav}{ln\_isfcav}), the definition
 of $z_0$ is the same.  However, definition of $e_3^0$ at $t$- and $w$-points is
 respectively changed to:
@@ -314 +316 @@
 \np{nn_bathy}{nn\_bathy} (found in \nam{dom}{dom} namelist (\texttt{DOMAINCFG} variant) ):
 \begin{description}
-\item[\np{nn_bathy}{nn\_bathy}\forcode{ = 0}]:
+\item[{\np[=0]{nn_bathy}{nn\_bathy}}]:
   a flat-bottom domain is defined.
   The total depth $z_w (jpk)$ is given by the coordinate transformation.
   The domain can either be a closed basin or a periodic channel depending on the parameter \np{jperio}{jperio}.
-\item[\np{nn_bathy}{nn\_bathy}\forcode{ = -1}]:
+\item[{\np[=-1]{nn_bathy}{nn\_bathy}}]:
   a domain with a bump of topography one third of the domain width at the central latitude.
   This is meant for the "EEL-R5" configuration, a periodic or open boundary channel with a seamount.
-\item[\np{nn_bathy}{nn\_bathy}\forcode{ = 1}]:
+\item[{\np[=1]{nn_bathy}{nn\_bathy}}]:
   read a bathymetry and ice shelf draft (if needed).
   The \ifile{bathy\_meter} file (Netcdf format) provides the ocean depth (positive, in meters) at
@@ -332 +334 @@
   The \ifile{isfdraft\_meter} file (Netcdf format) provides the ice shelf draft (positive, in meters) at
   each grid point of the model grid.
-  This file is only needed if \np{ln_isfcav}{ln\_isfcav}\forcode{ = .true.}.
+  This file is only needed if \np[=.true.]{ln_isfcav}{ln\_isfcav}.
   Defining the ice shelf draft will also define the ice shelf edge and the grounding line position.
 \end{description}
@@ -412 +414 @@
 %--------------------------------------------------------------------------------------------------------------
 Options are defined in \nam{zgr_sco}{zgr\_sco} (\texttt{DOMAINcfg} only).
-In $s$-coordinate (\np{ln_sco}{ln\_sco}\forcode{ = .true.}), the depth and thickness of the model levels are defined from
+In $s$-coordinate (\np[=.true.]{ln_sco}{ln\_sco}), the depth and thickness of the model levels are defined from
 the product of a depth field and either a stretching function or its derivative, respectively:
 
@@ -435 +437 @@
 
 The original default \NEMO\ s-coordinate stretching is available if neither of the other options are specified as true
-(\np{ln_s_SH94}{ln\_s\_SH94}\forcode{ = .false.} and \np{ln_s_SF12}{ln\_s\_SF12}\forcode{ = .false.}).
+(\np[=.false.]{ln_s_SH94}{ln\_s\_SH94} and \np[=.false.]{ln_s_SF12}{ln\_s\_SF12}).
 This uses a depth independent $\tanh$ function for the stretching \citep{madec.delecluse.ea_JPO96}:
 
@@ -455 +457 @@
 
 A stretching function,
-modified from the commonly used \citet{song.haidvogel_JCP94} stretching (\np{ln_s_SH94}{ln\_s\_SH94}\forcode{ = .true.}),
+modified from the commonly used \citet{song.haidvogel_JCP94} stretching (\np[=.true.]{ln_s_SH94}{ln\_s\_SH94}),
 is also available and is more commonly used for shelf seas modelling:
 
@@ -558 +560 @@
 This option is described in the Report by Levier \textit{et al.} (2007), available on the \NEMO\ web site.
 
-\biblio
-
-\pindex
+\onlyinsubfile{\bibliography{../main/bibliography}}
+
+\onlyinsubfile{\printindex}
 
 \end{document}