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

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

@@ -1 +1 @@
 \documentclass[../main/NEMO_manual]{subfiles}
+
+\onlyinsubfile{\makeindex}
 
 \begin{document}
@@ -55 +57 @@
 
 The user has the option of extracting each tendency term on the RHS of the tracer equation for output
-(\np{ln_tra_trd}{ln\_tra\_trd} or \np{ln_tra_mxl}{ln\_tra\_mxl}\forcode{=.true.}), as described in \autoref{chap:DIA}.
+(\np{ln_tra_trd}{ln\_tra\_trd} or \np[=.true.]{ln_tra_mxl}{ln\_tra\_mxl}), as described in \autoref{chap:DIA}.
 
 % ================================================================
@@ -85 +87 @@
 Indeed, it is obtained by using the following equality: $\nabla \cdot (\vect U \, T) = \vect U \cdot \nabla T$ which
 results from the use of the continuity equation, $\partial_t e_3 + e_3 \; \nabla \cdot \vect U = 0$
-(which reduces to $\nabla \cdot \vect U = 0$ in linear free surface, \ie\ \np{ln_linssh}{ln\_linssh}\forcode{=.true.}).
+(which reduces to $\nabla \cdot \vect U = 0$ in linear free surface, \ie\ \np[=.true.]{ln_linssh}{ln\_linssh}).
 Therefore it is of paramount importance to design the discrete analogue of the advection tendency so that
 it is consistent with the continuity equation in order to enforce the conservation properties of
@@ -121 +123 @@
 \begin{description}
 \item[linear free surface:]
-  (\np{ln_linssh}{ln\_linssh}\forcode{=.true.})
+  (\np[=.true.]{ln_linssh}{ln\_linssh})
   the first level thickness is constant in time:
   the vertical boundary condition is applied at the fixed surface $z = 0$ rather than on
@@ -129 +131 @@
   the first level tracer value.
 \item[non-linear free surface:]
-  (\np{ln_linssh}{ln\_linssh}\forcode{=.false.})
+  (\np[=.false.]{ln_linssh}{ln\_linssh})
   convergence/divergence in the first ocean level moves the free surface up/down.
   There is no tracer advection through it so that the advective fluxes through the surface are also zero.
@@ -190 +192 @@
 %        2nd order centred scheme
 
-The centred advection scheme (CEN) is used when \np{ln_traadv_cen}{ln\_traadv\_cen}\forcode{=.true.}.
+The centred advection scheme (CEN) is used when \np[=.true.]{ln_traadv_cen}{ln\_traadv\_cen}.
 Its order ($2^{nd}$ or $4^{th}$) can be chosen independently on horizontal (iso-level) and vertical direction by
 setting \np{nn_cen_h}{nn\_cen\_h} and \np{nn_cen_v}{nn\_cen\_v} to $2$ or $4$.
@@ -222 +224 @@
   \tau_u^{cen4} = \overline{T - \frac{1}{6} \, \delta_i \Big[ \delta_{i + 1/2}[T] \, \Big]}^{\,i + 1/2}
 \end{equation}
-In the vertical direction (\np{nn_cen_v}{nn\_cen\_v}\forcode{=4}),
+In the vertical direction (\np[=4]{nn_cen_v}{nn\_cen\_v}),
 a $4^{th}$ COMPACT interpolation has been prefered \citep{demange_phd14}.
 In the COMPACT scheme, both the field and its derivative are interpolated, which leads, after a matrix inversion,
@@ -255 +257 @@
 \label{subsec:TRA_adv_tvd}
 
-The Flux Corrected Transport schemes (FCT) is used when \np{ln_traadv_fct}{ln\_traadv\_fct}\forcode{=.true.}.
+The Flux Corrected Transport schemes (FCT) is used when \np[=.true.]{ln_traadv_fct}{ln\_traadv\_fct}.
 Its order ($2^{nd}$ or $4^{th}$) can be chosen independently on horizontal (iso-level) and vertical direction by
 setting \np{nn_fct_h}{nn\_fct\_h} and \np{nn_fct_v}{nn\_fct\_v} to $2$ or $4$.
