Changeset 9393
- Timestamp:
- 2018-03-13T15:00:56+01:00 (7 years ago)
- Location:
- branches/2017/dev_merge_2017/DOC
- Files:
-
- 1 added
- 30 edited
Legend:
- Unmodified
- Added
- Removed
-
branches/2017/dev_merge_2017/DOC/build_NEMO_manual.sh
r9388 r9393 7 7 8 8 latex ${latex_opts} ${latex_file} 9 makeindex -s ${latex_file}. sty${latex_file}9 makeindex -s ${latex_file}.ist ${latex_file} 10 10 bibtex ${latex_file} 11 latex ${latex_opts} ${latex_file} 11 12 12 13 pdflatex ${latex_opts} ${latex_file} -
branches/2017/dev_merge_2017/DOC/clean.sh
r9388 r9393 1 1 #!/bin/bash 2 2 3 rm -f $( ls -1 tex_main/NEMO_* | egrep -v "\.(bib| sty|tex)$" )3 rm -f $( ls -1 tex_main/NEMO_* | egrep -v "\.(bib|ist|sty|tex)$" ) 4 4 #rm -rf _minted-* 5 5 #rm -rf html* -
branches/2017/dev_merge_2017/DOC/tex_main/NEMO_manual.sty
r9389 r9393 128 128 \newcommand{\NEMO}{\textit{NEMO}\xspace} 129 129 130 \newcommand{\ifile}[1]{\textit{ #1.nc}\index{Input NetCDF files!#1.nc}} 131 \newcommand{ \hf}[1]{\textit{ #1.h90}\index{ h90 file!#1}} 132 \newcommand{ \key}[1]{\textbf{ key\_#1}\index{ CPP keys!key\_#1}} 133 \newcommand{ \mdl}[1]{\textit{ #1.F90}\index{ Modules!#1}} 134 \newcommand{ \ngn}[1]{\textit{ #1}\index{ Namelist Group Name!#1}} 135 \newcommand{ \rou}[1]{\textit{ #1}\index{ Routines!#1}} 136 137 \newcommand{\jp}[1]{\forcode{#1}\index{ Model parameters!#1}} 138 \newcommand{\np}[1]{\forcode{#1}\index{Namelist variables!#1}} 130 \newcommand{\hf}[1]{\textit{#1.h90}\index{h90 file!#1}} 131 \newcommand{\ifile}[1]{\textit{#1.nc}\index{Input NetCDF files!#1.nc}} 132 \newcommand{\jp}[1]{\textit{#1}\index{Model parameters!#1}} 133 \newcommand{\key}[1]{\textbf{key\_#1}\index{CPP keys!key\_#1}} 134 \newcommand{\mdl}[1]{\textit{#1.F90}\index{Modules!#1}} 135 \newcommand{\ngn}[1]{\textit{#1}\index{Namelist Group Name!#1}} 136 \newcommand{\np}[1]{\textit{#1}\index{Namelist variables!#1}} 137 \newcommand{\rou}[1]{\textit{#1}\index{Routines!#1}} 139 138 140 139 \newcommand{\grad}{\nabla} -
branches/2017/dev_merge_2017/DOC/tex_main/NEMO_manual.tex
r9389 r9393 142 142 %% Index 143 143 144 %\addcontentsline{toc}{chapter}{Index}144 \addcontentsline{toc}{chapter}{Index} 145 145 \printindex 146 146 … … 148 148 %% Bibliography 149 149 150 \addcontentsline{toc}{chapter}{Bibliography} 150 151 \bibliography{../tex_main/NEMO_manual} 151 152 -
branches/2017/dev_merge_2017/DOC/tex_sub/abstract_foreword.tex
r9389 r9393 31 31 \chapter*{Disclaimer} 32 32 33 Like all components of NEMO, the ocean component is developed under the CECILL license,33 Like all components of NEMO, the ocean component is developed under the \href{http://www.cecill.info/}{CECILL license}, 34 34 which is a French adaptation of the GNU GPL (General Public License). Anyone may use it 35 35 freely for research purposes, and is encouraged to communicate back to the NEMO team -
branches/2017/dev_merge_2017/DOC/tex_sub/annex_A.tex
r9389 r9393 15 15 % Chain rule 16 16 % ================================================================ 17 \section{ The chain rule for $s-$coordinates}17 \section{Chain rule for $s-$coordinates} 18 18 \label{Apdx_A_continuity} 19 19 … … 64 64 % continuity equation 65 65 % ================================================================ 66 \section{Continuity Equation in $s-$coordinates}66 \section{Continuity equation in $s-$coordinates} 67 67 \label{Apdx_A_continuity} 68 68 … … 183 183 % momentum equation 184 184 % ================================================================ 185 \section{Momentum Equation in $s-$coordinate}185 \section{Momentum equation in $s-$coordinate} 186 186 \label{Apdx_A_momentum} 187 187 … … 515 515 % Tracer equation 516 516 % ================================================================ 517 \section{Tracer Equation}517 \section{Tracer equation} 518 518 \label{Apdx_A_tracer} 519 519 -
branches/2017/dev_merge_2017/DOC/tex_sub/annex_B.tex
r9389 r9393 15 15 % Horizontal/Vertical 2nd Order Tracer Diffusive Operators 16 16 % ================================================================ 17 \section{Horizontal/Vertical 2nd Order Tracer Diffusive Operators}17 \section{Horizontal/Vertical $2^{nd}$ order tracer diffusive operators} 18 18 \label{Apdx_B_1} 19 19 … … 138 138 % Isopycnal/Vertical 2nd Order Tracer Diffusive Operators 139 139 % ================================================================ 140 \section{Iso/ diapycnal 2nd Order Tracer Diffusive Operators}140 \section{Iso/Diapycnal $2^{nd}$ order tracer diffusive operators} 141 141 \label{Apdx_B_2} 142 142 … … 288 288 % Lateral/Vertical Momentum Diffusive Operators 289 289 % ================================================================ 290 \section{Lateral/Vertical Momentum Diffusive Operators}290 \section{Lateral/Vertical momentum diffusive operators} 291 291 \label{Apdx_B_3} 292 292 -
branches/2017/dev_merge_2017/DOC/tex_sub/annex_C.tex
r9392 r9393 324 324 % Discrete Total energy Conservation : vector invariant form 325 325 % ================================================================ 326 \section{Discrete total energy conservation 326 \section{Discrete total energy conservation: vector invariant form} 327 327 \label{Apdx_C.1} 328 328 … … 363 363 % Vorticity Term with ENE scheme 364 364 % ------------------------------------------------------------------------------------------------------------- 365 \subsubsection{Vorticity Term with ENE scheme (\protect\np{ln_dynvor_ene}=.true.)}365 \subsubsection{Vorticity term with ENE scheme (\protect\np{ln\_dynvor\_ene}\forcode{ = .true.})} 366 366 \label{Apdx_C_vorENE} 367 367 … … 400 400 % Vorticity Term with EEN scheme 401 401 % ------------------------------------------------------------------------------------------------------------- 402 \subsubsection{Vorticity Term with EEN scheme (\protect\np{ln_dynvor_een}=.true.)}402 \subsubsection{Vorticity term with EEN scheme (\protect\np{ln\_dynvor\_een}\forcode{ = .true.})} 403 403 \label{Apdx_C_vorEEN} 404 404 … … 470 470 % Gradient of Kinetic Energy / Vertical Advection 471 471 % ------------------------------------------------------------------------------------------------------------- 472 \subsubsection{Gradient of Kinetic Energy / Vertical Advection}472 \subsubsection{Gradient of kinetic energy / Vertical advection} 473 473 \label{Apdx_C_zad} 474 474 … … 579 579 % Pressure Gradient Term 580 580 % ------------------------------------------------------------------------------------------------------------- 581 \subsection{Pressure Gradient Term}581 \subsection{Pressure gradient term} 582 582 \label{Apdx_C.1.4} 583 583 … … 732 732 % Discrete Total energy Conservation : flux form 733 733 % ================================================================ 734 \section{Discrete total energy conservation 734 \section{Discrete total energy conservation: flux form} 735 735 \label{Apdx_C.1} 736 736 … … 768 768 % Coriolis plus ``metric'' Term 769 769 % ------------------------------------------------------------------------------------------------------------- 770 \subsubsection{Coriolis plus ``metric'' Term}770 \subsubsection{Coriolis plus ``metric'' term} 771 771 \label{Apdx_C.1.3.1} 772 772 … … 883 883 % Vorticity Term with ENS scheme 884 884 % ------------------------------------------------------------------------------------------------------------- 885 \subsubsection{Vorticity Term with ENS scheme (\protect\np{ln_dynvor_ens}=.true.)}885 \subsubsection{Vorticity term with ENS scheme (\protect\np{ln\_dynvor\_ens}\forcode{ = .true.})} 886 886 \label{Apdx_C_vorENS} 887 887 … … 943 943 % Vorticity Term with EEN scheme 944 944 % ------------------------------------------------------------------------------------------------------------- 945 \subsubsection{Vorticity Term with EEN scheme (\protect\np{ln _dynvor_een}=.true.)}945 \subsubsection{Vorticity Term with EEN scheme (\protect\np{ln\_dynvor\_een}\forcode{ = .true.})} 946 946 \label{Apdx_C_vorEEN} 947 947 … … 1016 1016 % Conservation Properties on Tracers 1017 1017 % ================================================================ 1018 \section{Conservation Properties on Tracers}1018 \section{Conservation properties on tracers} 1019 1019 \label{Apdx_C.2} 1020 1020 … … 1032 1032 % Advection Term 1033 1033 % ------------------------------------------------------------------------------------------------------------- 1034 \subsection{Advection Term}1034 \subsection{Advection term} 1035 1035 \label{Apdx_C.2.1} 1036 1036 … … 1099 1099 % Conservation Properties on Lateral Momentum Physics 1100 1100 % ================================================================ 1101 \section{Conservation Properties on Lateral Momentum Physics}1101 \section{Conservation properties on lateral momentum physics} 1102 1102 \label{Apdx_dynldf_properties} 1103 1103 … … 1122 1122 % Conservation of Potential Vorticity 1123 1123 % ------------------------------------------------------------------------------------------------------------- 1124 \subsection{Conservation of Potential Vorticity}1124 \subsection{Conservation of potential vorticity} 1125 1125 \label{Apdx_C.3.1} 1126 1126 … … 1156 1156 % Dissipation of Horizontal Kinetic Energy 1157 1157 % ------------------------------------------------------------------------------------------------------------- 1158 \subsection{Dissipation of Horizontal Kinetic Energy}1158 \subsection{Dissipation of horizontal kinetic energy} 1159 1159 \label{Apdx_C.3.2} 1160 1160 … … 1208 1208 % Dissipation of Enstrophy 1209 1209 % ------------------------------------------------------------------------------------------------------------- 1210 \subsection{Dissipation of Enstrophy}1210 \subsection{Dissipation of enstrophy} 1211 1211 \label{Apdx_C.3.3} 1212 1212 … … 1233 1233 % Conservation of Horizontal Divergence 1234 1234 % ------------------------------------------------------------------------------------------------------------- 1235 \subsection{Conservation of Horizontal Divergence}1235 \subsection{Conservation of horizontal divergence} 1236 1236 \label{Apdx_C.3.4} 1237 1237 … … 1262 1262 % Dissipation of Horizontal Divergence Variance 1263 1263 % ------------------------------------------------------------------------------------------------------------- 1264 \subsection{Dissipation of Horizontal Divergence Variance}1264 \subsection{Dissipation of horizontal divergence variance} 1265 1265 \label{Apdx_C.3.5} 1266 1266 … … 1288 1288 % Conservation Properties on Vertical Momentum Physics 1289 1289 % ================================================================ 1290 \section{Conservation Properties on Vertical Momentum Physics}1290 \section{Conservation properties on vertical momentum physics} 1291 1291 \label{Apdx_C_4} 1292 1292 … … 1460 1460 % Conservation Properties on Tracer Physics 1461 1461 % ================================================================ 1462 \section{Conservation Properties on Tracer Physics}1462 \section{Conservation properties on tracer physics} 1463 1463 \label{Apdx_C.5} 1464 1464 … … 1472 1472 % Conservation of Tracers 1473 1473 % ------------------------------------------------------------------------------------------------------------- 1474 \subsection{Conservation of Tracers}1474 \subsection{Conservation of tracers} 1475 1475 \label{Apdx_C.5.1} 1476 1476 … … 1506 1506 % Dissipation of Tracer Variance 1507 1507 % ------------------------------------------------------------------------------------------------------------- 1508 \subsection{Dissipation of Tracer Variance}1508 \subsection{Dissipation of tracer variance} 1509 1509 \label{Apdx_C.5.2} 1510 1510 -
branches/2017/dev_merge_2017/DOC/tex_sub/annex_D.tex
r9389 r9393 46 46 % The program structure 47 47 % ================================================================ 48 \section{ The program structure}48 \section{Program structure} 49 49 \label{Apdx_D_structure} 50 50 … … 106 106 % Naming Conventions 107 107 % ================================================================ 108 \section{Naming Conventions}108 \section{Naming conventions} 109 109 \label{Apdx_D_naming} 110 110 … … 200 200 % The program structure 201 201 % ================================================================ 202 \section{The program structure}203 \label{Apdx_D_structure}204 205 To be done....202 %\section{Program structure} 203 %label{Apdx_D_structure} 204 205 %To be done.... 206 206 \end{document} -
branches/2017/dev_merge_2017/DOC/tex_sub/annex_E.tex
r9392 r9393 19 19 % UBS scheme 20 20 % ------------------------------------------------------------------------------------------------------------- 21 \section{Upstream Biased Scheme (UBS) (\protect\ forcode{ln_traadv_ubs= .true.})}21 \section{Upstream Biased Scheme (UBS) (\protect\np{ln\_traadv\_ubs}\forcode{ = .true.})} 22 22 \label{TRA_adv_ubs} 23 23 … … 59 59 where the control of artificial diapycnal fluxes is of paramount importance. 60 60 It has therefore been preferred to evaluate the vertical flux using the TVD 61 scheme when \ forcode{ln_traadv_ubs= .true.}.61 scheme when \np{ln\_traadv\_ubs}\forcode{ = .true.}. 62 62 63 63 For stability reasons, in \eqref{Eq_tra_adv_ubs}, the first term which corresponds … … 188 188 % Leap-Frog energetic 189 189 % ------------------------------------------------------------------------------------------------------------- 190 \section{Leap -Frog energetic}190 \section{Leapfrog energetic} 191 191 \label{LF} 192 192 … … 247 247 % Griffies' iso-neutral diffusion operator : 248 248 % ================================================================ 249 \subsection{Griffies 'iso-neutral diffusion operator}249 \subsection{Griffies iso-neutral diffusion operator} 250 250 251 251 Let try to define a scheme that get its inspiration from the \citet{Griffies_al_JPO98} … … 436 436 % Skew flux formulation for Eddy Induced Velocity : 437 437 % ================================================================ 438 \subsection{ Eddy induced velocity and Skew flux formulation}438 \subsection{Eddy induced velocity and skew flux formulation} 439 439 440 440 When Gent and McWilliams [1990] diffusion is used (\key{traldf\_eiv} defined), … … 585 585 % Discrete Invariants of the iso-neutral diffrusion 586 586 % ================================================================ 587 \subsection{Discrete Invariants of the iso-neutral diffrusion}587 \subsection{Discrete invariants of the iso-neutral diffrusion} 588 588 \label{Apdx_Gf_operator} 589 589 … … 738 738 % Discrete Invariants of the skew flux formulation 739 739 % ================================================================ 740 \subsection{Discrete Invariants of the skew flux formulation}740 \subsection{Discrete invariants of the skew flux formulation} 741 741 \label{Apdx_eiv_skew} 742 742 -
branches/2017/dev_merge_2017/DOC/tex_sub/annex_iso.tex
r9392 r9393 4 4 % Iso-neutral diffusion : 5 5 % ================================================================ 6 \chapter[Iso-neutral diffusion and eddy advection using 7 triads]{Iso-neutral diffusion and eddy advection using triads} 6 \chapter{Iso-neutral diffusion and eddy advection using triads} 8 7 \label{sec:triad} 9 8 \minitoc … … 15 14 16 15 Two scheme are available to perform the iso-neutral diffusion. 17 If the namelist logical \np{ln _traldf_triad} is set true,16 If the namelist logical \np{ln\_traldf\_triad} is set true, 18 17 \NEMO updates both active and passive tracers using the Griffies triad representation 19 18 of iso-neutral diffusion and the eddy-induced advective skew (GM) fluxes. 20 If the namelist logical \np{ln _traldf_iso} is set true,19 If the namelist logical \np{ln\_traldf\_iso} is set true, 21 20 the filtered version of Cox's original scheme (the Standard scheme) is employed (\S\ref{LDF_slp}). 22 21 In the present implementation of the Griffies scheme, 23 the advective skew fluxes are implemented even if \np{ln _traldf_eiv} is false.22 the advective skew fluxes are implemented even if \np{ln\_traldf\_eiv} is false. 24 23 25 24 Values of iso-neutral diffusivity and GM coefficient are set as … … 31 30 The options specific to the Griffies scheme include: 32 31 \begin{description}[font=\normalfont] 33 \item[\np{ln _triad_iso}] See \S\ref{sec:triad:taper}. If this is set false (the default), then32 \item[\np{ln\_triad\_iso}] See \S\ref{sec:triad:taper}. If this is set false (the default), then 34 33 `iso-neutral' mixing is accomplished within the surface mixed-layer 35 34 along slopes linearly decreasing with depth from the value immediately below 36 35 the mixed-layer to zero (flat) at the surface (\S\ref{sec:triad:lintaper}). 37 36 This is the same treatment as used in the default implementation \S\ref{LDF_slp_iso}; Fig.~\ref{Fig_eiv_slp}. 38 Where \np{ln _triad_iso} is set true, the vertical skew flux is further reduced37 Where \np{ln\_triad\_iso} is set true, the vertical skew flux is further reduced 39 38 to ensure no vertical buoyancy flux, giving an almost pure 40 39 horizontal diffusive tracer flux within the mixed layer. This is similar to 41 40 the tapering suggested by \citet{Gerdes1991}. See \S\ref{sec:triad:Gerdes-taper} 42 \item[\np{ln _botmix_triad}] See \S\ref{sec:triad:iso_bdry}.41 \item[\np{ln\_botmix\_triad}] See \S\ref{sec:triad:iso_bdry}. 43 42 If this is set false (the default) then the lateral diffusive fluxes 44 43 associated with triads partly masked by topography are neglected. 45 44 If it is set true, however, then these lateral diffusive fluxes are applied, 46 45 giving smoother bottom tracer fields at the cost of introducing diapycnal mixing. 47 \item[\np{rn _sw_triad}] blah blah to be added....46 \item[\np{rn\_sw\_triad}] blah blah to be added.... 48 47 \end{description} 49 48 The options shared with the Standard scheme include: 50 49 \begin{description}[font=\normalfont] 51 \item[\np{ln _traldf_msc}] blah blah to be added52 \item[\np{rn _slpmax}] blah blah to be added50 \item[\np{ln\_traldf\_msc}] blah blah to be added 51 \item[\np{rn\_slpmax}] blah blah to be added 53 52 \end{description} 53 54 54 \section{Triad formulation of iso-neutral diffusion} 55 55 \label{sec:triad:iso} … … 57 57 but formulated within the \NEMO framework, using scale factors rather than grid-sizes. 58 58 59 \subsection{ The iso-neutral diffusion operator}59 \subsection{Iso-neutral diffusion operator} 60 60 The iso-neutral second order tracer diffusive operator for small 61 61 angles between iso-neutral surfaces and geopotentials is given by … … 147 147 $w$-points but involves horizontal gradients defined at $u$-points. 148 148 149 \subsection{ The standard discretization}149 \subsection{Standard discretization} 150 150 The straightforward approach to discretize the lateral skew flux 151 151 \eqref{eq:triad:i13c} from tracer cell $i,k$ to $i+1,k$, introduced in 1995 … … 185 185 ($i.e.$ they enter the computation of density), but it does not work 186 186 for a passive tracer. 187 187 188 \subsection{Expression of the skew-flux in terms of triad slopes} 188 189 \citep{Griffies_al_JPO98} introduce a different discretization of the … … 278 279 and in \eqref{eq:triad:i31} $a'_{1}={\:}_i^k{\mathbb{A}_w}_{1/2}^{1/2}$. 279 280 280 \subsection{ The full triad fluxes}281 \subsection{Full triad fluxes} 281 282 A key property of iso-neutral diffusion is that it should not affect 282 283 the (locally referenced) density. In particular there should be no … … 368 369 \end{pmatrix}. 369 370 \end{flalign} 371 370 372 \subsection{Ensuring the scheme does not increase tracer variance} 371 373 \label{sec:triad:variance} … … 471 473 \right) 472 474 \] 475 473 476 \subsection{Triad volumes in Griffes's scheme and in \NEMO} 474 477 To complete the discretization we now need only specify the triad … … 633 636 RHS of \eqref{eq:triad:iso_property3}. 634 637 \end{description} 638 635 639 \subsection{Treatment of the triads at the boundaries}\label{sec:triad:iso_bdry} 636 640 The triad slope can only be defined where both the grid boxes centred at … … 651 655 or $i+1,k+1$ tracer points is masked, i.e.\ the $i,k+1$ $u$-point is 652 656 masked. The associated lateral fluxes (grey-black dashed line) are 653 masked if \ forcode{ln_botmix_triad= .false.}, but left unmasked,654 giving bottom mixing, if \ forcode{ln_botmix_triad= .true.}.655 656 The default option \ forcode{ln_botmix_triad= .false.} is suitable when the657 bbl mixing option is enabled (\key{trabbl}, with \ forcode{nn_bbl_ldf= 1}),657 masked if \np{ln\_botmix\_triad}\forcode{ = .false.}, but left unmasked, 658 giving bottom mixing, if \np{ln\_botmix\_triad}\forcode{ = .true.}. 659 660 The default option \np{ln\_botmix\_triad}\forcode{ = .false.} is suitable when the 661 bbl mixing option is enabled (\key{trabbl}, with \np{nn\_bbl\_ldf}\forcode{ = 1}), 658 662 or for simple idealized problems. For setups with topography without 659 bbl mixing, \ forcode{ln_botmix_triad= .true.} may be necessary.663 bbl mixing, \np{ln\_botmix\_triad}\forcode{ = .true.} may be necessary. 660 664 % >>>>>>>>>>>>>>>>>>>>>>>>>>>> 661 665 \begin{figure}[h] \begin{center} … … 674 678 or $i+1,k+1$ tracer points is masked, i.e.\ the $i,k+1$ $u$-point 675 679 is masked. The associated lateral fluxes (grey-black dashed 676 line) are masked if \ protect\np{botmix_triad}=.false., but left677 unmasked, giving bottom mixing, if \ protect\np{botmix_triad}=.true.}680 line) are masked if \np{botmix\_triad}\forcode{ = .false.}, but left 681 unmasked, giving bottom mixing, if \np{botmix\_triad}\forcode{ = .true.}} 678 682 \end{center} \end{figure} 679 683 % >>>>>>>>>>>>>>>>>>>>>>>>>>>> 684 680 685 \subsection{ Limiting of the slopes within the interior}\label{sec:triad:limit} 681 686 As discussed in \S\ref{LDF_slp_iso}, iso-neutral slopes relative to … … 703 708 iso-neutral density flux that drives dianeutral mixing. In particular this iso-neutral density flux 704 709 is always downwards, and so acts to reduce gravitational potential energy. 710 705 711 \subsection{Tapering within the surface mixed layer}\label{sec:triad:taper} 706 707 712 Additional tapering of the iso-neutral fluxes is necessary within the 708 713 surface mixed layer. When the Griffies triads are used, we offer two 709 714 options for this. 715 710 716 \subsubsection{Linear slope tapering within the surface mixed layer}\label{sec:triad:lintaper} 711 717 This is the option activated by the default choice 712 \ forcode{ln_triad_iso= .false.}. Slopes $\tilde{r}_i$ relative to718 \np{ln\_triad\_iso}\forcode{ = .false.}. Slopes $\tilde{r}_i$ relative to 713 719 geopotentials are tapered linearly from their value immediately below the mixed layer to zero at the 714 720 surface, as described in option (c) of Fig.~\ref{Fig_eiv_slp}, to values … … 839 845 % >>>>>>>>>>>>>>>>>>>>>>>>>>>> 840 846 841 \subsubsection{Additional truncation of skew iso-neutral flux 842 components} 847 \subsubsection{Additional truncation of skew iso-neutral flux components} 843 848 \label{sec:triad:Gerdes-taper} 844 The alternative option is activated by setting \np{ln _triad_iso} =849 The alternative option is activated by setting \np{ln\_triad\_iso} = 845 850 true. This retains the same tapered slope $\rML$ described above for the 846 851 calculation of the $_{33}$ term of the iso-neutral diffusion tensor (the … … 884 889 \section{Eddy induced advection formulated as a skew flux}\label{sec:triad:skew-flux} 885 890 886 \subsection{ The continuous skew flux formulation}\label{sec:triad:continuous-skew-flux}891 \subsection{Continuous skew flux formulation}\label{sec:triad:continuous-skew-flux} 887 892 888 893 When Gent and McWilliams's [1990] diffusion is used, … … 917 922 it to the Eulerian velocity prior to computing the tracer 918 923 advection. This is implemented if \key{traldf\_eiv} is set in the 919 default implementation, where \np{ln _traldf_triad} is set924 default implementation, where \np{ln\_traldf\_triad} is set 920 925 false. This allows us to take advantage of all the advection schemes 921 926 offered for the tracers (see \S\ref{TRA_adv}) and not just a $2^{nd}$ … … 924 929 paramount importance. 925 930 926 However, when \np{ln _traldf_triad} is set true, \NEMO instead931 However, when \np{ln\_traldf\_triad} is set true, \NEMO instead 927 932 implements eddy induced advection according to the so-called skew form 928 933 \citep{Griffies_JPO98}. It is based on a transformation of the advective fluxes … … 989 994 preserves the tracer variance. 990 995 991 \subsection{ The discrete skew flux formulation}996 \subsection{Discrete skew flux formulation} 992 997 The skew fluxes in (\ref{eq:triad:eiv_skew_physical}, \ref{eq:triad:eiv_skew_ijk}), like the off-diagonal terms 993 998 (\ref{eq:triad:i13c}, \ref{eq:triad:i31c}) of the small angle diffusion tensor, are best … … 1030 1035 operator as it uses the same definition for the slopes. It also 1031 1036 ensures the following two key properties. 1037 1032 1038 \subsubsection{No change in tracer variance} 1033 1039 The discretization conserves tracer variance, $i.e.$ it does not … … 1123 1129 and $\triadt{i+1}{k}{R}{-1/2}{1/2}$ are masked when either of the 1124 1130 $i,k+1$ or $i+1,k+1$ tracer points is masked, i.e.\ the $i,k+1$ 1125 $u$-point is masked. The namelist parameter \np{ln _botmix_triad} has1131 $u$-point is masked. The namelist parameter \np{ln\_botmix\_triad} has 1126 1132 no effect on the eddy-induced skew-fluxes. 1127 1133 1128 \subsection{ 1134 \subsection{Limiting of the slopes within the interior}\label{sec:triad:limitskew} 1129 1135 Presently, the iso-neutral slopes $\tilde{r}_i$ relative 1130 1136 to geopotentials are limited to be less than $1/100$, exactly as in … … 1138 1144 option (c) of Fig.~\ref{Fig_eiv_slp}. This linear tapering for the 1139 1145 slopes used to calculate the eddy-induced fluxes is 1140 unaffected by the value of \np{ln _triad_iso}.1146 unaffected by the value of \np{ln\_triad\_iso}. 1141 1147 1142 1148 The justification for this linear slope tapering is that, for $A_e$ … … 1153 1159 1154 1160 \subsection{Streamfunction diagnostics}\label{sec:triad:sfdiag} 1155 Where the namelist parameter \ forcode{ln_traldf_gdia= .true.}, diagnosed1161 Where the namelist parameter \np{ln\_traldf\_gdia}\forcode{ = .true.}, diagnosed 1156 1162 mean eddy-induced velocities are output. Each time step, 1157 1163 streamfunctions are calculated in the $i$-$k$ and $j$-$k$ planes at -
branches/2017/dev_merge_2017/DOC/tex_sub/chap_ASM.tex
r9392 r9393 4 4 % Chapter Assimilation increments (ASM) 5 5 % ================================================================ 6 \chapter{Apply assimilation increments (ASM)}6 \chapter{Apply Assimilation Increments (ASM)} 7 7 \label{ASM} 8 8 … … 30 30 Direct initialization (DI) refers to the instantaneous correction 31 31 of the model background state using the analysis increment. 32 DI is used when \np{ln _asmdin} is set to true.32 DI is used when \np{ln\_asmdin} is set to true. 33 33 34 \section{Incremental Analysis Updates}34 \section{Incremental analysis updates} 35 35 \label{ASM_IAU} 36 36 … … 40 40 is referred to as Incremental Analysis Updates (IAU) \citep{Bloom_al_MWR96}. 41 41 IAU is a common technique used with 3D assimilation methods such as 3D-Var or OI. 42 IAU is used when \np{ln _asmiau} is set to true.42 IAU is used when \np{ln\_asmiau} is set to true. 43 43 44 44 With IAU, the model state trajectory ${\bf x}$ in the assimilation window … … 117 117 integration \citep{Talagrand_JAS72, Dobricic_al_OS07}. Diffusion coefficients are defined as 118 118 $A_D = \alpha e_{1t} e_{2t}$, where $\alpha = 0.2$. The divergence damping is activated by 119 assigning to \np{nn _divdmp} in the \textit{nam\_asminc} namelist a value greater than zero.119 assigning to \np{nn\_divdmp} in the \textit{nam\_asminc} namelist a value greater than zero. 120 120 By choosing this value to be of the order of 100 the increments in the vertical velocity will 121 121 be significantly reduced. -
branches/2017/dev_merge_2017/DOC/tex_sub/chap_CONFIG.tex
r9392 r9393 32 32 % 1D model configuration 33 33 % ================================================================ 34 \section{ Water column model: 1D model (C1D)(\protect\key{c1d}) }34 \section{C1D: 1D Water column model (\protect\key{c1d}) } 35 35 \label{CFG_c1d} 36 36 … … 80 80 % ORCA family configurations 81 81 % ================================================================ 82 \section{ORCA family: global ocean with tripolar grid 82 \section{ORCA family: global ocean with tripolar grid} 83 83 \label{CFG_orca} 84 84 … … 164 164 \begin{table}[!t] \begin{center} 165 165 \begin{tabular}{p{4cm} c c c c} 166 Horizontal Grid & \np{ORCA _index} & \np{jpiglo} & \np{jpjglo} & \\166 Horizontal Grid & \np{ORCA\_index} & \np{jpiglo} & \np{jpjglo} & \\ 167 167 \hline \hline 168 168 \~4\deg & 4 & 92 & 76 & \\ … … 251 251 uniformly applied to the whole domain. 252 252 253 The GYRE configuration is set like an analytical configuration. Through \np{ln\_read\_cfg \textit{=false}} in \textit{namcfg} namelist defined in the reference configuration \textit{CONFIG/GYRE/EXP00/namelist\_cfg} anaylitical definition of grid in GYRE is done in usrdef\_hrg, usrdef\_zgr routines. Its horizontal resolution254 (and thus the size of the domain) is determined by setting \np{nn _GYRE} in \ngn{namusr\_def}: \\255 \np{jpiglo} $= 30 \times$ \np{nn _GYRE} + 2 \\256 \np{jpjglo} $= 20 \times$ \np{nn _GYRE} + 2 \\253 The GYRE configuration is set like an analytical configuration. Through \np{ln\_read\_cfg}\forcode{ = .false.} in \textit{namcfg} namelist defined in the reference configuration \path{CONFIG/GYRE/EXP00/namelist_cfg} anaylitical definition of grid in GYRE is done in usrdef\_hrg, usrdef\_zgr routines. Its horizontal resolution 254 (and thus the size of the domain) is determined by setting \np{nn\_GYRE} in \ngn{namusr\_def}: \\ 255 \np{jpiglo} $= 30 \times$ \np{nn\_GYRE} + 2 \\ 256 \np{jpjglo} $= 20 \times$ \np{nn\_GYRE} + 2 \\ 257 257 Obviously, the namelist parameters have to be adjusted to the chosen resolution, see the Configurations 258 258 pages on the NEMO web site (Using NEMO\/Configurations) . 259 In the vertical, GYRE uses the default 30 ocean levels (\jp{jpk} =31) (Fig.~\ref{Fig_zgr}).259 In the vertical, GYRE uses the default 30 ocean levels (\jp{jpk}\forcode{ = 31}) (Fig.~\ref{Fig_zgr}). 260 260 261 261 The GYRE configuration is also used in benchmark test as it is very simple to increase 262 262 its resolution and as it does not requires any input file. For example, keeping a same model size 263 263 on each processor while increasing the number of processor used is very easy, even though the 264 physical integrity of the solution can be compromised. Benchmark is activate via \np{ln\_bench \textit{=true}} in \ngn{namusr\_def} in namelist \textit{CONFIG/GYRE/EXP00/namelist\_cfg}.264 physical integrity of the solution can be compromised. Benchmark is activate via \np{ln\_bench}\forcode{ = .true.} in \ngn{namusr\_def} in namelist \path{CONFIG/GYRE/EXP00/namelist_cfg}. 265 265 266 266 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> … … 276 276 % AMM configuration 277 277 % ------------------------------------------------------------------------------------------------------------- 278 \section{AMM: atlantic margin configuration 278 \section{AMM: atlantic margin configuration} 279 279 \label{MISC_config_AMM} 280 280 … … 296 296 In addition to the tidal boundary condition the model may also take 297 297 open boundary conditions from a North Atlantic model. Boundaries may be 298 completely omitted by setting \np{ln _bdy} to false.298 completely omitted by setting \np{ln\_bdy} to false. 299 299 Sample surface fluxes, river forcing and a sample initial restart file 300 300 are included to test a realistic model run. The Baltic boundary is -
branches/2017/dev_merge_2017/DOC/tex_sub/chap_DIA.tex
r9392 r9393 14 14 % Old Model Output 15 15 % ================================================================ 16 \section{Old Model Output (default)}16 \section{Old model output (default)} 17 17 \label{DIA_io_old} 18 18 … … 55 55 % Diagnostics 56 56 % ================================================================ 57 \section{Standard model Output (IOM)}57 \section{Standard model output (IOM)} 58 58 \label{DIA_iom} 59 59 … … 106 106 even without a parallel-enabled NetCDF4 library, simply by employing only one dedicated I/O server. 107 107 108 \subsection{XIOS: the IO\_SERVER}108 \subsection{XIOS: XML Inputs-Outputs Server} 109 109 110 110 \subsubsection{Attached or detached mode?} … … 148 148 \texttt{ mpirun -np 62 ./nemo.exe : -np 2 ./xios\_server.exe } 149 149 150 \subsubsection{Control of XIOS: the XIOScontext in iodef.xml}150 \subsubsection{Control of XIOS: the context in iodef.xml} 151 151 152 152 As well as the {\tt using\_server} flag, other controls on the use of XIOS are set in the XIOS context in iodef.xml. … … 216 216 you used in the f90 code (see subsequent sections for a details of the XML syntax and rules). 217 217 For example: 218 \vspace{-20pt}219 218 \begin{xmllines} 220 219 <field_definition> … … 232 231 and axes either defined in the code (iom\_set\_domain\_attr and iom\_set\_axis\_attr in iom.F90) 233 232 or defined in the domain\_def.xml file. $e.g.$: 234 \vspace{-20pt}235 233 \begin{xmllines} 236 234 <grid id="grid_T_3D" domain_ref="grid_T" axis_ref="deptht"/> 237 235 \end{xmllines} 238 Note, if your array is computed within the surface module each nn\_fsbctime\_step,236 Note, if your array is computed within the surface module each \np{nn\_fsbc} time\_step, 239 237 add the field definition within the field\_group defined with the id ''SBC'': $<$field\_group id=''SBC''...$>$ 240 238 which has been defined with the correct frequency of operations (iom\_set\_field\_attr in iom.F90) 241 239 242 \item[4.] add your field in one of the output files defined in iodef.xml (again see subsequent sections for syntax and rules) \\ 243 \vspace{-20pt} 240 \item[4.] add your field in one of the output files defined in iodef.xml (again see subsequent sections for syntax and rules) 244 241 \begin{xmllines} 245 242 <file id="file1" .../> … … 251 248 252 249 \end{description} 250 253 251 \subsection{XML fundamentals} 254 252 … … 262 260 See \href{http://www.xmlnews.org/docs/xml-basics.html}{here} for more details. 263 261 264 \subsubsection{Structure of the xmlfile used in NEMO}262 \subsubsection{Structure of the XML file used in NEMO} 265 263 266 264 The XML file used in XIOS is structured by 7 families of tags: context, axis, domain, grid, field, file and variable. … … 397 395 \\ 398 396 example 1: Direct inheritance. 399 \vspace{-20pt}400 397 \begin{xmllines} 401 398 <field_definition operation="average" > … … 410 407 \\ 411 408 example 2: Inheritance by reference. 412 \vspace{-20pt}413 409 \begin{xmllines} 414 410 <field_definition> … … 426 422 Inherit (and overwrite, if needed) the attributes of a tag you are refering to. 427 423 428 \subsubsection{Use of Groups}424 \subsubsection{Use of groups} 429 425 430 426 Groups can be used for 2 purposes. … … 432 428 In the following example, we define a group of field that will share a common grid ''grid\_T\_2D''. 433 429 Note that for the field ''toce'', we overwrite the grid definition inherited from the group by ''grid\_T\_3D''. 434 \vspace{-20pt}435 430 \begin{xmllines} 436 431 <field_group id="grid_T" grid_ref="grid_T_2D"> … … 445 440 Several examples of groups of fields are proposed at the end of the file {\tt CONFIG/SHARED/field\_def.xml}. 446 441 For example, a short list of the usual variables related to the U grid: 447 \vspace{-20pt}448 442 \begin{xmllines} 449 443 <field_group id="groupU" > … … 454 448 \end{xmllines} 455 449 that can be directly included in a file through the following syntax: 456 \vspace{-20pt}457 450 \begin{xmllines} 458 451 <file id="myfile_U" output_freq="1d" /> … … 472 465 For example, in {\tt CONFIG/SHARED/domain\_def.xml}, we provide the following example of a definition 473 466 of a 5 by 5 box with the bottom left corner at point (10,10). 474 \vspace{-20pt}475 467 \begin{xmllines} 476 468 <domain_group id="grid_T"> … … 478 470 \end{xmllines} 479 471 The use of this subdomain is done through the redefinition of the attribute domain\_ref of the tag family field. For example: 480 \vspace{-20pt}481 472 \begin{xmllines} 482 473 <file id="myfile_vzoom" output_freq="1d" > … … 490 481 for the equatorial sections and the mooring position for TAO, RAMA and PIRATA followed 491 482 by ''T'' (for example: ''8s137eT'', ''1.5s80.5eT'' ...) 492 \vspace{-20pt}493 483 \begin{xmllines} 494 484 <file id="myfile_vzoom" output_freq="1d" > … … 500 490 \subsubsection{Define vertical zooms} 501 491 Vertical zooms are defined through the attributs zoom\_begin and zoom\_end of the tag family axis. It must therefore be done in the axis part of the XML file. For example, in NEMOGCM/CONFIG/ORCA2\_LIM/iodef\_demo.xml, we provide the following example: 502 \vspace{-20pt}503 492 \begin{xmllines} 504 493 <axis_group id="deptht" long_name="Vertical T levels" unit="m" positive="down" > … … 507 496 \end{xmllines} 508 497 The use of this vertical zoom is done through the redefinition of the attribute axis\_ref of the tag family field. For example: 509 \vspace{-20pt}510 498 \begin{xmllines} 511 499 <file id="myfile_hzoom" output_freq="1d" > … … 517 505 518 506 The output file names are defined by the attributs ''name'' and ''name\_suffix'' of the tag family file. for example: 519 \vspace{-20pt}520 507 \begin{xmllines} 521 508 <file_group id="1d" output_freq="1d" name="myfile_1d" > … … 577 564 }} 578 565 579 \subsubsection{Other controls of the xmlattributes from NEMO}566 \subsubsection{Other controls of the XML attributes from NEMO} 580 567 581 568 The values of some attributes are defined by subroutine calls within NEMO (calls to iom\_set\_domain\_attr, iom\_set\_axis\_attr and iom\_set\_field\_attr in iom.F90). Any definition given in the xml file will be overwritten. By convention, these attributes are defined to ''auto'' (for string) or ''0000'' (for integer) in the xml file (but this is not necessary). … … 589 576 \hline 590 577 \hline 591 \multicolumn{2}{|c|}{field\_definition} & freq\_op & \np{rn _rdt} \\592 \hline 593 \multicolumn{2}{|c|}{SBC} & freq\_op & \np{rn _rdt} $\times$ \np{nn_fsbc} \\594 \hline 595 \multicolumn{2}{|c|}{ptrc\_T} & freq\_op & \np{rn _rdt} $\times$ \np{nn_dttrc} \\596 \hline 597 \multicolumn{2}{|c|}{diad\_T} & freq\_op & \np{rn _rdt} $\times$ \np{nn_dttrc} \\578 \multicolumn{2}{|c|}{field\_definition} & freq\_op & \np{rn\_rdt} \\ 579 \hline 580 \multicolumn{2}{|c|}{SBC} & freq\_op & \np{rn\_rdt} $\times$ \np{nn\_fsbc} \\ 581 \hline 582 \multicolumn{2}{|c|}{ptrc\_T} & freq\_op & \np{rn\_rdt} $\times$ \np{nn\_dttrc} \\ 583 \hline 584 \multicolumn{2}{|c|}{diad\_T} & freq\_op & \np{rn\_rdt} $\times$ \np{nn\_dttrc} \\ 598 585 \hline 599 586 \multicolumn{2}{|c|}{EqT, EqU, EqW} & jbegin, ni, & according to the grid \\ … … 612 599 (1) Simple computation: directly define the computation when refering to the variable in the file definition. 613 600 614 \vspace{-20pt} 615 \begin{xmllines} 616 <field field\_ref="sst" name="tosK" unit="degK" > sst + 273.15 </field> 617 <field field\_ref="taum" name="taum2" unit="N2/m4" long\_name="square of wind stress module" > taum * taum </field> 618 <field field\_ref="qt" name="stupid\_check" > qt - qsr - qns </field> 601 \begin{xmllines} 602 <field field_ref="sst" name="tosK" unit="degK" > sst + 273.15 </field> 603 <field field_ref="taum" name="taum2" unit="N2/m4" long_name="square of wind stress module" > taum * taum </field> 604 <field field_ref="qt" name="stupid_check" > qt - qsr - qns </field> 619 605 \end{xmllines} 620 606 … … 622 608 623 609 in field\_definition: 624 \vspace{-20pt} 625 \begin{xmllines} 626 <field id="sst2" long\_name="square of sea surface temperature" unit="degC2" > sst * sst </field > 610 \begin{xmllines} 611 <field id="sst2" long_name="square of sea surface temperature" unit="degC2" > sst * sst </field > 627 612 \end{xmllines} 628 613 in file\_definition: 629 \vspace{-20pt} 630 \begin{xmllines} 631 <field field\_ref="sst2" > sst2 </field> 614 \begin{xmllines} 615 <field field_ref="sst2" > sst2 </field> 632 616 \end{xmllines} 633 617 Note that in this case, the following syntaxe $<$field field\_ref="sst2" /$>$ is not working as sst2 won't be evaluated. … … 635 619 (3) Change of variable precision: 636 620 637 \vspace{-20pt}638 621 \begin{xmllines} 639 622 <!-- force to keep real 8 --> 640 <field field \_ref="sst" name="tos\_r8" prec="8" />641 <!-- integer 2 with add \_offset and scale\_factor attributes -->642 <field field \_ref="sss" name="sos\_i2" prec="2" add\_offset="20." scale\_factor="1.e-3" />623 <field field_ref="sst" name="tos_r8" prec="8" /> 624 <!-- integer 2 with add_offset and scale_factor attributes --> 625 <field field_ref="sss" name="sos_i2" prec="2" add_offset="20." scale_factor="1.e-3" /> 643 626 \end{xmllines} 644 627 Note that, then the code is crashing, writting real4 variables forces a numerical convection from real8 to real4 which will create an internal error in NetCDF and will avoid the creation of the output files. Forcing double precision outputs with prec="8" (for example in the field\_definition) will avoid this problem. … … 646 629 (4) add user defined attributes: 647 630 648 \vspace{-20pt} 649 \begin{xmllines} 650 <file\_group id="1d" output\_freq="1d" output\_level="10" enabled=".TRUE."> <!-- 1d files --> 651 <file id="file1" name\_suffix="\_grid\_T" description="ocean T grid variables" > 652 <field field\_ref="sst" name="tos" > 653 <variable id="my\_attribute1" type="string" > blabla </variable> 654 <variable id="my\_attribute2" type="integer" > 3 </variable> 655 <variable id="my\_attribute3" type="float" > 5.0 </variable> 631 \begin{xmllines} 632 <file_group id="1d" output_freq="1d" output_level="10" enabled=".true."> <!-- 1d files --> 633 <file id="file1" name_suffix="_grid_T" description="ocean T grid variables" > 634 <field field_ref="sst" name="tos" > 635 <variable id="my_attribute1" type="string" > blabla </variable> 636 <variable id="my_attribute2" type="integer" > 3 </variable> 637 <variable id="my_attribute3" type="float" > 5.0 </variable> 656 638 </field> 657 <variable id="my \_global\_attribute" type="string" > blabla\_global </variable>639 <variable id="my_global_attribute" type="string" > blabla_global </variable> 658 640 </file> 659 </file \_group>641 </file_group> 660 642 \end{xmllines} 661 643 … … 663 645 664 646 - define a new variable in field\_definition 665 \vspace{-20pt} 666 \begin{xmllines} 667 <field id="toce\_e3t" long\_name="temperature * e3t" unit="degC*m" grid\_ref="grid\_T\_3D" > toce * e3t </field > 647 \begin{xmllines} 648 <field id="toce_e3t" long_name="temperature * e3t" unit="degC*m" grid_ref="grid_T_3D" > toce * e3t </field > 668 649 \end{xmllines} 669 650 - use it when defining your file. 670 \vspace{-20pt} 671 \begin{xmllines} 672 <file\_group id="5d" output\_freq="5d" output\_level="10" enabled=".TRUE." > <!-- 5d files --> 673 <file id="file1" name\_suffix="\_grid\_T" description="ocean T grid variables" > 674 <field field\_ref="toce" operation="instant" freq\_op="5d" > @toce\_e3t / @e3t </field> 651 \begin{xmllines} 652 <file_group id="5d" output_freq="5d" output_level="10" enabled=".true." > <!-- 5d files --> 653 <file id="file1" name_suffix="_grid_T" description="ocean T grid variables" > 654 <field field_ref="toce" operation="instant" freq_op="5d" > @toce_e3t / @e3t </field> 675 655 </file> 676 </file \_group>656 </file_group> 677 657 \end{xmllines} 678 658 The freq\_op="5d" attribute is used to define the operation frequency of the ``@'' function: here 5 day. The temporal operation done by the ``@'' is the one defined in the field definition: here we use the default, average. So, in the above case, @toce\_e3t will do the 5-day mean of toce*e3t. Operation="instant" refers to the temporal operation to be performed on the field''@toce\_e3t / @e3t'': here the temporal average is alreday done by the ``@'' function so we just use instant to do the ratio of the 2 mean values. field\_ref="toce" means that attributes not explicitely defined, are inherited from toce field. Note that in this case, freq\_op must be equal to the file output\_freq. … … 681 661 682 662 - define a new variable in field\_definition 683 \vspace{-20pt} 684 \begin{xmllines} 685 <field id="ssh2" long\_name="square of sea surface temperature" unit="degC2" > ssh * ssh </field > 663 \begin{xmllines} 664 <field id="ssh2" long_name="square of sea surface temperature" unit="degC2" > ssh * ssh </field > 686 665 \end{xmllines} 687 666 - use it when defining your file. 688 \vspace{-20pt} 689 \begin{xmllines} 690 <file\_group id="1m" output\_freq="1m" output\_level="10" enabled=".TRUE." > <!-- 1m files --> 691 <file id="file1" name\_suffix="\_grid\_T" description="ocean T grid variables" > 692 <field field\_ref="ssh" name="sshstd" long\_name="sea\_surface\_temperature\_standard\_deviation" operation="instant" freq\_op="1m" > sqrt( @ssh2 - @ssh * @ssh ) </field> 667 \begin{xmllines} 668 <file_group id="1m" output_freq="1m" output_level="10" enabled=".true." > <!-- 1m files --> 669 <file id="file1" name_suffix="_grid_T" description="ocean T grid variables" > 670 <field field_ref="ssh" name="sshstd" long_name="sea_surface_temperature_standard_deviation" operation="instant" freq_op="1m" > sqrt( @ssh2 - @ssh * @ssh ) </field> 693 671 </file> 694 </file \_group>672 </file_group> 695 673 \end{xmllines} 696 674 The freq\_op="1m" attribute is used to define the operation frequency of the ``@'' function: here 1 month. The temporal operation done by the ``@'' is the one defined in the field definition: here we use the default, average. So, in the above case, @ssh2 will do the monthly mean of ssh*ssh. Operation="instant" refers to the temporal operation to be performed on the field ''sqrt( @ssh2 - @ssh * @ssh )'': here the temporal average is alreday done by the ``@'' function so we just use instant. field\_ref="ssh" means that attributes not explicitely defined, are inherited from ssh field. Note that in this case, freq\_op must be equal to the file output\_freq. … … 699 677 700 678 - define 2 new variables in field\_definition 701 \vspace{-20pt} 702 \begin{xmllines} 703 <field id="sstmax" field\_ref="sst" long\_name="max of sea surface temperature" operation="maximum" /> 704 <field id="sstmin" field\_ref="sst" long\_name="min of sea surface temperature" operation="minimum" /> 679 \begin{xmllines} 680 <field id="sstmax" field_ref="sst" long_name="max of sea surface temperature" operation="maximum" /> 681 <field id="sstmin" field_ref="sst" long_name="min of sea surface temperature" operation="minimum" /> 705 682 \end{xmllines} 706 683 - use these 2 new variables when defining your file. 707 \vspace{-20pt} 708 \begin{xmllines} 709 <file\_group id="1m" output\_freq="1m" output\_level="10" enabled=".TRUE." > <!-- 1m files --> 710 <file id="file1" name\_suffix="\_grid\_T" description="ocean T grid variables" > 711 <field field\_ref="sst" name="sstdcy" long\_name="amplitude of sst diurnal cycle" operation="average" freq\_op="1d" > @sstmax - @sstmin </field> 684 \begin{xmllines} 685 <file_group id="1m" output_freq="1m" output_level="10" enabled=".true." > <!-- 1m files --> 686 <file id="file1" name_suffix="_grid_T" description="ocean T grid variables" > 687 <field field_ref="sst" name="sstdcy" long_name="amplitude of sst diurnal cycle" operation="average" freq_op="1d" > @sstmax - @sstmin </field> 712 688 </file> 713 </file \_group>689 </file_group> 714 690 \end{xmllines} 715 691 The freq\_op="1d" attribute is used to define the operation frequency of the ``@'' function: here 1 day. The temporal operation done by the ``@'' is the one defined in the field definition: here maximum for sstmax and minimum for sstmin. So, in the above case, @sstmax will do the daily max and @sstmin the daily min. Operation="average" refers to the temporal operation to be performed on the field ``@sstmax - @sstmin'': here monthly mean (of daily max - daily min of the sst). field\_ref="sst" means that attributes not explicitely defined, are inherited from sst field. … … 852 828 enabled & 853 829 switch on/off the output of a field or a file & 854 enabled=". TRUE." &830 enabled=".true." & 855 831 field, file families \\ 856 832 \hline … … 1024 1000 Output from the XIOS-1.0 IO server is compliant with \href{http://cfconventions.org/Data/cf-conventions/cf-conventions-1.5/build/cf-conventions.html}{version 1.5} of the CF metadata standard. Therefore while a user may wish to add their own metadata to the output files (as demonstrated in example 4 of section \ref{IOM_xmlref}) the metadata should, for the most part, comply with the CF-1.5 standard. 1025 1001 1026 Some metadata that may significantly increase the file size (horizontal cell areas and vertices) are controlled by the namelist parameter \np{ln _cfmeta} in the \ngn{namrun} namelist. This must be set to true if these metadata are to be included in the output files.1002 Some metadata that may significantly increase the file size (horizontal cell areas and vertices) are controlled by the namelist parameter \np{ln\_cfmeta} in the \ngn{namrun} namelist. This must be set to true if these metadata are to be included in the output files. 1027 1003 1028 1004 … … 1030 1006 % NetCDF4 support 1031 1007 % ================================================================ 1032 \section{NetCDF4 Support (\protect\key{netcdf4})}1008 \section{NetCDF4 support (\protect\key{netcdf4})} 1033 1009 \label{DIA_iom} 1034 1010 … … 1048 1024 new libraries and will then read both NetCDF3 and NetCDF4 files. NEMO 1049 1025 executables linked with NetCDF4 libraries can be made to produce NetCDF3 1050 files by setting the \np{ln _nc4zip} logical to false in the \textit{namnc4}1026 files by setting the \np{ln\_nc4zip} logical to false in the \textit{namnc4} 1051 1027 namelist: 1052 1028 … … 1056 1032 1057 1033 If \key{netcdf4} has not been defined, these namelist parameters are not read. 1058 In this case, \np{ln _nc4zip} is set false and dummy routines for a few1034 In this case, \np{ln\_nc4zip} is set false and dummy routines for a few 1059 1035 NetCDF4-specific functions are defined. These functions will not be used but 1060 1036 need to be included so that compilation is possible with NetCDF3 libraries. … … 1079 1055 domain size in any dimension. The algorithm used is: 1080 1056 1081 \vspace{-20pt}1082 1057 \begin{forlines} 1083 1058 ichunksz(1) = MIN( idomain_size,MAX( (idomain_size-1)/nn_nchunks_i + 1 ,16 ) ) … … 1088 1063 1089 1064 \noindent As an example, setting: 1090 \vspace{-20pt}1091 1065 \begin{forlines} 1092 1066 nn_nchunks_i=4, nn_nchunks_j=4 and nn_nchunks_k=31 … … 1106 1080 &filesize & filesize & \% \\ 1107 1081 &(KB) & (KB) & \\ 1108 \ifile{ORCA2\_restart\_0000}& 16420 & 8860 & 47\%\\1109 \ifile{ORCA2\_restart\_0001}& 16064 & 11456 & 29\%\\1110 \ifile{ORCA2\_restart\_0002}& 16064 & 9744 & 40\%\\1111 \ifile{ORCA2\_restart\_0003}& 16420 & 9404 & 43\%\\1112 \ifile{ORCA2\_restart\_0004}& 16200 & 5844 & 64\%\\1113 \ifile{ORCA2\_restart\_0005}& 15848 & 8172 & 49\%\\1114 \ifile{ORCA2\_restart\_0006}& 15848 & 8012 & 50\%\\1115 \ifile{ORCA2\_restart\_0007}& 16200 & 5148 & 69\%\\1116 \ifile{ORCA2\_2d\_grid\_T\_0000}& 2200 & 1504 & 32\%\\1117 \ifile{ORCA2\_2d\_grid\_T\_0001}& 2200 & 1748 & 21\%\\1118 \ifile{ORCA2\_2d\_grid\_T\_0002}& 2200 & 1592 & 28\%\\1119 \ifile{ORCA2\_2d\_grid\_T\_0003}& 2200 & 1540 & 30\%\\1120 \ifile{ORCA2\_2d\_grid\_T\_0004}& 2200 & 1204 & 46\%\\1121 \ifile{ORCA2\_2d\_grid\_T\_0005}& 2200 & 1444 & 35\%\\1122 \ifile{ORCA2\_2d\_grid\_T\_0006}& 2200 & 1428 & 36\%\\1123 \ifile{ORCA2\_2d\_grid\_T\_0007}& 2200 & 1148 & 48\%\\1124 1125 \ifile{ORCA2\_2d\_grid\_W\_0000}& 4416 & 2240 & 50\%\\1126 \ifile{ORCA2\_2d\_grid\_W\_0001}& 4416 & 2924 & 34\%\\1127 \ifile{ORCA2\_2d\_grid\_W\_0002}& 4416 & 2512 & 44\%\\1128 \ifile{ORCA2\_2d\_grid\_W\_0003}& 4416 & 2368 & 47\%\\1129 \ifile{ORCA2\_2d\_grid\_W\_0004}& 4416 & 1432 & 68\%\\1130 \ifile{ORCA2\_2d\_grid\_W\_0005}& 4416 & 1972 & 56\%\\1131 \ifile{ORCA2\_2d\_grid\_W\_0006}& 4416 & 2028 & 55\%\\1132 \ifile{ORCA2\_2d\_grid\_W\_0007}& 4416 & 1368 & 70\%\\1082 ORCA2\_restart\_0000.nc & 16420 & 8860 & 47\%\\ 1083 ORCA2\_restart\_0001.nc & 16064 & 11456 & 29\%\\ 1084 ORCA2\_restart\_0002.nc & 16064 & 9744 & 40\%\\ 1085 ORCA2\_restart\_0003.nc & 16420 & 9404 & 43\%\\ 1086 ORCA2\_restart\_0004.nc & 16200 & 5844 & 64\%\\ 1087 ORCA2\_restart\_0005.nc & 15848 & 8172 & 49\%\\ 1088 ORCA2\_restart\_0006.nc & 15848 & 8012 & 50\%\\ 1089 ORCA2\_restart\_0007.nc & 16200 & 5148 & 69\%\\ 1090 ORCA2\_2d\_grid\_T\_0000.nc & 2200 & 1504 & 32\%\\ 1091 ORCA2\_2d\_grid\_T\_0001.nc & 2200 & 1748 & 21\%\\ 1092 ORCA2\_2d\_grid\_T\_0002.nc & 2200 & 1592 & 28\%\\ 1093 ORCA2\_2d\_grid\_T\_0003.nc & 2200 & 1540 & 30\%\\ 1094 ORCA2\_2d\_grid\_T\_0004.nc & 2200 & 1204 & 46\%\\ 1095 ORCA2\_2d\_grid\_T\_0005.nc & 2200 & 1444 & 35\%\\ 1096 ORCA2\_2d\_grid\_T\_0006.nc & 2200 & 1428 & 36\%\\ 1097 ORCA2\_2d\_grid\_T\_0007.nc & 2200 & 1148 & 48\%\\ 1098 ... & ... & ... & ... \\ 1099 ORCA2\_2d\_grid\_W\_0000.nc & 4416 & 2240 & 50\%\\ 1100 ORCA2\_2d\_grid\_W\_0001.nc & 4416 & 2924 & 34\%\\ 1101 ORCA2\_2d\_grid\_W\_0002.nc & 4416 & 2512 & 44\%\\ 1102 ORCA2\_2d\_grid\_W\_0003.nc & 4416 & 2368 & 47\%\\ 1103 ORCA2\_2d\_grid\_W\_0004.nc & 4416 & 1432 & 68\%\\ 1104 ORCA2\_2d\_grid\_W\_0005.nc & 4416 & 1972 & 56\%\\ 1105 ORCA2\_2d\_grid\_W\_0006.nc & 4416 & 2028 & 55\%\\ 1106 ORCA2\_2d\_grid\_W\_0007.nc & 4416 & 1368 & 70\%\\ 1133 1107 \end{tabular} 1134 1108 \caption{ \protect\label{Tab_NC4} … … 1138 1112 1139 1113 When \key{iomput} is activated with \key{netcdf4} chunking and 1140 compression parameters for fields produced via \np{iom _put} calls are1114 compression parameters for fields produced via \np{iom\_put} calls are 1141 1115 set via an equivalent and identically named namelist to \textit{namnc4} 1142 1116 in \np{xmlio\_server.def}. Typically this namelist serves the mean files … … 1151 1125 % Tracer/Dynamics Trends 1152 1126 % ------------------------------------------------------------------------------------------------------------- 1153 \section[Tracer/Dynamics Trends (TRD)] 1154 {Tracer/Dynamics Trends (\protect\ngn{namtrd})} 1127 \section{Tracer/Dynamics trends (\protect\ngn{namtrd})} 1155 1128 \label{DIA_trd} 1156 1129 … … 1165 1138 Note that the output are done with xIOS, and therefore the \key{IOM} is required. 1166 1139 1167 What is done depends on the \ngn{namtrd} logical set to \ textit{true}:1140 What is done depends on the \ngn{namtrd} logical set to \forcode{.true.}: 1168 1141 \begin{description} 1169 \item[\np{ln _glo_trd}] : at each \np{nn_trd} time-step a check of the basin averaged properties1142 \item[\np{ln\_glo\_trd}] : at each \np{nn\_trd} time-step a check of the basin averaged properties 1170 1143 of the momentum and tracer equations is performed. This also includes a check of $T^2$, $S^2$, 1171 1144 $\tfrac{1}{2} (u^2+v2)$, and potential energy time evolution equations properties ; 1172 \item[\np{ln _dyn_trd}] : each 3D trend of the evolution of the two momentum components is output ;1173 \item[\np{ln _dyn_mxl}] : each 3D trend of the evolution of the two momentum components averaged1145 \item[\np{ln\_dyn\_trd}] : each 3D trend of the evolution of the two momentum components is output ; 1146 \item[\np{ln\_dyn\_mxl}] : each 3D trend of the evolution of the two momentum components averaged 1174 1147 over the mixed layer is output ; 1175 \item[\np{ln _vor_trd}] : a vertical summation of the moment tendencies is performed,1148 \item[\np{ln\_vor\_trd}] : a vertical summation of the moment tendencies is performed, 1176 1149 then the curl is computed to obtain the barotropic vorticity tendencies which are output ; 1177 \item[\np{ln _KE_trd}] : each 3D trend of the Kinetic Energy equation is output ;1178 \item[\np{ln _tra_trd}] : each 3D trend of the evolution of temperature and salinity is output ;1179 \item[\np{ln _tra_mxl}] : each 2D trend of the evolution of temperature and salinity averaged1150 \item[\np{ln\_KE\_trd}] : each 3D trend of the Kinetic Energy equation is output ; 1151 \item[\np{ln\_tra\_trd}] : each 3D trend of the evolution of temperature and salinity is output ; 1152 \item[\np{ln\_tra\_mxl}] : each 2D trend of the evolution of temperature and salinity averaged 1180 1153 over the mixed layer is output ; 1181 1154 \end{description} … … 1185 1158 1186 1159 \textbf{Note that} in the current version (v3.6), many changes has been introduced but not fully tested. 1187 In particular, options associated with \np{ln _dyn_mxl}, \np{ln_vor_trd}, and \np{ln_tra_mxl}1160 In particular, options associated with \np{ln\_dyn\_mxl}, \np{ln\_vor\_trd}, and \np{ln\_tra\_mxl} 1188 1161 are not working, and none of the option have been tested with variable volume ($i.e.$ \key{vvl} defined). 1189 1162 … … 1192 1165 % On-line Floats trajectories 1193 1166 % ------------------------------------------------------------------------------------------------------------- 1194 \section{ On-line Floats trajectories (FLO)(\protect\key{floats})}1167 \section{FLO: On-Line Floats trajectories (\protect\key{floats})} 1195 1168 \label{FLO} 1196 1169 %--------------------------------------------namflo------------------------------------------------------- … … 1203 1176 namelis variables. The algorithm used is based 1204 1177 either on the work of \cite{Blanke_Raynaud_JPO97} (default option), or on a $4^th$ 1205 Runge-Hutta algorithm (\ forcode{ln_flork4= .true.}). Note that the \cite{Blanke_Raynaud_JPO97}1178 Runge-Hutta algorithm (\np{ln\_flork4}\forcode{ = .true.}). Note that the \cite{Blanke_Raynaud_JPO97} 1206 1179 algorithm have the advantage of providing trajectories which are consistent with the 1207 1180 numeric of the code, so that the trajectories never intercept the bathymetry. … … 1209 1182 \subsubsection{ Input data: initial coordinates } 1210 1183 1211 Initial coordinates can be given with Ariane Tools convention ( IJK coordinates ,(\ forcode{ln_ariane= .true.}) )1184 Initial coordinates can be given with Ariane Tools convention ( IJK coordinates ,(\np{ln\_ariane}\forcode{ = .true.}) ) 1212 1185 or with longitude and latitude. 1213 1186 1214 1187 1215 In case of Ariane convention, input filename is \np{init _float_ariane}. Its format is:1188 In case of Ariane convention, input filename is \np{init\_float\_ariane}. Its format is: 1216 1189 1217 1190 \texttt{ I J K nisobfl itrash itrash } … … 1258 1231 1259 1232 \np{jpnfl} is the total number of floats during the run. 1260 When initial positions are read in a restart file ( \np{ln_rstflo}= .TRUE.), \np{jpnflnewflo}1233 When initial positions are read in a restart file (\np{ln\_rstflo}\forcode{ = .true.} ), \np{jpnflnewflo} 1261 1234 can be added in the initialization file. 1262 1235 1263 \subsubsection{ Output data}1264 1265 \np{nn _writefl} is the frequency of writing in float output file and \np{nn_stockfl}1236 \subsubsection{Output data} 1237 1238 \np{nn\_writefl} is the frequency of writing in float output file and \np{nn\_stockfl} 1266 1239 is the frequency of creation of the float restart file. 1267 1240 1268 Output data can be written in ascii files (\np{ln _flo_ascii} = .TRUE.). In that case,1241 Output data can be written in ascii files (\np{ln\_flo\_ascii}\forcode{ = .true.}). In that case, 1269 1242 output filename is trajec\_float. 1270 1243 1271 Another possiblity of writing format is Netcdf (\np{ln _flo_ascii} = .FALSE.). There are 2 possibilities:1244 Another possiblity of writing format is Netcdf (\np{ln\_flo\_ascii}\forcode{ = .false.}). There are 2 possibilities: 1272 1245 1273 1246 - if (\key{iomput}) is used, outputs are selected in iodef.xml. Here it is an example of specification 1274 1247 to put in files description section: 1275 1248 1276 \vspace{-30pt} 1277 \begin{xmllines} 1278 <group id="1d\_grid\_T" name="auto" description="ocean T grid variables" > } 1249 \begin{xmllines} 1250 <group id="1d_grid_T" name="auto" description="ocean T grid variables" > } 1279 1251 <file id="floats" description="floats variables"> }\\ 1280 <field ref="traj \_lon" name="floats\_longitude" freq\_op="86400" />}1281 <field ref="traj \_lat" name="floats\_latitude" freq\_op="86400" />}1282 <field ref="traj \_dep" name="floats\_depth" freq\_op="86400" />}1283 <field ref="traj \_temp" name="floats\_temperature" freq\_op="86400" />}1284 <field ref="traj \_salt" name="floats\_salinity" freq\_op="86400" />}1285 <field ref="traj \_dens" name="floats\_density" freq\_op="86400" />}1286 <field ref="traj \_group" name="floats\_group" freq\_op="86400" />}1252 <field ref="traj_lon" name="floats_longitude" freq_op="86400" />} 1253 <field ref="traj_lat" name="floats_latitude" freq_op="86400" />} 1254 <field ref="traj_dep" name="floats_depth" freq_op="86400" />} 1255 <field ref="traj_temp" name="floats_temperature" freq_op="86400" />} 1256 <field ref="traj_salt" name="floats_salinity" freq_op="86400" />} 1257 <field ref="traj_dens" name="floats_density" freq_op="86400" />} 1258 <field ref="traj_group" name="floats_group" freq_op="86400" />} 1287 1259 </file>} 1288 1260 </group>} … … 1312 1284 Some parameters are available in namelist \ngn{namdia\_harm} : 1313 1285 1314 - \np{nit000 _han} is the first time step used for harmonic analysis1315 1316 - \np{nitend _han} is the last time step used for harmonic analysis1317 1318 - \np{nstep _han} is the time step frequency for harmonic analysis1319 1320 - \np{nb _ana} is the number of harmonics to analyse1286 - \np{nit000\_han} is the first time step used for harmonic analysis 1287 1288 - \np{nitend\_han} is the last time step used for harmonic analysis 1289 1290 - \np{nstep\_han} is the time step frequency for harmonic analysis 1291 1292 - \np{nb\_ana} is the number of harmonics to analyse 1321 1293 1322 1294 - \np{tname} is an array with names of tidal constituents to analyse 1323 1295 1324 \np{nit000 _han} and \np{nitend_han} must be between \np{nit000} and \np{nitend} of the simulation.1296 \np{nit000\_han} and \np{nitend\_han} must be between \np{nit000} and \np{nitend} of the simulation. 1325 1297 The restart capability is not implemented. 1326 1298 … … 1369 1341 and the time scales over which they are averaged, as well as the level of output for debugging: 1370 1342 1371 \np{nn _dct}: frequency of instantaneous transports computing1372 1373 \np{nn _dctwri}: frequency of writing ( mean of instantaneous transports )1374 1375 \np{nn _debug}: debugging of the section1376 1377 \subsubsection{ Creating a binary file containing the pathway of each section}1343 \np{nn\_dct}: frequency of instantaneous transports computing 1344 1345 \np{nn\_dctwri}: frequency of writing ( mean of instantaneous transports ) 1346 1347 \np{nn\_debug}: debugging of the section 1348 1349 \subsubsection{Creating a binary file containing the pathway of each section} 1378 1350 1379 1351 In \texttt{NEMOGCM/TOOLS/SECTIONS\_DIADCT/run}, the file \textit{ {list\_sections.ascii\_global}} … … 1460 1432 1461 1433 1462 \subsubsection{ To read the output files}1434 \subsubsection{To read the output files} 1463 1435 1464 1436 The output format is : … … 1494 1466 % Steric effect in sea surface height 1495 1467 % ================================================================ 1496 \section{Diagnosing the Steric effect in sea surface height}1468 \section{Diagnosing the steric effect in sea surface height} 1497 1469 \label{DIA_steric} 1498 1470 … … 1649 1621 % Other Diagnostics 1650 1622 % ------------------------------------------------------------------------------------------------------------- 1651 \section{Other Diagnostics (\protect\key{diahth}, \protect\key{diaar5})}1623 \section{Other diagnostics (\protect\key{diahth}, \protect\key{diaar5})} 1652 1624 \label{DIA_diag_others} 1653 1625 … … 1681 1653 The poleward heat and salt transports, their advective and diffusive component, and 1682 1654 the meriodional stream function can be computed on-line in \mdl{diaptr} 1683 \np{ln _diaptr} to true (see the \textit{\ngn{namptr} } namelist below).1684 When \np{ln _subbas}~=~true, transports and stream function are computed1655 \np{ln\_diaptr} to true (see the \textit{\ngn{namptr} } namelist below). 1656 When \np{ln\_subbas}\forcode{ = .true.}, transports and stream function are computed 1685 1657 for the Atlantic, Indian, Pacific and Indo-Pacific Oceans (defined north of 30\deg S) 1686 1658 as well as for the World Ocean. The sub-basin decomposition requires an input file … … 1716 1688 % 25 hour mean and hourly Surface, Mid and Bed 1717 1689 % ----------------------------------------------------------- 1718 \subsection{25 hour mean output for tidal models 1690 \subsection{25 hour mean output for tidal models} 1719 1691 1720 1692 %------------------------------------------nam_dia25h------------------------------------- … … 1731 1703 % Top Middle and Bed hourly output 1732 1704 % ----------------------------------------------------------- 1733 \subsection{Top Middle and Bed hourly output}1705 \subsection{Top middle and bed hourly output} 1734 1706 1735 1707 %------------------------------------------nam_diatmb----------------------------------------------------- … … 1756 1728 in the zonal, meridional and vertical directions respectively. The vertical component is included although it is not strictly valid as the vertical velocity is calculated from the continuity equation rather than as a prognostic variable. Physically this represents the rate at which information is propogated across a grid cell. Values greater than 1 indicate that information is propagated across more than one grid cell in a single time step. 1757 1729 1758 The variables can be activated by setting the \np{nn _diacfl} namelist parameter to 1 in the \ngn{namctl} namelist. The diagnostics will be written out to an ascii file named cfl\_diagnostics.ascii. In this file the maximum value of $C_u$, $C_v$, and $C_w$ are printed at each timestep along with the coordinates of where the maximum value occurs. At the end of the model run the maximum value of $C_u$, $C_v$, and $C_w$ for the whole model run is printed along with the coordinates of each. The maximum values from the run are also copied to the ocean.output file.1730 The variables can be activated by setting the \np{nn\_diacfl} namelist parameter to 1 in the \ngn{namctl} namelist. The diagnostics will be written out to an ascii file named cfl\_diagnostics.ascii. In this file the maximum value of $C_u$, $C_v$, and $C_w$ are printed at each timestep along with the coordinates of where the maximum value occurs. At the end of the model run the maximum value of $C_u$, $C_v$, and $C_w$ for the whole model run is printed along with the coordinates of each. The maximum values from the run are also copied to the ocean.output file. 1759 1731 1760 1732 -
branches/2017/dev_merge_2017/DOC/tex_sub/chap_DIU.tex
r9392 r9393 5 5 % Edited by James While 6 6 % ================================================================ 7 \chapter{Diurnal SST models (DIU)}7 \chapter{Diurnal SST Models (DIU)} 8 8 \label{DIU} 9 9 … … 37 37 This namelist contains only two variables: 38 38 \begin{description} 39 \item[\np{ln _diurnal}] A logical switch for turning on/off both the cool skin and warm layer.40 \item[\np{ln _diurnal_only}] A logical switch which if .TRUE.will run the diurnal model39 \item[\np{ln\_diurnal}] A logical switch for turning on/off both the cool skin and warm layer. 40 \item[\np{ln\_diurnal\_only}] A logical switch which if \forcode{.true.} will run the diurnal model 41 41 without the other dynamical parts of NEMO. 42 \np{ln _diurnal_only} must be .FALSE. if \np{ln_diurnal} is .FALSE.42 \np{ln\_diurnal\_only} must be \forcode{.false.} if \np{ln\_diurnal} is \forcode{.false.}. 43 43 \end{description} 44 44 … … 53 53 54 54 %=============================================================== 55 \section{Warm Layer model}55 \section{Warm layer model} 56 56 \label{warm_layer_sec} 57 57 %=============================================================== … … 120 120 %=============================================================== 121 121 122 \section{Cool Skin model}122 \section{Cool skin model} 123 123 \label{cool_skin_sec} 124 124 -
branches/2017/dev_merge_2017/DOC/tex_sub/chap_DOM.tex
r9392 r9393 4 4 % Chapter 2 ——— Space and Time Domain (DOM) 5 5 % ================================================================ 6 \chapter{Space Domain (DOM) 6 \chapter{Space Domain (DOM)} 7 7 \label{DOM} 8 8 \minitoc … … 31 31 % Fundamentals of the Discretisation 32 32 % ================================================================ 33 \section{Fundamentals of the Discretisation}33 \section{Fundamentals of the discretisation} 34 34 \label{DOM_basics} 35 35 … … 37 37 % Arrangement of Variables 38 38 % ------------------------------------------------------------------------------------------------------------- 39 \subsection{Arrangement of Variables}39 \subsection{Arrangement of variables} 40 40 \label{DOM_cell} 41 41 … … 107 107 % Vector Invariant Formulation 108 108 % ------------------------------------------------------------------------------------------------------------- 109 \subsection{Discrete Operators}109 \subsection{Discrete operators} 110 110 \label{DOM_operators} 111 111 … … 198 198 % Numerical Indexing 199 199 % ------------------------------------------------------------------------------------------------------------- 200 \subsection{Numerical Indexing}200 \subsection{Numerical indexing} 201 201 \label{DOM_Num_Index} 202 202 … … 221 221 % Horizontal Indexing 222 222 % ----------------------------------- 223 \subsubsection{Horizontal Indexing}223 \subsubsection{Horizontal indexing} 224 224 \label{DOM_Num_Index_hor} 225 225 … … 232 232 % Vertical indexing 233 233 % ----------------------------------- 234 \subsubsection{Vertical Indexing}234 \subsubsection{Vertical indexing} 235 235 \label{DOM_Num_Index_vertical} 236 236 … … 264 264 % Domain Size 265 265 % ----------------------------------- 266 \subsubsection{Domain Size}266 \subsubsection{Domain size} 267 267 \label{DOM_size} 268 268 … … 281 281 % Domain: List of fields needed 282 282 % ================================================================ 283 \section [Domain: Needed fields] 284 {Domain: Needed fields} 283 \section{Needed fields} 285 284 \label{DOM_fields} 286 285 The ocean mesh ($i.e.$ the position of all the scalar and vector points) is defined … … 309 308 ie1e2u\_v is a flag to flag set u and v surfaces are neither read nor computed.\\ 310 309 311 These fields can be read in an domain input file which name is setted in \np{cn _domcfg} parameter specified in \ngn{namcfg}.310 These fields can be read in an domain input file which name is setted in \np{cn\_domcfg} parameter specified in \ngn{namcfg}. 312 311 \forfile{../namelists/namcfg} 313 312 or they can be defined in an analytical way in MY\_SRC directory of the configuration. … … 323 322 % Domain: Horizontal Grid (mesh) 324 323 % ================================================================ 325 \section [Domain: Horizontal Grid (mesh) (\textit{domhgr})] 326 {Domain: Horizontal Grid (mesh) \small{(\protect\mdl{domhgr} module)} } 324 \section{Horizontal grid mesh (\protect\mdl{domhgr})} 327 325 \label{DOM_hgr} 328 326 … … 409 407 % Grid files 410 408 % ------------------------------------------------------------------------------------------------------------- 411 \subsection{Output Grid files}409 \subsection{Output grid files} 412 410 \label{DOM_hgr_files} 413 411 414 412 All the arrays relating to a particular ocean model configuration (grid-point 415 position, scale factors, masks) can be saved in files if $nn\_msh\not= 0$413 position, scale factors, masks) can be saved in files if \np{nn\_msh} $\not= 0$ 416 414 (namelist variable in \ngn{namdom}). This can be particularly useful for plots and off-line 417 415 diagnostics. In some cases, the user may choose to make a local modification … … 420 418 happens to be too wide due to insufficient model resolution). An example 421 419 is Gibraltar Strait in the ORCA2 configuration. When such modifications are done, 422 the output grid written when $nn\_msh\not= 0$ is no more equal to the input grid.420 the output grid written when \np{nn\_msh} $\not= 0$ is no more equal to the input grid. 423 421 424 422 $\ $\newline % force a new line … … 427 425 % Domain: Vertical Grid (domzgr) 428 426 % ================================================================ 429 \section [Domain: Vertical Grid (\textit{domzgr})] 430 {Domain: Vertical Grid \small{(\protect\mdl{domzgr} module)} } 427 \section{Vertical grid (\protect\mdl{domzgr})} 431 428 \label{DOM_zgr} 432 429 %-----------------------------------------nam_zgr & namdom------------------------------------------- … … 454 451 (d) hybrid $s-z$ coordinate, 455 452 (e) hybrid $s-z$ coordinate with partial step, and 456 (f) same as (e) but in the non-linear free surface (\ protect\forcode{ln_linssh= .false.}).453 (f) same as (e) but in the non-linear free surface (\np{ln\_linssh}\forcode{ = .false.}). 457 454 Note that the non-linear free surface can be used with any of the 458 455 5 coordinates (a) to (e).} … … 464 461 option which can be enabled or disabled in the middle of an experiment. Three main 465 462 choices are offered (Fig.~\ref{Fig_z_zps_s_sps}a to c): $z$-coordinate with full step 466 bathymetry (\np{ln _zco}~=~true), $z$-coordinate with partial step bathymetry467 (\np{ln _zps}~=~true), or generalized, $s$-coordinate (\np{ln_sco}~=~true).463 bathymetry (\np{ln\_zco}\forcode{ = .true.}), $z$-coordinate with partial step bathymetry 464 (\np{ln\_zps}\forcode{ = .true.}), or generalized, $s$-coordinate (\np{ln\_sco}\forcode{ = .true.}). 468 465 Hybridation of the three main coordinates are available: $s-z$ or $s-zps$ coordinate 469 466 (Fig.~\ref{Fig_z_zps_s_sps}d and \ref{Fig_z_zps_s_sps}e). By default a non-linear free surface is used: 470 467 the coordinate follow the time-variation of the free surface so that the transformation is time dependent: 471 $z(i,j,k,t)$ (Fig.~\ref{Fig_z_zps_s_sps}f). When a linear free surface is assumed (\ forcode{ln_linssh= .true.}),468 $z(i,j,k,t)$ (Fig.~\ref{Fig_z_zps_s_sps}f). When a linear free surface is assumed (\np{ln\_linssh}\forcode{ = .true.}), 472 469 the vertical coordinate are fixed in time, but the seawater can move up and down across the z=0 surface 473 470 (in other words, the top of the ocean in not a rigid-lid). 474 471 The last choice in terms of vertical coordinate concerns the presence (or not) in the model domain 475 of ocean cavities beneath ice shelves. Setting \np{ln _isfcav} to true allows to manage ocean cavities,472 of ocean cavities beneath ice shelves. Setting \np{ln\_isfcav} to true allows to manage ocean cavities, 476 473 otherwise they are filled in. This option is currently only available in $z$- or $zps$-coordinate, 477 474 and partial step are also applied at the ocean/ice shelf interface. … … 483 480 \ifile{bathy\_meter} file, so that the computation of the number of wet ocean point 484 481 in each water column is by-passed}. 485 If \np{ln _isfcav}~=~true, an extra file input file describing the ice shelf draft482 If \np{ln\_isfcav}\forcode{ = .true.}, an extra file input file describing the ice shelf draft 486 483 (in meters) (\ifile{isf\_draft\_meter}) is needed. 487 484 … … 503 500 %%% 504 501 505 Unless a linear free surface is used (\ forcode{ln_linssh= .false.}), the arrays describing502 Unless a linear free surface is used (\np{ln\_linssh}\forcode{ = .false.}), the arrays describing 506 503 the grid point depths and vertical scale factors are three set of three dimensional arrays $(i,j,k)$ 507 504 defined at \textit{before}, \textit{now} and \textit{after} time step. The time at which they are 508 505 defined is indicated by a suffix:$\_b$, $\_n$, or $\_a$, respectively. They are updated at each model time step 509 506 using a fixed reference coordinate system which computer names have a $\_0$ suffix. 510 When the linear free surface option is used (\ forcode{ln_linssh= .true.}), \textit{before}, \textit{now}507 When the linear free surface option is used (\np{ln\_linssh}\forcode{ = .true.}), \textit{before}, \textit{now} 511 508 and \textit{after} arrays are simply set one for all to their reference counterpart. 512 509 … … 515 512 % Meter Bathymetry 516 513 % ------------------------------------------------------------------------------------------------------------- 517 \subsection{Meter Bathymetry}514 \subsection{Meter bathymetry} 518 515 \label{DOM_bathy} 519 516 520 517 Three options are possible for defining the bathymetry, according to the 521 namelist variable \np{nn _bathy} (found in \ngn{namdom} namelist):518 namelist variable \np{nn\_bathy} (found in \ngn{namdom} namelist): 522 519 \begin{description} 523 \item[\np{nn _bathy} = 0]a flat-bottom domain is defined. The total depth $z_w (jpk)$520 \item[\np{nn\_bathy}\forcode{ = 0}]: a flat-bottom domain is defined. The total depth $z_w (jpk)$ 524 521 is given by the coordinate transformation. The domain can either be a closed 525 522 basin or a periodic channel depending on the parameter \np{jperio}. 526 \item[\np{nn _bathy} = -1]a domain with a bump of topography one third of the523 \item[\np{nn\_bathy}\forcode{ = -1}]: a domain with a bump of topography one third of the 527 524 domain width at the central latitude. This is meant for the "EEL-R5" configuration, 528 525 a periodic or open boundary channel with a seamount. 529 \item[\np{nn _bathy} = 1]read a bathymetry and ice shelf draft (if needed).526 \item[\np{nn\_bathy}\forcode{ = 1}]: read a bathymetry and ice shelf draft (if needed). 530 527 The \ifile{bathy\_meter} file (Netcdf format) provides the ocean depth (positive, in meters) 531 528 at each grid point of the model grid. The bathymetry is usually built by interpolating a standard bathymetry product … … 535 532 536 533 The \ifile{isfdraft\_meter} file (Netcdf format) provides the ice shelf draft (positive, in meters) 537 at each grid point of the model grid. This file is only needed if \np{ln _isfcav}~=~true.534 at each grid point of the model grid. This file is only needed if \np{ln\_isfcav}\forcode{ = .true.}. 538 535 Defining the ice shelf draft will also define the ice shelf edge and the grounding line position. 539 536 \end{description} … … 550 547 % z-coordinate and reference coordinate transformation 551 548 % ------------------------------------------------------------------------------------------------------------- 552 \subsection[$ z$-coordinate (\protect\np{ln_zco}]553 {$z$-coordinate (\protect\forcode{ln_zco= .true.}) and reference coordinate}549 \subsection[$Z$-coordinate (\protect\np{ln\_zco}\forcode{ = .true.}) and ref. coordinate] 550 {$Z$-coordinate (\protect\np{ln\_zco}\forcode{ = .true.}) and reference coordinate} 554 551 \label{DOM_zco} 555 552 … … 593 590 (Fig.~\ref{Fig_zgr}). 594 591 595 If the ice shelf cavities are opened (\np{ln _isfcav}=~true~), the definition of $z_0$ is the same.592 If the ice shelf cavities are opened (\np{ln\_isfcav}\forcode{ = .true.}), the definition of $z_0$ is the same. 596 593 However, definition of $e_3^0$ at $t$- and $w$-points is respectively changed to: 597 594 \begin{equation} \label{DOM_zgr_ana} … … 629 626 Rather than entering parameters $h_{sur}$, $h_{0}$, and $h_{1}$ directly, it is 630 627 possible to recalculate them. In that case the user sets 631 \np{ppsur} =\np{ppa0}=\forcode{ppa1= 999999}., in \ngn{namcfg} namelist,628 \np{ppsur}\forcode{ = }\np{ppa0}\forcode{ = }\np{ppa1}\forcode{ = 999999}., in \ngn{namcfg} namelist, 632 629 and specifies instead the four following parameters: 633 630 \begin{itemize} … … 640 637 \end{itemize} 641 638 As an example, for the $45$ layers used in the DRAKKAR configuration those 642 parameters are: \jp{jpk}=46, \forcode{ppacr = 9}, \forcode{ppkth = 23}.563, \forcode{ppdzmin = 6}m, 643 \forcode{pphmax = 5750}m. 639 parameters are: \jp{jpk}\forcode{ = 46}, \np{ppacr}\forcode{ = 9}, \np{ppkth}\forcode{ = 23.563}, \np{ppdzmin}\forcode{ = 6}m, \np{pphmax}\forcode{ = 5750}m. 644 640 645 641 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> … … 688 684 % z-coordinate with partial step 689 685 % ------------------------------------------------------------------------------------------------------------- 690 \subsection [$z$-coordinate with partial step (\protect\np{ln_zps})] 691 {$z$-coordinate with partial step (\protect\np{ln_zps}=.true.)} 686 \subsection{$Z$-coordinate with partial step (\protect\np{ln\_zps}\forcode{ = .true.})} 692 687 \label{DOM_zps} 693 688 %--------------------------------------------namdom------------------------------------------------------- … … 712 707 Two variables in the namdom namelist are used to define the partial step 713 708 vertical grid. The mimimum water thickness (in meters) allowed for a cell 714 partially filled with bathymetry at level jk is the minimum of \np{rn _e3zps_min}715 (thickness in meters, usually $20~m$) or $e_{3t}(jk)* rn\_e3zps\_rat$(a fraction,709 partially filled with bathymetry at level jk is the minimum of \np{rn\_e3zps\_min} 710 (thickness in meters, usually $20~m$) or $e_{3t}(jk)*$\np{rn\_e3zps\_rat} (a fraction, 716 711 usually 10\%, of the default thickness $e_{3t}(jk)$). 717 712 … … 721 716 % s-coordinate 722 717 % ------------------------------------------------------------------------------------------------------------- 723 \subsection [$s$-coordinate (\protect\np{ln_sco})] 724 {$s$-coordinate (\protect\forcode{ln_sco = .true.})} 718 \subsection{$S$-coordinate (\protect\np{ln\_sco}\forcode{ = .true.})} 725 719 \label{DOM_sco} 726 720 %------------------------------------------nam_zgr_sco--------------------------------------------------- … … 728 722 %-------------------------------------------------------------------------------------------------------------- 729 723 Options are defined in \ngn{namzgr\_sco}. 730 In $s$-coordinate (\np{ln _sco}~=~true), the depth and thickness of the model724 In $s$-coordinate (\np{ln\_sco}\forcode{ = .true.}), the depth and thickness of the model 731 725 levels are defined from the product of a depth field and either a stretching 732 726 function or its derivative, respectively: … … 744 738 depth, since a mixed step-like and bottom-following representation of the 745 739 topography can be used (Fig.~\ref{Fig_z_zps_s_sps}d-e) or an envelop bathymetry can be defined (Fig.~\ref{Fig_z_zps_s_sps}f). 746 The namelist parameter \np{rn _rmax} determines the slope at which the terrain-following coordinate intersects740 The namelist parameter \np{rn\_rmax} determines the slope at which the terrain-following coordinate intersects 747 741 the sea bed and becomes a pseudo z-coordinate. 748 The coordinate can also be hybridised by specifying \np{rn _sbot_min} and \np{rn_sbot_max}742 The coordinate can also be hybridised by specifying \np{rn\_sbot\_min} and \np{rn\_sbot\_max} 749 743 as the minimum and maximum depths at which the terrain-following vertical coordinate is calculated. 750 744 … … 753 747 754 748 The original default NEMO s-coordinate stretching is available if neither of the other options 755 are specified as true (\np{ln _s_SH94}~=~false and \np{ln_s_SF12}~=~false).749 are specified as true (\np{ln\_s\_SH94}\forcode{ = .false.} and \np{ln\_s\_SF12}\forcode{ = .false.}). 756 750 This uses a depth independent $\tanh$ function for the stretching \citep{Madec_al_JPO96}: 757 751 … … 779 773 780 774 A stretching function, modified from the commonly used \citet{Song_Haidvogel_JCP94} 781 stretching (\np{ln _s_SH94}~=~true), is also available and is more commonly used for shelf seas modelling:775 stretching (\np{ln\_s\_SH94}\forcode{ = .true.}), is also available and is more commonly used for shelf seas modelling: 782 776 783 777 \begin{equation} … … 796 790 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 797 791 798 where $H_c$ is the critical depth (\np{rn _hc}) at which the coordinate transitions from799 pure $\sigma$ to the stretched coordinate, and $\theta$ (\np{rn _theta}) and $b$ (\np{rn_bb})792 where $H_c$ is the critical depth (\np{rn\_hc}) at which the coordinate transitions from 793 pure $\sigma$ to the stretched coordinate, and $\theta$ (\np{rn\_theta}) and $b$ (\np{rn\_bb}) 800 794 are the surface and bottom control parameters such that $0\leqslant \theta \leqslant 20$, and 801 795 $0\leqslant b\leqslant 1$. $b$ has been designed to allow surface and/or bottom 802 796 increase of the vertical resolution (Fig.~\ref{Fig_sco_function}). 803 797 804 Another example has been provided at version 3.5 (\np{ln _s_SF12}) that allows798 Another example has been provided at version 3.5 (\np{ln\_s\_SF12}) that allows 805 799 a fixed surface resolution in an analytical terrain-following stretching \citet{Siddorn_Furner_OM12}. 806 800 In this case the a stretching function $\gamma$ is defined such that: … … 823 817 824 818 This gives an analytical stretching of $\sigma$ that is solvable in $A$ and $B$ as a function of 825 the user prescribed stretching parameter $\alpha$ (\np{rn _alpha}) that stretches towards826 the surface ($\alpha > 1.0$) or the bottom ($\alpha < 1.0$) and user prescribed surface (\np{rn _zs})819 the user prescribed stretching parameter $\alpha$ (\np{rn\_alpha}) that stretches towards 820 the surface ($\alpha > 1.0$) or the bottom ($\alpha < 1.0$) and user prescribed surface (\np{rn\_zs}) 827 821 and bottom depths. The bottom cell depth in this example is given as a function of water depth: 828 822 … … 831 825 \end{equation} 832 826 833 where the namelist parameters \np{rn _zb_a} and \np{rn_zb_b} are $a$ and $b$ respectively.827 where the namelist parameters \np{rn\_zb\_a} and \np{rn\_zb\_b} are $a$ and $b$ respectively. 834 828 835 829 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> … … 843 837 This gives a smooth analytical stretching in computational space that is constrained to given specified surface and bottom grid cell thicknesses in real space. This is not to be confused with the hybrid schemes that superimpose geopotential coordinates on terrain following coordinates thus creating a non-analytical vertical coordinate that therefore may suffer from large gradients in the vertical resolutions. This stretching is less straightforward to implement than the \citet{Song_Haidvogel_JCP94} stretching, but has the advantage of resolving diurnal processes in deep water and has generally flatter slopes. 844 838 845 As with the \citet{Song_Haidvogel_JCP94} stretching the stretch is only applied at depths greater than the critical depth $h_c$. In this example two options are available in depths shallower than $h_c$, with pure sigma being applied if the \np{ln _sigcrit} is true and pure z-coordinates if it is false (the z-coordinate being equal to the depths of the stretched coordinate at $h_c$.839 As with the \citet{Song_Haidvogel_JCP94} stretching the stretch is only applied at depths greater than the critical depth $h_c$. In this example two options are available in depths shallower than $h_c$, with pure sigma being applied if the \np{ln\_sigcrit} is true and pure z-coordinates if it is false (the z-coordinate being equal to the depths of the stretched coordinate at $h_c$. 846 840 847 841 Minimising the horizontal slope of the vertical coordinate is important in terrain-following systems as large slopes lead to hydrostatic consistency. A hydrostatic consistency parameter diagnostic following \citet{Haney1991} has been implemented, and is output as part of the model mesh file at the start of the run. … … 850 844 % z*- or s*-coordinate 851 845 % ------------------------------------------------------------------------------------------------------------- 852 \subsection{$ z^*$- or $s^*$-coordinate (\protect\forcode{ln_linssh= .false.}) }846 \subsection{$Z^*$- or $S^*$-coordinate (\protect\np{ln\_linssh}\forcode{ = .false.}) } 853 847 \label{DOM_zgr_star} 854 848 … … 860 854 % level bathymetry and mask 861 855 % ------------------------------------------------------------------------------------------------------------- 862 \subsection{ level bathymetry and mask}856 \subsection{Level bathymetry and mask} 863 857 \label{DOM_msk} 864 858 … … 881 875 In case of ice shelf cavities, modifications of the model bathymetry and ice shelf draft into 882 876 the cavities are performed in the \textit{zgr\_isf} routine. The compatibility between ice shelf draft and bathymetry is checked. 883 All the locations where the isf cavity is thinnest than \np{rn _isfhmin} meters are grounded ($i.e.$ masked).877 All the locations where the isf cavity is thinnest than \np{rn\_isfhmin} meters are grounded ($i.e.$ masked). 884 878 If only one cell on the water column is opened at $t$-, $u$- or $v$-points, the bathymetry or the ice shelf draft is dug to fit this constrain. 885 879 If the incompatibility is too strong (need to dig more than 1 cell), the cell is masked.\\ … … 912 906 % Domain: Initial State (dtatsd & istate) 913 907 % ================================================================ 914 \section [Domain: Initial State (\textit{istate and dtatsd})] 915 {Domain: Initial State \small{(\protect\mdl{istate} and \protect\mdl{dtatsd} modules)} } 908 \section{Initial state (\protect\mdl{istate} and \protect\mdl{dtatsd})} 916 909 \label{DTA_tsd} 917 910 %-----------------------------------------namtsd------------------------------------------- … … 921 914 Options are defined in \ngn{namtsd}. 922 915 By default, the ocean start from rest (the velocity field is set to zero) and the initialization of 923 temperature and salinity fields is controlled through the \np{ln _tsd_ini} namelist parameter.916 temperature and salinity fields is controlled through the \np{ln\_tsd\_ini} namelist parameter. 924 917 \begin{description} 925 \item[ ln\_tsd\_init = .true.]use a T and S input files that can be given on the model grid itself or918 \item[\np{ln\_tsd\_init}\forcode{ = .true.}] use a T and S input files that can be given on the model grid itself or 926 919 on their native input data grid. In the latter case, the data will be interpolated on-the-fly both in the 927 920 horizontal and the vertical to the model grid (see \S~\ref{SBC_iof}). The information relative to the 928 input files are given in the \np{sn _tem} and \np{sn_sal} structures.921 input files are given in the \np{sn\_tem} and \np{sn\_sal} structures. 929 922 The computation is done in the \mdl{dtatsd} module. 930 \item[ ln\_tsd\_init = .false.] use constant salinity value of 35.5 psu and an analytical profile of temperature923 \item[\np{ln\_tsd\_init}\forcode{ = .false.}] use constant salinity value of 35.5 psu and an analytical profile of temperature 931 924 (typical of the tropical ocean), see \rou{istate\_t\_s} subroutine called from \mdl{istate} module. 932 925 \end{description} -
branches/2017/dev_merge_2017/DOC/tex_sub/chap_DYN.tex
r9392 r9393 69 69 % Horizontal divergence and relative vorticity 70 70 %-------------------------------------------------------------------------------------------------------------- 71 \subsection [Horizontal divergence and relative vorticity (\textit{divcur})] 72 {Horizontal divergence and relative vorticity (\protect\mdl{divcur})} 71 \subsection{Horizontal divergence and relative vorticity (\protect\mdl{divcur})} 73 72 \label{DYN_divcur} 74 73 … … 102 101 % Sea Surface Height evolution 103 102 %-------------------------------------------------------------------------------------------------------------- 104 \subsection [Sea surface height evolution and vertical velocity (\textit{sshwzv})] 105 {Horizontal divergence and relative vorticity (\protect\mdl{sshwzv})} 103 \subsection{Horizontal divergence and relative vorticity (\protect\mdl{sshwzv})} 106 104 \label{DYN_sshwzv} 107 105 … … 159 157 % Coriolis and Advection terms: vector invariant form 160 158 % ================================================================ 161 \section{Coriolis and Advection: vector invariant form}159 \section{Coriolis and advection: vector invariant form} 162 160 \label{DYN_adv_cor_vect} 163 161 %-----------------------------------------nam_dynadv---------------------------------------------------- … … 178 176 % Vorticity term 179 177 % ------------------------------------------------------------------------------------------------------------- 180 \subsection [Vorticity term (\textit{dynvor}) ] 181 {Vorticity term (\protect\mdl{dynvor})} 178 \subsection{Vorticity term (\protect\mdl{dynvor})} 182 179 \label{DYN_vor} 183 180 %------------------------------------------nam_dynvor---------------------------------------------------- … … 186 183 187 184 Options are defined through the \ngn{namdyn\_vor} namelist variables. 188 Four discretisations of the vorticity term (\ textit{ln\_dynvor\_xxx}=true) are available:185 Four discretisations of the vorticity term (\np{ln\_dynvor\_xxx}\forcode{ = .true.}) are available: 189 186 conserving potential enstrophy of horizontally non-divergent flow (ENS scheme) ; 190 187 conserving horizontal kinetic energy (ENE scheme) ; conserving potential enstrophy for … … 193 190 flow and horizontal kinetic energy (EEN scheme) (see Appendix~\ref{Apdx_C_vorEEN}). In the 194 191 case of ENS, ENE or MIX schemes the land sea mask may be slightly modified to ensure the 195 consistency of vorticity term with analytical equations (\ textit{ln\_dynvor\_con}=true).192 consistency of vorticity term with analytical equations (\np{ln\_dynvor\_con}\forcode{ = .true.}). 196 193 The vorticity terms are all computed in dedicated routines that can be found in 197 194 the \mdl{dynvor} module. … … 200 197 % enstrophy conserving scheme 201 198 %------------------------------------------------------------- 202 \subsubsection{Enstrophy conserving scheme (\protect\ forcode{ln_dynvor_ens= .true.})}199 \subsubsection{Enstrophy conserving scheme (\protect\np{ln\_dynvor\_ens}\forcode{ = .true.})} 203 200 \label{DYN_vor_ens} 204 201 … … 221 218 % energy conserving scheme 222 219 %------------------------------------------------------------- 223 \subsubsection{Energy conserving scheme (\protect\ forcode{ln_dynvor_ene= .true.})}220 \subsubsection{Energy conserving scheme (\protect\np{ln\_dynvor\_ene}\forcode{ = .true.})} 224 221 \label{DYN_vor_ene} 225 222 … … 238 235 % mix energy/enstrophy conserving scheme 239 236 %------------------------------------------------------------- 240 \subsubsection{Mixed energy/enstrophy conserving scheme (\protect\ forcode{ln_dynvor_mix= .true.}) }237 \subsubsection{Mixed energy/enstrophy conserving scheme (\protect\np{ln\_dynvor\_mix}\forcode{ = .true.}) } 241 238 \label{DYN_vor_mix} 242 239 … … 261 258 % energy and enstrophy conserving scheme 262 259 %------------------------------------------------------------- 263 \subsubsection{Energy and enstrophy conserving scheme (\protect\ forcode{ln_dynvor_een= .true.}) }260 \subsubsection{Energy and enstrophy conserving scheme (\protect\np{ln\_dynvor\_een}\forcode{ = .true.}) } 264 261 \label{DYN_vor_een} 265 262 … … 305 302 A key point in \eqref{Eq_een_e3f} is how the averaging in the \textbf{i}- and \textbf{j}- directions is made. 306 303 It uses the sum of masked t-point vertical scale factor divided either 307 by the sum of the four t-point masks (\np{nn _een_e3f}~=~1),308 or just by $4$ (\np{nn _een_e3f}~=~true).304 by the sum of the four t-point masks (\np{nn\_een\_e3f}\forcode{ = 1}), 305 or just by $4$ (\np{nn\_een\_e3f}\forcode{ = .true.}). 309 306 The latter case preserves the continuity of $e_{3f}$ when one or more of the neighbouring $e_{3t}$ 310 307 tends to zero and extends by continuity the value of $e_{3f}$ into the land areas. … … 346 343 % Kinetic Energy Gradient term 347 344 %-------------------------------------------------------------------------------------------------------------- 348 \subsection [Kinetic Energy Gradient term (\textit{dynkeg})] 349 {Kinetic Energy Gradient term (\protect\mdl{dynkeg})} 345 \subsection{Kinetic energy gradient term (\protect\mdl{dynkeg})} 350 346 \label{DYN_keg} 351 347 … … 363 359 % Vertical advection term 364 360 %-------------------------------------------------------------------------------------------------------------- 365 \subsection [Vertical advection term (\textit{dynzad}) ] 366 {Vertical advection term (\protect\mdl{dynzad}) } 361 \subsection{Vertical advection term (\protect\mdl{dynzad}) } 367 362 \label{DYN_zad} 368 363 … … 377 372 \end{aligned} \right. 378 373 \end{equation} 379 When \np{ln _dynzad_zts}~=~\textit{true}, a split-explicit time stepping with 5 sub-timesteps is used374 When \np{ln\_dynzad\_zts}\forcode{ = .true.}, a split-explicit time stepping with 5 sub-timesteps is used 380 375 on the vertical advection term. 381 376 This option can be useful when the value of the timestep is limited by vertical advection \citep{Lemarie_OM2015}. 382 377 Note that in this case, a similar split-explicit time stepping should be used on 383 378 vertical advection of tracer to ensure a better stability, 384 an option which is only available with a TVD scheme (see \np{ln _traadv_tvd_zts} in \S\ref{TRA_adv_tvd}).379 an option which is only available with a TVD scheme (see \np{ln\_traadv\_tvd\_zts} in \S\ref{TRA_adv_tvd}). 385 380 386 381 … … 388 383 % Coriolis and Advection : flux form 389 384 % ================================================================ 390 \section{Coriolis and Advection: flux form}385 \section{Coriolis and advection: flux form} 391 386 \label{DYN_adv_cor_flux} 392 387 %------------------------------------------nam_dynadv---------------------------------------------------- … … 405 400 % Coriolis plus curvature metric terms 406 401 %-------------------------------------------------------------------------------------------------------------- 407 \subsection [Coriolis plus curvature metric terms (\textit{dynvor}) ] 408 {Coriolis plus curvature metric terms (\protect\mdl{dynvor}) } 402 \subsection{Coriolis plus curvature metric terms (\protect\mdl{dynvor}) } 409 403 \label{DYN_cor_flux} 410 404 … … 427 421 % Flux form Advection term 428 422 %-------------------------------------------------------------------------------------------------------------- 429 \subsection [Flux form Advection term (\textit{dynadv}) ] 430 {Flux form Advection term (\protect\mdl{dynadv}) } 423 \subsection{Flux form advection term (\protect\mdl{dynadv}) } 431 424 \label{DYN_adv_flux} 432 425 … … 451 444 difference scheme, CEN2, or a $3^{rd}$ order upstream biased scheme, UBS. 452 445 The latter is described in \citet{Shchepetkin_McWilliams_OM05}. The schemes are 453 selected using the namelist logicals \np{ln _dynadv_cen2} and \np{ln_dynadv_ubs}.446 selected using the namelist logicals \np{ln\_dynadv\_cen2} and \np{ln\_dynadv\_ubs}. 454 447 In flux form, the schemes differ by the choice of a space and time interpolation to 455 448 define the value of $u$ and $v$ at the centre of each face of $u$- and $v$-cells, … … 460 453 % 2nd order centred scheme 461 454 %------------------------------------------------------------- 462 \subsubsection{ $2^{nd}$ order centred scheme (cen2) (\protect\forcode{ln_dynadv_cen2= .true.})}455 \subsubsection{CEN2: $2^{nd}$ order centred scheme (\protect\np{ln\_dynadv\_cen2}\forcode{ = .true.})} 463 456 \label{DYN_adv_cen2} 464 457 … … 481 474 % UBS scheme 482 475 %------------------------------------------------------------- 483 \subsubsection{U pstream Biased Scheme (UBS) (\protect\forcode{ln_dynadv_ubs= .true.})}476 \subsubsection{UBS: Upstream Biased Scheme (\protect\np{ln\_dynadv\_ubs}\forcode{ = .true.})} 484 477 \label{DYN_adv_ubs} 485 478 … … 500 493 permitted. But the amplitudes of the false extrema are significantly reduced over 501 494 those in the centred second order method. As the scheme already includes 502 a diffusion component, it can be used without explicit 503 ($i.e.$ \np{ln _dynldf_lap}=\forcode{ln_dynldf_bilap= .false.}), and it is recommended to do so.495 a diffusion component, it can be used without explicit lateral diffusion on momentum 496 ($i.e.$ \np{ln\_dynldf\_lap}\forcode{ = }\np{ln\_dynldf\_bilap}\forcode{ = .false.}), and it is recommended to do so. 504 497 505 498 The UBS scheme is not used in all directions. In the vertical, the centred $2^{nd}$ … … 532 525 % Hydrostatic pressure gradient term 533 526 % ================================================================ 534 \section [Hydrostatic pressure gradient (\textit{dynhpg})] 535 {Hydrostatic pressure gradient (\protect\mdl{dynhpg})} 527 \section{Hydrostatic pressure gradient (\protect\mdl{dynhpg})} 536 528 \label{DYN_hpg} 537 529 %------------------------------------------nam_dynhpg--------------------------------------------------- … … 554 546 % z-coordinate with full step 555 547 %-------------------------------------------------------------------------------------------------------------- 556 \subsection [$z$-coordinate with full step (\protect\np{ln_dynhpg_zco}) ] 557 {$z$-coordinate with full step (\protect\forcode{ln_dynhpg_zco = .true.})} 548 \subsection{Full step $Z$-coordinate (\protect\np{ln\_dynhpg\_zco}\forcode{ = .true.})} 558 549 \label{DYN_hpg_zco} 559 550 … … 595 586 % z-coordinate with partial step 596 587 %-------------------------------------------------------------------------------------------------------------- 597 \subsection [$z$-coordinate with partial step (\protect\np{ln_dynhpg_zps})] 598 {$z$-coordinate with partial step (\protect\forcode{ln_dynhpg_zps = .true.})} 588 \subsection{Partial step $Z$-coordinate (\protect\np{ln\_dynhpg\_zps}\forcode{ = .true.})} 599 589 \label{DYN_hpg_zps} 600 590 … … 616 606 % s- and s-z-coordinates 617 607 %-------------------------------------------------------------------------------------------------------------- 618 \subsection{$ s$- and $z$-$s$-coordinates}608 \subsection{$S$- and $Z$-$S$-coordinates} 619 609 \label{DYN_hpg_sco} 620 610 … … 624 614 cubic polynomial method is currently disabled whilst known bugs are under investigation. 625 615 626 $\bullet$ Traditional coding (see for example \citet{Madec_al_JPO96}: (\ forcode{ln_dynhpg_sco= .true.})616 $\bullet$ Traditional coding (see for example \citet{Madec_al_JPO96}: (\np{ln\_dynhpg\_sco}\forcode{ = .true.}) 627 617 \begin{equation} \label{Eq_dynhpg_sco} 628 618 \left\{ \begin{aligned} … … 639 629 ($e_{3w}$). 640 630 641 $\bullet$ Traditional coding with adaptation for ice shelf cavities (\ forcode{ln_dynhpg_isf= .true.}).642 This scheme need the activation of ice shelf cavities (\ forcode{ln_isfcav= .true.}).643 644 $\bullet$ Pressure Jacobian scheme (prj) (a research paper in preparation) (\ forcode{ln_dynhpg_prj= .true.})631 $\bullet$ Traditional coding with adaptation for ice shelf cavities (\np{ln\_dynhpg\_isf}\forcode{ = .true.}). 632 This scheme need the activation of ice shelf cavities (\np{ln\_isfcav}\forcode{ = .true.}). 633 634 $\bullet$ Pressure Jacobian scheme (prj) (a research paper in preparation) (\np{ln\_dynhpg\_prj}\forcode{ = .true.}) 645 635 646 636 $\bullet$ Density Jacobian with cubic polynomial scheme (DJC) \citep{Shchepetkin_McWilliams_OM05} 647 (\ forcode{ln_dynhpg_djc= .true.}) (currently disabled; under development)637 (\np{ln\_dynhpg\_djc}\forcode{ = .true.}) (currently disabled; under development) 648 638 649 639 Note that expression \eqref{Eq_dynhpg_sco} is commonly used when the variable volume formulation is 650 640 activated (\key{vvl}) because in that case, even with a flat bottom, the coordinate surfaces are not 651 641 horizontal but follow the free surface \citep{Levier2007}. The pressure jacobian scheme 652 (\ forcode{ln_dynhpg_prj = .true.}) is available as an improved option to \forcode{ln_dynhpg_sco= .true.} when642 (\np{ln\_dynhpg\_prj}\forcode{ = .true.}) is available as an improved option to \np{ln\_dynhpg\_sco}\forcode{ = .true.} when 653 643 \key{vvl} is active. The pressure Jacobian scheme uses a constrained cubic spline to reconstruct 654 644 the density profile across the water column. This method maintains the monotonicity between the … … 660 650 \label{DYN_hpg_isf} 661 651 Beneath an ice shelf, the total pressure gradient is the sum of the pressure gradient due to the ice shelf load and 662 the pressure gradient due to the ocean load. If cavity opened (\np{ln _isfcav}~=~true) these 2 terms can be663 calculated by setting \np{ln _dynhpg_isf}~=~true. No other scheme are working with the ice shelf.\\652 the pressure gradient due to the ocean load. If cavity opened (\np{ln\_isfcav}\forcode{ = .true.}) these 2 terms can be 653 calculated by setting \np{ln\_dynhpg\_isf}\forcode{ = .true.}. No other scheme are working with the ice shelf.\\ 664 654 665 655 $\bullet$ The main hypothesis to compute the ice shelf load is that the ice shelf is in an isostatic equilibrium. … … 673 663 % Time-scheme 674 664 %-------------------------------------------------------------------------------------------------------------- 675 \subsection [Time-scheme (\protect\np{ln_dynhpg_imp}) ] 676 {Time-scheme (\protect\np{ln_dynhpg_imp}= true/false)} 665 \subsection{Time-scheme (\protect\np{ln\_dynhpg\_imp}\forcode{ = .true./.false.})} 677 666 \label{DYN_hpg_imp} 678 667 … … 689 678 time level $t$ only, as in the standard leapfrog scheme. 690 679 691 $\bullet$ leapfrog scheme (\ forcode{ln_dynhpg_imp= .true.}):680 $\bullet$ leapfrog scheme (\np{ln\_dynhpg\_imp}\forcode{ = .true.}): 692 681 693 682 \begin{equation} \label{Eq_dynhpg_lf} … … 696 685 \end{equation} 697 686 698 $\bullet$ semi-implicit scheme (\ forcode{ln_dynhpg_imp= .true.}):687 $\bullet$ semi-implicit scheme (\np{ln\_dynhpg\_imp}\forcode{ = .true.}): 699 688 \begin{equation} \label{Eq_dynhpg_imp} 700 689 \frac{u^{t+\rdt}-u^{t-\rdt}}{2\rdt} = \;\cdots \; … … 713 702 the stability limits associated with advection or diffusion. 714 703 715 In practice, the semi-implicit scheme is used when \ forcode{ln_dynhpg_imp= .true.}.704 In practice, the semi-implicit scheme is used when \np{ln\_dynhpg\_imp}\forcode{ = .true.}. 716 705 In this case, we choose to apply the time filter to temperature and salinity used in 717 706 the equation of state, instead of applying it to the hydrostatic pressure or to the … … 727 716 Note that in the semi-implicit case, it is necessary to save the filtered density, an 728 717 extra three-dimensional field, in the restart file to restart the model with exact 729 reproducibility. This option is controlled by \np{nn _dynhpg_rst}, a namelist parameter.718 reproducibility. This option is controlled by \np{nn\_dynhpg\_rst}, a namelist parameter. 730 719 731 720 % ================================================================ 732 721 % Surface Pressure Gradient 733 722 % ================================================================ 734 \section [Surface pressure gradient (\textit{dynspg}) ] 735 {Surface pressure gradient (\protect\mdl{dynspg})} 723 \section{Surface pressure gradient (\protect\mdl{dynspg})} 736 724 \label{DYN_spg} 737 725 %-----------------------------------------nam_dynspg---------------------------------------------------- … … 793 781 % Split-explict free surface formulation 794 782 %-------------------------------------------------------------------------------------------------------------- 795 \subsection{Split- Explicit free surface (\protect\key{dynspg\_ts})}783 \subsection{Split-explicit free surface (\protect\key{dynspg\_ts})} 796 784 \label{DYN_spg_ts} 797 785 %------------------------------------------namsplit----------------------------------------------------------- … … 806 794 variables (Fig.~\ref{Fig_DYN_dynspg_ts}). 807 795 The size of the small time step, $\rdt_e$ (the external mode or barotropic time step) 808 is provided through the \np{nn _baro} namelist parameter as:809 $\rdt_e = \rdt / nn\_baro$. This parameter can be optionally defined automatically (\ forcode{ln_bt_nn_auto= .true.})796 is provided through the \np{nn\_baro} namelist parameter as: 797 $\rdt_e = \rdt / nn\_baro$. This parameter can be optionally defined automatically (\np{ln\_bt\_nn\_auto}\forcode{ = .true.}) 810 798 considering that the stability of the barotropic system is essentially controled by external waves propagation. 811 799 Maximum Courant number is in that case time independent, and easily computed online from the input bathymetry. 812 Therefore, $\rdt_e$ is adjusted so that the Maximum allowed Courant number is smaller than \np{rn _bt_cmax}.800 Therefore, $\rdt_e$ is adjusted so that the Maximum allowed Courant number is smaller than \np{rn\_bt\_cmax}. 813 801 814 802 %%% … … 839 827 The former are used to obtain time filtered quantities at $t+\rdt$ while the latter are used to obtain time averaged 840 828 transports to advect tracers. 841 a) Forward time integration: \ protect\forcode{ln_bt_fw = .true.}, \protect\forcode{ln_bt_av = .true.}.842 b) Centred time integration: \ protect\forcode{ln_bt_fw = .false.}, \protect\forcode{ln_bt_av = .true.}.843 c) Forward time integration with no time filtering (POM-like scheme): \ protect\forcode{ln_bt_fw = .true.}, \protect\forcode{ln_bt_av= .false.}. }829 a) Forward time integration: \np{ln\_bt\_fw}\forcode{ = .true.}, \np{ln\_bt\_av}\forcode{ = .true.}. 830 b) Centred time integration: \np{ln\_bt\_fw}\forcode{ = .false.}, \np{ln\_bt\_av}\forcode{ = .true.}. 831 c) Forward time integration with no time filtering (POM-like scheme): \np{ln\_bt\_fw}\forcode{ = .true.}, \np{ln\_bt\_av}\forcode{ = .false.}. } 844 832 \end{center} \end{figure} 845 833 %> > > > > > > > > > > > > > > > > > > > > > > > > > > > 846 834 847 In the default case (\ forcode{ln_bt_fw= .true.}), the external mode is integrated835 In the default case (\np{ln\_bt\_fw}\forcode{ = .true.}), the external mode is integrated 848 836 between \textit{now} and \textit{after} baroclinic time-steps (Fig.~\ref{Fig_DYN_dynspg_ts}a). To avoid aliasing of fast barotropic motions into three dimensional equations, time filtering is eventually applied on barotropic 849 quantities (\ forcode{ln_bt_av= .true.}). In that case, the integration is extended slightly beyond \textit{after} time step to provide time filtered quantities.837 quantities (\np{ln\_bt\_av}\forcode{ = .true.}). In that case, the integration is extended slightly beyond \textit{after} time step to provide time filtered quantities. 850 838 These are used for the subsequent initialization of the barotropic mode in the following baroclinic step. 851 839 Since external mode equations written at baroclinic time steps finally follow a forward time stepping scheme, 852 840 asselin filtering is not applied to barotropic quantities. \\ 853 841 Alternatively, one can choose to integrate barotropic equations starting 854 from \textit{before} time step (\ forcode{ln_bt_fw = .false.}). Although more computationaly expensive ( \np{nn_baro} additional iterations are indeed necessary), the baroclinic to barotropic forcing term given at \textit{now} time step842 from \textit{before} time step (\np{ln\_bt\_fw}\forcode{ = .false.}). Although more computationaly expensive ( \np{nn\_baro} additional iterations are indeed necessary), the baroclinic to barotropic forcing term given at \textit{now} time step 855 843 become centred in the middle of the integration window. It can easily be shown that this property 856 844 removes part of splitting errors between modes, which increases the overall numerical robustness. … … 868 856 %%% 869 857 870 One can eventually choose to feedback instantaneous values by not using any time filter (\ forcode{ln_bt_av= .false.}).858 One can eventually choose to feedback instantaneous values by not using any time filter (\np{ln\_bt\_av}\forcode{ = .false.}). 871 859 In that case, external mode equations are continuous in time, ie they are not re-initialized when starting a new 872 860 sub-stepping sequence. This is the method used so far in the POM model, the stability being maintained by refreshing at (almost) … … 1001 989 % Lateral diffusion term 1002 990 % ================================================================ 1003 \section [Lateral diffusion term (\textit{dynldf})] 1004 {Lateral diffusion term (\protect\mdl{dynldf})} 991 \section{Lateral diffusion term and operators (\protect\mdl{dynldf})} 1005 992 \label{DYN_ldf} 1006 993 %------------------------------------------nam_dynldf---------------------------------------------------- … … 1036 1023 1037 1024 % ================================================================ 1038 \subsection [Iso-level laplacian operator (\protect\np{ln_dynldf_lap})]1039 {Iso-level laplacian operator (\protect\forcode{ln_dynldf_lap= .true.})}1025 \subsection[Iso-level laplacian (\protect\np{ln\_dynldf\_lap}\forcode{ = .true.})] 1026 {Iso-level laplacian operator (\protect\np{ln\_dynldf\_lap}\forcode{ = .true.})} 1040 1027 \label{DYN_ldf_lap} 1041 1028 … … 1060 1047 % Rotated laplacian operator 1061 1048 %-------------------------------------------------------------------------------------------------------------- 1062 \subsection [Rotated laplacian operator (\protect\np{ln_dynldf_iso})]1063 {Rotated laplacian operator (\protect\forcode{ln_dynldf_iso= .true.})}1049 \subsection[Rotated laplacian (\protect\np{ln\_dynldf\_iso}\forcode{ = .true.})] 1050 {Rotated laplacian operator (\protect\np{ln\_dynldf\_iso}\forcode{ = .true.})} 1064 1051 \label{DYN_ldf_iso} 1065 1052 1066 1053 A rotation of the lateral momentum diffusion operator is needed in several cases: 1067 for iso-neutral diffusion in the $z$-coordinate (\ forcode{ln_dynldf_iso= .true.}) and for1068 either iso-neutral (\ forcode{ln_dynldf_iso= .true.}) or geopotential1069 (\ forcode{ln_dynldf_hor= .true.}) diffusion in the $s$-coordinate. In the partial step1054 for iso-neutral diffusion in the $z$-coordinate (\np{ln\_dynldf\_iso}\forcode{ = .true.}) and for 1055 either iso-neutral (\np{ln\_dynldf\_iso}\forcode{ = .true.}) or geopotential 1056 (\np{ln\_dynldf\_hor}\forcode{ = .true.}) diffusion in the $s$-coordinate. In the partial step 1070 1057 case, coordinates are horizontal except at the deepest level and no 1071 rotation is performed when \ forcode{ln_dynldf_hor= .true.}. The diffusion operator1058 rotation is performed when \np{ln\_dynldf\_hor}\forcode{ = .true.}. The diffusion operator 1072 1059 is defined simply as the divergence of down gradient momentum fluxes on each 1073 1060 momentum component. It must be emphasized that this formulation ignores … … 1129 1116 % Iso-level bilaplacian operator 1130 1117 %-------------------------------------------------------------------------------------------------------------- 1131 \subsection [Iso-level bilaplacian operator (\protect\np{ln_dynldf_bilap})]1132 {Iso-level bilaplacian operator (\protect\forcode{ln_dynldf_bilap= .true.})}1118 \subsection[Iso-level bilaplacian (\protect\np{ln\_dynldf\_bilap}\forcode{ = .true.})] 1119 {Iso-level bilaplacian operator (\protect\np{ln\_dynldf\_bilap}\forcode{ = .true.})} 1133 1120 \label{DYN_ldf_bilap} 1134 1121 … … 1145 1132 % Vertical diffusion term 1146 1133 % ================================================================ 1147 \section [Vertical diffusion term (\protect\mdl{dynzdf})] 1148 {Vertical diffusion term (\protect\mdl{dynzdf})} 1134 \section{Vertical diffusion term (\protect\mdl{dynzdf})} 1149 1135 \label{DYN_zdf} 1150 1136 %----------------------------------------------namzdf------------------------------------------------------ … … 1157 1143 would be too restrictive a constraint on the time step. Two time stepping schemes 1158 1144 can be used for the vertical diffusion term : $(a)$ a forward time differencing 1159 scheme (\ forcode{ln_zdfexp= .true.}) using a time splitting technique1160 (\np{nn _zdfexp} $>$ 1) or $(b)$ a backward (or implicit) time differencing scheme1161 (\ forcode{ln_zdfexp= .false.}) (see \S\ref{STP}). Note that namelist variables1162 \np{ln _zdfexp} and \np{nn_zdfexp} apply to both tracers and dynamics.1145 scheme (\np{ln\_zdfexp}\forcode{ = .true.}) using a time splitting technique 1146 (\np{nn\_zdfexp} $>$ 1) or $(b)$ a backward (or implicit) time differencing scheme 1147 (\np{ln\_zdfexp}\forcode{ = .false.}) (see \S\ref{STP}). Note that namelist variables 1148 \np{ln\_zdfexp} and \np{nn\_zdfexp} apply to both tracers and dynamics. 1163 1149 1164 1150 The formulation of the vertical subgrid scale physics is the same whatever … … 1199 1185 % External Forcing 1200 1186 % ================================================================ 1201 \section{External Forcings}1187 \section{External forcings} 1202 1188 \label{DYN_forcing} 1203 1189 … … 1206 1192 may enter the dynamical equations by affecting the surface pressure gradient. 1207 1193 1208 (1) When \np{ln _apr_dyn}~=~true(see \S\ref{SBC_apr}), the atmospheric pressure is taken1194 (1) When \np{ln\_apr\_dyn}\forcode{ = .true.} (see \S\ref{SBC_apr}), the atmospheric pressure is taken 1209 1195 into account when computing the surface pressure gradient. 1210 1196 1211 (2) When \np{ln _tide_pot}~=~true and \np{ln_tide}~=~true(see \S\ref{SBC_tide}),1197 (2) When \np{ln\_tide\_pot}\forcode{ = .true.} and \np{ln\_tide}\forcode{ = .true.} (see \S\ref{SBC_tide}), 1212 1198 the tidal potential is taken into account when computing the surface pressure gradient. 1213 1199 1214 (3) When \np{nn _ice_embd}~=~2and LIM or CICE is used ($i.e.$ when the sea-ice is embedded in the ocean),1200 (3) When \np{nn\_ice\_embd}\forcode{ = 2} and LIM or CICE is used ($i.e.$ when the sea-ice is embedded in the ocean), 1215 1201 the snow-ice mass is taken into account when computing the surface pressure gradient. 1216 1202 … … 1222 1208 % Time evolution term 1223 1209 % ================================================================ 1224 \section [Time evolution term (\textit{dynnxt})] 1225 {Time evolution term (\protect\mdl{dynnxt})} 1210 \section{Time evolution term (\protect\mdl{dynnxt})} 1226 1211 \label{DYN_nxt} 1227 1212 … … 1238 1223 weighted velocity (see \S\ref{Apdx_A_momentum}) 1239 1224 1240 $\bullet$ vector invariant form or linear free surface (\ forcode{ln_dynhpg_vec= .true.} ; \key{vvl} not defined):1225 $\bullet$ vector invariant form or linear free surface (\np{ln\_dynhpg\_vec}\forcode{ = .true.} ; \key{vvl} not defined): 1241 1226 \begin{equation} \label{Eq_dynnxt_vec} 1242 1227 \left\{ \begin{aligned} … … 1246 1231 \end{equation} 1247 1232 1248 $\bullet$ flux form and nonlinear free surface (\ forcode{ln_dynhpg_vec= .false.} ; \key{vvl} defined):1233 $\bullet$ flux form and nonlinear free surface (\np{ln\_dynhpg\_vec}\forcode{ = .false.} ; \key{vvl} defined): 1249 1234 \begin{equation} \label{Eq_dynnxt_flux} 1250 1235 \left\{ \begin{aligned} … … 1256 1241 where RHS is the right hand side of the momentum equation, the subscript $f$ 1257 1242 denotes filtered values and $\gamma$ is the Asselin coefficient. $\gamma$ is 1258 initialized as \np{nn _atfp} (namelist parameter). Its default value is \np{nn_atfp} = $10^{-3}$.1243 initialized as \np{nn\_atfp} (namelist parameter). Its default value is \np{nn\_atfp}\forcode{ = 10.e-3}. 1259 1244 In both cases, the modified Asselin filter is not applied since perfect conservation 1260 1245 is not an issue for the momentum equations. -
branches/2017/dev_merge_2017/DOC/tex_sub/chap_LBC.tex
r9392 r9393 4 4 % Chapter — Lateral Boundary Condition (LBC) 5 5 % ================================================================ 6 \chapter{Lateral Boundary Condition (LBC) 6 \chapter{Lateral Boundary Condition (LBC)} 7 7 \label{LBC} 8 8 \minitoc … … 17 17 % Boundary Condition at the Coast 18 18 % ================================================================ 19 \section{Boundary Condition at the Coast (\protect\np{rn_shlat})}19 \section{Boundary condition at the coast (\protect\np{rn\_shlat})} 20 20 \label{LBC_coast} 21 21 %--------------------------------------------nam_lbc------------------------------------------------------- … … 72 72 condition influences the relative vorticity and momentum diffusive trends, and is 73 73 required in order to compute the vorticity at the coast. Four different types of 74 lateral boundary condition are available, controlled by the value of the \np{rn _shlat}74 lateral boundary condition are available, controlled by the value of the \np{rn\_shlat} 75 75 namelist parameter. (The value of the mask$_{f}$ array along the coastline is set 76 76 equal to this parameter.) These are: … … 88 88 \begin{description} 89 89 90 \item[free-slip boundary condition (\ forcode{rn_shlat= 0}): ] the tangential velocity at the90 \item[free-slip boundary condition (\np{rn\_shlat}\forcode{ = 0}): ] the tangential velocity at the 91 91 coastline is equal to the offshore velocity, $i.e.$ the normal derivative of the 92 92 tangential velocity is zero at the coast, so the vorticity: mask$_{f}$ array is set 93 93 to zero inside the land and just at the coast (Fig.~\ref{Fig_LBC_shlat}-a). 94 94 95 \item[no-slip boundary condition (\ forcode{rn_shlat= 2}): ] the tangential velocity vanishes95 \item[no-slip boundary condition (\np{rn\_shlat}\forcode{ = 2}): ] the tangential velocity vanishes 96 96 at the coastline. Assuming that the tangential velocity decreases linearly from 97 97 the closest ocean velocity grid point to the coastline, the normal derivative is … … 112 112 \end{equation} 113 113 114 \item["partial" free-slip boundary condition (0$<$\np{rn _shlat}$<$2): ] the tangential114 \item["partial" free-slip boundary condition (0$<$\np{rn\_shlat}$<$2): ] the tangential 115 115 velocity at the coastline is smaller than the offshore velocity, $i.e.$ there is a lateral 116 116 friction but not strong enough to make the tangential velocity at the coast vanish … … 118 118 strictly inbetween $0$ and $2$. 119 119 120 \item["strong" no-slip boundary condition (2$<$\np{rn _shlat}): ] the viscous boundary120 \item["strong" no-slip boundary condition (2$<$\np{rn\_shlat}): ] the viscous boundary 121 121 layer is assumed to be smaller than half the grid size (Fig.~\ref{Fig_LBC_shlat}-d). 122 122 The friction is thus larger than in the no-slip case. … … 133 133 % Boundary Condition around the Model Domain 134 134 % ================================================================ 135 \section{Model Domain Boundary Condition (\protect\np{jperio})}135 \section{Model domain boundary condition (\protect\np{jperio})} 136 136 \label{LBC_jperio} 137 137 … … 141 141 142 142 % ------------------------------------------------------------------------------------------------------------- 143 % Closed, cyclic, south symmetric (\np{jperio} = 0, 1 or 2)143 % Closed, cyclic, south symmetric (\np{jperio}\forcode{ = 0..2}) 144 144 % ------------------------------------------------------------------------------------------------------------- 145 \subsection{Closed, cyclic, south symmetric (\protect\np{jperio} = 0, 1 or 2)}145 \subsection{Closed, cyclic, south symmetric (\protect\np{jperio}\forcode{= 0..2})} 146 146 \label{LBC_jperio012} 147 147 … … 155 155 \begin{description} 156 156 157 \item[For closed boundary (\ textit{jperio=0})], solid walls are imposed at all model157 \item[For closed boundary (\np{jperio}\forcode{ = 0})], solid walls are imposed at all model 158 158 boundaries: first and last rows and columns are set to zero. 159 159 160 \item[For cyclic east-west boundary (\ textit{jperio=1})], first and last rows are set160 \item[For cyclic east-west boundary (\np{jperio}\forcode{ = 1})], first and last rows are set 161 161 to zero (closed) whilst the first column is set to the value of the last-but-one column 162 162 and the last column to the value of the second one (Fig.~\ref{Fig_LBC_jperio}-a). … … 165 165 cyclic cases. 166 166 167 \item[For symmetric boundary condition across the equator (\ textit{jperio=2})],167 \item[For symmetric boundary condition across the equator (\np{jperio}\forcode{ = 2})], 168 168 last rows, and first and last columns are set to zero (closed). The row of symmetry 169 169 is chosen to be the $u$- and $T-$points equator line ($j=2$, i.e. at the southern … … 188 188 % North fold (\textit{jperio = 3 }to $6)$ 189 189 % ------------------------------------------------------------------------------------------------------------- 190 \subsection{North-fold (\ textit{jperio = 3 }to $6$)}190 \subsection{North-fold (\protect\np{jperio}\forcode{ = 3..6})} 191 191 \label{LBC_north_fold} 192 192 … … 209 209 % Exchange with neighbouring processors 210 210 % ==================================================================== 211 \section [Exchange with neighbouring processors (\textit{lbclnk}, \textit{lib\_mpp})] 212 {Exchange with neighbouring processors (\protect\mdl{lbclnk}, \protect\mdl{lib\_mpp})} 211 \section{Exchange with neighbouring processors (\protect\mdl{lbclnk}, \protect\mdl{lib\_mpp})} 213 212 \label{LBC_mpp} 214 213 … … 331 330 the model output files is undefined. Note that this is a problem for the meshmask file 332 331 which requires to be defined over the whole domain. Therefore, user should not eliminate 333 land processors when creating a meshmask file ($i.e.$ when setting a non-zero value to \np{nn _msh}).332 land processors when creating a meshmask file ($i.e.$ when setting a non-zero value to \np{nn\_msh}). 334 333 335 334 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> … … 350 349 % Unstructured open boundaries BDY 351 350 % ==================================================================== 352 \section{Unstructured Open Boundary Conditions (BDY)}351 \section{Unstructured open boundary conditions (BDY)} 353 352 \label{LBC_bdy} 354 353 … … 384 383 385 384 %---------------------------------------------- 386 \subsection{ The namelists}385 \subsection{Namelists} 387 386 \label{BDY_namelist} 388 387 389 The BDY module is activated by setting \np{ln _bdy} to true.388 The BDY module is activated by setting \np{ln\_bdy} to true. 390 389 It is possible to define more than one boundary ``set'' and apply 391 390 different boundary conditions to each set. The number of boundary 392 sets is defined by \np{nb _bdy}. Each boundary set may be defined391 sets is defined by \np{nb\_bdy}. Each boundary set may be defined 393 392 as a set of straight line segments in a namelist 394 (\np{ln _coords_file}=.false.) or read in from a file395 (\np{ln _coords_file}=.true.). If the set is defined in a namelist,393 (\np{ln\_coords\_file}\forcode{ = .false.}) or read in from a file 394 (\np{ln\_coords\_file}\forcode{ = .true.}). If the set is defined in a namelist, 396 395 then the namelists nambdy\_index must be included separately, one for 397 396 each set. If the set is defined by a file, then a … … 410 409 (``tra''). For each set of variables there is a choice of algorithm 411 410 and a choice for the data, eg. for the active tracers the algorithm is 412 set by \np{nn _tra} and the choice of data is set by413 \np{nn _tra_dta}.411 set by \np{nn\_tra} and the choice of data is set by 412 \np{nn\_tra\_dta}. 414 413 415 414 The choice of algorithm is currently as follows: … … 429 428 430 429 The main choice for the boundary data is 431 to use initial conditions as boundary data (\ forcode{nn_tra_dta= 0}) or to432 use external data from a file (\ forcode{nn_tra_dta= 1}). For the430 to use initial conditions as boundary data (\np{nn\_tra\_dta}\forcode{ = 0}) or to 431 use external data from a file (\np{nn\_tra\_dta}\forcode{ = 1}). For the 433 432 barotropic solution there is also the option to use tidal 434 433 harmonic forcing either by itself or in addition to other external … … 457 456 458 457 %---------------------------------------------- 459 \subsection{ The Flow Relaxation Scheme}458 \subsection{Flow relaxation scheme} 460 459 \label{BDY_FRS_scheme} 461 460 … … 492 491 \end{equation} 493 492 The width of the FRS zone is specified in the namelist as 494 \np{nn _rimwidth}. This is typically set to a value between 8 and 10.493 \np{nn\_rimwidth}. This is typically set to a value between 8 and 10. 495 494 496 495 %---------------------------------------------- 497 \subsection{ TheFlather radiation scheme}496 \subsection{Flather radiation scheme} 498 497 \label{BDY_flather_scheme} 499 498 … … 561 560 shelf break, then the areas of ocean outside of this boundary will 562 561 need to be masked out. This can be done by reading a mask file defined 563 as \np{cn _mask_file} in the nam\_bdy namelist. Only one mask file is562 as \np{cn\_mask\_file} in the nam\_bdy namelist. Only one mask file is 564 563 used even if multiple boundary sets are defined. 565 564 … … 618 617 619 618 There is an option to force the total volume in the regional model to be constant, 620 similar to the option in the OBC module. This is controlled by the \np{nn _volctl}621 parameter in the namelist. A value of \np{nn _volctl}~=~0indicates that this option is not used.622 If \np{nn _volctl}~=~1then a correction is applied to the normal velocities619 similar to the option in the OBC module. This is controlled by the \np{nn\_volctl} 620 parameter in the namelist. A value of \np{nn\_volctl}\forcode{ = 0} indicates that this option is not used. 621 If \np{nn\_volctl}\forcode{ = 1} then a correction is applied to the normal velocities 623 622 around the boundary at each timestep to ensure that the integrated volume flow 624 through the boundary is zero. If \np{nn _volctl}~=~2then the calculation of623 through the boundary is zero. If \np{nn\_volctl}\forcode{ = 2} then the calculation of 625 624 the volume change on the timestep includes the change due to the freshwater 626 625 flux across the surface and the correction velocity corrects for this as well. -
branches/2017/dev_merge_2017/DOC/tex_sub/chap_LDF.tex
r9392 r9393 25 25 Note that this chapter describes the standard implementation of iso-neutral 26 26 tracer mixing, and Griffies's implementation, which is used if 27 \ forcode{traldf_grif= .true.}, is described in Appdx\ref{sec:triad}27 \np{traldf\_grif}\forcode{ = .true.}, is described in Appdx\ref{sec:triad} 28 28 29 29 %-----------------------------------nam_traldf - nam_dynldf-------------------------------------------- … … 36 36 % Direction of lateral Mixing 37 37 % ================================================================ 38 \section [Direction of Lateral Mixing (\textit{ldfslp})] 39 {Direction of Lateral Mixing (\protect\mdl{ldfslp})} 38 \section{Direction of lateral mixing (\protect\mdl{ldfslp})} 40 39 \label{LDF_slp} 41 40 … … 46 45 A direction for lateral mixing has to be defined when the desired operator does 47 46 not act along the model levels. This occurs when $(a)$ horizontal mixing is 48 required on tracer or momentum (\np{ln _traldf_hor} or \np{ln_dynldf_hor})47 required on tracer or momentum (\np{ln\_traldf\_hor} or \np{ln\_dynldf\_hor}) 49 48 in $s$- or mixed $s$-$z$- coordinates, and $(b)$ isoneutral mixing is required 50 49 whatever the vertical coordinate is. This direction of mixing is defined by its … … 57 56 %gm% add here afigure of the slope in i-direction 58 57 59 \subsection{ slopes for tracer geopotential mixing in the $s$-coordinate}58 \subsection{Slopes for tracer geopotential mixing in the $s$-coordinate} 60 59 61 60 In $s$-coordinates, geopotential mixing ($i.e.$ horizontal mixing) $r_1$ and … … 88 87 %gm% caution I'm not sure the simplification was a good idea! 89 88 90 These slopes are computed once in \rou{ldfslp\_init} when \forcode{ln_sco = .true.}rue, 91 and either \forcode{ln_traldf_hor = .true.}rue or \forcode{ln_dynldf_hor = .true.}rue. 92 93 \subsection{Slopes for tracer iso-neutral mixing}\label{LDF_slp_iso} 89 These slopes are computed once in \rou{ldfslp\_init} when \np{ln\_sco}\forcode{ = .true.}rue, 90 and either \np{ln\_traldf\_hor}\forcode{ = .true.}rue or \np{ln\_dynldf\_hor}\forcode{ = .true.}rue. 91 92 \subsection{Slopes for tracer iso-neutral mixing} 93 \label{LDF_slp_iso} 94 94 In iso-neutral mixing $r_1$ and $r_2$ are the slopes between the iso-neutral 95 95 and computational surfaces. Their formulation does not depend on the vertical … … 147 147 \item[$s$- or hybrid $s$-$z$- coordinate : ] in the current release of \NEMO, 148 148 iso-neutral mixing is only employed for $s$-coordinates if the 149 Griffies scheme is used (\ forcode{traldf_grif= .true.}; see Appdx \ref{sec:triad}).149 Griffies scheme is used (\np{traldf\_grif}\forcode{ = .true.}; see Appdx \ref{sec:triad}). 150 150 In other words, iso-neutral mixing will only be accurately represented with a 151 linear equation of state (\ forcode{nn_eos = 1} or 2). In the case of a "true" equation151 linear equation of state (\np{nn\_eos}\forcode{ = 1..2}). In the case of a "true" equation 152 152 of state, the evaluation of $i$ and $j$ derivatives in \eqref{Eq_ldfslp_iso} 153 153 will include a pressure dependent part, leading to the wrong evaluation of … … 212 212 ocean model are modified \citep{Weaver_Eby_JPO97, 213 213 Griffies_al_JPO98}. Griffies's scheme is now available in \NEMO if 214 \np{traldf _grif_iso} is set true; see Appdx \ref{sec:triad}. Here,214 \np{traldf\_grif\_iso} is set true; see Appdx \ref{sec:triad}. Here, 215 215 another strategy is presented \citep{Lazar_PhD97}: a local 216 216 filtering of the iso-neutral slopes (made on 9 grid-points) prevents … … 276 276 \colorbox{yellow}{add here a discussion about the flattening of the slopes, vs tapering the coefficient.} 277 277 278 \subsection{ slopes for momentum iso-neutral mixing}278 \subsection{Slopes for momentum iso-neutral mixing} 279 279 280 280 The iso-neutral diffusion operator on momentum is the same as the one used on … … 306 306 % Lateral Mixing Operator 307 307 % ================================================================ 308 \section [Lateral Mixing Operators (\textit{ldftra}, \textit{ldfdyn})] 309 {Lateral Mixing Operators (\protect\mdl{traldf}, \protect\mdl{traldf}) } 308 \section{Lateral mixing operators (\protect\mdl{traldf}, \protect\mdl{traldf}) } 310 309 \label{LDF_op} 311 310 … … 315 314 % Lateral Mixing Coefficients 316 315 % ================================================================ 317 \section [Lateral Mixing Coefficient (\textit{ldftra}, \textit{ldfdyn})] 318 {Lateral Mixing Coefficient (\protect\mdl{ldftra}, \protect\mdl{ldfdyn}) } 316 \section{Lateral mixing coefficient (\protect\mdl{ldftra}, \protect\mdl{ldfdyn}) } 319 317 \label{LDF_coef} 320 318 … … 344 342 as follows: 345 343 346 \subsubsection{Constant Mixing Coefficients (default option)}344 \subsubsection{Constant mixing coefficients (default option)} 347 345 When none of the \textbf{key\_dynldf\_...} and \textbf{key\_traldf\_...} keys are 348 346 defined, a constant value is used over the whole ocean for momentum and 349 tracers, which is specified through the \np{rn _ahm0} and \np{rn_aht0} namelist347 tracers, which is specified through the \np{rn\_ahm0} and \np{rn\_aht0} namelist 350 348 parameters. 351 349 352 \subsubsection{Vertically varying Mixing Coefficients (\protect\key{traldf\_c1d} and \key{dynldf\_c1d})}350 \subsubsection{Vertically varying mixing coefficients (\protect\key{traldf\_c1d} and \key{dynldf\_c1d})} 353 351 The 1D option is only available when using the $z$-coordinate with full step. 354 352 Indeed in all the other types of vertical coordinate, the depth is a 3D function … … 356 354 mixing coefficients will require 3D arrays. In the 1D option, a hyperbolic variation 357 355 of the lateral mixing coefficient is introduced in which the surface value is 358 \np{rn _aht0} (\np{rn_ahm0}), the bottom value is 1/4 of the surface value,356 \np{rn\_aht0} (\np{rn\_ahm0}), the bottom value is 1/4 of the surface value, 359 357 and the transition takes place around z=300~m with a width of 300~m 360 358 ($i.e.$ both the depth and the width of the inflection point are set to 300~m). 361 359 This profile is hard coded in file \hf{traldf\_c1d}, but can be easily modified by users. 362 360 363 \subsubsection{Horizontally Varying Mixing Coefficients (\protect\key{traldf\_c2d} and \protect\key{dynldf\_c2d})}361 \subsubsection{Horizontally varying mixing coefficients (\protect\key{traldf\_c2d} and \protect\key{dynldf\_c2d})} 364 362 By default the horizontal variation of the eddy coefficient depends on the local mesh 365 363 size and the type of operator used: … … 372 370 \end{equation} 373 371 where $e_{max}$ is the maximum of $e_1$ and $e_2$ taken over the whole masked 374 ocean domain, and $A_o^l$ is the \np{rn _ahm0} (momentum) or \np{rn_aht0} (tracer)372 ocean domain, and $A_o^l$ is the \np{rn\_ahm0} (momentum) or \np{rn\_aht0} (tracer) 375 373 namelist parameter. This variation is intended to reflect the lesser need for subgrid 376 374 scale eddy mixing where the grid size is smaller in the domain. It was introduced in … … 384 382 Other formulations can be introduced by the user for a given configuration. 385 383 For example, in the ORCA2 global ocean model (see Configurations), the laplacian 386 viscosity operator uses \np{rn _ahm0}~= 4.10$^4$ m$^2$/s poleward of 20$^{\circ}$387 north and south and decreases linearly to \np{rn _aht0}~= 2.10$^3$ m$^2$/s384 viscosity operator uses \np{rn\_ahm0}~= 4.10$^4$ m$^2$/s poleward of 20$^{\circ}$ 385 north and south and decreases linearly to \np{rn\_aht0}~= 2.10$^3$ m$^2$/s 388 386 at the equator \citep{Madec_al_JPO96, Delecluse_Madec_Bk00}. This modification 389 387 can be found in routine \rou{ldf\_dyn\_c2d\_orca} defined in \mdl{ldfdyn\_c2d}. … … 391 389 sub-domain options of ORCA2 and ORCA05 (see \&namcfg namelist). 392 390 393 \subsubsection{Space Varying Mixing Coefficients (\protect\key{traldf\_c3d} and \key{dynldf\_c3d})}391 \subsubsection{Space varying mixing coefficients (\protect\key{traldf\_c3d} and \key{dynldf\_c3d})} 394 392 395 393 The 3D space variation of the mixing coefficient is simply the combination of the … … 397 395 a grid size dependence of the magnitude of the coefficient. 398 396 399 \subsubsection{Space and Time Varying Mixing Coefficients}397 \subsubsection{Space and time varying mixing coefficients} 400 398 401 399 There is no default specification of space and time varying mixing coefficient. … … 423 421 (3) for isopycnal diffusion on momentum or tracers, an additional purely 424 422 horizontal background diffusion with uniform coefficient can be added by 425 setting a non zero value of \np{rn _ahmb0} or \np{rn_ahtb0}, a background horizontal423 setting a non zero value of \np{rn\_ahmb0} or \np{rn\_ahtb0}, a background horizontal 426 424 eddy viscosity or diffusivity coefficient (namelist parameters whose default 427 425 values are $0$). However, the technique used to compute the isopycnal … … 438 436 (6) it is possible to use both the laplacian and biharmonic operators concurrently. 439 437 440 (7) it is possible to run without explicit lateral diffusion on momentum (\np{ln _dynldf_lap}=441 \np{ln_dynldf_bilap} = false). This is recommended when using the UBS advection442 scheme on momentum (\np{ln _dynadv_ubs} = true, see \ref{DYN_adv_ubs})438 (7) it is possible to run without explicit lateral diffusion on momentum (\np{ln\_dynldf\_lap}\forcode{ = 439 }\np{ln\_dynldf\_bilap}\forcode{ = .false.}). This is recommended when using the UBS advection 440 scheme on momentum (\np{ln\_dynadv\_ubs}\forcode{ = .true.}, see \ref{DYN_adv_ubs}) 443 441 and can be useful for testing purposes. 444 442 … … 446 444 % Eddy Induced Mixing 447 445 % ================================================================ 448 \section [Eddy Induced Velocity (\textit{traadv\_eiv}, \textit{ldfeiv})] 449 {Eddy Induced Velocity (\protect\mdl{traadv\_eiv}, \protect\mdl{ldfeiv})} 446 \section{Eddy induced velocity (\protect\mdl{traadv\_eiv}, \protect\mdl{ldfeiv})} 450 447 \label{LDF_eiv} 451 448 … … 455 452 described in \S\ref{LDF_coef}. If none of the keys \key{traldf\_cNd}, 456 453 N=1,2,3 is set (the default), spatially constant iso-neutral $A_l$ and 457 GM diffusivity $A_e$ are directly set by \np{rn _aeih_0} and458 \np{rn _aeiv_0}. If 2D-varying coefficients are set with454 GM diffusivity $A_e$ are directly set by \np{rn\_aeih\_0} and 455 \np{rn\_aeiv\_0}. If 2D-varying coefficients are set with 459 456 \key{traldf\_c2d} then $A_l$ is reduced in proportion with horizontal 460 457 scale factor according to \eqref{Eq_title} \footnote{Except in global ORCA … … 467 464 case, $A_e$ at low latitudes $|\theta|<20^{\circ}$ is further 468 465 reduced by a factor $|f/f_{20}|$, where $f_{20}$ is the value of $f$ 469 at $20^{\circ}$~N} (\mdl{ldfeiv}) and \np{rn _aeiv_0} is ignored466 at $20^{\circ}$~N} (\mdl{ldfeiv}) and \np{rn\_aeiv\_0} is ignored 470 467 unless it is zero. 471 468 } … … 485 482 \end{equation} 486 483 where $A^{eiv}$ is the eddy induced velocity coefficient whose value is set 487 through \np{rn _aeiv}, a \textit{nam\_traldf} namelist parameter.484 through \np{rn\_aeiv}, a \textit{nam\_traldf} namelist parameter. 488 485 The three components of the eddy induced velocity are computed and add 489 486 to the eulerian velocity in \mdl{traadv\_eiv}. This has been preferred to a -
branches/2017/dev_merge_2017/DOC/tex_sub/chap_OBS.tex
r9392 r9393 4 4 % Chapter observation operator (OBS) 5 5 % ================================================================ 6 \chapter{Observation and model comparison (OBS)}6 \chapter{Observation and Model Comparison (OBS)} 7 7 \label{OBS} 8 8 … … 24 24 The OBS code is called from \mdl{nemogcm} for model initialisation and to calculate the model 25 25 equivalent values for observations on the 0th timestep. The code is then called again after 26 each timestep from \mdl{step}. The code is only activated if the namelist logical \np{ln _diaobs}26 each timestep from \mdl{step}. The code is only activated if the namelist logical \np{ln\_diaobs} 27 27 is set to true. 28 28 … … 34 34 Some profile observation types (e.g. tropical moored buoys) are made available as daily averaged quantities. 35 35 The observation operator code can be set-up to calculate the equivalent daily average model temperature fields 36 using the \np{nn _profdavtypes} namelist array. Some SST observations are equivalent to a night-time36 using the \np{nn\_profdavtypes} namelist array. Some SST observations are equivalent to a night-time 37 37 average value and the observation operator code can calculate equivalent night-time average model SST fields by 38 setting the namelist value \np{ln _sstnight} to true. Otherwise the model value from the nearest timestep to the38 setting the namelist value \np{ln\_sstnight} to true. Otherwise the model value from the nearest timestep to the 39 39 observation time is used. 40 40 … … 88 88 89 89 Options are defined through the \ngn{namobs} namelist variables. 90 The options \np{ln _t3d} and \np{ln_s3d} switch on the temperature and salinity90 The options \np{ln\_t3d} and \np{ln\_s3d} switch on the temperature and salinity 91 91 profile observation operator code. The filename or array of filenames are 92 specified using the \np{cn _profbfiles} variable. The model grid points for a92 specified using the \np{cn\_profbfiles} variable. The model grid points for a 93 93 particular observation latitude and longitude are found using the grid 94 94 searching part of the code. This can be expensive, particularly for large 95 numbers of observations, setting \np{ln _grid_search_lookup} allows the use of95 numbers of observations, setting \np{ln\_grid\_search\_lookup} allows the use of 96 96 a lookup table which is saved into an ``xypos`` file (or files). This will need 97 97 to be generated the first time if it does not exist in the run directory. 98 98 However, once produced it will significantly speed up future grid searches. 99 Setting \np{ln _grid_global} means that the code distributes the observations99 Setting \np{ln\_grid\_global} means that the code distributes the observations 100 100 evenly between processors. Alternatively each processor will work with 101 101 observations located within the model subdomain (see section~\ref{OBS_parallel}). … … 556 556 NEMO therefore has the capability to specify either an interpolation or an averaging (for surface observation types only). 557 557 558 The main namelist option associated with the interpolation/averaging is \np{nn _2dint}. This default option can be set to values from 0 to 6.558 The main namelist option associated with the interpolation/averaging is \np{nn\_2dint}. This default option can be set to values from 0 to 6. 559 559 Values between 0 to 4 are associated with interpolation while values 5 or 6 are associated with averaging. 560 560 \begin{itemize} 561 \item \ forcode{nn_2dint= 0}: Distance-weighted interpolation562 \item \ forcode{nn_2dint= 1}: Distance-weighted interpolation (small angle)563 \item \ forcode{nn_2dint= 2}: Bilinear interpolation (geographical grid)564 \item \ forcode{nn_2dint= 3}: Bilinear remapping interpolation (general grid)565 \item \ forcode{nn_2dint= 4}: Polynomial interpolation566 \item \ forcode{nn_2dint= 5}: Radial footprint averaging with diameter specified in the namelist as \np{rn\_???\_avglamscl} in degrees or metres (set using \np{ln\_???\_fp\_indegs})567 \item \ forcode{nn_2dint= 6}: Rectangular footprint averaging with E/W and N/S size specified in the namelist as \np{rn\_???\_avglamscl} and \np{rn\_???\_avgphiscl} in degrees or metres (set using \np{ln\_???\_fp\_indegs})561 \item \np{nn\_2dint}\forcode{ = 0}: Distance-weighted interpolation 562 \item \np{nn\_2dint}\forcode{ = 1}: Distance-weighted interpolation (small angle) 563 \item \np{nn\_2dint}\forcode{ = 2}: Bilinear interpolation (geographical grid) 564 \item \np{nn\_2dint}\forcode{ = 3}: Bilinear remapping interpolation (general grid) 565 \item \np{nn\_2dint}\forcode{ = 4}: Polynomial interpolation 566 \item \np{nn\_2dint}\forcode{ = 5}: Radial footprint averaging with diameter specified in the namelist as \np{rn\_???\_avglamscl} in degrees or metres (set using \np{ln\_???\_fp\_indegs}) 567 \item \np{nn\_2dint}\forcode{ = 6}: Rectangular footprint averaging with E/W and N/S size specified in the namelist as \np{rn\_???\_avglamscl} and \np{rn\_???\_avgphiscl} in degrees or metres (set using \np{ln\_???\_fp\_indegs}) 568 568 \end{itemize} 569 569 The ??? in the last two options indicate these options should be specified for each observation type for which the averaging is to be performed (see namelist example above). 570 The \np{nn _2dint} default option can be overridden for surface observation types using namelist values \np{nn\_2dint\_???} where ??? is one of sla,sst,sss,sic.570 The \np{nn\_2dint} default option can be overridden for surface observation types using namelist values \np{nn\_2dint\_???} where ??? is one of sla,sst,sss,sic. 571 571 572 572 Below is some more detail on the various options for interpolation and averaging available in NEMO. … … 956 956 957 957 The above namelist will result in feedback files whose first 12 hours contain 958 the first field of \ifile{foo}and the second 12 hours contain the second field.958 the first field of foo.nc and the second 12 hours contain the second field. 959 959 960 960 %\begin{framed} … … 988 988 989 989 %\begin{framed} 990 \textbf{Note: ln\_cl4} must be set to \ emph{.TRUE.} in \textbf{namobs}990 \textbf{Note: ln\_cl4} must be set to \forcode{.true.} in \textbf{namobs} 991 991 to use class 4 outputs. 992 992 %\end{framed} … … 998 998 \noindent 999 999 \linebreak 1000 \ ifile{\textbf{\$\{prefix\}\_\$\{yyyymmdd\}\_\$\{sys\}\_\$\{cfg\}\_\$\{vn\}\_\$\{kind\}\_\$\{nproc\}}}1000 \textbf{\$\{prefix\}\_\$\{yyyymmdd\}\_\$\{sys\}\_\$\{cfg\}\_\$\{vn\}\_\$\{kind\}\_\$\{nproc\}}.nc 1001 1001 1002 1002 \noindent … … 1182 1182 \newpage 1183 1183 1184 \section{Observation Utilities}1184 \section{Observation utilities} 1185 1185 \label{OBS_obsutils} 1186 1186 … … 1331 1331 \end{cmds} 1332 1332 1333 \subsection{ building the obstools}1333 \subsection{Building the obstools} 1334 1334 1335 1335 To build the obstools use in the tools directory use ./maketools -n OBSTOOLS -m [ARCH]. -
branches/2017/dev_merge_2017/DOC/tex_sub/chap_SBC.tex
r9392 r9393 28 28 29 29 Five different ways to provide the first six fields to the ocean are available which 30 are controlled by namelist \ngn{namsbc} variables: an analytical formulation (\np{ln _ana}~=~true),31 a flux formulation (\np{ln _flx}~=~true), a bulk formulae formulation (CORE32 (\np{ln _blk_core}~=~true), CLIO (\np{ln_blk_clio}~=~true) or MFS30 are controlled by namelist \ngn{namsbc} variables: an analytical formulation (\np{ln\_ana}\forcode{ = .true.}), 31 a flux formulation (\np{ln\_flx}\forcode{ = .true.}), a bulk formulae formulation (CORE 32 (\np{ln\_blk\_core}\forcode{ = .true.}), CLIO (\np{ln\_blk\_clio}\forcode{ = .true.}) or MFS 33 33 \footnote { Note that MFS bulk formulae compute fluxes only for the ocean component} 34 (\np{ln _blk_mfs}~=~true) bulk formulae) and a coupled or mixed forced/coupled formulation35 (exchanges with a atmospheric model via the OASIS coupler) (\np{ln _cpl} or \np{ln_mixcpl}~=~true).36 When used ($i.e.$ \np{ln _apr_dyn}~=~true), the atmospheric pressure forces both ocean and ice dynamics.37 38 The frequency at which the forcing fields have to be updated is given by the \np{nn _fsbc} namelist parameter.34 (\np{ln\_blk\_mfs}\forcode{ = .true.}) bulk formulae) and a coupled or mixed forced/coupled formulation 35 (exchanges with a atmospheric model via the OASIS coupler) (\np{ln\_cpl} or \np{ln\_mixcpl}\forcode{ = .true.}). 36 When used ($i.e.$ \np{ln\_apr\_dyn}\forcode{ = .true.}), the atmospheric pressure forces both ocean and ice dynamics. 37 38 The frequency at which the forcing fields have to be updated is given by the \np{nn\_fsbc} namelist parameter. 39 39 When the fields are supplied from data files (flux and bulk formulations), the input fields 40 40 need not be supplied on the model grid. Instead a file of coordinates and weights can … … 50 50 \item the rotation of vector components supplied relative to an east-north 51 51 coordinate system onto the local grid directions in the model ; 52 \item the addition of a surface restoring term to observed SST and/or SSS (\np{ln _ssr}~=~true) ;53 \item the modification of fluxes below ice-covered areas (using observed ice-cover or a sea-ice model) (\np{nn _ice}~=~0,1, 2 or 3) ;54 \item the addition of river runoffs as surface freshwater fluxes or lateral inflow (\np{ln _rnf}~=~true) ;55 \item the addition of isf melting as lateral inflow (parameterisation) or as fluxes applied at the land-ice ocean interface (\np{ln _isf}) ;56 \item the addition of a freshwater flux adjustment in order to avoid a mean sea-level drift (\np{nn _fwb}~=~0,~1~or~2) ;57 \item the transformation of the solar radiation (if provided as daily mean) into a diurnal cycle (\np{ln _dm2dc}~=~true) ;58 and a neutral drag coefficient can be read from an external wave model (\np{ln _cdgw}~=~true).52 \item the addition of a surface restoring term to observed SST and/or SSS (\np{ln\_ssr}\forcode{ = .true.}) ; 53 \item the modification of fluxes below ice-covered areas (using observed ice-cover or a sea-ice model) (\np{nn\_ice}\forcode{ = 0..3}) ; 54 \item the addition of river runoffs as surface freshwater fluxes or lateral inflow (\np{ln\_rnf}\forcode{ = .true.}) ; 55 \item the addition of isf melting as lateral inflow (parameterisation) or as fluxes applied at the land-ice ocean interface (\np{ln\_isf}) ; 56 \item the addition of a freshwater flux adjustment in order to avoid a mean sea-level drift (\np{nn\_fwb}\forcode{ = 0..2}) ; 57 \item the transformation of the solar radiation (if provided as daily mean) into a diurnal cycle (\np{ln\_dm2dc}\forcode{ = .true.}) ; 58 and a neutral drag coefficient can be read from an external wave model (\np{ln\_cdgw}\forcode{ = .true.}). 59 59 \end{itemize} 60 60 The latter option is possible only in case core or mfs bulk formulas are selected. … … 91 91 and \eqref{Eq_tra_sbc_lin} in \S\ref{TRA_sbc}). 92 92 The latter is the penetrative part of the heat flux. It is applied as a 3D 93 trends of the temperature equation (\mdl{traqsr} module) when \np{ln _traqsr}=\textit{true}.93 trends of the temperature equation (\mdl{traqsr} module) when \np{ln\_traqsr}\forcode{ = .true.}. 94 94 The way the light penetrates inside the water column is generally a sum of decreasing 95 95 exponentials (see \S\ref{TRA_qsr}). … … 110 110 %created!) 111 111 % 112 %Especially the \np{nn _fsbc}, the \mdl{sbc\_oce} module (fluxes + mean sst sss ssu112 %Especially the \np{nn\_fsbc}, the \mdl{sbc\_oce} module (fluxes + mean sst sss ssu 113 113 %ssv) i.e. information required by flux computation or sea-ice 114 114 % … … 130 130 The ocean model provides, at each time step, to the surface module (\mdl{sbcmod}) 131 131 the surface currents, temperature and salinity. 132 These variables are averaged over \np{nn _fsbc} time-step (\ref{Tab_ssm}),132 These variables are averaged over \np{nn\_fsbc} time-step (\ref{Tab_ssm}), 133 133 and it is these averaged fields which are used to computes the surface fluxes 134 at a frequency of \np{nn _fsbc} time-step.134 at a frequency of \np{nn\_fsbc} time-step. 135 135 136 136 … … 157 157 % Input Data 158 158 % ================================================================ 159 \section{Input Data generic interface}159 \section{Input data generic interface} 160 160 \label{SBC_input} 161 161 … … 185 185 186 186 Note that when an input data is archived on a disc which is accessible directly 187 from the workspace where the code is executed, then the use can set the \np{cn _dir}187 from the workspace where the code is executed, then the use can set the \np{cn\_dir} 188 188 to the pathway leading to the data. By default, the data are assumed to have been 189 189 copied so that cn\_dir='./'. … … 192 192 % Input Data specification (\mdl{fldread}) 193 193 % ------------------------------------------------------------------------------------------------------------- 194 \subsection{Input Data specification (\protect\mdl{fldread})}194 \subsection{Input data specification (\protect\mdl{fldread})} 195 195 \label{SBC_fldread} 196 196 … … 214 214 \hline 215 215 & daily or weekLLL & monthly & yearly \\ \hline 216 clim = false & \ifile{fn\_yYYYYmMMdDD} & \ifile{fn\_yYYYYmMM} & \ifile{fn\_yYYYY}\\ \hline217 clim = true & not possible & \ifile{fn\_m??}& fn \\ \hline216 \np{clim}\forcode{ = .false.} & fn\_yYYYYmMMdDD.nc & fn\_yYYYYmMM.nc & fn\_yYYYY.nc \\ \hline 217 \np{clim}\forcode{ = .true.} & not possible & fn\_m??.nc & fn \\ \hline 218 218 \end{tabular} 219 219 \end{center} … … 271 271 a time interpolation will be performed at the following time: 0h30'00", 1h30'00", 2h30'00", etc. 272 272 However, for forcing data related to the surface module, values are not needed at every 273 time-step but at every \np{nn _fsbc} time-step. For example with \np{nn_fsbc}~=~3,273 time-step but at every \np{nn\_fsbc} time-step. For example with \np{nn\_fsbc}\forcode{ = 3}, 274 274 the surface module will be called at time-steps 1, 4, 7, etc. The date used for the time interpolation 275 is thus redefined to be at the middle of \np{nn _fsbc} time-step period. In the previous example,275 is thus redefined to be at the middle of \np{nn\_fsbc} time-step period. In the previous example, 276 276 this leads to: 1h30'00", 4h30'00", 7h30'00", etc. \\ 277 277 (2) For code readablility and maintenance issues, we don't take into account the NetCDF input file … … 300 300 % Interpolation on the Fly 301 301 % ------------------------------------------------------------------------------------------------------------- 302 \subsection [Interpolation on-the-Fly] {Interpolation on-the-Fly}302 \subsection{Interpolation on-the-fly} 303 303 \label{SBC_iof} 304 304 … … 324 324 Note that nn\_lsm=0 forces the code to not apply the procedure even if a file for land/sea mask is supplied. 325 325 326 \subsubsection{Bilinear Interpolation}326 \subsubsection{Bilinear interpolation} 327 327 \label{SBC_iof_bilinear} 328 328 … … 346 346 and wgt(1) corresponds to variable "wgt01" for example. 347 347 348 \subsubsection{Bicubic Interpolation}348 \subsubsection{Bicubic interpolation} 349 349 \label{SBC_iof_bicubic} 350 350 … … 421 421 % Standalone Surface Boundary Condition Scheme 422 422 % ------------------------------------------------------------------------------------------------------------- 423 \subsection [Standalone Surface Boundary Condition Scheme] {Standalone Surface Boundary Condition Scheme}423 \subsection{Standalone surface boundary condition scheme} 424 424 \label{SAS_iof} 425 425 … … 438 438 \item Development of sea-ice algorithms or parameterizations. 439 439 \item spinup of the iceberg floats 440 \item ocean/sea-ice simulation with both media running in parallel (\np{ln _mixcpl}~=~\textit{true})440 \item ocean/sea-ice simulation with both media running in parallel (\np{ln\_mixcpl}\forcode{ = .true.}) 441 441 \end{itemize} 442 442 … … 481 481 % Analytical formulation (sbcana module) 482 482 % ================================================================ 483 \section [Analytical formulation (\textit{sbcana}) ] 484 {Analytical formulation (\protect\mdl{sbcana} module) } 483 \section{Analytical formulation (\protect\mdl{sbcana})} 485 484 \label{SBC_ana} 486 485 … … 492 491 In this case, all the six fluxes needed by the ocean are assumed to 493 492 be uniform in space. They take constant values given in the namelist 494 \ngn{namsbc{\_}ana} by the variables \np{rn _utau0}, \np{rn_vtau0}, \np{rn_qns0},495 \np{rn _qsr0}, and \np{rn_emp0} ($\textit{emp}=\textit{emp}_S$). The runoff is set to zero.493 \ngn{namsbc{\_}ana} by the variables \np{rn\_utau0}, \np{rn\_vtau0}, \np{rn\_qns0}, 494 \np{rn\_qsr0}, and \np{rn\_emp0} ($\textit{emp}=\textit{emp}_S$). The runoff is set to zero. 496 495 In addition, the wind is allowed to reach its nominal value within a given number 497 of time steps (\np{nn _tau000}).496 of time steps (\np{nn\_tau000}). 498 497 499 498 If a user wants to apply a different analytical forcing, the \mdl{sbcana} … … 506 505 % Flux formulation 507 506 % ================================================================ 508 \section [Flux formulation (\textit{sbcflx}) ] 509 {Flux formulation (\protect\mdl{sbcflx} module) } 507 \section{Flux formulation (\protect\mdl{sbcflx})} 510 508 \label{SBC_flx} 511 509 %------------------------------------------namsbc_flx---------------------------------------------------- … … 513 511 %------------------------------------------------------------------------------------------------------------- 514 512 515 In the flux formulation (\ forcode{ln_flx= .true.}), the surface boundary513 In the flux formulation (\np{ln\_flx}\forcode{ = .true.}), the surface boundary 516 514 condition fields are directly read from input files. The user has to define 517 515 in the namelist \ngn{namsbc{\_}flx} the name of the file, the name of the variable … … 528 526 % Bulk formulation 529 527 % ================================================================ 530 \section [Bulk formulation (\textit{sbcblk\_core}, \textit{sbcblk\_clio} or \textit{sbcblk\_mfs})]531 {Bulk formulation \small{(\protect\mdl{sbcblk\_core} \protect\mdl{sbcblk\_clio} \protect\mdl{sbcblk\_mfs} modules)}}528 \section[Bulk formulation {(\textit{sbcblk\{\_core,\_clio,\_mfs\}.F90})}] 529 {Bulk formulation {(\protect\mdl{sbcblk\_core}, \protect\mdl{sbcblk\_clio}, \protect\mdl{sbcblk\_mfs})}} 532 530 \label{SBC_blk} 533 531 … … 537 535 The atmospheric fields used depend on the bulk formulae used. Three bulk formulations 538 536 are available : the CORE, the CLIO and the MFS bulk formulea. The choice is made by setting to true 539 one of the following namelist variable : \np{ln _core} ; \np{ln_clio} or \np{ln_mfs}.537 one of the following namelist variable : \np{ln\_core} ; \np{ln\_clio} or \np{ln\_mfs}. 540 538 541 539 Note : in forced mode, when a sea-ice model is used, a bulk formulation (CLIO or CORE) have to be used. … … 546 544 % CORE Bulk formulea 547 545 % ------------------------------------------------------------------------------------------------------------- 548 \subsection [CORE Bulk formulea (\protect\forcode{ln_core = .true.})] 549 {CORE Bulk formulea (\protect\forcode{ln_core = .true.}, \protect\mdl{sbcblk\_core})} 546 \subsection{CORE formulea (\protect\mdl{sbcblk\_core}, \protect\np{ln\_core}\forcode{ = .true.})} 550 547 \label{SBC_blk_core} 551 548 %------------------------------------------namsbc_core---------------------------------------------------- … … 592 589 or larger than the one of the input atmospheric fields. 593 590 594 The \np{sn _wndi}, \np{sn_wndj}, \np{sn_qsr}, \np{sn_qlw}, \np{sn_tair}, \np{sn_humi},595 \np{sn _prec}, \np{sn_snow}, \np{sn_tdif} parameters describe the fields591 The \np{sn\_wndi}, \np{sn\_wndj}, \np{sn\_qsr}, \np{sn\_qlw}, \np{sn\_tair}, \np{sn\_humi}, 592 \np{sn\_prec}, \np{sn\_snow}, \np{sn\_tdif} parameters describe the fields 596 593 and the way they have to be used (spatial and temporal interpolations). 597 594 598 \np{cn _dir} is the directory of location of bulk files599 \np{ln _taudif} is the flag to specify if we use Hight Frequency (HF) tau information (.true.) or not (.false.)600 \np{rn _zqt}: is the height of humidity and temperature measurements (m)601 \np{rn _zu}: is the height of wind measurements (m)595 \np{cn\_dir} is the directory of location of bulk files 596 \np{ln\_taudif} is the flag to specify if we use Hight Frequency (HF) tau information (.true.) or not (.false.) 597 \np{rn\_zqt}: is the height of humidity and temperature measurements (m) 598 \np{rn\_zu}: is the height of wind measurements (m) 602 599 603 600 Three multiplicative factors are availables : 604 \np{rn _pfac} and \np{rn_efac} allows to adjust (if necessary) the global freshwater budget601 \np{rn\_pfac} and \np{rn\_efac} allows to adjust (if necessary) the global freshwater budget 605 602 by increasing/reducing the precipitations (total and snow) and or evaporation, respectively. 606 The third one,\np{rn _vfac}, control to which extend the ice/ocean velocities are taken into account603 The third one,\np{rn\_vfac}, control to which extend the ice/ocean velocities are taken into account 607 604 in the calculation of surface wind stress. Its range should be between zero and one, 608 605 and it is recommended to set it to 0. … … 611 608 % CLIO Bulk formulea 612 609 % ------------------------------------------------------------------------------------------------------------- 613 \subsection [CLIO Bulk formulea (\protect\forcode{ln_clio = .true.})] 614 {CLIO Bulk formulea (\protect\forcode{ln_clio = .true.}, \protect\mdl{sbcblk\_clio})} 610 \subsection{CLIO formulea (\protect\mdl{sbcblk\_clio}, \protect\np{ln\_clio}\forcode{ = .true.})} 615 611 \label{SBC_blk_clio} 616 612 %------------------------------------------namsbc_clio---------------------------------------------------- … … 652 648 % MFS Bulk formulae 653 649 % ------------------------------------------------------------------------------------------------------------- 654 \subsection [MFS Bulk formulea (\protect\forcode{ln_mfs = .true.})] 655 {MFS Bulk formulea (\protect\forcode{ln_mfs = .true.}, \protect\mdl{sbcblk\_mfs})} 650 \subsection{MFS formulea (\protect\mdl{sbcblk\_mfs}, \protect\np{ln\_mfs}\forcode{ = .true.})} 656 651 \label{SBC_blk_mfs} 657 652 %------------------------------------------namsbc_mfs---------------------------------------------------- … … 679 674 The required 7 input fields must be provided on the model Grid-T and are: 680 675 \begin{itemize} 681 \item Zonal Component of the 10m wind ($ms^{-1}$) (\np{sn _windi})682 \item Meridional Component of the 10m wind ($ms^{-1}$) (\np{sn _windj})683 \item Total Claud Cover (\%) (\np{sn _clc})684 \item 2m Air Temperature ($K$) (\np{sn _tair})685 \item 2m Dew Point Temperature ($K$) (\np{sn _rhm})686 \item Total Precipitation ${Kg} m^{-2} s^{-1}$ (\np{sn _prec})687 \item Mean Sea Level Pressure (${Pa}$) (\np{sn _msl})676 \item Zonal Component of the 10m wind ($ms^{-1}$) (\np{sn\_windi}) 677 \item Meridional Component of the 10m wind ($ms^{-1}$) (\np{sn\_windj}) 678 \item Total Claud Cover (\%) (\np{sn\_clc}) 679 \item 2m Air Temperature ($K$) (\np{sn\_tair}) 680 \item 2m Dew Point Temperature ($K$) (\np{sn\_rhm}) 681 \item Total Precipitation ${Kg} m^{-2} s^{-1}$ (\np{sn\_prec}) 682 \item Mean Sea Level Pressure (${Pa}$) (\np{sn\_msl}) 688 683 \end{itemize} 689 684 % ------------------------------------------------------------------------------------------------------------- … … 691 686 % Coupled formulation 692 687 % ================================================================ 693 \section [Coupled formulation (\textit{sbccpl}) ] 694 {Coupled formulation (\protect\mdl{sbccpl} module)} 688 \section{Coupled formulation (\protect\mdl{sbccpl})} 695 689 \label{SBC_cpl} 696 690 %------------------------------------------namsbc_cpl---------------------------------------------------- … … 709 703 as well as to \href{http://wrf-model.org/}{WRF} (Weather Research and Forecasting Model). 710 704 711 Note that in addition to the setting of \np{ln _cpl} to true, the \key{coupled} have to be defined.705 Note that in addition to the setting of \np{ln\_cpl} to true, the \key{coupled} have to be defined. 712 706 The CPP key is mainly used in sea-ice to ensure that the atmospheric fluxes are 713 707 actually recieved by the ice-ocean system (no calculation of ice sublimation in coupled mode). … … 730 724 % Atmospheric pressure 731 725 % ================================================================ 732 \section [Atmospheric pressure (\textit{sbcapr})] 733 {Atmospheric pressure (\protect\mdl{sbcapr})} 726 \section{Atmospheric pressure (\protect\mdl{sbcapr})} 734 727 \label{SBC_apr} 735 728 %------------------------------------------namsbc_apr---------------------------------------------------- … … 738 731 739 732 The optional atmospheric pressure can be used to force ocean and ice dynamics 740 (\np{ln _apr_dyn}~=~true, \textit{\ngn{namsbc}} namelist ).741 The input atmospheric forcing defined via \np{sn _apr} structure (\textit{namsbc\_apr} namelist)733 (\np{ln\_apr\_dyn}\forcode{ = .true.}, \textit{\ngn{namsbc}} namelist ). 734 The input atmospheric forcing defined via \np{sn\_apr} structure (\textit{namsbc\_apr} namelist) 742 735 can be interpolated in time to the model time step, and even in space when the 743 736 interpolation on-the-fly is used. When used to force the dynamics, the atmospheric … … 748 741 \end{equation} 749 742 where $P_{atm}$ is the atmospheric pressure and $P_o$ a reference atmospheric pressure. 750 A value of $101,000~N/m^2$ is used unless \np{ln _ref_apr} is set to true. In this case $P_o$743 A value of $101,000~N/m^2$ is used unless \np{ln\_ref\_apr} is set to true. In this case $P_o$ 751 744 is set to the value of $P_{atm}$ averaged over the ocean domain, $i.e.$ the mean value of 752 745 $\eta_{ib}$ is kept to zero at all time step. … … 760 753 When using time-splitting and BDY package for open boundaries conditions, the equivalent 761 754 inverse barometer sea surface height $\eta_{ib}$ can be added to BDY ssh data: 762 \np{ln _apr_obc} might be set to true.755 \np{ln\_apr\_obc} might be set to true. 763 756 764 757 % ================================================================ 765 758 % Tidal Potential 766 759 % ================================================================ 767 \section [Tidal Potential (\textit{sbctide})] 768 {Tidal Potential (\protect\mdl{sbctide})} 760 \section{Tidal potential (\protect\mdl{sbctide})} 769 761 \label{SBC_tide} 770 762 … … 774 766 775 767 A module is available to compute the tidal potential and use it in the momentum equation. 776 This option is activated when \np{ln _tide} is set to true in \ngn{nam\_tide}.768 This option is activated when \np{ln\_tide} is set to true in \ngn{nam\_tide}. 777 769 778 770 Some parameters are available in namelist \ngn{nam\_tide}: 779 771 780 - \np{ln _tide_load} activate the load potential forcing and \np{filetide_load} is the associated file781 782 - \np{ln _tide_pot} activate the tidal potential forcing783 784 - \np{nb _harmo} is the number of constituent used772 - \np{ln\_tide\_load} activate the load potential forcing and \np{filetide\_load} is the associated file 773 774 - \np{ln\_tide\_pot} activate the tidal potential forcing 775 776 - \np{nb\_harmo} is the number of constituent used 785 777 786 778 - \np{clname} is the name of constituent … … 821 813 % River runoffs 822 814 % ================================================================ 823 \section [River runoffs (\textit{sbcrnf})] 824 {River runoffs (\protect\mdl{sbcrnf})} 815 \section{River runoffs (\protect\mdl{sbcrnf})} 825 816 \label{SBC_rnf} 826 817 %------------------------------------------namsbc_rnf---------------------------------------------------- … … 863 854 depth (in metres) which the river should be added to. 864 855 865 Namelist variables in \ngn{namsbc\_rnf}, \np{ln _rnf_depth}, \np{ln_rnf_sal} and \np{ln_rnf_temp} control whether856 Namelist variables in \ngn{namsbc\_rnf}, \np{ln\_rnf\_depth}, \np{ln\_rnf\_sal} and \np{ln\_rnf\_temp} control whether 866 857 the river attributes (depth, salinity and temperature) are read in and used. If these are set 867 858 as false the river is added to the surface box only, assumed to be fresh (0~psu), and/or … … 876 867 to give the heat and salt content of the river runoff. 877 868 After the user specified depth is read ini, the number of grid boxes this corresponds to is 878 calculated and stored in the variable \np{nz _rnf}.869 calculated and stored in the variable \np{nz\_rnf}. 879 870 The variable \textit{h\_dep} is then calculated to be the depth (in metres) of the bottom of the 880 871 lowest box the river water is being added to (i.e. the total depth that river water is being added to in the model). … … 937 928 % Ice shelf melting 938 929 % ================================================================ 939 \section [Ice shelf melting (\textit{sbcisf})] 940 {Ice shelf melting (\protect\mdl{sbcisf})} 930 \section{Ice shelf melting (\protect\mdl{sbcisf})} 941 931 \label{SBC_isf} 942 932 %------------------------------------------namsbc_isf---------------------------------------------------- 943 933 \forfile{../namelists/namsbc_isf} 944 934 %-------------------------------------------------------------------------------------------------------- 945 Namelist variable in \ngn{namsbc}, \np{nn _isf}, controls the ice shelf representation used.935 Namelist variable in \ngn{namsbc}, \np{nn\_isf}, controls the ice shelf representation used. 946 936 \begin{description} 947 \item[\np{nn _isf}~=~1]948 The ice shelf cavity is represented (\np{ln _isfcav}~=~trueneeded). The fwf and heat flux are computed.937 \item[\np{nn\_isf}\forcode{ = 1}] 938 The ice shelf cavity is represented (\np{ln\_isfcav}\forcode{ = .true.} needed). The fwf and heat flux are computed. 949 939 Two different bulk formula are available: 950 940 \begin{description} 951 \item[\np{nn _isfblk}~=~1]941 \item[\np{nn\_isfblk}\forcode{ = 1}] 952 942 The bulk formula used to compute the melt is based the one described in \citet{Hunter2006}. 953 943 This formulation is based on a balance between the upward ocean heat flux and the latent heat flux at the ice shelf base. 954 944 955 \item[\np{nn _isfblk}~=~2]945 \item[\np{nn\_isfblk}\forcode{ = 2}] 956 946 The bulk formula used to compute the melt is based the one described in \citet{Jenkins1991}. 957 947 This formulation is based on a 3 equations formulation (a heat flux budget, a salt flux budget … … 961 951 For this 2 bulk formulations, there are 3 different ways to compute the exchange coeficient: 962 952 \begin{description} 963 \item[\np{nn\_gammablk ~=~0~}]964 The salt and heat exchange coefficients are constant and defined by \np{rn _gammas0} and \np{rn_gammat0}965 966 \item[\np{nn\_gammablk ~=~1~}]967 The salt and heat exchange coefficients are velocity dependent and defined as $rn\_gammas0 \times u_{*}$ and $rn\_gammat0\times u_{*}$968 where $u_{*}$ is the friction velocity in the top boundary layer (ie first \np{rn _hisf_tbl} meters).953 \item[\np{nn\_gammablk}\forcode{ = 0}] 954 The salt and heat exchange coefficients are constant and defined by \np{rn\_gammas0} and \np{rn\_gammat0} 955 956 \item[\np{nn\_gammablk}\forcode{ = 1}] 957 The salt and heat exchange coefficients are velocity dependent and defined as \np{rn\_gammas0}$ \times u_{*}$ and \np{rn\_gammat0}$ \times u_{*}$ 958 where $u_{*}$ is the friction velocity in the top boundary layer (ie first \np{rn\_hisf\_tbl} meters). 969 959 See \citet{Jenkins2010} for all the details on this formulation. 970 960 971 \item[\np{nn\_gammablk ~=~2~}]961 \item[\np{nn\_gammablk}\forcode{ = 2}] 972 962 The salt and heat exchange coefficients are velocity and stability dependent and defined as 973 963 $\gamma_{T,S} = \frac{u_{*}}{\Gamma_{Turb} + \Gamma^{T,S}_{Mole}}$ 974 where $u_{*}$ is the friction velocity in the top boundary layer (ie first \np{rn _hisf_tbl} meters),964 where $u_{*}$ is the friction velocity in the top boundary layer (ie first \np{rn\_hisf\_tbl} meters), 975 965 $\Gamma_{Turb}$ the contribution of the ocean stability and 976 966 $\Gamma^{T,S}_{Mole}$ the contribution of the molecular diffusion. … … 978 968 \end{description} 979 969 980 \item[\np{nn _isf}~=~2]970 \item[\np{nn\_isf}\forcode{ = 2}] 981 971 A parameterisation of isf is used. The ice shelf cavity is not represented. 982 972 The fwf is distributed along the ice shelf edge between the depth of the average grounding line (GL) 983 (\np{sn _depmax_isf}) and the base of the ice shelf along the calving front (\np{sn_depmin_isf}) as in (\np{nn_isf}~=~3).973 (\np{sn\_depmax\_isf}) and the base of the ice shelf along the calving front (\np{sn\_depmin\_isf}) as in (\np{nn\_isf}\forcode{ = 3}). 984 974 Furthermore the fwf and heat flux are computed using the \citet{Beckmann2003} parameterisation of isf melting. 985 The effective melting length (\np{sn _Leff_isf}) is read from a file.986 987 \item[\np{nn _isf}~=~3]975 The effective melting length (\np{sn\_Leff\_isf}) is read from a file. 976 977 \item[\np{nn\_isf}\forcode{ = 3}] 988 978 A simple parameterisation of isf is used. The ice shelf cavity is not represented. 989 The fwf (\np{sn _rnfisf}) is prescribed and distributed along the ice shelf edge between the depth of the average grounding line (GL)990 (\np{sn _depmax_isf}) and the base of the ice shelf along the calving front (\np{sn_depmin_isf}).979 The fwf (\np{sn\_rnfisf}) is prescribed and distributed along the ice shelf edge between the depth of the average grounding line (GL) 980 (\np{sn\_depmax\_isf}) and the base of the ice shelf along the calving front (\np{sn\_depmin\_isf}). 991 981 The heat flux ($Q_h$) is computed as $Q_h = fwf \times L_f$. 992 982 993 \item[\np{nn _isf}~=~4]994 The ice shelf cavity is opened (\np{ln _isfcav}~=~true needed). However, the fwf is not computed but specified from file \np{sn_fwfisf}).983 \item[\np{nn\_isf}\forcode{ = 4}] 984 The ice shelf cavity is opened (\np{ln\_isfcav}\forcode{ = .true.} needed). However, the fwf is not computed but specified from file \np{sn\_fwfisf}). 995 985 The heat flux ($Q_h$) is computed as $Q_h = fwf \times L_f$.\\ 996 986 \end{description} 997 987 998 988 999 $\bullet$ \np{nn _isf}~=~1 and \np{nn_isf}~=~2compute a melt rate based on the water mass properties, ocean velocities and depth.989 $\bullet$ \np{nn\_isf}\forcode{ = 1} and \np{nn\_isf}\forcode{ = 2} compute a melt rate based on the water mass properties, ocean velocities and depth. 1000 990 This flux is thus highly dependent of the model resolution (horizontal and vertical), realism of the water masses onto the shelf ...\\ 1001 991 1002 992 1003 $\bullet$ \np{nn _isf}~=~3 and \np{nn_isf}~=~4read the melt rate from a file. You have total control of the fwf forcing.993 $\bullet$ \np{nn\_isf}\forcode{ = 3} and \np{nn\_isf}\forcode{ = 4} read the melt rate from a file. You have total control of the fwf forcing. 1004 994 This can be usefull if the water masses on the shelf are not realistic or the resolution (horizontal/vertical) are too 1005 995 coarse to have realistic melting or for studies where you need to control your heat and fw input.\\ 1006 996 1007 997 A namelist parameters control over how many meters the heat and fw fluxes are spread. 1008 \np{rn _hisf_tbl}] is the top boundary layer thickness as defined in \citet{Losch2008}.1009 This parameter is only used if \np{nn _isf}~=~1 or \np{nn_isf}~=~41010 1011 If \np{rn _hisf_tbl} = 0., the fluxes are put in the top level whatever is its tickness.1012 1013 If \np{rn _hisf_tbl} $>$ 0., the fluxes are spread over the first \np{rn_hisf_tbl} m (ie over one or several cells).\\998 \np{rn\_hisf\_tbl}] is the top boundary layer thickness as defined in \citet{Losch2008}. 999 This parameter is only used if \np{nn\_isf}\forcode{ = 1} or \np{nn\_isf}\forcode{ = 4} 1000 1001 If \np{rn\_hisf\_tbl}\forcode{ = 0}., the fluxes are put in the top level whatever is its tickness. 1002 1003 If \np{rn\_hisf\_tbl} $>$ 0., the fluxes are spread over the first \np{rn\_hisf\_tbl} m (ie over one or several cells).\\ 1014 1004 1015 1005 The ice shelf melt is implemented as a volume flux with in the same way as for the runoff. … … 1019 1009 1020 1010 1021 \section{ 1011 \section{Ice sheet coupling} 1022 1012 \label{SBC_iscpl} 1023 1013 %------------------------------------------namsbc_iscpl---------------------------------------------------- … … 1026 1016 Ice sheet/ocean coupling is done through file exchange at the restart step. NEMO, at each restart step, 1027 1017 read the bathymetry and ice shelf draft variable in a netcdf file. 1028 If \np{ln\_iscpl = ~true}, the isf draft is assume to be different at each restart step1018 If \np{ln\_iscpl}\forcode{ = .true.}, the isf draft is assume to be different at each restart step 1029 1019 with potentially some new wet/dry cells due to the ice sheet dynamics/thermodynamics. 1030 1020 The wetting and drying scheme applied on the restart is very simple and described below for the 6 different cases: … … 1043 1033 set mask to 1, T/S is extrapolated from neighbours, ssh is extrapolated from neighbours and U/V set to 0. If no neighbour, T/S/U/V and mask set to 0. 1044 1034 \end{description} 1045 The extrapolation is call \np{nn _drown} times. It means that if the grounding line retreat by more than \np{nn_drown} cells between 2 coupling steps,1035 The extrapolation is call \np{nn\_drown} times. It means that if the grounding line retreat by more than \np{nn\_drown} cells between 2 coupling steps, 1046 1036 the code will be unable to fill all the new wet cells properly. The default number is set up for the MISOMIP idealised experiments.\\ 1047 1037 This coupling procedure is able to take into account grounding line and calving front migration. However, it is a non-conservative processe. 1048 1038 This could lead to a trend in heat/salt content and volume. In order to remove the trend and keep the conservation level as close to 0 as possible, 1049 a simple conservation scheme is available with \np{ln\_hsb = ~true}. The heat/salt/vol. gain/loss is diagnose, as well as the location.1039 a simple conservation scheme is available with \np{ln\_hsb}\forcode{ = .true.}. The heat/salt/vol. gain/loss is diagnose, as well as the location. 1050 1040 Based on what is done on sbcrnf to prescribed a source of heat/salt/vol., the heat/salt/vol. gain/loss is removed/added, 1051 over a period of \np{rn _fiscpl} time step, into the system.1052 So after \np{rn _fiscpl} time step, all the heat/salt/vol. gain/loss due to extrapolation process is canceled.\\1041 over a period of \np{rn\_fiscpl} time step, into the system. 1042 So after \np{rn\_fiscpl} time step, all the heat/salt/vol. gain/loss due to extrapolation process is canceled.\\ 1053 1043 1054 1044 As the before and now fields are not compatible (modification of the geometry), the restart time step is prescribed to be an euler time step instead of a leap frog and $fields_b = fields_n$. … … 1068 1058 Icebergs are initially spawned into one of ten classes which have specific mass and thickness as described 1069 1059 in the \ngn{namberg} namelist: 1070 \np{rn _initial_mass} and \np{rn_initial_thickness}.1071 Each class has an associated scaling (\np{rn _mass_scaling}), which is an integer representing how many icebergs1060 \np{rn\_initial\_mass} and \np{rn\_initial\_thickness}. 1061 Each class has an associated scaling (\np{rn\_mass\_scaling}), which is an integer representing how many icebergs 1072 1062 of this class are being described as one lagrangian point (this reduces the numerical problem of tracking every single iceberg). 1073 They are enabled by setting \np{ln _icebergs}~=~true.1063 They are enabled by setting \np{ln\_icebergs}\forcode{ = .true.}. 1074 1064 1075 1065 Two initialisation schemes are possible. 1076 1066 \begin{description} 1077 \item[\np{nn _test_icebergs}~$>$~0]1078 In this scheme, the value of \np{nn _test_icebergs} represents the class of iceberg to generate1079 (so between 1 and 10), and \np{nn _test_icebergs} provides a lon/lat box in the domain at each1067 \item[\np{nn\_test\_icebergs}~$>$~0] 1068 In this scheme, the value of \np{nn\_test\_icebergs} represents the class of iceberg to generate 1069 (so between 1 and 10), and \np{nn\_test\_icebergs} provides a lon/lat box in the domain at each 1080 1070 grid point of which an iceberg is generated at the beginning of the run. 1081 (Note that this happens each time the timestep equals \np{nn _nit000}.)1082 \np{nn _test_icebergs} is defined by four numbers in \np{nn_test_box} representing the corners1071 (Note that this happens each time the timestep equals \np{nn\_nit000}.) 1072 \np{nn\_test\_icebergs} is defined by four numbers in \np{nn\_test\_box} representing the corners 1083 1073 of the geographical box: lonmin,lonmax,latmin,latmax 1084 \item[\np{nn _test_icebergs}~=~-1]1085 In this scheme the model reads a calving file supplied in the \np{sn _icb} parameter.1074 \item[\np{nn\_test\_icebergs}\forcode{ = -1}] 1075 In this scheme the model reads a calving file supplied in the \np{sn\_icb} parameter. 1086 1076 This should be a file with a field on the configuration grid (typically ORCA) representing ice accumulation rate at each model point. 1087 1077 These should be ocean points adjacent to land where icebergs are known to calve. … … 1095 1085 Icebergs are influenced by wind, waves and currents, bottom melt and erosion. 1096 1086 The latter act to disintegrate the iceberg. This is either all melted freshwater, or 1097 (if \np{rn _bits_erosion_fraction}~$>$~0) into melt and additionally small ice bits1087 (if \np{rn\_bits\_erosion\_fraction}~$>$~0) into melt and additionally small ice bits 1098 1088 which are assumed to propagate with their larger parent and thus delay fluxing into the ocean. 1099 1089 Melt water (and other variables on the configuration grid) are written into the main NEMO model output files. … … 1101 1091 Extensive diagnostics can be produced. 1102 1092 Separate output files are maintained for human-readable iceberg information. 1103 A separate file is produced for each processor (independent of \np{ln _ctl}).1093 A separate file is produced for each processor (independent of \np{ln\_ctl}). 1104 1094 The amount of information is controlled by two integer parameters: 1105 1095 \begin{description} 1106 \item[\np{nn _verbose_level}] takes a value between one and four and represents1096 \item[\np{nn\_verbose\_level}] takes a value between one and four and represents 1107 1097 an increasing number of points in the code at which variables are written, and an 1108 1098 increasing level of obscurity. 1109 \item[\np{nn _verbose_write}] is the number of timesteps between writes1099 \item[\np{nn\_verbose\_write}] is the number of timesteps between writes 1110 1100 \end{description} 1111 1101 1112 Iceberg trajectories can also be written out and this is enabled by setting \np{nn _sample_rate}~$>$~0.1102 Iceberg trajectories can also be written out and this is enabled by setting \np{nn\_sample\_rate}~$>$~0. 1113 1103 A non-zero value represents how many timesteps between writes of information into the output file. 1114 1104 These output files are in NETCDF format. … … 1128 1118 % Diurnal cycle 1129 1119 % ------------------------------------------------------------------------------------------------------------- 1130 \subsection [Diurnal cycle (\textit{sbcdcy})] 1131 {Diurnal cycle (\protect\mdl{sbcdcy})} 1120 \subsection{Diurnal cycle (\protect\mdl{sbcdcy})} 1132 1121 \label{SBC_dcy} 1133 1122 %------------------------------------------namsbc_rnf---------------------------------------------------- … … 1155 1144 the diurnal cycle of SWF is a scaling of the top of the atmosphere diurnal cycle 1156 1145 of incident SWF. The \cite{Bernie_al_CD07} reconstruction algorithm is available 1157 in \NEMO by setting \np{ln _dm2dc}~=~true(a \textit{\ngn{namsbc}} namelist variable) when using1158 CORE bulk formulea (\np{ln _blk_core}~=~true) or the flux formulation (\np{ln_flx}~=~true).1146 in \NEMO by setting \np{ln\_dm2dc}\forcode{ = .true.} (a \textit{\ngn{namsbc}} namelist variable) when using 1147 CORE bulk formulea (\np{ln\_blk\_core}\forcode{ = .true.}) or the flux formulation (\np{ln\_flx}\forcode{ = .true.}). 1159 1148 The reconstruction is performed in the \mdl{sbcdcy} module. The detail of the algoritm used 1160 1149 can be found in the appendix~A of \cite{Bernie_al_CD07}. The algorithm preserve the daily … … 1162 1151 of the analytical cycle over this time step (Fig.\ref{Fig_SBC_diurnal}). 1163 1152 The use of diurnal cycle reconstruction requires the input SWF to be daily 1164 ($i.e.$ a frequency of 24 and a time interpolation set to true in \np{sn _qsr} namelist parameter).1153 ($i.e.$ a frequency of 24 and a time interpolation set to true in \np{sn\_qsr} namelist parameter). 1165 1154 Furthermore, it is recommended to have a least 8 surface module time step per day, 1166 1155 that is $\rdt \ nn\_fsbc < 10,800~s = 3~h$. An example of recontructed SWF … … 1189 1178 \label{SBC_rotation} 1190 1179 1191 When using a flux (\ forcode{ln_flx = .true.}) or bulk (\forcode{ln_clio = .true.} or \forcode{ln_core= .true.}) formulation,1180 When using a flux (\np{ln\_flx}\forcode{ = .true.}) or bulk (\np{ln\_clio}\forcode{ = .true.} or \np{ln\_core}\forcode{ = .true.}) formulation, 1192 1181 pairs of vector components can be rotated from east-north directions onto the local grid directions. 1193 1182 This is particularly useful when interpolation on the fly is used since here any vectors are likely to be defined … … 1205 1194 % Surface restoring to observed SST and/or SSS 1206 1195 % ------------------------------------------------------------------------------------------------------------- 1207 \subsection [Surface restoring to observed SST and/or SSS (\textit{sbcssr})] 1208 {Surface restoring to observed SST and/or SSS (\protect\mdl{sbcssr})} 1196 \subsection{Surface restoring to observed SST and/or SSS (\protect\mdl{sbcssr})} 1209 1197 \label{SBC_ssr} 1210 1198 %------------------------------------------namsbc_ssr---------------------------------------------------- … … 1213 1201 1214 1202 IOptions are defined through the \ngn{namsbc\_ssr} namelist variables. 1215 n forced mode using a flux formulation (\np{ln _flx}~=~true), a1203 n forced mode using a flux formulation (\np{ln\_flx}\forcode{ = .true.}), a 1216 1204 feedback term \emph{must} be added to the surface heat flux $Q_{ns}^o$: 1217 1205 \begin{equation} \label{Eq_sbc_dmp_q} … … 1251 1239 The presence at the sea surface of an ice covered area modifies all the fluxes 1252 1240 transmitted to the ocean. There are several way to handle sea-ice in the system 1253 depending on the value of the \np{nn _ice} namelist parameter found in \ngn{namsbc} namelist.1241 depending on the value of the \np{nn\_ice} namelist parameter found in \ngn{namsbc} namelist. 1254 1242 \begin{description} 1255 1243 \item[nn{\_}ice = 0] there will never be sea-ice in the computational domain. … … 1275 1263 % {Description of Ice-ocean interface to be added here or in LIM 2 and 3 doc ?} 1276 1264 1277 \subsection [Interface to CICE (\textit{sbcice\_cice})] 1278 {Interface to CICE (\protect\mdl{sbcice\_cice})} 1265 \subsection{Interface to CICE (\protect\mdl{sbcice\_cice})} 1279 1266 \label{SBC_cice} 1280 1267 … … 1287 1274 \textit{calc\_strair~=~true} and \textit{calc\_Tsfc~=~true} in the CICE name-list), or alternatively when NEMO 1288 1275 is coupled to the HadGAM3 atmosphere model (with \textit{calc\_strair~=~false} and \textit{calc\_Tsfc~=~false}). 1289 The code is intended to be used with \np{nn _fsbc} set to 1 (although coupling ocean and ice less frequently1276 The code is intended to be used with \np{nn\_fsbc} set to 1 (although coupling ocean and ice less frequently 1290 1277 should work, it is possible the calculation of some of the ocean-ice fluxes needs to be modified slightly - the 1291 1278 user should check that results are not significantly different to the standard case). … … 1303 1290 % Freshwater budget control 1304 1291 % ------------------------------------------------------------------------------------------------------------- 1305 \subsection [Freshwater budget control (\textit{sbcfwb})] 1306 {Freshwater budget control (\protect\mdl{sbcfwb})} 1292 \subsection{Freshwater budget control (\protect\mdl{sbcfwb})} 1307 1293 \label{SBC_fwb} 1308 1294 … … 1311 1297 in the freshwater fluxes. In \NEMO, two way of controlling the the freshwater budget. 1312 1298 \begin{description} 1313 \item[\ forcode{nn_fwb= 0}] no control at all. The mean sea level is free to drift, and will1299 \item[\np{nn\_fwb}\forcode{ = 0}] no control at all. The mean sea level is free to drift, and will 1314 1300 certainly do so. 1315 \item[\ forcode{nn_fwb= 1}] global mean \textit{emp} set to zero at each model time step.1301 \item[\np{nn\_fwb}\forcode{ = 1}] global mean \textit{emp} set to zero at each model time step. 1316 1302 %Note that with a sea-ice model, this technique only control the mean sea level with linear free surface (\key{vvl} not defined) and no mass flux between ocean and ice (as it is implemented in the current ice-ocean coupling). 1317 \item[\ forcode{nn_fwb= 2}] freshwater budget is adjusted from the previous year annual1303 \item[\np{nn\_fwb}\forcode{ = 2}] freshwater budget is adjusted from the previous year annual 1318 1304 mean budget which is read in the \textit{EMPave\_old.dat} file. As the model uses the 1319 1305 Boussinesq approximation, the annual mean fresh water budget is simply evaluated … … 1325 1311 % Neutral Drag Coefficient from external wave model 1326 1312 % ------------------------------------------------------------------------------------------------------------- 1327 \subsection [Neutral drag coefficient from external wave model (\textit{sbcwave})]1328 1313 \subsection[Neutral drag coeff. from external wave model (\protect\mdl{sbcwave})] 1314 {Neutral drag coefficient from external wave model (\protect\mdl{sbcwave})} 1329 1315 \label{SBC_wave} 1330 1316 %------------------------------------------namwave---------------------------------------------------- … … 1332 1318 %------------------------------------------------------------------------------------------------------------- 1333 1319 1334 In order to read a neutral drag coeff , from an external data source ($i.e.$ a wave model), the1335 logical variable \np{ln _cdgw} in \ngn{namsbc} namelist must be set to \textit{true}.1336 The \mdl{sbcwave} module containing the routine \np{sbc _wave} reads the1320 In order to read a neutral drag coefficient, from an external data source ($i.e.$ a wave model), the 1321 logical variable \np{ln\_cdgw} in \ngn{namsbc} namelist must be set to \forcode{.true.}. 1322 The \mdl{sbcwave} module containing the routine \np{sbc\_wave} reads the 1337 1323 namelist \ngn{namsbc\_wave} (for external data names, locations, frequency, interpolation and all 1338 1324 the miscellanous options allowed by Input Data generic Interface see \S\ref{SBC_input}) -
branches/2017/dev_merge_2017/DOC/tex_sub/chap_STO.tex
r9392 r9393 4 4 % Chapter stochastic parametrization of EOS (STO) 5 5 % ================================================================ 6 \chapter{Stochastic parametrization of EOS (STO)}6 \chapter{Stochastic Parametrization of EOS (STO)} 7 7 \label{STO} 8 8 … … 155 155 Parameters for the processes can be specified through the following \ngn{namsto} namelist parameters: 156 156 \begin{description} 157 \item[\np{nn _sto_eos}] : number of independent random walks158 \item[\np{rn _eos_stdxy}] : random walk horz. standard deviation (in grid points)159 \item[\np{rn _eos_stdz}] : random walk vert. standard deviation (in grid points)160 \item[\np{rn _eos_tcor}] : random walk time correlation (in timesteps)161 \item[\np{nn _eos_ord}] : order of autoregressive processes162 \item[\np{nn _eos_flt}] : passes of Laplacian filter163 \item[\np{rn _eos_lim}] : limitation factor (default = 3.0)157 \item[\np{nn\_sto\_eos}] : number of independent random walks 158 \item[\np{rn\_eos\_stdxy}] : random walk horz. standard deviation (in grid points) 159 \item[\np{rn\_eos\_stdz}] : random walk vert. standard deviation (in grid points) 160 \item[\np{rn\_eos\_tcor}] : random walk time correlation (in timesteps) 161 \item[\np{nn\_eos\_ord}] : order of autoregressive processes 162 \item[\np{nn\_eos\_flt}] : passes of Laplacian filter 163 \item[\np{rn\_eos\_lim}] : limitation factor (default = 3.0) 164 164 \end{description} 165 165 This routine also includes the initialization (seeding) of the random number generator. 166 166 167 167 The third routine (\rou{sto\_rst\_write}) writes a restart file (which suffix name is 168 given by \np{cn _storst_out} namelist parameter) containing the current value of168 given by \np{cn\_storst\_out} namelist parameter) containing the current value of 169 169 all autoregressive processes to allow restarting a simulation from where it has been interrupted. 170 170 This file also contains the current state of the random number generator. 171 When \np{ln _rststo} is set to \textit{true}), the restart file (which suffix name is172 given by \np{cn _storst_in} namelist parameter) is read by the initialization routine171 When \np{ln\_rststo} is set to \forcode{.true.}), the restart file (which suffix name is 172 given by \np{cn\_storst\_in} namelist parameter) is read by the initialization routine 173 173 (\rou{sto\_par\_init}). The simulation will continue exactly as if it was not interrupted 174 only when \np{ln _rstseed} is set to \textit{true}, $i.e.$ when the state of174 only when \np{ln\_rstseed} is set to \forcode{.true.}, $i.e.$ when the state of 175 175 the random number generator is read in the restart file. 176 176 -
branches/2017/dev_merge_2017/DOC/tex_sub/chap_TRA.tex
r9392 r9393 57 57 58 58 The user has the option of extracting each tendency term on the RHS of the tracer 59 equation for output (\np{ln _tra_trd} or \np{ln_tra_mxl}~=~true), as described in Chap.~\ref{DIA}.59 equation for output (\np{ln\_tra\_trd} or \np{ln\_tra\_mxl}\forcode{ = .true.}), as described in Chap.~\ref{DIA}. 60 60 61 61 $\ $\newline % force a new ligne … … 63 63 % Tracer Advection 64 64 % ================================================================ 65 \section [Tracer Advection (\textit{traadv})] 66 {Tracer Advection (\protect\mdl{traadv})} 65 \section{Tracer advection (\protect\mdl{traadv})} 67 66 \label{TRA_adv} 68 67 %------------------------------------------namtra_adv----------------------------------------------------- … … 70 69 %------------------------------------------------------------------------------------------------------------- 71 70 72 When considered ($i.e.$ when \np{ln _traadv_NONE} is not set to \textit{true}),71 When considered ($i.e.$ when \np{ln\_traadv\_NONE} is not set to \forcode{.true.}), 73 72 the advection tendency of a tracer is expressed in flux form, 74 73 $i.e.$ as the divergence of the advective fluxes. Its discrete expression is given by : … … 84 83 by using the following equality : $\nabla \cdot \left( \vect{U}\,T \right)=\vect{U} \cdot \nabla T$ 85 84 which results from the use of the continuity equation, $\partial _t e_3 + e_3\;\nabla \cdot \vect{U}=0$ 86 (which reduces to $\nabla \cdot \vect{U}=0$ in linear free surface, $i.e.$ \ forcode{ln_linssh= .true.}).85 (which reduces to $\nabla \cdot \vect{U}=0$ in linear free surface, $i.e.$ \np{ln\_linssh}\forcode{ = .true.}). 87 86 Therefore it is of paramount importance to design the discrete analogue of the 88 87 advection tendency so that it is consistent with the continuity equation in order to … … 114 113 boundary condition depends on the type of sea surface chosen: 115 114 \begin{description} 116 \item [linear free surface:] (\ forcode{ln_linssh= .true.}) the first level thickness is constant in time:115 \item [linear free surface:] (\np{ln\_linssh}\forcode{ = .true.}) the first level thickness is constant in time: 117 116 the vertical boundary condition is applied at the fixed surface $z=0$ 118 117 rather than on the moving surface $z=\eta$. There is a non-zero advective … … 120 119 $\left. {\tau _w } \right|_{k=1/2} =T_{k=1} $, $i.e.$ 121 120 the product of surface velocity (at $z=0$) by the first level tracer value. 122 \item [non-linear free surface:] (\ forcode{ln_linssh= .false.})121 \item [non-linear free surface:] (\np{ln\_linssh}\forcode{ = .false.}) 123 122 convergence/divergence in the first ocean level moves the free surface 124 123 up/down. There is no tracer advection through it so that the advective … … 146 145 Estimated Streaming Terms scheme (QUICKEST). 147 146 The choice is made in the \textit{\ngn{namtra\_adv}} namelist, by 148 setting to \ textit{true} one of the logicals \textit{ln\_traadv\_xxx}.147 setting to \forcode{.true.} one of the logicals \textit{ln\_traadv\_xxx}. 149 148 The corresponding code can be found in the \textit{traadv\_xxx.F90} module, 150 149 where \textit{xxx} is a 3 or 4 letter acronym corresponding to each scheme. 151 150 By default ($i.e.$ in the reference namelist, \ngn{namelist\_ref}), all the logicals 152 are set to \ textit{false}. If the user does not select an advection scheme151 are set to \forcode{.false.}. If the user does not select an advection scheme 153 152 in the configuration namelist (\ngn{namelist\_cfg}), the tracers will \textit{not} be advected ! 154 153 … … 174 173 % 2nd and 4th order centred schemes 175 174 % ------------------------------------------------------------------------------------------------------------- 176 \subsection [Centred schemes (CEN) (\protect\np{ln_traadv_cen})] 177 {Centred schemes (CEN) (\protect\forcode{ln_traadv_cen = .true.})} 175 \subsection{CEN: Centred scheme (\protect\np{ln\_traadv\_cen}\forcode{ = .true.})} 178 176 \label{TRA_adv_cen} 179 177 180 178 % 2nd order centred scheme 181 179 182 The centred advection scheme (CEN) is used when \np{ln _traadv_cen}~=~\textit{true}.180 The centred advection scheme (CEN) is used when \np{ln\_traadv\_cen}\forcode{ = .true.}. 183 181 Its order ($2^{nd}$ or $4^{th}$) can be chosen independently on horizontal (iso-level) 184 and vertical direction by setting \np{nn _cen_h} and \np{nn_cen_v} to $2$ or $4$.182 and vertical direction by setting \np{nn\_cen\_h} and \np{nn\_cen\_v} to $2$ or $4$. 185 183 CEN implementation can be found in the \mdl{traadv\_cen} module. 186 184 … … 212 210 =\overline{ T - \frac{1}{6}\,\delta _i \left[ \delta_{i+1/2}[T] \,\right] }^{\,i+1/2} 213 211 \end{equation} 214 In the vertical direction (\np{nn _cen_v}=$4$), a $4^{th}$ COMPACT interpolation212 In the vertical direction (\np{nn\_cen\_v}\forcode{ = 4}), a $4^{th}$ COMPACT interpolation 215 213 has been prefered \citep{Demange_PhD2014}. 216 214 In the COMPACT scheme, both the field and its derivative are interpolated, … … 224 222 The expression \textit{$4^{th}$ order scheme} used in oceanographic literature 225 223 is usually associated with the scheme presented here. 226 Introducing a \ textit{true} $4^{th}$ order advection scheme is feasible but,224 Introducing a \forcode{.true.} $4^{th}$ order advection scheme is feasible but, 227 225 for consistency reasons, it requires changes in the discretisation of the tracer 228 226 advection together with changes in the continuity equation, … … 246 244 % FCT scheme 247 245 % ------------------------------------------------------------------------------------------------------------- 248 \subsection [Flux Corrected Transport schemes (FCT) (\protect\np{ln_traadv_fct})] 249 {Flux Corrected Transport schemes (FCT) (\protect\forcode{ln_traadv_fct = .true.})} 246 \subsection{FCT: Flux Corrected Transport scheme (\protect\np{ln\_traadv\_fct}\forcode{ = .true.})} 250 247 \label{TRA_adv_tvd} 251 248 252 The Flux Corrected Transport schemes (FCT) is used when \np{ln _traadv_fct}~=~\textit{true}.249 The Flux Corrected Transport schemes (FCT) is used when \np{ln\_traadv\_fct}\forcode{ = .true.}. 253 250 Its order ($2^{nd}$ or $4^{th}$) can be chosen independently on horizontal (iso-level) 254 and vertical direction by setting \np{nn _fct_h} and \np{nn_fct_v} to $2$ or $4$.251 and vertical direction by setting \np{nn\_fct\_h} and \np{nn\_fct\_v} to $2$ or $4$. 255 252 FCT implementation can be found in the \mdl{traadv\_fct} module. 256 253 … … 269 266 where $c_u$ is a flux limiter function taking values between 0 and 1. 270 267 The FCT order is the one of the centred scheme used ($i.e.$ it depends on the setting of 271 \np{nn _fct_h} and \np{nn_fct_v}.268 \np{nn\_fct\_h} and \np{nn\_fct\_v}. 272 269 There exist many ways to define $c_u$, each corresponding to a different 273 270 FCT scheme. The one chosen in \NEMO is described in \citet{Zalesak_JCP79}. … … 277 274 A comparison of FCT-2 with MUSCL and a MPDATA scheme can be found in \citet{Levy_al_GRL01}. 278 275 279 An additional option has been added controlled by \np{nn _fct_zts}. By setting this integer to276 An additional option has been added controlled by \np{nn\_fct\_zts}. By setting this integer to 280 277 a value larger than zero, a $2^{nd}$ order FCT scheme is used on both horizontal and vertical direction, 281 278 but on the latter, a split-explicit time stepping is used, with a number of sub-timestep equals 282 to \np{nn _fct_zts}. This option can be useful when the size of the timestep is limited279 to \np{nn\_fct\_zts}. This option can be useful when the size of the timestep is limited 283 280 by vertical advection \citep{Lemarie_OM2015}. Note that in this case, a similar split-explicit 284 281 time stepping should be used on vertical advection of momentum to insure a better stability … … 293 290 % MUSCL scheme 294 291 % ------------------------------------------------------------------------------------------------------------- 295 \subsection[MUSCL scheme (\protect\np{ln_traadv_mus})] 296 {Monotone Upstream Scheme for Conservative Laws (MUSCL) (\protect\forcode{ln_traadv_mus = .true.})} 292 \subsection{MUSCL: Monotone Upstream Scheme for Conservative Laws (\protect\np{ln\_traadv\_mus}\forcode{ = .true.})} 297 293 \label{TRA_adv_mus} 298 294 299 The Monotone Upstream Scheme for Conservative Laws (MUSCL) is used when \np{ln _traadv_mus}~=~\textit{true}.295 The Monotone Upstream Scheme for Conservative Laws (MUSCL) is used when \np{ln\_traadv\_mus}\forcode{ = .true.}. 300 296 MUSCL implementation can be found in the \mdl{traadv\_mus} module. 301 297 … … 321 317 the \textit{positive} character of the scheme. 322 318 In addition, fluxes round a grid-point where a runoff is applied can optionally be 323 computed using upstream fluxes (\np{ln _mus_ups}~=~\textit{true}).319 computed using upstream fluxes (\np{ln\_mus\_ups}\forcode{ = .true.}). 324 320 325 321 % ------------------------------------------------------------------------------------------------------------- 326 322 % UBS scheme 327 323 % ------------------------------------------------------------------------------------------------------------- 328 \subsection [Upstream-Biased Scheme (UBS) (\protect\np{ln_traadv_ubs})] 329 {Upstream-Biased Scheme (UBS) (\protect\forcode{ln_traadv_ubs = .true.})} 324 \subsection{UBS a.k.a. UP3: Upstream-Biased Scheme (\protect\np{ln\_traadv\_ubs}\forcode{ = .true.})} 330 325 \label{TRA_adv_ubs} 331 326 332 The Upstream-Biased Scheme (UBS) is used when \np{ln _traadv_ubs}~=~\textit{true}.327 The Upstream-Biased Scheme (UBS) is used when \np{ln\_traadv\_ubs}\forcode{ = .true.}. 333 328 UBS implementation can be found in the \mdl{traadv\_mus} module. 334 329 … … 358 353 where the control of artificial diapycnal fluxes is of paramount importance \citep{Shchepetkin_McWilliams_OM05, Demange_PhD2014}. 359 354 Therefore the vertical flux is evaluated using either a $2^nd$ order FCT scheme 360 or a $4^th$ order COMPACT scheme (\ forcode{nn_cen_v = 2} or 4).355 or a $4^th$ order COMPACT scheme (\np{nn\_cen\_v}\forcode{ = 2 or 4}). 361 356 362 357 For stability reasons (see \S\ref{STP}), … … 401 396 % QCK scheme 402 397 % ------------------------------------------------------------------------------------------------------------- 403 \subsection [QUICKEST scheme (QCK) (\protect\np{ln_traadv_qck})] 404 {QUICKEST scheme (QCK) (\protect\forcode{ln_traadv_qck = .true.})} 398 \subsection{QCK: QuiCKest scheme (\protect\np{ln\_traadv\_qck}\forcode{ = .true.})} 405 399 \label{TRA_adv_qck} 406 400 407 401 The Quadratic Upstream Interpolation for Convective Kinematics with 408 402 Estimated Streaming Terms (QUICKEST) scheme proposed by \citet{Leonard1979} 409 is used when \np{ln _traadv_qck}~=~\textit{true}.403 is used when \np{ln\_traadv\_qck}\forcode{ = .true.}. 410 404 QUICKEST implementation can be found in the \mdl{traadv\_qck} module. 411 405 … … 428 422 % Tracer Lateral Diffusion 429 423 % ================================================================ 430 \section [Tracer Lateral Diffusion (\textit{traldf})] 431 {Tracer Lateral Diffusion (\protect\mdl{traldf})} 424 \section{Tracer lateral diffusion (\protect\mdl{traldf})} 432 425 \label{TRA_ldf} 433 426 %-----------------------------------------nam_traldf------------------------------------------------------ … … 449 442 except for the pure vertical component that appears when a rotation tensor is used. 450 443 This latter component is solved implicitly together with the vertical diffusion term (see \S\ref{STP}). 451 When \np{ln _traldf_msc}~=~\textit{true}, a Method of Stabilizing Correction is used in which444 When \np{ln\_traldf\_msc}\forcode{ = .true.}, a Method of Stabilizing Correction is used in which 452 445 the pure vertical component is split into an explicit and an implicit part \citep{Lemarie_OM2012}. 453 446 … … 455 448 % Type of operator 456 449 % ------------------------------------------------------------------------------------------------------------- 457 \subsection [Type of operator (\protect\np{ln\_traldf\{\_NONE, \_lap, \_blp\}})]458 {Type of operator (\protect\np{ln _traldf_NONE}, \protect\np{ln_traldf_lap}, or \protect\np{ln_traldf_blp} = true) }450 \subsection[Type of operator (\protect\np{ln\_traldf}\{\_NONE,\_lap,\_blp\}\})] 451 {Type of operator (\protect\np{ln\_traldf\_NONE}, \protect\np{ln\_traldf\_lap}, or \protect\np{ln\_traldf\_blp}) } 459 452 \label{TRA_ldf_op} 460 453 461 454 Three operator options are proposed and, one and only one of them must be selected: 462 455 \begin{description} 463 \item [\np{ln _traldf_NONE}] = true: no operator selected, the lateral diffusive tendency will not be456 \item [\np{ln\_traldf\_NONE}\forcode{ = .true.}]: no operator selected, the lateral diffusive tendency will not be 464 457 applied to the tracer equation. This option can be used when the selected advection scheme 465 458 is diffusive enough (MUSCL scheme for example). 466 \item [ \np{ln_traldf_lap}] = true: a laplacian operator is selected. This harmonic operator459 \item [\np{ln\_traldf\_lap}\forcode{ = .true.}]: a laplacian operator is selected. This harmonic operator 467 460 takes the following expression: $\mathpzc{L}(T)=\nabla \cdot A_{ht}\;\nabla T $, 468 461 where the gradient operates along the selected direction (see \S\ref{TRA_ldf_dir}), 469 462 and $A_{ht}$ is the eddy diffusivity coefficient expressed in $m^2/s$ (see Chap.~\ref{LDF}). 470 \item [\np{ln _traldf_blp}] = true: a bilaplacian operator is selected. This biharmonic operator463 \item [\np{ln\_traldf\_blp}\forcode{ = .true.}]: a bilaplacian operator is selected. This biharmonic operator 471 464 takes the following expression: 472 465 $\mathpzc{B}=- \mathpzc{L}\left(\mathpzc{L}(T) \right) = -\nabla \cdot b\nabla \left( {\nabla \cdot b\nabla T} \right)$ … … 488 481 % Direction of action 489 482 % ------------------------------------------------------------------------------------------------------------- 490 \subsection [Direction of action (\protect\np{ln\_traldf\{\_lev, \_hor, \_iso, \_triad\}})]491 {Direction of action (\protect\np{ln _traldf_lev}, \textit{...\_hor}, \textit{...\_iso}, or \textit{...\_triad} = true) }483 \subsection[Action direction (\protect\np{ln\_traldf}\{\_lev,\_hor,\_iso,\_triad\})] 484 {Direction of action (\protect\np{ln\_traldf\_lev}, \protect\np{ln\_traldf\_hor}, \protect\np{ln\_traldf\_iso}, or \protect\np{ln\_traldf\_triad}) } 492 485 \label{TRA_ldf_dir} 493 486 494 487 The choice of a direction of action determines the form of operator used. 495 488 The operator is a simple (re-entrant) laplacian acting in the (\textbf{i},\textbf{j}) plane 496 when iso-level option is used (\np{ln _traldf_lev}~=~\textit{true})489 when iso-level option is used (\np{ln\_traldf\_lev}\forcode{ = .true.}) 497 490 or when a horizontal ($i.e.$ geopotential) operator is demanded in \textit{z}-coordinate 498 (\np{ln _traldf_hor} and \np{ln_zco} equal \textit{true}).491 (\np{ln\_traldf\_hor} and \np{ln\_zco} equal \forcode{.true.}). 499 492 The associated code can be found in the \mdl{traldf\_lap\_blp} module. 500 493 The operator is a rotated (re-entrant) laplacian when the direction along which it acts 501 494 does not coincide with the iso-level surfaces, 502 that is when standard or triad iso-neutral option is used (\np{ln _traldf_iso} or503 \np{ln _traldf_triad} equals \textit{true}, see \mdl{traldf\_iso} or \mdl{traldf\_triad} module, resp.),495 that is when standard or triad iso-neutral option is used (\np{ln\_traldf\_iso} or 496 \np{ln\_traldf\_triad} equals \forcode{.true.}, see \mdl{traldf\_iso} or \mdl{traldf\_triad} module, resp.), 504 497 or when a horizontal ($i.e.$ geopotential) operator is demanded in \textit{s}-coordinate 505 (\np{ln _traldf_hor} and \np{ln_sco} equal \textit{true})498 (\np{ln\_traldf\_hor} and \np{ln\_sco} equal \forcode{.true.}) 506 499 \footnote{In this case, the standard iso-neutral operator will be automatically selected}. 507 500 In that case, a rotation is applied to the gradient(s) that appears in the operator … … 515 508 % iso-level operator 516 509 % ------------------------------------------------------------------------------------------------------------- 517 \subsection [Iso-level (bi-)laplacian operator ( \protect\np{ln_traldf_iso})] 518 {Iso-level (bi-)laplacian operator ( \protect\np{ln_traldf_iso}) } 510 \subsection{Iso-level (bi-)laplacian operator ( \protect\np{ln\_traldf\_iso}) } 519 511 \label{TRA_ldf_lev} 520 512 … … 534 526 It is a \emph{horizontal} operator ($i.e.$ acting along geopotential surfaces) in the $z$-coordinate 535 527 with or without partial steps, but is simply an iso-level operator in the $s$-coordinate. 536 It is thus used when, in addition to \np{ln _traldf_lap} or \np{ln_traldf_blp}~=~\textit{true},537 we have \np{ln _traldf_lev}~=~\textit{true} or \np{ln_traldf_hor}~=~\np{ln_zco}~=~\textit{true}.528 It is thus used when, in addition to \np{ln\_traldf\_lap} or \np{ln\_traldf\_blp}\forcode{ = .true.}, 529 we have \np{ln\_traldf\_lev}\forcode{ = .true.} or \np{ln\_traldf\_hor}~=~\np{ln\_zco}\forcode{ = .true.}. 538 530 In both cases, it significantly contributes to diapycnal mixing. 539 531 It is therefore never recommended, even when using it in the bilaplacian case. 540 532 541 Note that in the partial step $z$-coordinate (\ forcode{ln_zps= .true.}), tracers in horizontally533 Note that in the partial step $z$-coordinate (\np{ln\_zps}\forcode{ = .true.}), tracers in horizontally 542 534 adjacent cells are located at different depths in the vicinity of the bottom. 543 535 In this case, horizontal derivatives in (\ref{Eq_tra_ldf_lap}) at the bottom level … … 549 541 % Rotated laplacian operator 550 542 % ------------------------------------------------------------------------------------------------------------- 551 \subsection [Standard and triad rotated (bi-)laplacian operator] 552 {Standard and triad (bi-)laplacian operator} 543 \subsection{Standard and triad (bi-)laplacian operator} 553 544 \label{TRA_ldf_iso_triad} 554 545 555 546 %&& Standard rotated (bi-)laplacian operator 556 547 %&& ---------------------------------------------- 557 \subsubsection [Standard rotated (bi-)laplacian operator (\protect\mdl{traldf\_iso})] 558 {Standard rotated (bi-)laplacian operator (\protect\mdl{traldf\_iso})} 548 \subsubsection{Standard rotated (bi-)laplacian operator (\protect\mdl{traldf\_iso})} 559 549 \label{TRA_ldf_iso} 560 550 The general form of the second order lateral tracer subgrid scale physics … … 584 574 ($z$- or $s$-surfaces) and the surface along which the diffusion operator 585 575 acts ($i.e.$ horizontal or iso-neutral surfaces). It is thus used when, 586 in addition to \np{ln _traldf_lap}= true, we have \forcode{ln_traldf_iso= .true.},587 or both \ forcode{ln_traldf_hor = .true.} and \forcode{ln_zco= .true.}. The way these576 in addition to \np{ln\_traldf\_lap}\forcode{ = .true.}, we have \np{ln\_traldf\_iso}\forcode{ = .true.}, 577 or both \np{ln\_traldf\_hor}\forcode{ = .true.} and \np{ln\_zco}\forcode{ = .true.}. The way these 588 578 slopes are evaluated is given in \S\ref{LDF_slp}. At the surface, bottom 589 579 and lateral boundaries, the turbulent fluxes of heat and salt are set to zero … … 603 593 background horizontal diffusion \citep{Guilyardi_al_CD01}. 604 594 605 Note that in the partial step $z$-coordinate (\ forcode{ln_zps= .true.}), the horizontal derivatives595 Note that in the partial step $z$-coordinate (\np{ln\_zps}\forcode{ = .true.}), the horizontal derivatives 606 596 at the bottom level in \eqref{Eq_tra_ldf_iso} require a specific treatment. 607 597 They are calculated in module zpshde, described in \S\ref{TRA_zpshde}. … … 609 599 %&& Triad rotated (bi-)laplacian operator 610 600 %&& ------------------------------------------- 611 \subsubsection [Triad rotated (bi-)laplacian operator (\protect\np{ln_traldf_triad})] 612 {Triad rotated (bi-)laplacian operator (\protect\np{ln_traldf_triad})} 601 \subsubsection{Triad rotated (bi-)laplacian operator (\protect\np{ln\_traldf\_triad})} 613 602 \label{TRA_ldf_triad} 614 603 615 If the Griffies triad scheme is employed (\ forcode{ln_traldf_triad= .true.} ; see App.\ref{sec:triad})604 If the Griffies triad scheme is employed (\np{ln\_traldf\_triad}\forcode{ = .true.} ; see App.\ref{sec:triad}) 616 605 617 606 An alternative scheme developed by \cite{Griffies_al_JPO98} which ensures tracer variance decreases 618 is also available in \NEMO (\ forcode{ln_traldf_grif= .true.}). A complete description of607 is also available in \NEMO (\np{ln\_traldf\_grif}\forcode{ = .true.}). A complete description of 619 608 the algorithm is given in App.\ref{sec:triad}. 620 609 … … 631 620 %&& Option for the rotated operators 632 621 %&& ---------------------------------------------- 633 \subsubsection [Option for the rotated operators] 634 {Option for the rotated operators} 622 \subsubsection{Option for the rotated operators} 635 623 \label{TRA_ldf_options} 636 624 637 \np{ln _traldf_msc} = Method of Stabilizing Correction (both operators)638 639 \np{rn _slpmax} = slope limit (both operators)640 641 \np{ln _triad_iso} = pure horizontal mixing in ML (triad only)642 643 \np{rn _sw_triad} =1 switching triad ; =0 all 4 triads used (triad only)644 645 \np{ln _botmix_triad} = lateral mixing on bottom (triad only)625 \np{ln\_traldf\_msc} = Method of Stabilizing Correction (both operators) 626 627 \np{rn\_slpmax} = slope limit (both operators) 628 629 \np{ln\_triad\_iso} = pure horizontal mixing in ML (triad only) 630 631 \np{rn\_sw\_triad} =1 switching triad ; =0 all 4 triads used (triad only) 632 633 \np{ln\_botmix\_triad} = lateral mixing on bottom (triad only) 646 634 647 635 % ================================================================ 648 636 % Tracer Vertical Diffusion 649 637 % ================================================================ 650 \section [Tracer Vertical Diffusion (\textit{trazdf})] 651 {Tracer Vertical Diffusion (\protect\mdl{trazdf})} 638 \section{Tracer vertical diffusion (\protect\mdl{trazdf})} 652 639 \label{TRA_zdf} 653 640 %--------------------------------------------namzdf--------------------------------------------------------- … … 685 672 The large eddy coefficient found in the mixed layer together with high 686 673 vertical resolution implies that in the case of explicit time stepping 687 (\ forcode{ln_zdfexp= .true.}) there would be too restrictive a constraint on674 (\np{ln\_zdfexp}\forcode{ = .true.}) there would be too restrictive a constraint on 688 675 the time step. Therefore, the default implicit time stepping is preferred 689 676 for the vertical diffusion since it overcomes the stability constraint. 690 A forward time differencing scheme (\ forcode{ln_zdfexp= .true.}) using a time691 splitting technique (\np{nn _zdfexp} $> 1$) is provided as an alternative.692 Namelist variables \np{ln _zdfexp} and \np{nn_zdfexp} apply to both677 A forward time differencing scheme (\np{ln\_zdfexp}\forcode{ = .true.}) using a time 678 splitting technique (\np{nn\_zdfexp} $> 1$) is provided as an alternative. 679 Namelist variables \np{ln\_zdfexp} and \np{nn\_zdfexp} apply to both 693 680 tracers and dynamics. 694 681 … … 696 683 % External Forcing 697 684 % ================================================================ 698 \section{External Forcing}685 \section{External forcing} 699 686 \label{TRA_sbc_qsr_bbc} 700 687 … … 702 689 % surface boundary condition 703 690 % ------------------------------------------------------------------------------------------------------------- 704 \subsection [Surface boundary condition (\textit{trasbc})] 705 {Surface boundary condition (\protect\mdl{trasbc})} 691 \subsection{Surface boundary condition (\protect\mdl{trasbc})} 706 692 \label{TRA_sbc} 707 693 … … 750 736 divergence of odd and even time step (see \S\ref{STP}). 751 737 752 In the linear free surface case (\np{ln _linssh}~=~\textit{true}),738 In the linear free surface case (\np{ln\_linssh}\forcode{ = .true.}), 753 739 an additional term has to be added on both temperature and salinity. 754 740 On temperature, this term remove the heat content associated with mass exchange … … 773 759 % Solar Radiation Penetration 774 760 % ------------------------------------------------------------------------------------------------------------- 775 \subsection [Solar Radiation Penetration (\textit{traqsr})] 776 {Solar Radiation Penetration (\protect\mdl{traqsr})} 761 \subsection{Solar radiation penetration (\protect\mdl{traqsr})} 777 762 \label{TRA_qsr} 778 763 %--------------------------------------------namqsr-------------------------------------------------------- … … 781 766 782 767 Options are defined through the \ngn{namtra\_qsr} namelist variables. 783 When the penetrative solar radiation option is used (\ forcode{ln_flxqsr= .true.}),768 When the penetrative solar radiation option is used (\np{ln\_flxqsr}\forcode{ = .true.}), 784 769 the solar radiation penetrates the top few tens of meters of the ocean. If it is not used 785 (\ forcode{ln_flxqsr= .false.}) all the heat flux is absorbed in the first ocean level.770 (\np{ln\_flxqsr}\forcode{ = .false.}) all the heat flux is absorbed in the first ocean level. 786 771 Thus, in the former case a term is added to the time evolution equation of 787 772 temperature \eqref{Eq_PE_tra_T} and the surface boundary condition is … … 805 790 wavelengths contribute to heating the upper few tens of centimetres. The fraction of $Q_{sr}$ 806 791 that resides in these almost non-penetrative wavebands, $R$, is $\sim 58\%$ (specified 807 through namelist parameter \np{rn _abs}). It is assumed to penetrate the ocean792 through namelist parameter \np{rn\_abs}). It is assumed to penetrate the ocean 808 793 with a decreasing exponential profile, with an e-folding depth scale, $\xi_0$, 809 of a few tens of centimetres (typically $\xi_0=0.35~m$ set as \np{rn _si0} in the namtra\_qsr namelist).794 of a few tens of centimetres (typically $\xi_0=0.35~m$ set as \np{rn\_si0} in the namtra\_qsr namelist). 810 795 For shorter wavelengths (400-700~nm), the ocean is more transparent, and solar energy 811 796 propagates to larger depths where it contributes to 812 797 local heating. 813 798 The way this second part of the solar energy penetrates into the ocean depends on 814 which formulation is chosen. In the simple 2-waveband light penetration scheme (\ forcode{ln_qsr_2bd= .true.})799 which formulation is chosen. In the simple 2-waveband light penetration scheme (\np{ln\_qsr\_2bd}\forcode{ = .true.}) 815 800 a chlorophyll-independent monochromatic formulation is chosen for the shorter wavelengths, 816 801 leading to the following expression \citep{Paulson1977}: … … 819 804 \end{equation} 820 805 where $\xi_1$ is the second extinction length scale associated with the shorter wavelengths. 821 It is usually chosen to be 23~m by setting the \np{rn _si0} namelist parameter.806 It is usually chosen to be 23~m by setting the \np{rn\_si0} namelist parameter. 822 807 The set of default values ($\xi_0$, $\xi_1$, $R$) corresponds to a Type I water in 823 808 Jerlov's (1968) classification (oligotrophic waters). … … 839 824 computational efficiency. The 2-bands formulation does not reproduce the full model very well. 840 825 841 The RGB formulation is used when \ forcode{ln_qsr_rgb= .true.}. The RGB attenuation coefficients826 The RGB formulation is used when \np{ln\_qsr\_rgb}\forcode{ = .true.}. The RGB attenuation coefficients 842 827 ($i.e.$ the inverses of the extinction length scales) are tabulated over 61 nonuniform 843 828 chlorophyll classes ranging from 0.01 to 10 g.Chl/L (see the routine \rou{trc\_oce\_rgb} 844 829 in \mdl{trc\_oce} module). Four types of chlorophyll can be chosen in the RGB formulation: 845 830 \begin{description} 846 \item[\ forcode{nn_chdta= 0}]831 \item[\np{nn\_chdta}\forcode{ = 0}] 847 832 a constant 0.05 g.Chl/L value everywhere ; 848 \item[\ forcode{nn_chdta= 1}]833 \item[\np{nn\_chdta}\forcode{ = 1}] 849 834 an observed time varying chlorophyll deduced from satellite surface ocean color measurement 850 835 spread uniformly in the vertical direction ; 851 \item[\ forcode{nn_chdta= 2}]836 \item[\np{nn\_chdta}\forcode{ = 2}] 852 837 same as previous case except that a vertical profile of chlorophyl is used. 853 838 Following \cite{Morel_Berthon_LO89}, the profile is computed from the local surface chlorophyll value ; 854 \item[\ forcode{ln_qsr_bio= .true.}]839 \item[\np{ln\_qsr\_bio}\forcode{ = .true.}] 855 840 simulated time varying chlorophyll by TOP biogeochemical model. 856 841 In this case, the RGB formulation is used to calculate both the phytoplankton … … 884 869 % Bottom Boundary Condition 885 870 % ------------------------------------------------------------------------------------------------------------- 886 \subsection [Bottom Boundary Condition (\textit{trabbc})] 887 {Bottom Boundary Condition (\protect\mdl{trabbc})} 871 \subsection{Bottom boundary condition (\protect\mdl{trabbc})} 888 872 \label{TRA_bbc} 889 873 %--------------------------------------------nambbc-------------------------------------------------------- … … 913 897 Options are defined through the \ngn{namtra\_bbc} namelist variables. 914 898 The presence of geothermal heating is controlled by setting the namelist 915 parameter \np{ln _trabbc} to true. Then, when \np{nn_geoflx} is set to 1,899 parameter \np{ln\_trabbc} to true. Then, when \np{nn\_geoflx} is set to 1, 916 900 a constant geothermal heating is introduced whose value is given by the 917 \np{nn _geoflx_cst}, which is also a namelist parameter.918 When \np{nn _geoflx} is set to 2, a spatially varying geothermal heat flux is901 \np{nn\_geoflx\_cst}, which is also a namelist parameter. 902 When \np{nn\_geoflx} is set to 2, a spatially varying geothermal heat flux is 919 903 introduced which is provided in the \ifile{geothermal\_heating} NetCDF file 920 904 (Fig.\ref{Fig_geothermal}) \citep{Emile-Geay_Madec_OS09}. … … 923 907 % Bottom Boundary Layer 924 908 % ================================================================ 925 \section [Bottom Boundary Layer (\protect\mdl{trabbl} - \protect\key{trabbl})] 926 {Bottom Boundary Layer (\protect\mdl{trabbl} - \protect\key{trabbl})} 909 \section{Bottom boundary layer (\protect\mdl{trabbl} - \protect\key{trabbl})} 927 910 \label{TRA_bbl} 928 911 %--------------------------------------------nambbl--------------------------------------------------------- … … 959 942 % Diffusive BBL 960 943 % ------------------------------------------------------------------------------------------------------------- 961 \subsection{Diffusive Bottom Boundary layer (\protect\forcode{nn_bbl_ldf= 1})}944 \subsection{Diffusive bottom boundary layer (\protect\np{nn\_bbl\_ldf}\forcode{ = 1})} 962 945 \label{TRA_bbl_diff} 963 946 964 When applying sigma-diffusion (\key{trabbl} defined and \np{nn _bbl_ldf} set to 1),947 When applying sigma-diffusion (\key{trabbl} defined and \np{nn\_bbl\_ldf} set to 1), 965 948 the diffusive flux between two adjacent cells at the ocean floor is given by 966 949 \begin{equation} \label{Eq_tra_bbl_diff} … … 978 961 \end{equation} 979 962 where $A_{bbl}$ is the BBL diffusivity coefficient, given by the namelist 980 parameter \np{rn _ahtbbl} and usually set to a value much larger963 parameter \np{rn\_ahtbbl} and usually set to a value much larger 981 964 than the one used for lateral mixing in the open ocean. The constraint in \eqref{Eq_tra_bbl_coef} 982 965 implies that sigma-like diffusion only occurs when the density above the sea floor, at the top of … … 994 977 % Advective BBL 995 978 % ------------------------------------------------------------------------------------------------------------- 996 \subsection {Advective Bottom Boundary Layer (\protect\np{nn_bbl_adv}= 1 or 2)}979 \subsection{Advective bottom boundary layer (\protect\np{nn\_bbl\_adv}\forcode{ = 1..2})} 997 980 \label{TRA_bbl_adv} 998 981 … … 1022 1005 %%%gmcomment : this section has to be really written 1023 1006 1024 When applying an advective BBL (\np{nn _bbl_adv} = 1 or 2), an overturning1007 When applying an advective BBL (\np{nn\_bbl\_adv}\forcode{ = 1..2}), an overturning 1025 1008 circulation is added which connects two adjacent bottom grid-points only if dense 1026 1009 water overlies less dense water on the slope. The density difference causes dense 1027 1010 water to move down the slope. 1028 1011 1029 \np{nn _bbl_adv} = 1: the downslope velocity is chosen to be the Eulerian1012 \np{nn\_bbl\_adv}\forcode{ = 1} : the downslope velocity is chosen to be the Eulerian 1030 1013 ocean velocity just above the topographic step (see black arrow in Fig.\ref{Fig_bbl}) 1031 1014 \citep{Beckmann_Doscher1997}. It is a \textit{conditional advection}, that is, advection … … 1034 1017 greater depth ($i.e.$ $\vect{U} \cdot \nabla H>0$). 1035 1018 1036 \np{nn _bbl_adv} = 2: the downslope velocity is chosen to be proportional to $\Delta \rho$,1019 \np{nn\_bbl\_adv}\forcode{ = 2} : the downslope velocity is chosen to be proportional to $\Delta \rho$, 1037 1020 the density difference between the higher cell and lower cell densities \citep{Campin_Goosse_Tel99}. 1038 1021 The advection is allowed only if dense water overlies less dense water on the slope ($i.e.$ … … 1044 1027 \end{equation} 1045 1028 where $\gamma$, expressed in seconds, is the coefficient of proportionality 1046 provided as \np{rn _gambbl}, a namelist parameter, and \textit{kup} and \textit{kdwn}1029 provided as \np{rn\_gambbl}, a namelist parameter, and \textit{kup} and \textit{kdwn} 1047 1030 are the vertical index of the higher and lower cells, respectively. 1048 1031 The parameter $\gamma$ should take a different value for each bathymetric … … 1083 1066 % Tracer damping 1084 1067 % ================================================================ 1085 \section [Tracer damping (\textit{tradmp})] 1086 {Tracer damping (\protect\mdl{tradmp})} 1068 \section{Tracer damping (\protect\mdl{tradmp})} 1087 1069 \label{TRA_dmp} 1088 1070 %--------------------------------------------namtra_dmp------------------------------------------------- … … 1101 1083 are given temperature and salinity fields (usually a climatology). 1102 1084 Options are defined through the \ngn{namtra\_dmp} namelist variables. 1103 The restoring term is added when the namelist parameter \np{ln _tradmp} is set to true.1104 It also requires that both \np{ln _tsd_init} and \np{ln_tsd_tradmp} are set to true1105 in \textit{namtsd} namelist as well as \np{sn _tem} and \np{sn_sal} structures are1085 The restoring term is added when the namelist parameter \np{ln\_tradmp} is set to true. 1086 It also requires that both \np{ln\_tsd\_init} and \np{ln\_tsd\_tradmp} are set to true 1087 in \textit{namtsd} namelist as well as \np{sn\_tem} and \np{sn\_sal} structures are 1106 1088 correctly set ($i.e.$ that $T_o$ and $S_o$ are provided in input files and read 1107 1089 using \mdl{fldread}, see \S\ref{SBC_fldread}). 1108 The restoring coefficient $\gamma$ is a three-dimensional array read in during the \rou{tra\_dmp\_init} routine. The file name is specified by the namelist variable \np{cn _resto}. The DMP\_TOOLS tool is provided to allow users to generate the netcdf file.1090 The restoring coefficient $\gamma$ is a three-dimensional array read in during the \rou{tra\_dmp\_init} routine. The file name is specified by the namelist variable \np{cn\_resto}. The DMP\_TOOLS tool is provided to allow users to generate the netcdf file. 1109 1091 1110 1092 The two main cases in which \eqref{Eq_tra_dmp} is used are \textit{(a)} … … 1128 1110 by stabilising the water column too much. 1129 1111 1130 The namelist parameter \np{nn _zdmp} sets whether the damping should be applied in the whole water column or only below the mixed layer (defined either on a density or $S_o$ criterion). It is common to set the damping to zero in the mixed layer as the adjustment time scale is short here \citep{Madec_al_JPO96}.1131 1132 \subsection [DMP\_TOOLS]{Generating \ifile{resto} using DMP\_TOOLS}1112 The namelist parameter \np{nn\_zdmp} sets whether the damping should be applied in the whole water column or only below the mixed layer (defined either on a density or $S_o$ criterion). It is common to set the damping to zero in the mixed layer as the adjustment time scale is short here \citep{Madec_al_JPO96}. 1113 1114 \subsection{Generating \ifile{resto} using DMP\_TOOLS} 1133 1115 1134 1116 DMP\_TOOLS can be used to generate a netcdf file containing the restoration coefficient $\gamma$. 1135 1117 Note that in order to maintain bit comparison with previous NEMO versions DMP\_TOOLS must be compiled 1136 1118 and run on the same machine as the NEMO model. A \ifile{mesh\_mask} file for the model configuration is required as an input. 1137 This can be generated by carrying out a short model run with the namelist parameter \np{nn _msh} set to 1.1138 The namelist parameter \np{ln _tradmp} will also need to be set to .false. for this to work.1119 This can be generated by carrying out a short model run with the namelist parameter \np{nn\_msh} set to 1. 1120 The namelist parameter \np{ln\_tradmp} will also need to be set to .false. for this to work. 1139 1121 The \nl{nam\_dmp\_create} namelist in the DMP\_TOOLS directory is used to specify options for the restoration coefficient. 1140 1122 … … 1143 1125 %------------------------------------------------------------------------------------------------------- 1144 1126 1145 \np{cp _cfg}, \np{cp_cpz}, \np{jp_cfg} and \np{jperio} specify the model configuration being used and should be the same as specified in \nl{namcfg}. The variable \nl{lzoom} is used to specify that the damping is being used as in case \textit{a} above to provide boundary conditions to a zoom configuration. In the case of the arctic or antarctic zoom configurations this includes some specific treatment. Otherwise damping is applied to the 6 grid points along the ocean boundaries. The open boundaries are specified by the variables \np{lzoom_n}, \np{lzoom_e}, \np{lzoom_s}, \np{lzoom_w} in the \nl{nam\_zoom\_dmp} name list.1127 \np{cp\_cfg}, \np{cp\_cpz}, \np{jp\_cfg} and \np{jperio} specify the model configuration being used and should be the same as specified in \nl{namcfg}. The variable \nl{lzoom} is used to specify that the damping is being used as in case \textit{a} above to provide boundary conditions to a zoom configuration. In the case of the arctic or antarctic zoom configurations this includes some specific treatment. Otherwise damping is applied to the 6 grid points along the ocean boundaries. The open boundaries are specified by the variables \np{lzoom\_n}, \np{lzoom\_e}, \np{lzoom\_s}, \np{lzoom\_w} in the \nl{nam\_zoom\_dmp} name list. 1146 1128 1147 1129 The remaining switch namelist variables determine the spatial variation of the restoration coefficient in non-zoom configurations. 1148 \np{ln _full_field} specifies that newtonian damping should be applied to the whole model domain.1149 \np{ln _med_red_seas} specifies grid specific restoration coefficients in the Mediterranean Sea1130 \np{ln\_full\_field} specifies that newtonian damping should be applied to the whole model domain. 1131 \np{ln\_med\_red\_seas} specifies grid specific restoration coefficients in the Mediterranean Sea 1150 1132 for the ORCA4, ORCA2 and ORCA05 configurations. 1151 If \np{ln _old_31_lev_code} is set then the depth variation of the coeffients will be specified as1133 If \np{ln\_old\_31\_lev\_code} is set then the depth variation of the coeffients will be specified as 1152 1134 a function of the model number. This option is included to allow backwards compatability of the ORCA2 reference 1153 1135 configurations with previous model versions. 1154 \np{ln _coast} specifies that the restoration coefficient should be reduced near to coastlines.1155 This option only has an effect if \np{ln _full_field} is true.1156 \np{ln _zero_top_layer} specifies that the restoration coefficient should be zero in the surface layer.1157 Finally \np{ln _custom} specifies that the custom module will be called.1136 \np{ln\_coast} specifies that the restoration coefficient should be reduced near to coastlines. 1137 This option only has an effect if \np{ln\_full\_field} is true. 1138 \np{ln\_zero\_top\_layer} specifies that the restoration coefficient should be zero in the surface layer. 1139 Finally \np{ln\_custom} specifies that the custom module will be called. 1158 1140 This module is contained in the file custom.F90 and can be edited by users. For example damping could be applied in a specific region. 1159 1141 1160 The restoration coefficient can be set to zero in equatorial regions by specifying a positive value of \np{nn _hdmp}.1142 The restoration coefficient can be set to zero in equatorial regions by specifying a positive value of \np{nn\_hdmp}. 1161 1143 Equatorward of this latitude the restoration coefficient will be zero with a smooth transition to 1162 1144 the full values of a 10\deg latitud band. 1163 1145 This is often used because of the short adjustment time scale in the equatorial region 1164 1146 \citep{Reverdin1991, Fujio1991, Marti_PhD92}. The time scale associated with the damping depends on the depth as a 1165 hyperbolic tangent, with \np{rn _surf} as surface value, \np{rn_bot} as bottom value and a transition depth of \np{rn_dep}.1147 hyperbolic tangent, with \np{rn\_surf} as surface value, \np{rn\_bot} as bottom value and a transition depth of \np{rn\_dep}. 1166 1148 1167 1149 % ================================================================ 1168 1150 % Tracer time evolution 1169 1151 % ================================================================ 1170 \section [Tracer time evolution (\textit{tranxt})] 1171 {Tracer time evolution (\protect\mdl{tranxt})} 1152 \section{Tracer time evolution (\protect\mdl{tranxt})} 1172 1153 \label{TRA_nxt} 1173 1154 %--------------------------------------------namdom----------------------------------------------------- … … 1191 1172 the subscript $f$ denotes filtered values, $\gamma$ is the Asselin coefficient, 1192 1173 and $S$ is the total forcing applied on $T$ ($i.e.$ fluxes plus content in mass exchanges). 1193 $\gamma$ is initialized as \np{rn _atfp} (\textbf{namelist} parameter).1194 Its default value is \np{rn _atfp}=$10^{-3}$. Note that the forcing correction term in the filter1195 is not applied in linear free surface (\jp{lk\_vvl} =false) (see \S\ref{TRA_sbc}.1174 $\gamma$ is initialized as \np{rn\_atfp} (\textbf{namelist} parameter). 1175 Its default value is \np{rn\_atfp}\forcode{ = 10.e-3}. Note that the forcing correction term in the filter 1176 is not applied in linear free surface (\jp{lk\_vvl}\forcode{ = .false.}) (see \S\ref{TRA_sbc}. 1196 1177 Not also that in constant volume case, the time stepping is performed on $T$, 1197 1178 not on its content, $e_{3t}T$. … … 1207 1188 % Equation of State (eosbn2) 1208 1189 % ================================================================ 1209 \section [Equation of State (\textit{eosbn2}) ] 1210 {Equation of State (\protect\mdl{eosbn2}) } 1190 \section{Equation of state (\protect\mdl{eosbn2}) } 1211 1191 \label{TRA_eosbn2} 1212 1192 %--------------------------------------------nameos----------------------------------------------------- … … 1217 1197 % Equation of State 1218 1198 % ------------------------------------------------------------------------------------------------------------- 1219 \subsection{Equation Of Seawater (\protect\np{nn_eos} = -1, 0, or 1)}1199 \subsection{Equation of seawater (\protect\np{nn\_eos}\forcode{ = -1..1})} 1220 1200 \label{TRA_eos} 1221 1201 … … 1248 1228 density in the World Ocean varies by no more than 2$\%$ from that value \citep{Gill1982}. 1249 1229 1250 Options are defined through the \ngn{nameos} namelist variables, and in particular \np{nn _eos}1251 which controls the EOS used ( =-1 for TEOS10 ; =0 for EOS-80 ; =1for S-EOS).1230 Options are defined through the \ngn{nameos} namelist variables, and in particular \np{nn\_eos} 1231 which controls the EOS used (\forcode{= -1} for TEOS10 ; \forcode{= 0} for EOS-80 ; \forcode{= 1} for S-EOS). 1252 1232 \begin{description} 1253 1233 1254 \item[\np{nn _eos}$=-1$] the polyTEOS10-bsq equation of seawater \citep{Roquet_OM2015} is used.1234 \item[\np{nn\_eos}\forcode{ = -1}] the polyTEOS10-bsq equation of seawater \citep{Roquet_OM2015} is used. 1255 1235 The accuracy of this approximation is comparable to the TEOS-10 rational function approximation, 1256 1236 but it is optimized for a boussinesq fluid and the polynomial expressions have simpler … … 1268 1248 $\Theta$ and $S_A$. In particular, the initial state deined by the user have to be given as 1269 1249 \textit{Conservative} Temperature and \textit{Absolute} Salinity. 1270 In addition, setting \np{ln _useCT} to \textit{true} convert the Conservative SST to potential SST1250 In addition, setting \np{ln\_useCT} to \forcode{.true.} convert the Conservative SST to potential SST 1271 1251 prior to either computing the air-sea and ice-sea fluxes (forced mode) 1272 1252 or sending the SST field to the atmosphere (coupled mode). 1273 1253 1274 \item[\np{nn _eos}$=0$] the polyEOS80-bsq equation of seawater is used.1254 \item[\np{nn\_eos}\forcode{ = 0}] the polyEOS80-bsq equation of seawater is used. 1275 1255 It takes the same polynomial form as the polyTEOS10, but the coefficients have been optimized 1276 1256 to accurately fit EOS80 (Roquet, personal comm.). The state variables used in both the EOS80 … … 1283 1263 value, the TEOS10 value. 1284 1264 1285 \item[\np{nn _eos}$=1$] a simplified EOS (S-EOS) inspired by \citet{Vallis06} is chosen,1265 \item[\np{nn\_eos}\forcode{ = 1}] a simplified EOS (S-EOS) inspired by \citet{Vallis06} is chosen, 1286 1266 the coefficients of which has been optimized to fit the behavior of TEOS10 (Roquet, personal comm.) 1287 1267 (see also \citet{Roquet_JPO2015}). It provides a simplistic linear representation of both … … 1315 1295 \hline 1316 1296 coeff. & computer name & S-EOS & description \\ \hline 1317 $a_0$ & \np{rn _a0} & 1.6550 $10^{-1}$ & linear thermal expansion coeff. \\ \hline1318 $b_0$ & \np{rn _b0} & 7.6554 $10^{-1}$ & linear haline expansion coeff. \\ \hline1319 $\lambda_1$ & \np{rn _lambda1}& 5.9520 $10^{-2}$ & cabbeling coeff. in $T^2$ \\ \hline1320 $\lambda_2$ & \np{rn _lambda2}& 5.4914 $10^{-4}$ & cabbeling coeff. in $S^2$ \\ \hline1321 $\nu$ & \np{rn _nu} & 2.4341 $10^{-3}$ & cabbeling coeff. in $T \, S$ \\ \hline1322 $\mu_1$ & \np{rn _mu1} & 1.4970 $10^{-4}$ & thermobaric coeff. in T \\ \hline1323 $\mu_2$ & \np{rn _mu2} & 1.1090 $10^{-5}$ & thermobaric coeff. in S \\ \hline1297 $a_0$ & \np{rn\_a0} & 1.6550 $10^{-1}$ & linear thermal expansion coeff. \\ \hline 1298 $b_0$ & \np{rn\_b0} & 7.6554 $10^{-1}$ & linear haline expansion coeff. \\ \hline 1299 $\lambda_1$ & \np{rn\_lambda1}& 5.9520 $10^{-2}$ & cabbeling coeff. in $T^2$ \\ \hline 1300 $\lambda_2$ & \np{rn\_lambda2}& 5.4914 $10^{-4}$ & cabbeling coeff. in $S^2$ \\ \hline 1301 $\nu$ & \np{rn\_nu} & 2.4341 $10^{-3}$ & cabbeling coeff. in $T \, S$ \\ \hline 1302 $\mu_1$ & \np{rn\_mu1} & 1.4970 $10^{-4}$ & thermobaric coeff. in T \\ \hline 1303 $\mu_2$ & \np{rn\_mu2} & 1.1090 $10^{-5}$ & thermobaric coeff. in S \\ \hline 1324 1304 \end{tabular} 1325 1305 \caption{ \protect\label{Tab_SEOS} … … 1333 1313 % Brunt-V\"{a}is\"{a}l\"{a} Frequency 1334 1314 % ------------------------------------------------------------------------------------------------------------- 1335 \subsection{Brunt-V\"{a}is\"{a}l\"{a} Frequency (\protect\np{nn_eos} = 0, 1 or 2)}1315 \subsection{Brunt-V\"{a}is\"{a}l\"{a} frequency (\protect\np{nn\_eos}\forcode{ = 0..2})} 1336 1316 \label{TRA_bn2} 1337 1317 … … 1355 1335 % Freezing Point of Seawater 1356 1336 % ------------------------------------------------------------------------------------------------------------- 1357 \subsection [Freezing Point of Seawater] 1358 {Freezing Point of Seawater} 1337 \subsection{Freezing point of seawater} 1359 1338 \label{TRA_fzp} 1360 1339 … … 1388 1367 % Horizontal Derivative in zps-coordinate 1389 1368 % ================================================================ 1390 \section [Horizontal Derivative in \textit{zps}-coordinate (\textit{zpshde})] 1391 {Horizontal Derivative in \textit{zps}-coordinate (\protect\mdl{zpshde})} 1369 \section{Horizontal derivative in \textit{zps}-coordinate (\protect\mdl{zpshde})} 1392 1370 \label{TRA_zpshde} 1393 1371 … … 1395 1373 I've changed "derivative" to "difference" and "mean" to "average"} 1396 1374 1397 With partial cells (\ forcode{ln_zps = .true.}) at bottom and top (\forcode{ln_isfcav= .true.}), in general,1375 With partial cells (\np{ln\_zps}\forcode{ = .true.}) at bottom and top (\np{ln\_isfcav}\forcode{ = .true.}), in general, 1398 1376 tracers in horizontally adjacent cells live at different depths. 1399 1377 Horizontal gradients of tracers are needed for horizontal diffusion (\mdl{traldf} module) 1400 1378 and the hydrostatic pressure gradient calculations (\mdl{dynhpg} module). 1401 The partial cell properties at the top (\ forcode{ln_isfcav= .true.}) are computed in the same way as for the bottom.1379 The partial cell properties at the top (\np{ln\_isfcav}\forcode{ = .true.}) are computed in the same way as for the bottom. 1402 1380 So, only the bottom interpolation is explained below. 1403 1381 … … 1413 1391 \caption{ \protect\label{Fig_Partial_step_scheme} 1414 1392 Discretisation of the horizontal difference and average of tracers in the $z$-partial 1415 step coordinate (\ protect\forcode{ln_zps= .true.}) in the case $( e3w_k^{i+1} - e3w_k^i )>0$.1393 step coordinate (\np{ln\_zps}\forcode{ = .true.}) in the case $( e3w_k^{i+1} - e3w_k^i )>0$. 1416 1394 A linear interpolation is used to estimate $\widetilde{T}_k^{i+1}$, the tracer value 1417 1395 at the depth of the shallower tracer point of the two adjacent bottom $T$-points. -
branches/2017/dev_merge_2017/DOC/tex_sub/chap_ZDF.tex
r9392 r9393 18 18 % Vertical Mixing 19 19 % ================================================================ 20 \section{Vertical Mixing}20 \section{Vertical mixing} 21 21 \label{ZDF_zdf} 22 22 … … 42 42 general trend in the \mdl{dynzdf} and \mdl{trazdf} modules, respectively. 43 43 These trends can be computed using either a forward time stepping scheme 44 (namelist parameter \ forcode{ln_zdfexp= .true.}) or a backward time stepping45 scheme (\ forcode{ln_zdfexp= .false.}) depending on the magnitude of the mixing44 (namelist parameter \np{ln\_zdfexp}\forcode{ = .true.}) or a backward time stepping 45 scheme (\np{ln\_zdfexp}\forcode{ = .false.}) depending on the magnitude of the mixing 46 46 coefficients, and thus of the formulation used (see \S\ref{STP}). 47 47 … … 65 65 \end{align*} 66 66 67 These values are set through the \np{rn _avm0} and \np{rn_avt0} namelist parameters.67 These values are set through the \np{rn\_avm0} and \np{rn\_avt0} namelist parameters. 68 68 In all cases, do not use values smaller that those associated with the molecular 69 69 viscosity and diffusivity, that is $\sim10^{-6}~m^2.s^{-1}$ for momentum, … … 74 74 % Richardson Number Dependent 75 75 % ------------------------------------------------------------------------------------------------------------- 76 \subsection{Richardson Number Dependent (\protect\key{zdfric})}76 \subsection{Richardson number dependent (\protect\key{zdfric})} 77 77 \label{ZDF_ric} 78 78 … … 103 103 is the maximum value that can be reached by the coefficient when $Ri\leq 0$, 104 104 $a=5$ and $n=2$. The last three values can be modified by setting the 105 \np{rn _avmri}, \np{rn_alp} and \np{nn_ric} namelist parameters, respectively.105 \np{rn\_avmri}, \np{rn\_alp} and \np{nn\_ric} namelist parameters, respectively. 106 106 107 107 A simple mixing-layer model to transfer and dissipate the atmospheric 108 108 forcings (wind-stress and buoyancy fluxes) can be activated setting 109 the \np{ln _mldw} =.true.in the namelist.109 the \np{ln\_mldw}\forcode{ = .true.} in the namelist. 110 110 111 111 In this case, the local depth of turbulent wind-mixing or "Ekman depth" … … 125 125 126 126 is computed from the wind stress vector $|\tau|$ and the reference density $ \rho_o$. 127 The final $h_{e}$ is further constrained by the adjustable bounds \np{rn _mldmin} and \np{rn_mldmax}.127 The final $h_{e}$ is further constrained by the adjustable bounds \np{rn\_mldmin} and \np{rn\_mldmax}. 128 128 Once $h_{e}$ is computed, the vertical eddy coefficients within $h_{e}$ are set to 129 the empirical values \np{rn _wtmix} and \np{rn_wvmix} \citep{Lermusiaux2001}.129 the empirical values \np{rn\_wtmix} and \np{rn\_wvmix} \citep{Lermusiaux2001}. 130 130 131 131 % ------------------------------------------------------------------------------------------------------------- 132 132 % TKE Turbulent Closure Scheme 133 133 % ------------------------------------------------------------------------------------------------------------- 134 \subsection{TKE Turbulent Closure Scheme (\protect\key{zdftke})}134 \subsection{TKE turbulent closure scheme (\protect\key{zdftke})} 135 135 \label{ZDF_tke} 136 136 … … 170 170 and diffusivity coefficients. The constants $C_k = 0.1$ and $C_\epsilon = \sqrt {2} /2$ 171 171 $\approx 0.7$ are designed to deal with vertical mixing at any depth \citep{Gaspar1990}. 172 They are set through namelist parameters \np{nn _ediff} and \np{nn_ediss}.172 They are set through namelist parameters \np{nn\_ediff} and \np{nn\_ediss}. 173 173 $P_{rt}$ can be set to unity or, following \citet{Blanke1993}, be a function 174 174 of the local Richardson number, $R_i$: … … 181 181 \end{align*} 182 182 Options are defined through the \ngn{namzdfy\_tke} namelist variables. 183 The choice of $P_{rt}$ is controlled by the \np{nn _pdl} namelist variable.183 The choice of $P_{rt}$ is controlled by the \np{nn\_pdl} namelist variable. 184 184 185 185 At the sea surface, the value of $\bar{e}$ is prescribed from the wind 186 stress field as $\bar{e}_o = e_{bb} |\tau| / \rho_o$, with $e_{bb}$ the \np{rn _ebb}186 stress field as $\bar{e}_o = e_{bb} |\tau| / \rho_o$, with $e_{bb}$ the \np{rn\_ebb} 187 187 namelist parameter. The default value of $e_{bb}$ is 3.75. \citep{Gaspar1990}), 188 188 however a much larger value can be used when taking into account the … … 191 191 The time integration of the $\bar{e}$ equation may formally lead to negative values 192 192 because the numerical scheme does not ensure its positivity. To overcome this 193 problem, a cut-off in the minimum value of $\bar{e}$ is used (\np{rn _emin}193 problem, a cut-off in the minimum value of $\bar{e}$ is used (\np{rn\_emin} 194 194 namelist parameter). Following \citet{Gaspar1990}, the cut-off value is set 195 195 to $\sqrt{2}/2~10^{-6}~m^2.s^{-2}$. This allows the subsequent formulations … … 199 199 instabilities associated with too weak vertical diffusion. They must be 200 200 specified at least larger than the molecular values, and are set through 201 \np{rn _avm0} and \np{rn_avt0} (namzdf namelist, see \S\ref{ZDF_cst}).201 \np{rn\_avm0} and \np{rn\_avt0} (namzdf namelist, see \S\ref{ZDF_cst}). 202 202 203 203 \subsubsection{Turbulent length scale} 204 204 For computational efficiency, the original formulation of the turbulent length 205 205 scales proposed by \citet{Gaspar1990} has been simplified. Four formulations 206 are proposed, the choice of which is controlled by the \np{nn _mxl} namelist206 are proposed, the choice of which is controlled by the \np{nn\_mxl} namelist 207 207 parameter. The first two are based on the following first order approximation 208 208 \citep{Blanke1993}: … … 212 212 which is valid in a stable stratified region with constant values of the Brunt- 213 213 Vais\"{a}l\"{a} frequency. The resulting length scale is bounded by the distance 214 to the surface or to the bottom (\np{nn _mxl} = 0) or by the local vertical scale factor215 (\np{nn _mxl} = 1). \citet{Blanke1993} notice that this simplification has two major214 to the surface or to the bottom (\np{nn\_mxl}\forcode{ = 0}) or by the local vertical scale factor 215 (\np{nn\_mxl}\forcode{ = 1}). \citet{Blanke1993} notice that this simplification has two major 216 216 drawbacks: it makes no sense for locally unstable stratification and the 217 217 computation no longer uses all the information contained in the vertical density 218 218 profile. To overcome these drawbacks, \citet{Madec1998} introduces the 219 \np{nn _mxl} = 2 or 3cases, which add an extra assumption concerning the vertical219 \np{nn\_mxl}\forcode{ = 2..3} cases, which add an extra assumption concerning the vertical 220 220 gradient of the computed length scale. So, the length scales are first evaluated 221 221 as in \eqref{Eq_tke_mxl0_1} and then bounded such that: … … 253 253 $i.e.$ $l^{(k)} = \sqrt {2 {\bar e}^{(k)} / {N^2}^{(k)} }$. 254 254 255 In the \np{nn _mxl}~=~2case, the dissipation and mixing length scales take the same255 In the \np{nn\_mxl}\forcode{ = 2} case, the dissipation and mixing length scales take the same 256 256 value: $ l_k= l_\epsilon = \min \left(\ l_{up} \;,\; l_{dwn}\ \right)$, while in the 257 \np{nn _mxl}~=~3case, the dissipation and mixing turbulent length scales are give257 \np{nn\_mxl}\forcode{ = 3} case, the dissipation and mixing turbulent length scales are give 258 258 as in \citet{Gaspar1990}: 259 259 \begin{equation} \label{Eq_tke_mxl_gaspar} … … 264 264 \end{equation} 265 265 266 At the ocean surface, a non zero length scale is set through the \np{rn _mxl0} namelist266 At the ocean surface, a non zero length scale is set through the \np{rn\_mxl0} namelist 267 267 parameter. Usually the surface scale is given by $l_o = \kappa \,z_o$ 268 268 where $\kappa = 0.4$ is von Karman's constant and $z_o$ the roughness 269 269 parameter of the surface. Assuming $z_o=0.1$~m \citep{Craig_Banner_JPO94} 270 leads to a 0.04~m, the default value of \np{rn _mxl0}. In the ocean interior270 leads to a 0.04~m, the default value of \np{rn\_mxl0}. In the ocean interior 271 271 a minimum length scale is set to recover the molecular viscosity when $\bar{e}$ 272 272 reach its minimum value ($1.10^{-6}= C_k\, l_{min} \,\sqrt{\bar{e}_{min}}$ ). … … 296 296 citing observation evidence, and $\alpha_{CB} = 100$ the Craig and Banner's value. 297 297 As the surface boundary condition on TKE is prescribed through $\bar{e}_o = e_{bb} |\tau| / \rho_o$, 298 with $e_{bb}$ the \np{rn _ebb} namelist parameter, setting \np{rn_ebb}~=~67.83corresponds299 to $\alpha_{CB} = 100$. Further setting \np{ln _mxl0} to true applies \eqref{ZDF_Lsbc}298 with $e_{bb}$ the \np{rn\_ebb} namelist parameter, setting \np{rn\_ebb}\forcode{ = 67.83} corresponds 299 to $\alpha_{CB} = 100$. Further setting \np{ln\_mxl0} to true applies \eqref{ZDF_Lsbc} 300 300 as surface boundary condition on length scale, with $\beta$ hard coded to the Stacey's value. 301 Note that a minimal threshold of \np{rn _emin0}$=10^{-4}~m^2.s^{-2}$ (namelist parameters)301 Note that a minimal threshold of \np{rn\_emin0}$=10^{-4}~m^2.s^{-2}$ (namelist parameters) 302 302 is applied on surface $\bar{e}$ value. 303 303 … … 317 317 of LC in an extra source terms of TKE, $P_{LC}$. 318 318 The presence of $P_{LC}$ in \eqref{Eq_zdftke_e}, the TKE equation, is controlled 319 by setting \np{ln _lc} to \textit{true} in the namtke namelist.319 by setting \np{ln\_lc} to \forcode{.true.} in the namtke namelist. 320 320 321 321 By making an analogy with the characteristic convective velocity scale … … 343 343 where $c_{LC} = 0.15$ has been chosen by \citep{Axell_JGR02} as a good compromise 344 344 to fit LES data. The chosen value yields maximum vertical velocities $w_{LC}$ of the order 345 of a few centimeters per second. The value of $c_{LC}$ is set through the \np{rn _lc}345 of a few centimeters per second. The value of $c_{LC}$ is set through the \np{rn\_lc} 346 346 namelist parameter, having in mind that it should stay between 0.15 and 0.54 \citep{Axell_JGR02}. 347 347 … … 366 366 ($i.e.$ near-inertial oscillations and ocean swells and waves). 367 367 368 When using this parameterization ($i.e.$ when \np{nn _etau}~=~1), the TKE input to the ocean ($S$)368 When using this parameterization ($i.e.$ when \np{nn\_etau}\forcode{ = 1}), the TKE input to the ocean ($S$) 369 369 imposed by the winds in the form of near-inertial oscillations, swell and waves is parameterized 370 370 by \eqref{ZDF_Esbc} the standard TKE surface boundary condition, plus a depth depend one given by: … … 379 379 and $f_i$ is the ice concentration (no penetration if $f_i=1$, that is if the ocean is entirely 380 380 covered by sea-ice). 381 The value of $f_r$, usually a few percents, is specified through \np{rn _efr} namelist parameter.382 The vertical mixing length scale, $h_\tau$, can be set as a 10~m uniform value (\np{nn _etau}~=~0)381 The value of $f_r$, usually a few percents, is specified through \np{rn\_efr} namelist parameter. 382 The vertical mixing length scale, $h_\tau$, can be set as a 10~m uniform value (\np{nn\_etau}\forcode{ = 0}) 383 383 or a latitude dependent value (varying from 0.5~m at the Equator to a maximum value of 30~m 384 at high latitudes (\np{nn _etau}~=~1).385 386 Note that two other option existe, \np{nn _etau}~=~2, or 3. They correspond to applying384 at high latitudes (\np{nn\_etau}\forcode{ = 1}). 385 386 Note that two other option existe, \np{nn\_etau}\forcode{ = 2..3}. They correspond to applying 387 387 \eqref{ZDF_Ehtau} only at the base of the mixed layer, or to using the high frequency part 388 388 of the stress to evaluate the fraction of TKE that penetrate the ocean. … … 508 508 % GLS Generic Length Scale Scheme 509 509 % ------------------------------------------------------------------------------------------------------------- 510 \subsection{GLS Generic Length Scale (\protect\key{zdfgls})}510 \subsection{GLS: Generic Length Scale (\protect\key{zdfgls})} 511 511 \label{ZDF_gls} 512 512 … … 558 558 The constants $C_1$, $C_2$, $C_3$, ${\sigma_e}$, ${\sigma_{\psi}}$ and the wall function ($Fw$) 559 559 depends of the choice of the turbulence model. Four different turbulent models are pre-defined 560 (Tab.\ref{Tab_GLS}). They are made available through the \np{nn _clo} namelist parameter.560 (Tab.\ref{Tab_GLS}). They are made available through the \np{nn\_clo} namelist parameter. 561 561 562 562 %--------------------------------------------------TABLE-------------------------------------------------- … … 567 567 % & \citep{Mellor_Yamada_1982} & \citep{Rodi_1987} & \citep{Wilcox_1988} & \\ 568 568 \hline \hline 569 \np{nn _clo} & \textbf{0} & \textbf{1} & \textbf{2} & \textbf{3} \\569 \np{nn\_clo} & \textbf{0} & \textbf{1} & \textbf{2} & \textbf{3} \\ 570 570 \hline 571 571 $( p , n , m )$ & ( 0 , 1 , 1 ) & ( 3 , 1.5 , -1 ) & ( -1 , 0.5 , -1 ) & ( 2 , 1 , -0.67 ) \\ … … 581 581 \caption{ \protect\label{Tab_GLS} 582 582 Set of predefined GLS parameters, or equivalently predefined turbulence models available 583 with \protect\key{zdfgls} and controlled by the \protect\np{nn _clos} namelist variable in \protect\ngn{namzdf\_gls} .}583 with \protect\key{zdfgls} and controlled by the \protect\np{nn\_clos} namelist variable in \protect\ngn{namzdf\_gls} .} 584 584 \end{center} \end{table} 585 585 %-------------------------------------------------------------------------------------------------------------- … … 589 589 value near physical boundaries (logarithmic boundary layer law). $C_{\mu}$ and $C_{\mu'}$ 590 590 are calculated from stability function proposed by \citet{Galperin_al_JAS88}, or by \citet{Kantha_Clayson_1994} 591 or one of the two functions suggested by \citet{Canuto_2001} (\np{nn _stab_func} = 0, 1, 2 or 3, resp.).591 or one of the two functions suggested by \citet{Canuto_2001} (\np{nn\_stab\_func}\forcode{ = 0..3}, resp.). 592 592 The value of $C_{0\mu}$ depends of the choice of the stability function. 593 593 594 594 The surface and bottom boundary condition on both $\bar{e}$ and $\psi$ can be calculated 595 thanks to Dirichlet or Neumann condition through \np{nn _tkebc_surf} and \np{nn_tkebc_bot}, resp.596 As for TKE closure , the wave effect on the mixing is considered when \np{ln _crban}~=~true597 \citep{Craig_Banner_JPO94, Mellor_Blumberg_JPO04}. The \np{rn _crban} namelist parameter598 is $\alpha_{CB}$ in \eqref{ZDF_Esbc} and \np{rn _charn} provides the value of $\beta$ in \eqref{ZDF_Lsbc}.595 thanks to Dirichlet or Neumann condition through \np{nn\_tkebc\_surf} and \np{nn\_tkebc\_bot}, resp. 596 As for TKE closure , the wave effect on the mixing is considered when \np{ln\_crban}\forcode{ = .true.} 597 \citep{Craig_Banner_JPO94, Mellor_Blumberg_JPO04}. The \np{rn\_crban} namelist parameter 598 is $\alpha_{CB}$ in \eqref{ZDF_Esbc} and \np{rn\_charn} provides the value of $\beta$ in \eqref{ZDF_Lsbc}. 599 599 600 600 The $\psi$ equation is known to fail in stably stratified flows, and for this reason … … 606 606 stably stratified situations, and that its value has to be chosen in accordance 607 607 with the algebraic model for the turbulent fluxes. The clipping is only activated 608 if \ forcode{ln_length_lim = .true.}, and the $c_{lim}$ is set to the \np{rn_clim_galp} value.608 if \np{ln\_length\_lim}\forcode{ = .true.}, and the $c_{lim}$ is set to the \np{rn\_clim\_galp} value. 609 609 610 610 The time and space discretization of the GLS equations follows the same energetic … … 615 615 % OSM OSMOSIS BL Scheme 616 616 % ------------------------------------------------------------------------------------------------------------- 617 \subsection{OSM OSMOSIS Boundary Layer scheme (\protect\key{zdfosm})}617 \subsection{OSM: OSMOSIS boundary layer scheme (\protect\key{zdfosm})} 618 618 \label{ZDF_osm} 619 619 … … 646 646 % Non-Penetrative Convective Adjustment 647 647 % ------------------------------------------------------------------------------------------------------------- 648 \subsection [Non-Penetrative Convective Adjustment (\protect\np{ln_tranpc})]649 {Non-Penetrative Convective Adjustment (\protect\np{ln_tranpc}=.true.)}648 \subsection[Non-penetrative convective adjmt (\protect\np{ln\_tranpc}\forcode{ = .true.})] 649 {Non-penetrative convective adjustment (\protect\np{ln\_tranpc}\forcode{ = .true.})} 650 650 \label{ZDF_npc} 651 651 … … 671 671 672 672 Options are defined through the \ngn{namzdf} namelist variables. 673 The non-penetrative convective adjustment is used when \np{ln _zdfnpc}~=~\textit{true}.674 It is applied at each \np{nn _npc} time step and mixes downwards instantaneously673 The non-penetrative convective adjustment is used when \np{ln\_zdfnpc}\forcode{ = .true.}. 674 It is applied at each \np{nn\_npc} time step and mixes downwards instantaneously 675 675 the statically unstable portion of the water column, but only until the density 676 676 structure becomes neutrally stable ($i.e.$ until the mixed portion of the water … … 713 713 % Enhanced Vertical Diffusion 714 714 % ------------------------------------------------------------------------------------------------------------- 715 \subsection [Enhanced Vertical Diffusion (\protect\np{ln_zdfevd})] 716 {Enhanced Vertical Diffusion (\protect\forcode{ln_zdfevd = .true.})} 715 \subsection{Enhanced vertical diffusion (\protect\np{ln\_zdfevd}\forcode{ = .true.})} 717 716 \label{ZDF_evd} 718 717 … … 722 721 723 722 Options are defined through the \ngn{namzdf} namelist variables. 724 The enhanced vertical diffusion parameterisation is used when \ forcode{ln_zdfevd= .true.}.723 The enhanced vertical diffusion parameterisation is used when \np{ln\_zdfevd}\forcode{ = .true.}. 725 724 In this case, the vertical eddy mixing coefficients are assigned very large values 726 725 (a typical value is $10\;m^2s^{-1})$ in regions where the stratification is unstable 727 726 ($i.e.$ when $N^2$ the Brunt-Vais\"{a}l\"{a} frequency is negative) 728 727 \citep{Lazar_PhD97, Lazar_al_JPO99}. This is done either on tracers only 729 (\ forcode{nn_evdm = 0}) or on both momentum and tracers (\forcode{nn_evdm= 1}).