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

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

@@ -335 +335 @@
 
 Two typical methods are available to specify the spatial domain configuration;
-they can be selected using parameter \np{ln_read_cfg}{ln\_read\_cfg} parameter in namelist \nam{cfg}.
+they can be selected using parameter \np{ln_read_cfg}{ln\_read\_cfg} parameter in namelist \nam{cfg}{cfg}.
 
 If \np{ln_read_cfg}{ln\_read\_cfg} is set to \forcode{.true.},
 the domain-specific parameters and fields are read from a netCDF input file,
-whose name (without its .nc suffix) can be specified as the value of the \np{cn_domcfg}{cn\_domcfg} parameter in namelist \nam{cfg}.
+whose name (without its .nc suffix) can be specified as the value of the \np{cn_domcfg}{cn\_domcfg} parameter in namelist \nam{cfg}{cfg}.
 
 If \np{ln_read_cfg}{ln\_read\_cfg} is set to \forcode{.false.},
@@ -502 +502 @@
 a single configuration file can support both options.
 
-By default a non-linear free surface is used (\np{ln_linssh}{ln\_linssh} set to \forcode{=.false.} in \nam{dom}):
+By default a non-linear free surface is used (\np{ln_linssh}{ln\_linssh} set to \forcode{=.false.} in \nam{dom}{dom}):
 the coordinate follow the time-variation of the free surface so that the transformation is time dependent:
 $z(i,j,k,t)$ (\eg\ \autoref{fig:DOM_z_zps_s_sps}f).
-When a linear free surface is assumed (\np{ln_linssh}{ln\_linssh} set to \forcode{=.true.} in \nam{dom}),
+When a linear free surface is assumed (\np{ln_linssh}{ln\_linssh} set to \forcode{=.true.} in \nam{dom}{dom}),
 the vertical coordinates are fixed in time, but the seawater can move up and down across the $z_0$ surface
 (in other words, the top of the ocean in not a rigid lid).
@@ -652 +652 @@
 (grid-point position, scale factors)
 can be saved in a file if
-namelist parameter \np{ln_write_cfg}{ln\_write\_cfg} (namelist \nam{cfg}) is set to \forcode{.true.};
+namelist parameter \np{ln_write_cfg}{ln\_write\_cfg} (namelist \nam{cfg}{cfg}) is set to \forcode{.true.};
 the output filename is set through parameter \np{cn_domcfg_out}{cn\_domcfg\_out}.
 This is only really useful if
@@ -661 +661 @@
 (grid-point position, scale factors, depths and masks)
 can be saved in a file called \texttt{mesh\_mask} if
-namelist parameter \np{ln_meshmask}{ln\_meshmask} (namelist \nam{dom}) is set to \forcode{.true.}.
+namelist parameter \np{ln_meshmask}{ln\_meshmask} (namelist \nam{dom}{dom}) is set to \forcode{.true.}.
 This file contains additional fields that can be useful for post-processing applications.
 
@@ -677 +677 @@
 %------------------------------------------------------------------------------------------
 
-Basic initial state options are defined in \nam{tsd}.
+Basic initial state options are defined in \nam{tsd}{tsd}.
 By default, the ocean starts from rest (the velocity field is set to zero) and
 the initialization of temperature and salinity fields is controlled through the \np{ln_tsd_init}{ln\_tsd\_init} namelist parameter.