@@ -298 +300 @@
 \label{subsec:TRA_adv_mus}
 
-The Monotone Upstream Scheme for Conservative Laws (MUSCL) is used when \np{ln_traadv_mus}{ln\_traadv\_mus}\forcode{=.true.}.
+The Monotone Upstream Scheme for Conservative Laws (MUSCL) is used when \np[=.true.]{ln_traadv_mus}{ln\_traadv\_mus}.
 MUSCL implementation can be found in the \mdl{traadv\_mus} module.
 
@@ -326 +328 @@
 This choice ensure the \textit{positive} character of the scheme.
 In addition, fluxes round a grid-point where a runoff is applied can optionally be computed using upstream fluxes
-(\np{ln_mus_ups}{ln\_mus\_ups}\forcode{=.true.}).
+(\np[=.true.]{ln_mus_ups}{ln\_mus\_ups}).
 
 % -------------------------------------------------------------------------------------------------------------
@@ -334 +336 @@
 \label{subsec:TRA_adv_ubs}
 
-The Upstream-Biased Scheme (UBS) is used when \np{ln_traadv_ubs}{ln\_traadv\_ubs}\forcode{=.true.}.
+The Upstream-Biased Scheme (UBS) is used when \np[=.true.]{ln_traadv_ubs}{ln\_traadv\_ubs}.
 UBS implementation can be found in the \mdl{traadv\_mus} module.
 
@@ -364 +366 @@
 \citep{shchepetkin.mcwilliams_OM05, demange_phd14}.
 Therefore the vertical flux is evaluated using either a $2^nd$ order FCT scheme or a $4^th$ order COMPACT scheme
-(\np{nn_ubs_v}{nn\_ubs\_v}\forcode{=2 or 4}).
+(\np[=2 or 4]{nn_ubs_v}{nn\_ubs\_v}).
 
 For stability reasons (see \autoref{chap:TD}), the first term  in \autoref{eq:TRA_adv_ubs}
@@ -407 +409 @@
 
 The Quadratic Upstream Interpolation for Convective Kinematics with Estimated Streaming Terms (QUICKEST) scheme
-proposed by \citet{leonard_CMAME79} is used when \np{ln_traadv_qck}{ln\_traadv\_qck}\forcode{=.true.}.
+proposed by \citet{leonard_CMAME79} is used when \np[=.true.]{ln_traadv_qck}{ln\_traadv\_qck}.
 QUICKEST implementation can be found in the \mdl{traadv\_qck} module.
 
@@ -452 +454 @@
 except for the pure vertical component that appears when a rotation tensor is used.
 This latter component is solved implicitly together with the vertical diffusion term (see \autoref{chap:TD}).
-When \np{ln_traldf_msc}{ln\_traldf\_msc}\forcode{=.true.}, a Method of Stabilizing Correction is used in which
+When \np[=.true.]{ln_traldf_msc}{ln\_traldf\_msc}, a Method of Stabilizing Correction is used in which
 the pure vertical component is split into an explicit and an implicit part \citep{lemarie.debreu.ea_OM12}.
 
@@ -464 +466 @@
 
 \begin{description}
-\item[\np{ln_traldf_OFF}{ln\_traldf\_OFF}\forcode{=.true.}:]
+\item[{\np[=.true.]{ln_traldf_OFF}{ln\_traldf\_OFF}}]
   no operator selected, the lateral diffusive tendency will not be applied to the tracer equation.
   This option can be used when the selected advection scheme is diffusive enough (MUSCL scheme for example).
-\item[\np{ln_traldf_lap}{ln\_traldf\_lap}\forcode{=.true.}:]
+\item[{\np[=.true.]{ln_traldf_lap}{ln\_traldf\_lap}}]
   a laplacian operator is selected.
   This harmonic operator takes the following expression:  $\mathcal{L}(T) = \nabla \cdot A_{ht} \; \nabla T $,
   where the gradient operates along the selected direction (see \autoref{subsec:TRA_ldf_dir}),
   and $A_{ht}$ is the eddy diffusivity coefficient expressed in $m^2/s$ (see \autoref{chap:LDF}).
