Changeset 11582 for NEMO/trunk/doc/latex/NEMO/subfiles/chap_DOM.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/chap_DOM.tex (modified) (7 diffs)

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

@@ -1 +1 @@
 \documentclass[../main/NEMO_manual]{subfiles}
+
+\onlyinsubfile{\makeindex}
 
 \begin{document}
@@ -487 +489 @@
     (d) hybrid $s-z$ coordinate,
     (e) hybrid $s-z$ coordinate with partial step, and
-    (f) same as (e) but in the non-linear free surface (\protect\np{ln_linssh}{ln\_linssh}\forcode{=.false.}).
+    (f) same as (e) but in the non-linear free surface (\protect\np[=.false.]{ln_linssh}{ln\_linssh}).
     Note that the non-linear free surface can be used with any of the 5 coordinates (a) to (e).}
   \label{fig:DOM_z_zps_s_sps}
@@ -524 +526 @@
 
 \begin{itemize}
-\item $z$-coordinate with full step bathymetry (\np{ln_zco}{ln\_zco}\forcode{=.true.}),
-\item $z$-coordinate with partial step ($zps$) bathymetry (\np{ln_zps}{ln\_zps}\forcode{=.true.}),
-\item Generalized, $s$-coordinate (\np{ln_sco}{ln\_sco}\forcode{=.true.}).
+\item $z$-coordinate with full step bathymetry (\np[=.true.]{ln_zco}{ln\_zco}),
+\item $z$-coordinate with partial step ($zps$) bathymetry (\np[=.true.]{ln_zps}{ln\_zps}),
+\item Generalized, $s$-coordinate (\np[=.true.]{ln_sco}{ln\_sco}).
 \end{itemize}
 
@@ -544 +546 @@
 They are updated at each model time step.
 The initial fixed reference coordinate system is held in variable names with a $\_0$ suffix.
-When the linear free surface option is used (\np{ln_linssh}{ln\_linssh}\forcode{=.true.}),
+When the linear free surface option is used (\np[=.true.]{ln_linssh}{ln\_linssh}),
 \textit{before}, \textit{now} and \textit{after} arrays are initially set to
 their reference counterpart and remain fixed.
@@ -682 +684 @@
 
 \begin{description}
-\item[\np{ln_tsd_init}{ln\_tsd\_init}\forcode{= .true.}]
+\item[{\np[=.true.]{ln_tsd_init}{ln\_tsd\_init}}]
   Use T and S input files that can be given on the model grid itself or on their native input data grids.
   In the latter case, the data will be interpolated on-the-fly both in the horizontal and the vertical to the model grid
@@ -688 +690 @@
   The information relating to the input files are specified in the \np{sn_tem}{sn\_tem} and \np{sn_sal}{sn\_sal} structures.
   The computation is done in the \mdl{dtatsd} module.
-\item[\np{ln_tsd_init}{ln\_tsd\_init}\forcode{= .false.}]
+\item[{\np[=.false.]{ln_tsd_init}{ln\_tsd\_init}}]
   Initial values for T and S are set via a user supplied \rou{usr\_def\_istate} routine contained in \mdl{userdef\_istate}.
   The default version sets horizontally uniform T and profiles as used in the GYRE configuration
@@ -694 +696 @@
 \end{description}
 
-\biblio
-
-\pindex
+\onlyinsubfile{\bibliography{../main/bibliography}}
+
+\onlyinsubfile{\printindex}
 
 \end{document}