New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Changeset 11582 for NEMO/trunk/doc/latex/NEMO/subfiles/apdx_triads.tex – NEMO

Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/doc/latex/NEMO/subfiles/apdx_triads.tex

    r11577 r11582  
    1111\newcommand{\rtriadt}[1]{\ensuremath{\triadt{i}{k}{#1}{i_p}{k_p}}} 
    1212 
     13\onlyinsubfile{\makeindex} 
     14 
    1315\begin{document} 
    1416% ================================================================ 
     
    4244The options specific to the Griffies scheme include: 
    4345\begin{description} 
    44 \item[\np{ln_triad_iso}{ln\_triad\_iso}] 
     46\item[{\np{ln_triad_iso}{ln\_triad\_iso}}] 
    4547  See \autoref{sec:TRIADS_taper}. 
    4648  If this is set false (the default), 
     
    5355  giving an almost pure horizontal diffusive tracer flux within the mixed layer. 
    5456  This is similar to the tapering suggested by \citet{gerdes.koberle.ea_CD91}. See \autoref{subsec:TRIADS_Gerdes-taper} 
    55 \item[\np{ln_botmix_triad}{ln\_botmix\_triad}] 
     57\item[{\np{ln_botmix_triad}{ln\_botmix\_triad}}] 
    5658  See \autoref{sec:TRIADS_iso_bdry}. 
    5759  If this is set false (the default) then the lateral diffusive fluxes 
     
    5961  If it is set true, however, then these lateral diffusive fluxes are applied, 
    6062  giving smoother bottom tracer fields at the cost of introducing diapycnal mixing. 
    61 \item[\np{rn_sw_triad}{rn\_sw\_triad}] 
     63\item[{\np{rn_sw_triad}{rn\_sw\_triad}}] 
    6264  blah blah to be added.... 
    6365\end{description} 
    6466The options shared with the Standard scheme include: 
    6567\begin{description} 
    66 \item[\np{ln_traldf_msc}{ln\_traldf\_msc}]   blah blah to be added 
    67 \item[\np{rn_slpmax}{rn\_slpmax}]  blah blah to be added 
     68\item[{\np{ln_traldf_msc}{ln\_traldf\_msc}}]   blah blah to be added 
     69\item[{\np{rn_slpmax}{rn\_slpmax}}]  blah blah to be added 
    6870\end{description} 
    6971 
     
    646648Note that both near bottom triad slopes \triad{i}{k}{R}{1/2}{1/2} and \triad{i+1}{k}{R}{-1/2}{1/2} are masked when 
    647649either of the $i,k+1$ or $i+1,k+1$ tracer points is masked, \ie\ the $i,k+1$ $u$-point is masked. 
    648 The associated lateral fluxes (grey-black dashed line) are masked if \np{ln_botmix_triad}{ln\_botmix\_triad}\forcode{ = .false.}, 
    649 but left unmasked, giving bottom mixing, if \np{ln_botmix_triad}{ln\_botmix\_triad}\forcode{ = .true.}. 
    650  
    651 The default option \np{ln_botmix_triad}{ln\_botmix\_triad}\forcode{ = .false.} is suitable when the bbl mixing option is enabled 
    652 (\np{ln_trabbl}{ln\_trabbl}\forcode{ = .true.}, with \np{nn_bbl_ldf}{nn\_bbl\_ldf}\forcode{ = 1}), or for simple idealized problems. 
    653 For setups with topography without bbl mixing, \np{ln_botmix_triad}{ln\_botmix\_triad}\forcode{ = .true.} may be necessary. 
     650The associated lateral fluxes (grey-black dashed line) are masked if \np[=.false.]{ln_botmix_triad}{ln\_botmix\_triad}, 
     651but left unmasked, giving bottom mixing, if \np[=.true.]{ln_botmix_triad}{ln\_botmix\_triad}. 
     652 
     653The default option \np[=.false.]{ln_botmix_triad}{ln\_botmix\_triad} is suitable when the bbl mixing option is enabled 
     654(\np[=.true.]{ln_trabbl}{ln\_trabbl}, with \np[=1]{nn_bbl_ldf}{nn\_bbl\_ldf}), or for simple idealized problems. 
     655For setups with topography without bbl mixing, \np[=.true.]{ln_botmix_triad}{ln\_botmix\_triad} may be necessary. 
    654656% >>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    655657\begin{figure}[h] 
     
    672674    \ie\ the $i,k+1$ $u$-point is masked. 
    673675    The associated lateral fluxes (grey-black dashed line) are masked if 
    674     \protect\np{ln_botmix_triad}{ln\_botmix\_triad}\forcode{ = .false.}, but left unmasked, 
    675     giving bottom mixing, if \protect\np{ln_botmix_triad}{ln\_botmix\_triad}\forcode{ = .true.}} 
     676    \protect\np[=.false.]{ln_botmix_triad}{ln\_botmix\_triad}, but left unmasked, 
     677    giving bottom mixing, if \protect\np[=.true.]{ln_botmix_triad}{ln\_botmix\_triad}} 
    676678  \label{fig:TRIADS_bdry_triads} 
    677679\end{figure} 
     
    715717\label{sec:TRIADS_lintaper} 
    716718 
    717 This is the option activated by the default choice \np{ln_triad_iso}{ln\_triad\_iso}\forcode{ = .false.}. 
     719This is the option activated by the default choice \np[=.false.]{ln_triad_iso}{ln\_triad\_iso}. 
    718720Slopes $\tilde{r}_i$ relative to geopotentials are tapered linearly from their value immediately below 
    719721the mixed layer to zero at the surface, as described in option (c) of \autoref{fig:LDF_eiv_slp}, to values 
     
    11451147\label{sec:TRIADS_sfdiag} 
    11461148 
    1147 Where the namelist parameter \np{ln_traldf_gdia}{ln\_traldf\_gdia}\forcode{ = .true.}, 
     1149Where the namelist parameter \np[=.true.]{ln_traldf_gdia}{ln\_traldf\_gdia}, 
    11481150diagnosed mean eddy-induced velocities are output. 
    11491151Each time step, streamfunctions are calculated in the $i$-$k$ and $j$-$k$ planes at 
     
    11711173\] 
    11721174 
    1173 \biblio 
    1174  
    1175 \pindex 
     1175\onlyinsubfile{\bibliography{../main/bibliography}} 
     1176 
     1177\onlyinsubfile{\printindex} 
    11761178 
    11771179\end{document} 
Note: See TracChangeset for help on using the changeset viewer.