-\item[\np{ln_traldf_blp}{ln\_traldf\_blp}\forcode{=.true.}]:
+\item[{\np[=.true.]{ln_traldf_blp}{ln\_traldf\_blp}}]:
   a bilaplacian operator is selected.
   This biharmonic operator takes the following expression:
@@ -497 +499 @@
 The choice of a direction of action determines the form of operator used.
 The operator is a simple (re-entrant) laplacian acting in the (\textbf{i},\textbf{j}) plane when
-iso-level option is used (\np{ln_traldf_lev}{ln\_traldf\_lev}\forcode{=.true.}) or
+iso-level option is used (\np[=.true.]{ln_traldf_lev}{ln\_traldf\_lev}) or
 when a horizontal (\ie\ geopotential) operator is demanded in \textit{z}-coordinate
-(\np{ln_traldf_hor}{ln\_traldf\_hor} and \np{ln_zco}{ln\_zco}\forcode{=.true.}).
+(\np{ln_traldf_hor}{ln\_traldf\_hor} and \np[=.true.]{ln_zco}{ln\_zco}).
 The associated code can be found in the \mdl{traldf\_lap\_blp} module.
 The operator is a rotated (re-entrant) laplacian when
@@ -536 +538 @@
 It is a \textit{horizontal} operator (\ie acting along geopotential surfaces) in
 the $z$-coordinate with or without partial steps, but is simply an iso-level operator in the $s$-coordinate.
-It is thus used when, in addition to \np{ln_traldf_lap}{ln\_traldf\_lap} or \np{ln_traldf_blp}{ln\_traldf\_blp}\forcode{=.true.},
-we have \np{ln_traldf_lev}{ln\_traldf\_lev}\forcode{=.true.} or \np{ln_traldf_hor}{ln\_traldf\_hor}~=~\np{ln_zco}{ln\_zco}\forcode{=.true.}.
+It is thus used when, in addition to \np{ln_traldf_lap}{ln\_traldf\_lap} or \np[=.true.]{ln_traldf_blp}{ln\_traldf\_blp},
+we have \np[=.true.]{ln_traldf_lev}{ln\_traldf\_lev} or \np{ln_traldf_hor}{ln\_traldf\_hor}~=~\np[=.true.]{ln_zco}{ln\_zco}.
 In both cases, it significantly contributes to diapycnal mixing.
 It is therefore never recommended, even when using it in the bilaplacian case.
 
-Note that in the partial step $z$-coordinate (\np{ln_zps}{ln\_zps}\forcode{=.true.}),
+Note that in the partial step $z$-coordinate (\np[=.true.]{ln_zps}{ln\_zps}),
 tracers in horizontally adjacent cells are located at different depths in the vicinity of the bottom.
 In this case, horizontal derivatives in (\autoref{eq:TRA_ldf_lap}) at the bottom level require a specific treatment.
@@ -573 +575 @@
 $r_1$ and $r_2$ are the slopes between the surface of computation ($z$- or $s$-surfaces) and
 the surface along which the diffusion operator acts (\ie\ horizontal or iso-neutral surfaces).
-It is thus used when, in addition to \np{ln_traldf_lap}{ln\_traldf\_lap}\forcode{=.true.},
-we have \np{ln_traldf_iso}{ln\_traldf\_iso}\forcode{=.true.},
-or both \np{ln_traldf_hor}{ln\_traldf\_hor}\forcode{=.true.} and \np{ln_zco}{ln\_zco}\forcode{=.true.}.
+It is thus used when, in addition to \np[=.true.]{ln_traldf_lap}{ln\_traldf\_lap},
+we have \np[=.true.]{ln_traldf_iso}{ln\_traldf\_iso},
+or both \np[=.true.]{ln_traldf_hor}{ln\_traldf\_hor} and \np[=.true.]{ln_zco}{ln\_zco}.
 The way these slopes are evaluated is given in \autoref{sec:LDF_slp}.
 At the surface, bottom and lateral boundaries, the turbulent fluxes of heat and salt are set to zero using
