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

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Changeset 9407 for branches/2017/dev_merge_2017/DOC/tex_sub/chap_DYN.tex – NEMO

Ignore:
Timestamp:
2018-03-15T17:40:35+01:00 (6 years ago)
Author:
nicolasmartin
Message:

Complete refactoring of cross-referencing

  • Use of \autoref instead of simple \ref for contextual text depending on target type
  • creation of few prefixes for marker to identify the type reference: apdx|chap|eq|fig|sec|subsec|tab
File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/2017/dev_merge_2017/DOC/tex_sub/chap_DYN.tex

    r9394 r9407  
    55% ================================================================ 
    66\chapter{Ocean Dynamics (DYN)} 
    7 \label{DYN} 
     7\label{chap:DYN} 
    88\minitoc 
    99 
     
    1111$\ $\newline      %force an empty line 
    1212 
    13 Using the representation described in Chapter \ref{DOM}, several semi-discrete  
     13Using the representation described in \autoref{chap:DOM}, several semi-discrete  
    1414space forms of the dynamical equations are available depending on the vertical  
    1515coordinate used and on the conservation properties of the vorticity term. In all  
     
    3636inputs (surface wind stress calculation using bulk formulae, estimation of mixing  
    3737coefficients) that are carried out in modules SBC, LDF and ZDF and are described  
    38 in Chapters \ref{SBC}, \ref{LDF} and \ref{ZDF}, respectively.  
     38in \autoref{chap:SBC}, \autoref{chap:LDF} and \autoref{chap:ZDF}, respectively.  
    3939 
    4040In the present chapter we also describe the diagnostic equations used to compute  
     
    5151The user has the option of extracting and outputting each tendency term from the 
    52523D momentum equations (\key{trddyn} defined), as described in  
    53 Chap.\ref{MISC}.  Furthermore, the tendency terms associated with the 2D  
     53\autoref{chap:MISC}.  Furthermore, the tendency terms associated with the 2D  
    5454barotropic vorticity balance (when \key{trdvor} is defined) can be derived from the  
    55553D terms. 
     
    6464% ================================================================ 
    6565\section{Sea surface height and diagnostic variables ($\eta$, $\zeta$, $\chi$, $w$)} 
    66 \label{DYN_divcur_wzv} 
     66\label{sec:DYN_divcur_wzv} 
    6767 
    6868%-------------------------------------------------------------------------------------------------------------- 
     
    7070%-------------------------------------------------------------------------------------------------------------- 
    7171\subsection{Horizontal divergence and relative vorticity (\protect\mdl{divcur})} 
    72 \label{DYN_divcur} 
     72\label{subsec:DYN_divcur} 
    7373 
    7474The vorticity is defined at an $f$-point ($i.e.$ corner point) as follows: 
    75 \begin{equation} \label{Eq_divcur_cur} 
     75\begin{equation} \label{eq:divcur_cur} 
    7676\zeta =\frac{1}{e_{1f}\,e_{2f} }\left( {\;\delta _{i+1/2} \left[ {e_{2v}\;v} \right] 
    7777                          -\delta _{j+1/2} \left[ {e_{1u}\;u} \right]\;} \right) 
     
    7979 
    8080The horizontal divergence is defined at a $T$-point. It is given by: 
    81 \begin{equation} \label{Eq_divcur_div} 
     81\begin{equation} \label{eq:divcur_div} 
    8282\chi =\frac{1}{e_{1t}\,e_{2t}\,e_{3t} } 
    8383      \left( {\delta _i \left[ {e_{2u}\,e_{3u}\,u} \right] 
     
    102102%-------------------------------------------------------------------------------------------------------------- 
    103103\subsection{Horizontal divergence and relative vorticity (\protect\mdl{sshwzv})} 
    104 \label{DYN_sshwzv} 
     104\label{subsec:DYN_sshwzv} 
    105105 
    106106The sea surface height is given by : 
    107 \begin{equation} \label{Eq_dynspg_ssh} 
     107\begin{equation} \label{eq:dynspg_ssh} 
    108108\begin{aligned} 
    109109\frac{\partial \eta }{\partial t} 
     
    117117expressed in Kg/m$^2$/s (which is equal to mm/s), and $\rho _w$=1,035~Kg/m$^3$  
    118118is the reference density of sea water (Boussinesq approximation). If river runoff is  
    119 expressed as a surface freshwater flux (see \S\ref{SBC}) then \textit{emp} can be  
     119expressed as a surface freshwater flux (see \autoref{chap:SBC}) then \textit{emp} can be  
    120120written as the evaporation minus precipitation, minus the river runoff.  
    121121The sea-surface height is evaluated using exactly the same time stepping scheme  
    122 as the tracer equation \eqref{Eq_tra_nxt}:  
     122as the tracer equation \autoref{eq:tra_nxt}:  
    123123a leapfrog scheme in combination with an Asselin time filter, $i.e.$ the velocity appearing  
    124 in \eqref{Eq_dynspg_ssh} is centred in time (\textit{now} velocity).  
     124in \autoref{eq:dynspg_ssh} is centred in time (\textit{now} velocity).  
    125125This is of paramount importance. Replacing $T$ by the number $1$ in the tracer equation and summing 
    126126over the water column must lead to the sea surface height equation otherwise tracer content 
     
    129129The vertical velocity is computed by an upward integration of the horizontal  
    130130divergence starting at the bottom, taking into account the change of the thickness of the levels : 
    131 \begin{equation} \label{Eq_wzv} 
     131\begin{equation} \label{eq:wzv} 
    132132\left\{   \begin{aligned} 
    133133&\left. w \right|_{k_b-1/2} \quad= 0    \qquad \text{where } k_b \text{ is the level just above the sea floor }   \\ 
     
    141141of the level thicknesses, re-orientated downward. 
    142142\gmcomment{not sure of this...  to be modified with the change in emp setting} 
    143 In the case of a linear free surface, the time derivative in \eqref{Eq_wzv} disappears. 
     143In the case of a linear free surface, the time derivative in \autoref{eq:wzv} disappears. 
    144144The upper boundary condition applies at a fixed level $z=0$. The top vertical velocity  
    145145is thus equal to the divergence of the barotropic transport ($i.e.$ the first term in the 
    146 right-hand-side of \eqref{Eq_dynspg_ssh}). 
     146right-hand-side of \autoref{eq:dynspg_ssh}). 
    147147 
    148148Note also that whereas the vertical velocity has the same discrete  
     
    150150in the second case, $w$ is the velocity normal to the $s$-surfaces.  
    151151Note also that the $k$-axis is re-orientated downwards in the \textsc{fortran} code compared  
    152 to the indexing used in the semi-discrete equations such as \eqref{Eq_wzv}  
    153 (see  \S\ref{DOM_Num_Index_vertical}).  
     152to the indexing used in the semi-discrete equations such as \autoref{eq:wzv}  
     153(see \autoref{subsec:DOM_Num_Index_vertical}).  
    154154 
    155155 
     
    158158% ================================================================ 
    159159\section{Coriolis and advection: vector invariant form} 
    160 \label{DYN_adv_cor_vect} 
     160\label{sec:DYN_adv_cor_vect} 
    161161%-----------------------------------------nam_dynadv---------------------------------------------------- 
    162162\forfile{../namelists/namdyn_adv}  
     
    171171time (\textit{now} velocity).  
    172172At the lateral boundaries either free slip, no slip or partial slip boundary  
    173 conditions are applied following Chap.\ref{LBC}. 
     173conditions are applied following \autoref{chap:LBC}. 
    174174 
    175175% ------------------------------------------------------------------------------------------------------------- 
     
    177177% ------------------------------------------------------------------------------------------------------------- 
    178178\subsection{Vorticity term (\protect\mdl{dynvor})} 
    179 \label{DYN_vor} 
     179\label{subsec:DYN_vor} 
    180180%------------------------------------------nam_dynvor---------------------------------------------------- 
    181181\forfile{../namelists/namdyn_vor}  
     
    188188the relative vorticity term and horizontal kinetic energy for the planetary vorticity  
    189189term (MIX scheme) ; or conserving both the potential enstrophy of horizontally non-divergent  
    190 flow and horizontal kinetic energy (EEN scheme) (see  Appendix~\ref{Apdx_C_vorEEN}). In the  
     190flow and horizontal kinetic energy (EEN scheme) (see \autoref{subsec:C_vorEEN}). In the  
    191191case of ENS, ENE or MIX schemes the land sea mask may be slightly modified to ensure the  
    192192consistency of vorticity term with analytical equations (\np{ln\_dynvor\_con}\forcode{ = .true.}). 
     
    198198%------------------------------------------------------------- 
    199199\subsubsection{Enstrophy conserving scheme (\protect\np{ln\_dynvor\_ens}\forcode{ = .true.})} 
    200 \label{DYN_vor_ens} 
     200\label{subsec:DYN_vor_ens} 
    201201 
    202202In the enstrophy conserving case (ENS scheme), the discrete formulation of the  
     
    204204($ [ (\zeta +f ) / e_{3f} ]^2 $ in $s$-coordinates) for a horizontally non-divergent  
    205205flow ($i.e.$ $\chi$=$0$), but does not conserve the total kinetic energy. It is given by: 
    206 \begin{equation} \label{Eq_dynvor_ens} 
     206\begin{equation} \label{eq:dynvor_ens} 
    207207\left\{  
    208208\begin{aligned} 
     
    219219%------------------------------------------------------------- 
    220220\subsubsection{Energy conserving scheme (\protect\np{ln\_dynvor\_ene}\forcode{ = .true.})} 
    221 \label{DYN_vor_ene} 
     221\label{subsec:DYN_vor_ene} 
    222222 
    223223The kinetic energy conserving scheme (ENE scheme) conserves the global  
    224224kinetic energy but not the global enstrophy. It is given by: 
    225 \begin{equation} \label{Eq_dynvor_ene} 
     225\begin{equation} \label{eq:dynvor_ene} 
    226226\left\{   \begin{aligned} 
    227227{+\frac{1}{e_{1u}}\; {\overline {\left( {\frac{\zeta +f}{e_{3f} }} \right) 
     
    236236%------------------------------------------------------------- 
    237237\subsubsection{Mixed energy/enstrophy conserving scheme (\protect\np{ln\_dynvor\_mix}\forcode{ = .true.}) } 
    238 \label{DYN_vor_mix} 
     238\label{subsec:DYN_vor_mix} 
    239239 
    240240For the mixed energy/enstrophy conserving scheme (MIX scheme), a mixture of the  
    241 two previous schemes is used. It consists of the ENS scheme (\ref{Eq_dynvor_ens})  
    242 for the relative vorticity term, and of the ENE scheme (\ref{Eq_dynvor_ene}) applied  
     241two previous schemes is used. It consists of the ENS scheme (\autoref{eq:dynvor_ens})  
     242for the relative vorticity term, and of the ENE scheme (\autoref{eq:dynvor_ene}) applied  
    243243to the planetary vorticity term. 
    244 \begin{equation} \label{Eq_dynvor_mix} 
     244\begin{equation} \label{eq:dynvor_mix} 
    245245\left\{ {     \begin{aligned} 
    246246 {+\frac{1}{e_{1u} }\; {\overline {\left( {\frac{\zeta }{e_{3f} }} \right)} }^{\,i}  
     
    259259%------------------------------------------------------------- 
    260260\subsubsection{Energy and enstrophy conserving scheme (\protect\np{ln\_dynvor\_een}\forcode{ = .true.}) } 
    261 \label{DYN_vor_een} 
     261\label{subsec:DYN_vor_een} 
    262262 
    263263In both the ENS and ENE schemes, it is apparent that the combination of $i$ and $j$  
     
    277277The idea is to get rid of the double averaging by considering triad combinations of vorticity.  
    278278It is noteworthy that this solution is conceptually quite similar to the one proposed by 
    279 \citep{Griffies_al_JPO98} for the discretization of the iso-neutral diffusion operator (see App.\ref{Apdx_C}). 
     279\citep{Griffies_al_JPO98} for the discretization of the iso-neutral diffusion operator (see \autoref{apdx:C}). 
    280280 
    281281The \citet{Arakawa_Hsu_MWR90} vorticity advection scheme for a single layer is modified  
    282282for spherical coordinates as described by \citet{Arakawa_Lamb_MWR81} to obtain the EEN scheme.  
    283283First consider the discrete expression of the potential vorticity, $q$, defined at an $f$-point:  
    284 \begin{equation} \label{Eq_pot_vor} 
     284\begin{equation} \label{eq:pot_vor} 
    285285q  = \frac{\zeta +f} {e_{3f} } 
    286286\end{equation} 
    287 where the relative vorticity is defined by (\ref{Eq_divcur_cur}), the Coriolis parameter  
     287where the relative vorticity is defined by (\autoref{eq:divcur_cur}), the Coriolis parameter  
    288288is given by $f=2 \,\Omega \;\sin \varphi _f $ and the layer thickness at $f$-points is:  
    289 \begin{equation} \label{Eq_een_e3f} 
     289\begin{equation} \label{eq:een_e3f} 
    290290e_{3f} = \overline{\overline {e_{3t} }} ^{\,i+1/2,j+1/2} 
    291291\end{equation} 
     
    294294\begin{figure}[!ht]    \begin{center} 
    295295\includegraphics[width=0.70\textwidth]{Fig_DYN_een_triad} 
    296 \caption{ \protect\label{Fig_DYN_een_triad}   
     296\caption{ \protect\label{fig:DYN_een_triad}   
    297297Triads used in the energy and enstrophy conserving scheme (een) for  
    298298$u$-component (upper panel) and $v$-component (lower panel).} 
     
    300300%>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    301301 
    302 A key point in \eqref{Eq_een_e3f} is how the averaging in the \textbf{i}- and \textbf{j}- directions is made.  
     302A key point in \autoref{eq:een_e3f} is how the averaging in the \textbf{i}- and \textbf{j}- directions is made.  
    303303It uses the sum of masked t-point vertical scale factor divided either  
    304304by the sum of the four t-point masks (\np{nn\_een\_e3f}\forcode{ = 1}),  
     
    312312Next, the vorticity triads, $ {^i_j}\mathbb{Q}^{i_p}_{j_p}$ can be defined at a $T$-point as  
    313313the following triad combinations of the neighbouring potential vorticities defined at f-points  
    314 (Fig.~\ref{Fig_DYN_een_triad}):  
    315 \begin{equation} \label{Q_triads} 
     314(\autoref{fig:DYN_een_triad}):  
     315\begin{equation} \label{eq:Q_triads} 
    316316_i^j \mathbb{Q}^{i_p}_{j_p} 
    317317= \frac{1}{12} \ \left(   q^{i-i_p}_{j+j_p} + q^{i+j_p}_{j+i_p} + q^{i+i_p}_{j-j_p}  \right) 
     
    320320 
    321321Finally, the vorticity terms are represented as:  
    322 \begin{equation} \label{Eq_dynvor_een} 
     322\begin{equation} \label{eq:dynvor_een} 
    323323\left\{ { 
    324324\begin{aligned} 
     
    333333This EEN scheme in fact combines the conservation properties of the ENS and ENE schemes.  
    334334It conserves both total energy and potential enstrophy in the limit of horizontally  
    335 nondivergent flow ($i.e.$ $\chi$=$0$) (see  Appendix~\ref{Apdx_C_vorEEN}).  
     335nondivergent flow ($i.e.$ $\chi$=$0$) (see \autoref{subsec:C_vorEEN}).  
    336336Applied to a realistic ocean configuration, it has been shown that it leads to a significant  
    337337reduction of the noise in the vertical velocity field \citep{Le_Sommer_al_OM09}.  
     
    344344%-------------------------------------------------------------------------------------------------------------- 
    345345\subsection{Kinetic energy gradient term (\protect\mdl{dynkeg})} 
    346 \label{DYN_keg} 
    347  
    348 As demonstrated in Appendix~\ref{Apdx_C}, there is a single discrete formulation  
     346\label{subsec:DYN_keg} 
     347 
     348As demonstrated in \autoref{apdx:C}, there is a single discrete formulation  
    349349of the kinetic energy gradient term that, together with the formulation chosen for  
    350350the vertical advection (see below), conserves the total kinetic energy: 
    351 \begin{equation} \label{Eq_dynkeg} 
     351\begin{equation} \label{eq:dynkeg} 
    352352\left\{ \begin{aligned} 
    353353 -\frac{1}{2 \; e_{1u} }  & \ \delta _{i+1/2} \left[ {\overline {u^2}^{\,i} + \overline{v^2}^{\,j}} \right]   \\ 
     
    360360%-------------------------------------------------------------------------------------------------------------- 
    361361\subsection{Vertical advection term (\protect\mdl{dynzad}) } 
    362 \label{DYN_zad} 
     362\label{subsec:DYN_zad} 
    363363 
    364364The discrete formulation of the vertical advection, together with the formulation  
    365365chosen for the gradient of kinetic energy (KE) term, conserves the total kinetic  
    366366energy. Indeed, the change of KE due to the vertical advection is exactly  
    367 balanced by the change of KE due to the gradient of KE (see Appendix~\ref{Apdx_C}). 
    368 \begin{equation} \label{Eq_dynzad} 
     367balanced by the change of KE due to the gradient of KE (see \autoref{apdx:C}). 
     368\begin{equation} \label{eq:dynzad} 
    369369\left\{     \begin{aligned} 
    370370-\frac{1} {e_{1u}\,e_{2u}\,e_{3u}} &\ \overline{\ \overline{ e_{1t}\,e_{2t}\;w } ^{\,i+1/2}  \;\delta _{k+1/2} \left[ u \right]\  }^{\,k}  \\ 
     
    377377Note that in this case, a similar split-explicit time stepping should be used on  
    378378vertical advection of tracer to ensure a better stability,  
    379 an option which is only available with a TVD scheme (see \np{ln\_traadv\_tvd\_zts} in \S\ref{TRA_adv_tvd}). 
     379an option which is only available with a TVD scheme (see \np{ln\_traadv\_tvd\_zts} in \autoref{subsec:TRA_adv_tvd}). 
    380380 
    381381 
     
    384384% ================================================================ 
    385385\section{Coriolis and advection: flux form} 
    386 \label{DYN_adv_cor_flux} 
     386\label{sec:DYN_adv_cor_flux} 
    387387%------------------------------------------nam_dynadv---------------------------------------------------- 
    388388\forfile{../namelists/namdyn_adv}  
     
    394394appearing in their expressions is centred in time (\textit{now} velocity). At the  
    395395lateral boundaries either free slip, no slip or partial slip boundary conditions  
    396 are applied following Chap.\ref{LBC}. 
     396are applied following \autoref{chap:LBC}. 
    397397 
    398398 
     
    401401%-------------------------------------------------------------------------------------------------------------- 
    402402\subsection{Coriolis plus curvature metric terms (\protect\mdl{dynvor}) } 
    403 \label{DYN_cor_flux} 
     403\label{subsec:DYN_cor_flux} 
    404404 
    405405In flux form, the vorticity term reduces to a Coriolis term in which the Coriolis  
    406406parameter has been modified to account for the "metric" term. This altered  
    407407Coriolis parameter is thus discretised at $f$-points. It is given by:  
    408 \begin{multline} \label{Eq_dyncor_metric} 
     408\begin{multline} \label{eq:dyncor_metric} 
    409409f+\frac{1}{e_1 e_2 }\left( {v\frac{\partial e_2 }{\partial i}  -  u\frac{\partial e_1 }{\partial j}} \right)  \\ 
    410410   \equiv   f + \frac{1}{e_{1f} e_{2f} } \left( { \ \overline v ^{i+1/2}\delta _{i+1/2} \left[ {e_{2u} } \right]   
     
    412412\end{multline}  
    413413 
    414 Any of the (\ref{Eq_dynvor_ens}), (\ref{Eq_dynvor_ene}) and (\ref{Eq_dynvor_een})  
     414Any of the (\autoref{eq:dynvor_ens}), (\autoref{eq:dynvor_ene}) and (\autoref{eq:dynvor_een})  
    415415schemes can be used to compute the product of the Coriolis parameter and the  
    416 vorticity. However, the energy-conserving scheme  (\ref{Eq_dynvor_een}) has  
     416vorticity. However, the energy-conserving scheme  (\autoref{eq:dynvor_een}) has  
    417417exclusively been used to date. This term is evaluated using a leapfrog scheme,  
    418418$i.e.$ the velocity is centred in time (\textit{now} velocity). 
     
    422422%-------------------------------------------------------------------------------------------------------------- 
    423423\subsection{Flux form advection term (\protect\mdl{dynadv}) } 
    424 \label{DYN_adv_flux} 
     424\label{subsec:DYN_adv_flux} 
    425425 
    426426The discrete expression of the advection term is given by : 
    427 \begin{equation} \label{Eq_dynadv} 
     427\begin{equation} \label{eq:dynadv} 
    428428\left\{  
    429429\begin{aligned} 
     
    454454%------------------------------------------------------------- 
    455455\subsubsection{CEN2: $2^{nd}$ order centred scheme (\protect\np{ln\_dynadv\_cen2}\forcode{ = .true.})} 
    456 \label{DYN_adv_cen2} 
     456\label{subsec:DYN_adv_cen2} 
    457457 
    458458In the centered $2^{nd}$ order formulation, the velocity is evaluated as the  
    459459mean of the two neighbouring points : 
    460 \begin{equation} \label{Eq_dynadv_cen2} 
     460\begin{equation} \label{eq:dynadv_cen2} 
    461461\left\{     \begin{aligned} 
    462462 u_T^{cen2} &=\overline u^{i }       \quad &  u_F^{cen2} &=\overline u^{j+1/2}  \quad &  u_{uw}^{cen2} &=\overline u^{k+1/2}   \\ 
     
    475475%------------------------------------------------------------- 
    476476\subsubsection{UBS: Upstream Biased Scheme (\protect\np{ln\_dynadv\_ubs}\forcode{ = .true.})} 
    477 \label{DYN_adv_ubs} 
     477\label{subsec:DYN_adv_ubs} 
    478478 
    479479The UBS advection scheme is an upstream biased third order scheme based on  
    480480an upstream-biased parabolic interpolation. For example, the evaluation of  
    481481$u_T^{ubs} $ is done as follows: 
    482 \begin{equation} \label{Eq_dynadv_ubs} 
     482\begin{equation} \label{eq:dynadv_ubs} 
    483483u_T^{ubs} =\overline u ^i-\;\frac{1}{6}   \begin{cases} 
    484484      u"_{i-1/2}&    \text{if $\ \overline{e_{2u}\,e_{3u} \ u}^i  \geqslant 0$ }    \\ 
     
    498498The UBS scheme is not used in all directions. In the vertical, the centred $2^{nd}$  
    499499order evaluation of the advection is preferred, $i.e.$ $u_{uw}^{ubs}$ and  
    500 $u_{vw}^{ubs}$ in \eqref{Eq_dynadv_cen2} are used. UBS is diffusive and is  
     500$u_{vw}^{ubs}$ in \autoref{eq:dynadv_cen2} are used. UBS is diffusive and is  
    501501associated with vertical mixing of momentum. \gmcomment{ gm  pursue the  
    502502sentence:Since vertical mixing of momentum is a source term of the TKE equation...  } 
    503503 
    504 For stability reasons,  the first term in (\ref{Eq_dynadv_ubs}), which corresponds  
     504For stability reasons, the first term in (\autoref{eq:dynadv_ubs}), which corresponds  
    505505to a second order centred scheme, is evaluated using the \textit{now} velocity  
    506506(centred in time), while the second term, which is the diffusion part of the scheme,  
     
    510510Note that the UBS and QUICK (Quadratic Upstream Interpolation for Convective Kinematics)  
    511511schemes only differ by one coefficient. Replacing $1/6$ by $1/8$ in  
    512 (\ref{Eq_dynadv_ubs}) leads to the QUICK advection scheme \citep{Webb_al_JAOT98}.  
     512(\autoref{eq:dynadv_ubs}) leads to the QUICK advection scheme \citep{Webb_al_JAOT98}.  
    513513This option is not available through a namelist parameter, since the $1/6$ coefficient  
    514514is hard coded. Nevertheless it is quite easy to make the substitution in the 
     
    526526% ================================================================ 
    527527\section{Hydrostatic pressure gradient (\protect\mdl{dynhpg})} 
    528 \label{DYN_hpg} 
     528\label{sec:DYN_hpg} 
    529529%------------------------------------------nam_dynhpg--------------------------------------------------- 
    530530\forfile{../namelists/namdyn_hpg}  
     
    547547%-------------------------------------------------------------------------------------------------------------- 
    548548\subsection{Full step $Z$-coordinate (\protect\np{ln\_dynhpg\_zco}\forcode{ = .true.})} 
    549 \label{DYN_hpg_zco} 
     549\label{subsec:DYN_hpg_zco} 
    550550 
    551551The hydrostatic pressure can be obtained by integrating the hydrostatic equation  
     
    556556 
    557557for $k=km$ (surface layer, $jk=1$ in the code) 
    558 \begin{equation} \label{Eq_dynhpg_zco_surf} 
     558\begin{equation} \label{eq:dynhpg_zco_surf} 
    559559\left\{ \begin{aligned} 
    560560               \left. \delta _{i+1/2} \left[  p^h         \right] \right|_{k=km}  
     
    566566 
    567567for $1<k<km$ (interior layer) 
    568 \begin{equation} \label{Eq_dynhpg_zco} 
     568\begin{equation} \label{eq:dynhpg_zco} 
    569569\left\{ \begin{aligned} 
    570570               \left. \delta _{i+1/2} \left[  p^h         \right] \right|_{k}  
     
    577577\end{equation}  
    578578 
    579 Note that the $1/2$ factor in (\ref{Eq_dynhpg_zco_surf}) is adequate because of  
     579Note that the $1/2$ factor in (\autoref{eq:dynhpg_zco_surf}) is adequate because of  
    580580the definition of $e_{3w}$ as the vertical derivative of the scale factor at the surface  
    581581level ($z=0$). Note also that in case of variable volume level (\key{vvl} defined), the  
    582 surface pressure gradient is included in \eqref{Eq_dynhpg_zco_surf} and \eqref{Eq_dynhpg_zco}  
     582surface pressure gradient is included in \autoref{eq:dynhpg_zco_surf} and \autoref{eq:dynhpg_zco}  
    583583through the space and time variations of the vertical scale factor $e_{3w}$. 
    584584 
     
    587587%-------------------------------------------------------------------------------------------------------------- 
    588588\subsection{Partial step $Z$-coordinate (\protect\np{ln\_dynhpg\_zps}\forcode{ = .true.})} 
    589 \label{DYN_hpg_zps} 
     589\label{subsec:DYN_hpg_zps} 
    590590 
    591591With partial bottom cells, tracers in horizontally adjacent cells generally live at  
     
    596596Apart from this modification, the horizontal hydrostatic pressure gradient evaluated  
    597597in the $z$-coordinate with partial step is exactly as in the pure $z$-coordinate case.  
    598 As explained in detail in section \S\ref{TRA_zpshde}, the nonlinearity of pressure  
     598As explained in detail in section \autoref{sec:TRA_zpshde}, the nonlinearity of pressure  
    599599effects in the equation of state is such that it is better to interpolate temperature and  
    600600salinity vertically before computing the density. Horizontal gradients of temperature  
    601601and salinity are needed for the TRA modules, which is the reason why the horizontal  
    602602gradients of density at the deepest model level are computed in module \mdl{zpsdhe}  
    603 located in the TRA directory and described in \S\ref{TRA_zpshde}. 
     603located in the TRA directory and described in \autoref{sec:TRA_zpshde}. 
    604604 
    605605%-------------------------------------------------------------------------------------------------------------- 
     
    607607%-------------------------------------------------------------------------------------------------------------- 
    608608\subsection{$S$- and $Z$-$S$-coordinates} 
    609 \label{DYN_hpg_sco} 
     609\label{subsec:DYN_hpg_sco} 
    610610 
    611611Pressure gradient formulations in an $s$-coordinate have been the subject of a vast  
     
    615615 
    616616$\bullet$ Traditional coding (see for example \citet{Madec_al_JPO96}: (\np{ln\_dynhpg\_sco}\forcode{ = .true.}) 
    617 \begin{equation} \label{Eq_dynhpg_sco} 
     617\begin{equation} \label{eq:dynhpg_sco} 
    618618\left\{ \begin{aligned} 
    619619 - \frac{1}                   {\rho_o \, e_{1u}} \;   \delta _{i+1/2} \left[  p^h  \right]  
     
    625625 
    626626Where the first term is the pressure gradient along coordinates, computed as in  
    627 \eqref{Eq_dynhpg_zco_surf} - \eqref{Eq_dynhpg_zco}, and $z_T$ is the depth of  
     627\autoref{eq:dynhpg_zco_surf} - \autoref{eq:dynhpg_zco}, and $z_T$ is the depth of  
    628628the $T$-point evaluated from the sum of the vertical scale factors at the $w$-point  
    629629($e_{3w}$). 
     
    637637(\np{ln\_dynhpg\_djc}\forcode{ = .true.}) (currently disabled; under development) 
    638638 
    639 Note that expression \eqref{Eq_dynhpg_sco} is commonly used when the variable volume formulation is 
     639Note that expression \autoref{eq:dynhpg_sco} is commonly used when the variable volume formulation is 
    640640activated (\key{vvl}) because in that case, even with a flat bottom, the coordinate surfaces are not 
    641641horizontal but follow the free surface \citep{Levier2007}. The pressure jacobian scheme 
     
    648648 
    649649\subsection{Ice shelf cavity} 
    650 \label{DYN_hpg_isf} 
     650\label{subsec:DYN_hpg_isf} 
    651651Beneath an ice shelf, the total pressure gradient is the sum of the pressure gradient due to the ice shelf load and 
    652652 the pressure gradient due to the ocean load. If cavity opened (\np{ln\_isfcav}\forcode{ = .true.}) these 2 terms can be 
     
    658658This top pressure is constant over time. A detailed description of this method is described in \citet{Losch2008}.\\ 
    659659 
    660 $\bullet$ The ocean load is computed using the expression \eqref{Eq_dynhpg_sco} described in \ref{DYN_hpg_sco}.  
     660$\bullet$ The ocean load is computed using the expression \autoref{eq:dynhpg_sco} described in \autoref{subsec:DYN_hpg_sco}.  
    661661 
    662662%-------------------------------------------------------------------------------------------------------------- 
     
    664664%-------------------------------------------------------------------------------------------------------------- 
    665665\subsection{Time-scheme (\protect\np{ln\_dynhpg\_imp}\forcode{ = .true./.false.})} 
    666 \label{DYN_hpg_imp} 
     666\label{subsec:DYN_hpg_imp} 
    667667 
    668668The default time differencing scheme used for the horizontal pressure gradient is  
     
    680680$\bullet$ leapfrog scheme (\np{ln\_dynhpg\_imp}\forcode{ = .true.}): 
    681681 
    682 \begin{equation} \label{Eq_dynhpg_lf} 
     682\begin{equation} \label{eq:dynhpg_lf} 
    683683\frac{u^{t+\rdt}-u^{t-\rdt}}{2\rdt} = \;\cdots \; 
    684684   -\frac{1}{\rho _o \,e_{1u} }\delta _{i+1/2} \left[ {p_h^t } \right] 
     
    686686 
    687687$\bullet$ semi-implicit scheme (\np{ln\_dynhpg\_imp}\forcode{ = .true.}): 
    688 \begin{equation} \label{Eq_dynhpg_imp} 
     688\begin{equation} \label{eq:dynhpg_imp} 
    689689\frac{u^{t+\rdt}-u^{t-\rdt}}{2\rdt} = \;\cdots \; 
    690690   -\frac{1}{4\,\rho _o \,e_{1u} } \delta_{i+1/2} \left[ p_h^{t+\rdt} +2\,p_h^t +p_h^{t-\rdt}  \right] 
    691691\end{equation} 
    692692 
    693 The semi-implicit time scheme \eqref{Eq_dynhpg_imp} is made possible without  
     693The semi-implicit time scheme \autoref{eq:dynhpg_imp} is made possible without  
    694694significant additional computation since the density can be updated to time level  
    695695$t+\rdt$ before computing the horizontal hydrostatic pressure gradient. It can  
    696696be easily shown that the stability limit associated with the hydrostatic pressure  
    697 gradient doubles using \eqref{Eq_dynhpg_imp} compared to that using the  
    698 standard leapfrog scheme \eqref{Eq_dynhpg_lf}. Note that \eqref{Eq_dynhpg_imp}  
     697gradient doubles using \autoref{eq:dynhpg_imp} compared to that using the  
     698standard leapfrog scheme \autoref{eq:dynhpg_lf}. Note that \autoref{eq:dynhpg_imp}  
    699699is equivalent to applying a time filter to the pressure gradient to eliminate high  
    700 frequency IGWs. Obviously, when using \eqref{Eq_dynhpg_imp}, the doubling of  
     700frequency IGWs. Obviously, when using \autoref{eq:dynhpg_imp}, the doubling of  
    701701the time-step is achievable only if no other factors control the time-step, such as  
    702702the stability limits associated with advection or diffusion. 
     
    708708compute the hydrostatic pressure gradient (whatever the formulation) is evaluated  
    709709as follows: 
    710 \begin{equation} \label{Eq_rho_flt} 
     710\begin{equation} \label{eq:rho_flt} 
    711711   \rho^t = \rho( \widetilde{T},\widetilde {S},z_t) 
    712712 \quad     \text{with}  \quad  
     
    722722% ================================================================ 
    723723\section{Surface pressure gradient (\protect\mdl{dynspg})} 
    724 \label{DYN_spg} 
     724\label{sec:DYN_spg} 
    725725%-----------------------------------------nam_dynspg---------------------------------------------------- 
    726726\forfile{../namelists/namdyn_spg}  
     
    730730 
    731731Options are defined through the \ngn{namdyn\_spg} namelist variables. 
    732 The surface pressure gradient term is related to the representation of the free surface (\S\ref{PE_hor_pg}).  
     732The surface pressure gradient term is related to the representation of the free surface (\autoref{sec:PE_hor_pg}).  
    733733The main distinction is between the fixed volume case (linear free surface) and the variable volume case  
    734 (nonlinear free surface, \key{vvl} is defined). In the linear free surface case (\S\ref{PE_free_surface})  
     734(nonlinear free surface, \key{vvl} is defined). In the linear free surface case (\autoref{subsec:PE_free_surface})  
    735735the vertical scale factors $e_{3}$ are fixed in time, while they are time-dependent in the nonlinear case  
    736 (\S\ref{PE_free_surface}).  
     736(\autoref{subsec:PE_free_surface}).  
    737737With both linear and nonlinear free surface, external gravity waves are allowed in the equations,  
    738738which imposes a very small time step when an explicit time stepping is used.  
    739739Two methods are proposed to allow a longer time step for the three-dimensional equations:  
    740 the filtered free surface, which is a modification of the continuous equations (see \eqref{Eq_PE_flt}),  
     740the filtered free surface, which is a modification of the continuous equations (see \autoref{eq:PE_flt}),  
    741741and the split-explicit free surface described below.  
    742742The extra term introduced in the filtered method is calculated implicitly,  
     
    745745 
    746746The form of the surface pressure gradient term depends on how the user wants to handle  
    747 the fast external gravity waves that are a solution of the analytical equation (\S\ref{PE_hor_pg}).  
     747the fast external gravity waves that are a solution of the analytical equation (\autoref{sec:PE_hor_pg}).  
    748748Three formulations are available, all controlled by a CPP key (ln\_dynspg\_xxx): 
    749749an explicit formulation which requires a small time step ; 
     
    761761%-------------------------------------------------------------------------------------------------------------- 
    762762\subsection{Explicit free surface (\protect\key{dynspg\_exp})} 
    763 \label{DYN_spg_exp} 
     763\label{subsec:DYN_spg_exp} 
    764764 
    765765In the explicit free surface formulation (\key{dynspg\_exp} defined), the model time step  
     
    767767The surface pressure gradient, evaluated using a leap-frog scheme ($i.e.$ centered in time), 
    768768is thus simply given by : 
    769 \begin{equation} \label{Eq_dynspg_exp} 
     769\begin{equation} \label{eq:dynspg_exp} 
    770770\left\{ \begin{aligned} 
    771771 - \frac{1}{e_{1u}\,\rho_o} \;   \delta _{i+1/2} \left[  \,\rho \,\eta\,  \right]   \\ 
     
    782782%-------------------------------------------------------------------------------------------------------------- 
    783783\subsection{Split-explicit free surface (\protect\key{dynspg\_ts})} 
    784 \label{DYN_spg_ts} 
     784\label{subsec:DYN_spg_ts} 
    785785%------------------------------------------namsplit----------------------------------------------------------- 
    786786%\forfile{../namelists/namsplit} 
     
    792792equation and the associated barotropic velocity equations with a smaller time  
    793793step than $\rdt$, the time step used for the three dimensional prognostic  
    794 variables (Fig.~\ref{Fig_DYN_dynspg_ts}).  
     794variables (\autoref{fig:DYN_dynspg_ts}).  
    795795The size of the small time step, $\rdt_e$ (the external mode or barotropic time step) 
    796796 is provided through the \np{nn\_baro} namelist parameter as:  
     
    802802%%% 
    803803The barotropic mode solves the following equations: 
    804 \begin{subequations} \label{Eq_BT} 
    805   \begin{equation}     \label{Eq_BT_dyn} 
     804\begin{subequations} \label{eq:BT} 
     805  \begin{equation}     \label{eq:BT_dyn} 
    806806\frac{\partial {\rm \overline{{\bf U}}_h} }{\partial t}= 
    807807 -f\;{\rm {\bf k}}\times {\rm \overline{{\bf U}}_h}  
     
    809809  \end{equation} 
    810810 
    811   \begin{equation} \label{Eq_BT_ssh} 
     811  \begin{equation} \label{eq:BT_ssh} 
    812812\frac{\partial \eta }{\partial t}=-\nabla \cdot \left[ {\left( {H+\eta } \right) \; {\rm{\bf \overline{U}}}_h \,} \right]+P-E 
    813813  \end{equation} 
    814814\end{subequations} 
    815 where $\rm {\overline{\bf G}}$ is a forcing term held constant, containing coupling term between modes, surface atmospheric forcing as well as slowly varying barotropic terms not explicitly computed to gain efficiency. The third term on the right hand side of \eqref{Eq_BT_dyn} represents the bottom stress (see section \S\ref{ZDF_bfr}), explicitly accounted for at each barotropic iteration. Temporal discretization of the system above follows a three-time step Generalized Forward Backward algorithm detailed in \citet{Shchepetkin_McWilliams_OM05}. AB3-AM4 coefficients used in \NEMO follow the second-order accurate, "multi-purpose" stability compromise as defined in \citet{Shchepetkin_McWilliams_Bk08} (see their figure 12, lower left).  
     815where $\rm {\overline{\bf G}}$ is a forcing term held constant, containing coupling term between modes, surface atmospheric forcing as well as slowly varying barotropic terms not explicitly computed to gain efficiency. The third term on the right hand side of \autoref{eq:BT_dyn} represents the bottom stress (see section \autoref{sec:ZDF_bfr}), explicitly accounted for at each barotropic iteration. Temporal discretization of the system above follows a three-time step Generalized Forward Backward algorithm detailed in \citet{Shchepetkin_McWilliams_OM05}. AB3-AM4 coefficients used in \NEMO follow the second-order accurate, "multi-purpose" stability compromise as defined in \citet{Shchepetkin_McWilliams_Bk08} (see their figure 12, lower left).  
    816816 
    817817%>   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   > 
    818818\begin{figure}[!t]    \begin{center} 
    819819\includegraphics[width=0.7\textwidth]{Fig_DYN_dynspg_ts} 
    820 \caption{  \protect\label{Fig_DYN_dynspg_ts} 
     820\caption{  \protect\label{fig:DYN_dynspg_ts} 
    821821Schematic of the split-explicit time stepping scheme for the external  
    822822and internal modes. Time increases to the right. In this particular exemple,  
     
    827827The former are used to obtain time filtered quantities at $t+\rdt$ while the latter are used to obtain time averaged  
    828828transports to advect tracers. 
    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.}. } 
     829a) Forward time integration: \protect\np{ln\_bt\_fw}\forcode{ = .true.},  \protect\np{ln\_bt\_av}\forcode{ = .true.}. 
     830b) Centred time integration: \protect\np{ln\_bt\_fw}\forcode{ = .false.}, \protect\np{ln\_bt\_av}\forcode{ = .true.}. 
     831c) Forward time integration with no time filtering (POM-like scheme): \protect\np{ln\_bt\_fw}\forcode{ = .true.}, \protect\np{ln\_bt\_av}\forcode{ = .false.}. } 
    832832\end{center}    \end{figure} 
    833833%>   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   >   > 
    834834 
    835835In the default case (\np{ln\_bt\_fw}\forcode{ = .true.}), the external mode is integrated  
    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  
     836between \textit{now} and  \textit{after} baroclinic time-steps (\autoref{fig:DYN_dynspg_ts}a). To avoid aliasing of fast barotropic motions into three dimensional equations, time filtering is eventually applied on barotropic  
    837837quantities (\np{ln\_bt\_av}\forcode{ = .true.}). In that case, the integration is extended slightly beyond  \textit{after} time step to provide time filtered quantities.  
    838838These are used for the subsequent initialization of the barotropic mode in the following baroclinic step.  
     
    850850at \textit{now} time step. This implies to change the traditional order of computations in \NEMO: most of momentum   
    851851trends (including the barotropic mode calculation) updated first, tracers' after. This \textit{de facto} makes semi-implicit hydrostatic  
    852 pressure gradient (see section \S\ref{DYN_hpg_imp}) and time splitting not compatible.  
     852pressure gradient (see section \autoref{subsec:DYN_hpg_imp}) and time splitting not compatible.  
    853853Advective barotropic velocities are obtained by using a secondary set of filtering weights, uniquely defined from the filter  
    854854coefficients used for the time averaging (\citet{Shchepetkin_McWilliams_OM05}). Consistency between the time averaged continuity equation and the time stepping of tracers is here the key to obtain exact conservation. 
     
    872872scheme using the small barotropic time step $\rdt$. We have  
    873873 
    874 \begin{equation} \label{DYN_spg_ts_eta} 
     874\begin{equation} \label{eq:DYN_spg_ts_eta} 
    875875\eta^{(b)}(\tau,t_{n+1}) - \eta^{(b)}(\tau,t_{n+1}) (\tau,t_{n-1}) 
    876876   = 2 \rdt \left[-\nabla \cdot \textbf{U}^{(b)}(\tau,t_n) + \text{EMP}_w(\tau) \right]  
    877877\end{equation} 
    878 \begin{multline} \label{DYN_spg_ts_u} 
     878\begin{multline} \label{eq:DYN_spg_ts_u} 
    879879\textbf{U}^{(b)}(\tau,t_{n+1}) - \textbf{U}^{(b)}(\tau,t_{n-1})  \\ 
    880880   = 2\rdt \left[ - f \textbf{k} \times \textbf{U}^{(b)}(\tau,t_{n})  
     
    886886and $U^{(b)}$ denotes the baroclinic time at which the vertically integrated forcing $\textbf{M}(\tau)$ (note that this forcing includes the surface freshwater forcing), the tracer fields, the freshwater flux $\text{EMP}_w(\tau)$, and total depth of the ocean $H(\tau)$ are held for the duration of the barotropic time stepping over a single cycle. This is also the time  
    887887that sets the barotropic time steps via  
    888 \begin{equation} \label{DYN_spg_ts_t} 
     888\begin{equation} \label{eq:DYN_spg_ts_t} 
    889889t_n=\tau+n\rdt    
    890890\end{equation} 
    891891with $n$ an integer. The density scaled surface pressure is evaluated via  
    892 \begin{equation} \label{DYN_spg_ts_ps} 
     892\begin{equation} \label{eq:DYN_spg_ts_ps} 
    893893p_s^{(b)}(\tau,t_{n}) = \begin{cases} 
    894894   g \;\eta_s^{(b)}(\tau,t_{n}) \;\rho(\tau)_{k=1}) / \rho_o  &      \text{non-linear case} \\ 
     
    897897\end{equation} 
    898898To get started, we assume the following initial conditions  
    899 \begin{equation} \label{DYN_spg_ts_eta} 
     899\begin{equation} \label{eq:DYN_spg_ts_eta} 
    900900\begin{split} 
    901901\eta^{(b)}(\tau,t_{n=0}) &= \overline{\eta^{(b)}(\tau)} 
     
    905905\end{equation} 
    906906with  
    907 \begin{equation} \label{DYN_spg_ts_etaF} 
     907\begin{equation} \label{eq:DYN_spg_ts_etaF} 
    908908 \overline{\eta^{(b)}(\tau)} = \frac{1}{N+1} \sum\limits_{n=0}^N \eta^{(b)}(\tau-\rdt,t_{n}) 
    909909\end{equation} 
    910910the time averaged surface height taken from the previous barotropic cycle. Likewise,  
    911 \begin{equation} \label{DYN_spg_ts_u} 
     911\begin{equation} \label{eq:DYN_spg_ts_u} 
    912912\textbf{U}^{(b)}(\tau,t_{n=0}) = \overline{\textbf{U}^{(b)}(\tau)}   \\ 
    913913\\ 
     
    915915\end{equation} 
    916916with  
    917 \begin{equation} \label{DYN_spg_ts_u} 
     917\begin{equation} \label{eq:DYN_spg_ts_u} 
    918918 \overline{\textbf{U}^{(b)}(\tau)}  
    919919   = \frac{1}{N+1} \sum\limits_{n=0}^N\textbf{U}^{(b)}(\tau-\rdt,t_{n}) 
     
    922922 
    923923Upon reaching $t_{n=N} = \tau + 2\rdt \tau$ , the vertically integrated velocity is time averaged to produce the updated vertically integrated velocity at baroclinic time $\tau + \rdt \tau$  
    924 \begin{equation} \label{DYN_spg_ts_u} 
     924\begin{equation} \label{eq:DYN_spg_ts_u} 
    925925\textbf{U}(\tau+\rdt) = \overline{\textbf{U}^{(b)}(\tau+\rdt)}  
    926926   = \frac{1}{N+1} \sum\limits_{n=0}^N\textbf{U}^{(b)}(\tau,t_{n}) 
     
    928928The surface height on the new baroclinic time step is then determined via a baroclinic leap-frog using the following form  
    929929 
    930 \begin{equation} \label{DYN_spg_ts_ssh} 
     930\begin{equation} \label{eq:DYN_spg_ts_ssh} 
    931931\eta(\tau+\Delta) - \eta^{F}(\tau-\Delta) = 2\rdt \ \left[ - \nabla \cdot \textbf{U}(\tau) + \text{EMP}_w \right]   
    932932\end{equation} 
     
    935935  
    936936In general, some form of time filter is needed to maintain integrity of the surface  
    937 height field due to the leap-frog splitting mode in equation \ref{DYN_spg_ts_ssh}. We  
     937height field due to the leap-frog splitting mode in equation \autoref{eq:DYN_spg_ts_ssh}. We  
    938938have tried various forms of such filtering, with the following method discussed in  
    939939\cite{Griffies_al_MWR01} chosen due to its stability and reasonably good maintenance of  
    940 tracer conservation properties (see Section ??)  
    941  
    942 \begin{equation} \label{DYN_spg_ts_sshf} 
     940tracer conservation properties (see ??)  
     941 
     942\begin{equation} \label{eq:DYN_spg_ts_sshf} 
    943943\eta^{F}(\tau-\Delta) =  \overline{\eta^{(b)}(\tau)}  
    944944\end{equation} 
    945945Another approach tried was  
    946946 
    947 \begin{equation} \label{DYN_spg_ts_sshf2} 
     947\begin{equation} \label{eq:DYN_spg_ts_sshf2} 
    948948\eta^{F}(\tau-\Delta) = \eta(\tau)  
    949949   + (\alpha/2) \left[\overline{\eta^{(b)}}(\tau+\rdt) 
     
    953953which is useful since it isolates all the time filtering aspects into the term multiplied  
    954954by $\alpha$. This isolation allows for an easy check that tracer conservation is exact when  
    955 eliminating tracer and surface height time filtering (see Section ?? for more complete discussion). However, in the general case with a non-zero $\alpha$, the filter \ref{DYN_spg_ts_sshf} was found to be more conservative, and so is recommended.  
     955eliminating tracer and surface height time filtering (see ?? for more complete discussion). However, in the general case with a non-zero $\alpha$, the filter \autoref{eq:DYN_spg_ts_sshf} was found to be more conservative, and so is recommended.  
    956956 
    957957}            %%end gm comment (copy of griffies book) 
     
    964964%-------------------------------------------------------------------------------------------------------------- 
    965965\subsection{Filtered free surface (\protect\key{dynspg\_flt})} 
    966 \label{DYN_spg_fltp} 
     966\label{subsec:DYN_spg_fltp} 
    967967 
    968968The filtered formulation follows the \citet{Roullet_Madec_JGR00} implementation.  
    969 The extra term introduced in the equations (see \S\ref{PE_free_surface}) is solved implicitly.  
    970 The elliptic solvers available in the code are documented in \S\ref{MISC}. 
     969The extra term introduced in the equations (see \autoref{subsec:PE_free_surface}) is solved implicitly.  
     970The elliptic solvers available in the code are documented in \autoref{chap:MISC}. 
    971971 
    972972%% gm %%======>>>>   given here the discrete eqs provided to the solver 
    973973\gmcomment{               %%% copy from chap-model basics  
    974 \begin{equation} \label{Eq_spg_flt} 
     974\begin{equation} \label{eq:spg_flt} 
    975975\frac{\partial {\rm {\bf U}}_h }{\partial t}= {\rm {\bf M}} 
    976976- g \nabla \left( \tilde{\rho} \ \eta \right)  
     
    980980$\widetilde{\rho} = \rho / \rho_o$ is the dimensionless density, and $\rm {\bf M}$  
    981981represents the collected contributions of the Coriolis, hydrostatic pressure gradient,  
    982 non-linear and viscous terms in \eqref{Eq_PE_dyn}. 
     982non-linear and viscous terms in \autoref{eq:PE_dyn}. 
    983983}   %end gmcomment 
    984984 
     
    990990% ================================================================ 
    991991\section{Lateral diffusion term and operators (\protect\mdl{dynldf})} 
    992 \label{DYN_ldf} 
     992\label{sec:DYN_ldf} 
    993993%------------------------------------------nam_dynldf---------------------------------------------------- 
    994994\forfile{../namelists/namdyn_ldf}  
     
    999999(rotated or not) or biharmonic operators. The coefficients may be constant  
    10001000or spatially variable; the description of the coefficients is found in the chapter  
    1001 on lateral physics (Chap.\ref{LDF}). The lateral diffusion of momentum is  
     1001on lateral physics (\autoref{chap:LDF}). The lateral diffusion of momentum is  
    10021002evaluated using a forward scheme, $i.e.$ the velocity appearing in its expression  
    10031003is the \textit{before} velocity in time, except for the pure vertical component  
    10041004that appears when a tensor of rotation is used. This latter term is solved  
    1005 implicitly together with the vertical diffusion term (see \S\ref{STP})  
     1005implicitly together with the vertical diffusion term (see \autoref{chap:STP})  
    10061006 
    10071007At the lateral boundaries either free slip, no slip or partial slip boundary  
    1008 conditions are applied according to the user's choice (see Chap.\ref{LBC}). 
     1008conditions are applied according to the user's choice (see \autoref{chap:LBC}). 
    10091009 
    10101010\gmcomment{ 
     
    10251025\subsection[Iso-level laplacian (\protect\np{ln\_dynldf\_lap}\forcode{ = .true.})] 
    10261026            {Iso-level laplacian operator (\protect\np{ln\_dynldf\_lap}\forcode{ = .true.})} 
    1027 \label{DYN_ldf_lap} 
     1027\label{subsec:DYN_ldf_lap} 
    10281028 
    10291029For lateral iso-level diffusion, the discrete operator is:  
    1030 \begin{equation} \label{Eq_dynldf_lap} 
     1030\begin{equation} \label{eq:dynldf_lap} 
    10311031\left\{ \begin{aligned} 
    10321032 D_u^{l{\rm {\bf U}}} =\frac{1}{e_{1u} }\delta _{i+1/2} \left[ {A_T^{lm}  
     
    10401040\end{equation}  
    10411041 
    1042 As explained in \S\ref{PE_ldf}, this formulation (as the gradient of a divergence  
     1042As explained in \autoref{subsec:PE_ldf}, this formulation (as the gradient of a divergence  
    10431043and curl of the vorticity) preserves symmetry and ensures a complete  
    10441044separation between the vorticity and divergence parts of the momentum diffusion.  
     
    10491049\subsection[Rotated laplacian (\protect\np{ln\_dynldf\_iso}\forcode{ = .true.})] 
    10501050            {Rotated laplacian operator (\protect\np{ln\_dynldf\_iso}\forcode{ = .true.})} 
    1051 \label{DYN_ldf_iso} 
     1051\label{subsec:DYN_ldf_iso} 
    10521052 
    10531053A rotation of the lateral momentum diffusion operator is needed in several cases:  
     
    10611061constraints on the stress tensor such as symmetry. The resulting discrete  
    10621062representation is: 
    1063 \begin{equation} \label{Eq_dyn_ldf_iso} 
     1063\begin{equation} \label{eq:dyn_ldf_iso} 
    10641064\begin{split} 
    10651065 D_u^{l\textbf{U}} &= \frac{1}{e_{1u} \, e_{2u} \, e_{3u} } \\ 
     
    11111111diffusion operator acts and the surface of computation ($z$- or $s$-surfaces).  
    11121112The way these slopes are evaluated is given in the lateral physics chapter  
    1113 (Chap.\ref{LDF}). 
     1113(\autoref{chap:LDF}). 
    11141114 
    11151115%-------------------------------------------------------------------------------------------------------------- 
     
    11181118\subsection[Iso-level bilaplacian (\protect\np{ln\_dynldf\_bilap}\forcode{ = .true.})] 
    11191119            {Iso-level bilaplacian operator (\protect\np{ln\_dynldf\_bilap}\forcode{ = .true.})} 
    1120 \label{DYN_ldf_bilap} 
     1120\label{subsec:DYN_ldf_bilap} 
    11211121 
    11221122The lateral fourth order operator formulation on momentum is obtained by  
    1123 applying \eqref{Eq_dynldf_lap} twice. It requires an additional assumption on  
     1123applying \autoref{eq:dynldf_lap} twice. It requires an additional assumption on  
    11241124boundary conditions: the first derivative term normal to the coast depends on  
    11251125the free or no-slip lateral boundary conditions chosen, while the third  
    1126 derivative terms normal to the coast are set to zero (see Chap.\ref{LBC}). 
     1126derivative terms normal to the coast are set to zero (see \autoref{chap:LBC}). 
    11271127%%% 
    11281128\gmcomment{add a remark on the the change in the position of the coefficient} 
     
    11331133% ================================================================ 
    11341134\section{Vertical diffusion term (\protect\mdl{dynzdf})} 
    1135 \label{DYN_zdf} 
     1135\label{sec:DYN_zdf} 
    11361136%----------------------------------------------namzdf------------------------------------------------------ 
    11371137\forfile{../namelists/namzdf}  
     
    11451145scheme (\np{ln\_zdfexp}\forcode{ = .true.}) using a time splitting technique  
    11461146(\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  
     1147(\np{ln\_zdfexp}\forcode{ = .false.}) (see \autoref{chap:STP}). Note that namelist variables  
    11481148\np{ln\_zdfexp} and \np{nn\_zdfexp} apply to both tracers and dynamics.  
    11491149 
    11501150The formulation of the vertical subgrid scale physics is the same whatever  
    11511151the vertical coordinate is. The vertical diffusion operators given by  
    1152 \eqref{Eq_PE_zdf} take the following semi-discrete space form: 
    1153 \begin{equation} \label{Eq_dynzdf} 
     1152\autoref{eq:PE_zdf} take the following semi-discrete space form: 
     1153\begin{equation} \label{eq:dynzdf} 
    11541154\left\{   \begin{aligned} 
    11551155D_u^{vm} &\equiv \frac{1}{e_{3u}} \ \delta _k \left[ \frac{A_{uw}^{vm} }{e_{3uw} } 
     
    11621162where $A_{uw}^{vm} $ and $A_{vw}^{vm} $ are the vertical eddy viscosity and  
    11631163diffusivity coefficients. The way these coefficients are evaluated  
    1164 depends on the vertical physics used (see \S\ref{ZDF}). 
     1164depends on the vertical physics used (see \autoref{chap:ZDF}). 
    11651165 
    11661166The surface boundary condition on momentum is the stress exerted by  
    11671167the wind. At the surface, the momentum fluxes are prescribed as the boundary  
    11681168condition on the vertical turbulent momentum fluxes, 
    1169 \begin{equation} \label{Eq_dynzdf_sbc} 
     1169\begin{equation} \label{eq:dynzdf_sbc} 
    11701170\left.{\left( {\frac{A^{vm} }{e_3 }\ \frac{\partial \textbf{U}_h}{\partial k}} \right)} \right|_{z=1} 
    11711171    = \frac{1}{\rho _o} \binom{\tau _u}{\tau _v } 
     
    11771177is small (when no mixed layer scheme is used) the surface stress enters only  
    11781178the top model level, as a body force. The surface wind stress is calculated  
    1179 in the surface module routines (SBC, see Chap.\ref{SBC}) 
     1179in the surface module routines (SBC, see \autoref{chap:SBC}) 
    11801180 
    11811181The turbulent flux of momentum at the bottom of the ocean is specified through  
    1182 a bottom friction parameterisation (see \S\ref{ZDF_bfr}) 
     1182a bottom friction parameterisation (see \autoref{sec:ZDF_bfr}) 
    11831183 
    11841184% ================================================================ 
     
    11861186% ================================================================ 
    11871187\section{External forcings} 
    1188 \label{DYN_forcing} 
     1188\label{sec:DYN_forcing} 
    11891189 
    11901190Besides the surface and bottom stresses (see the above section) which are  
     
    11921192may enter the dynamical equations by affecting the surface pressure gradient.  
    11931193 
    1194 (1) When \np{ln\_apr\_dyn}\forcode{ = .true.} (see \S\ref{SBC_apr}), the atmospheric pressure is taken  
     1194(1) When \np{ln\_apr\_dyn}\forcode{ = .true.} (see \autoref{sec:SBC_apr}), the atmospheric pressure is taken  
    11951195into account when computing the surface pressure gradient. 
    11961196 
    1197 (2) When \np{ln\_tide\_pot}\forcode{ = .true.} and \np{ln\_tide}\forcode{ = .true.} (see \S\ref{SBC_tide}),  
     1197(2) When \np{ln\_tide\_pot}\forcode{ = .true.} and \np{ln\_tide}\forcode{ = .true.} (see \autoref{sec:SBC_tide}),  
    11981198the tidal potential is taken into account when computing the surface pressure gradient. 
    11991199 
     
    12091209% ================================================================ 
    12101210\section{Time evolution term (\protect\mdl{dynnxt})} 
    1211 \label{DYN_nxt} 
     1211\label{sec:DYN_nxt} 
    12121212 
    12131213%----------------------------------------------namdom---------------------------------------------------- 
     
    12181218The general framework for dynamics time stepping is a leap-frog scheme,  
    12191219$i.e.$ a three level centred time scheme associated with an Asselin time filter  
    1220 (cf. Chap.\ref{STP}). The scheme is applied to the velocity, except when using  
    1221 the flux form of momentum advection (cf. \S\ref{DYN_adv_cor_flux}) in the variable  
     1220(cf. \autoref{chap:STP}). The scheme is applied to the velocity, except when using  
     1221the flux form of momentum advection (cf. \autoref{sec:DYN_adv_cor_flux}) in the variable  
    12221222volume case (\key{vvl} defined), where it has to be applied to the thickness  
    1223 weighted velocity (see \S\ref{Apdx_A_momentum})   
     1223weighted velocity (see \autoref{sec:A_momentum})   
    12241224 
    12251225$\bullet$ vector invariant form or linear free surface (\np{ln\_dynhpg\_vec}\forcode{ = .true.} ; \key{vvl} not defined): 
    1226 \begin{equation} \label{Eq_dynnxt_vec} 
     1226\begin{equation} \label{eq:dynnxt_vec} 
    12271227\left\{   \begin{aligned} 
    12281228&u^{t+\rdt} = u_f^{t-\rdt} + 2\rdt  \ \text{RHS}_u^t     \\ 
     
    12321232 
    12331233$\bullet$ flux form and nonlinear free surface (\np{ln\_dynhpg\_vec}\forcode{ = .false.} ; \key{vvl} defined): 
    1234 \begin{equation} \label{Eq_dynnxt_flux} 
     1234\begin{equation} \label{eq:dynnxt_flux} 
    12351235\left\{   \begin{aligned} 
    12361236&\left(e_{3u}\,u\right)^{t+\rdt} = \left(e_{3u}\,u\right)_f^{t-\rdt} + 2\rdt \; e_{3u} \;\text{RHS}_u^t     \\ 
Note: See TracChangeset for help on using the changeset viewer.