@@ -591 +593 @@
 any additional background horizontal diffusion \citep{guilyardi.madec.ea_CD01}.
 
-Note that in the partial step $z$-coordinate (\np{ln_zps}{ln\_zps}\forcode{=.true.}),
+Note that in the partial step $z$-coordinate (\np[=.true.]{ln_zps}{ln\_zps}),
 the horizontal derivatives at the bottom level in \autoref{eq:TRA_ldf_iso} require a specific treatment.
 They are calculated in module zpshde, described in \autoref{sec:TRA_zpshde}.
@@ -601 +603 @@
 
 An alternative scheme developed by \cite{griffies.gnanadesikan.ea_JPO98} which ensures tracer variance decreases
-is also available in \NEMO\ (\np{ln_traldf_triad}{ln\_traldf\_triad}\forcode{=.true.}).
+is also available in \NEMO\ (\np[=.true.]{ln_traldf_triad}{ln\_traldf\_triad}).
 A complete description of the algorithm is given in \autoref{apdx:TRIADS}.
 
@@ -647 +649 @@
 respectively.
 Generally, $A_w^{vT} = A_w^{vS}$ except when double diffusive mixing is parameterised
-(\ie\ \np{ln_zdfddm}{ln\_zdfddm}\forcode{=.true.},).
+(\ie\ \np[=.true.]{ln_zdfddm}{ln\_zdfddm},).
 The way these coefficients are evaluated is given in \autoref{chap:ZDF} (ZDF).
 Furthermore, when iso-neutral mixing is used, both mixing coefficients are increased by
@@ -722 +724 @@
 Such time averaging prevents the divergence of odd and even time step (see \autoref{chap:TD}).
 
-In the linear free surface case (\np{ln_linssh}{ln\_linssh}\forcode{=.true.}), an additional term has to be added on
+In the linear free surface case (\np[=.true.]{ln_linssh}{ln\_linssh}), an additional term has to be added on
 both temperature and salinity.
 On temperature, this term remove the heat content associated with mass exchange that has been added to $Q_{ns}$.
@@ -757 +759 @@
 
 Options are defined through the \nam{tra_qsr}{tra\_qsr} namelist variables.
-When the penetrative solar radiation option is used (\np{ln_traqsr}{ln\_traqsr}\forcode{=.true.}),
+When the penetrative solar radiation option is used (\np[=.true.]{ln_traqsr}{ln\_traqsr}),
 the solar radiation penetrates the top few tens of meters of the ocean.
-If it is not used (\np{ln_traqsr}{ln\_traqsr}\forcode{=.false.}) all the heat flux is absorbed in the first ocean level.
+If it is not used (\np[=.false.]{ln_traqsr}{ln\_traqsr}) all the heat flux is absorbed in the first ocean level.
 Thus, in the former case a term is added to the time evolution equation of temperature \autoref{eq:MB_PE_tra_T} and
 the surface boundary condition is modified to take into account only the non-penetrative part of the surface
@@ -788 +790 @@
 larger depths where it contributes to local heating.
 The way this second part of the solar energy penetrates into the ocean depends on which formulation is chosen.
-In the simple 2-waveband light penetration scheme (\np{ln_qsr_2bd}{ln\_qsr\_2bd}\forcode{=.true.})
+In the simple 2-waveband light penetration scheme (\np[=.true.]{ln_qsr_2bd}{ln\_qsr\_2bd})
 a chlorophyll-independent monochromatic formulation is chosen for the shorter wavelengths,
 leading to the following expression \citep{paulson.simpson_JPO77}:
@@ -816 +818 @@
 The 2-bands formulation does not reproduce the full model very well.
 
-The RGB formulation is used when \np{ln_qsr_rgb}{ln\_qsr\_rgb}\forcode{=.true.}.
+The RGB formulation is used when \np[=.true.]{ln_qsr_rgb}{ln\_qsr\_rgb}.
 The RGB attenuation coefficients (\ie\ the inverses of the extinction length scales) are tabulated over
 61 nonuniform chlorophyll classes ranging from 0.01 to 10 g.Chl/L
@@ -823 +825 @@
 
 \begin{description}
-\item[\np{nn_chldta}{nn\_chldta}\forcode{=0}]
+\item[{\np[=0]{nn_chldta}{nn\_chldta}}]
   a constant 0.05 g.Chl/L value everywhere ;
-\item[\np{nn_chldta}{nn\_chldta}\forcode{=1}]
+\item[{\np[=1]{nn_chldta}{nn\_chldta}}]
   an observed time varying chlorophyll deduced from satellite surface ocean color measurement spread uniformly in
   the vertical direction;
-\item[\np{nn_chldta}{nn\_chldta}\forcode{=2}]
+\item[{\np[=2]{nn_chldta}{nn\_chldta}}]
   same as previous case except that a vertical profile of chlorophyl is used.
   Following \cite{morel.berthon_LO89}, the profile is computed from the local surface chlorophyll value;
-\item[\np{ln_qsr_bio}{ln\_qsr\_bio}\forcode{=.true.}]
+\item[{\np[=.true.]{ln_qsr_bio}{ln\_qsr\_bio}}]
   simulated time varying chlorophyll by TOP biogeochemical model.
   In this case, the RGB formulation is used to calculate both the phytoplankton light limitation in
@@ -944 +946 @@
 %        Diffusive BBL
 % -------------------------------------------------------------------------------------------------------------
-\subsection[Diffusive bottom boundary layer (\forcode{nn_bbl_ldf=1})]{Diffusive bottom boundary layer (\protect\np{nn_bbl_ldf}{nn\_bbl\_ldf}\forcode{=1})}
+\subsection[Diffusive bottom boundary layer (\forcode{nn_bbl_ldf=1})]{Diffusive bottom boundary layer (\protect\np[=1]{nn_bbl_ldf}{nn\_bbl\_ldf})}
 \label{subsec:TRA_bbl_diff}
 
-When applying sigma-diffusion (\np{ln_trabbl}{ln\_trabbl}\forcode{=.true.} and \np{nn_bbl_ldf}{nn\_bbl\_ldf} set to 1),
+When applying sigma-diffusion (\np[=.true.]{ln_trabbl}{ln\_trabbl} and \np{nn_bbl_ldf}{nn\_bbl\_ldf} set to 1),
 the diffusive flux between two adjacent cells at the ocean floor is given by
 \[
@@ -983 +985 @@
 %        Advective BBL
 % -------------------------------------------------------------------------------------------------------------
-\subsection[Advective bottom boundary layer (\forcode{nn_bbl_adv=1,2})]{Advective bottom boundary layer (\protect\np{nn_bbl_adv}{nn\_bbl\_adv}\forcode{=1,2})}
+\subsection[Advective bottom boundary layer (\forcode{nn_bbl_adv=1,2})]{Advective bottom boundary layer (\protect\np[=1,2]{nn_bbl_adv}{nn\_bbl\_adv})}
 \label{subsec:TRA_bbl_adv}
 
@@ -1014 +1016 @@
 %%%gmcomment   :  this section has to be really written
 
-When applying an advective BBL (\np{nn_bbl_adv}{nn\_bbl\_adv}\forcode{=1..2}), an overturning circulation is added which
+When applying an advective BBL (\np[=1..2]{nn_bbl_adv}{nn\_bbl\_adv}), an overturning circulation is added which
 connects two adjacent bottom grid-points only if dense water overlies less dense water on the slope.
 The density difference causes dense water to move down the slope.
 
-\np{nn_bbl_adv}{nn\_bbl\_adv}\forcode{=1}:
+\np[=1]{nn_bbl_adv}{nn\_bbl\_adv}:
 the downslope velocity is chosen to be the Eulerian ocean velocity just above the topographic step
 (see black arrow in \autoref{fig:TRA_bbl}) \citep{beckmann.doscher_JPO97}.
@@ -1025 +1027 @@
 if the velocity is directed towards greater depth (\ie\ $\vect U \cdot \nabla H > 0$).
 
-\np{nn_bbl_adv}{nn\_bbl\_adv}\forcode{=2}:
+\np[=2]{nn_bbl_adv}{nn\_bbl\_adv}:
 the downslope velocity is chosen to be proportional to $\Delta \rho$,
 the density difference between the higher cell and lower cell densities \citep{campin.goosse_T99}.
@@ -1153 +1155 @@
 (\ie\ fluxes plus content in mass exchanges).
 $\gamma$ is initialized as \np{rn_atfp}{rn\_atfp} (\textbf{namelist} parameter).
-Its default value is \np{rn_atfp}{rn\_atfp}\forcode{=10.e-3}.
+Its default value is \np[=10.e-3]{rn_atfp}{rn\_atfp}.
 Note that the forcing correction term in the filter is not applied in linear free surface
 (\jp{ln\_linssh}\forcode{=.true.}) (see \autoref{subsec:TRA_sbc}).
@@ -1216 +1218 @@
 
 \begin{description}
-\item[\np{ln_teos10}{ln\_teos10}\forcode{=.true.}]
+\item[{\np[=.true.]{ln_teos10}{ln\_teos10}}]
   the polyTEOS10-bsq equation of seawater \citep{roquet.madec.ea_OM15} is used.
   The accuracy of this approximation is comparable to the TEOS-10 rational function approximation,
@@ -1235 +1237 @@
   either computing the air-sea and ice-sea fluxes (forced mode) or
   sending the SST field to the atmosphere (coupled mode).
-\item[\np{ln_eos80}{ln\_eos80}\forcode{=.true.}]
+\item[{\np[=.true.]{ln_eos80}{ln\_eos80}}]
   the polyEOS80-bsq equation of seawater is used.
   It takes the same polynomial form as the polyTEOS10, but the coefficients have been optimized to
@@ -1247 +1249 @@
   Nevertheless, a severe assumption is made in order to have a heat content ($C_p T_p$) which
   is conserved by the model: $C_p$ is set to a constant value, the TEOS10 value.
-\item[\np{ln_seos}{ln\_seos}\forcode{=.true.}]
+\item[{\np[=.true.]{ln_seos}{ln\_seos}}]
   a simplified EOS (S-EOS) inspired by \citet{vallis_bk06} is chosen,
   the coefficients of which has been optimized to fit the behavior of TEOS10
@@ -1367 +1369 @@
 I've changed "derivative" to "difference" and "mean" to "average"}
 
-With partial cells (\np{ln_zps}{ln\_zps}\forcode{=.true.}) at bottom and top (\np{ln_isfcav}{ln\_isfcav}\forcode{=.true.}),
+With partial cells (\np[=.true.]{ln_zps}{ln\_zps}) at bottom and top (\np[=.true.]{ln_isfcav}{ln\_isfcav}),
 in general, tracers in horizontally adjacent cells live at different depths.
 Horizontal gradients of tracers are needed for horizontal diffusion (\mdl{traldf} module) and
 the hydrostatic pressure gradient calculations (\mdl{dynhpg} module).
-The partial cell properties at the top (\np{ln_isfcav}{ln\_isfcav}\forcode{=.true.}) are computed in the same way as
+The partial cell properties at the top (\np[=.true.]{ln_isfcav}{ln\_isfcav}) are computed in the same way as
 for the bottom.
 So, only the bottom interpolation is explained below.
@@ -1387 +1389 @@
   the $z$-partial step coordinate]{
     Discretisation of the horizontal difference and average of tracers in
-    the $z$-partial step coordinate (\protect\np{ln_zps}{ln\_zps}\forcode{=.true.}) in
+    the $z$-partial step coordinate (\protect\np[=.true.]{ln_zps}{ln\_zps}) in
     the case $(e3w_k^{i + 1} - e3w_k^i) > 0$.
     A linear interpolation is used to estimate $\widetilde T_k^{i + 1}$,
@@ -1459 +1461 @@
 %%%
 
-\biblio
-
-\pindex
+\onlyinsubfile{\bibliography{../main/bibliography}}
+
+\onlyinsubfile{\printindex}
 
 \end{document}