Changeset 11543 for NEMO/trunk/doc/latex/NEMO/subfiles/chap_SBC.tex

Timestamp:

2019-09-13T15:57:52+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Implementation of convention for labelling references + files renaming
Now each reference is supposed to have the information of the chapter in its name
to identify quickly which file contains the reference (\label{$prefix:$chap_...)

Rename the appendices from 'annex_' to 'apdx_' to conform with the prefix used in labels (apdx:...)
Suppress the letter numbering

File:

• NEMO/trunk/doc/latex/NEMO/subfiles/chap_SBC.tex (modified) (34 diffs)

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

@@ -109 +109 @@
 Next, the scheme for interpolation on the fly is described.
 Finally, the different options that further modify the fluxes applied to the ocean are discussed.
-One of these is modification by icebergs (see \autoref{sec:ICB_icebergs}),
+One of these is modification by icebergs (see \autoref{sec:SBC_ICB_icebergs}),
 which act as drifting sources of fresh water.
 Another example of modification is that due to the ice shelf melting/freezing (see \autoref{sec:SBC_isf}),
@@ -124 +124 @@
 The surface ocean stress is the stress exerted by the wind and the sea-ice on the ocean.
 It is applied in \mdl{dynzdf} module as a surface boundary condition of the computation of
-the momentum vertical mixing trend (see \autoref{eq:dynzdf_sbc} in \autoref{sec:DYN_zdf}).
+the momentum vertical mixing trend (see \autoref{eq:DYN_zdf_sbc} in \autoref{sec:DYN_zdf}).
 As such, it has to be provided as a 2D vector interpolated onto the horizontal velocity ocean mesh,
 \ie\ resolved onto the model (\textbf{i},\textbf{j}) direction at $u$- and $v$-points.
@@ -135 +135 @@
 It is applied in \mdl{trasbc} module as a surface boundary condition trend of
 the first level temperature time evolution equation
-(see \autoref{eq:tra_sbc} and \autoref{eq:tra_sbc_lin} in \autoref{subsec:TRA_sbc}).
+(see \autoref{eq:TRA_sbc} and \autoref{eq:TRA_sbc_lin} in \autoref{subsec:TRA_sbc}).
 The latter is the penetrative part of the heat flux.
 It is applied as a 3D trend of the temperature equation (\mdl{traqsr} module) when
@@ -177 +177 @@
 The ocean model provides, at each time step, to the surface module (\mdl{sbcmod})
 the surface currents, temperature and salinity.
-These variables are averaged over \np{nn\_fsbc} time-step (\autoref{tab:ssm}), and
+These variables are averaged over \np{nn\_fsbc} time-step (\autoref{tab:SBC_ssm}), and
 these averaged fields are used to compute the surface fluxes at the frequency of \np{nn\_fsbc} time-steps.
 
@@ -193 +193 @@
     \end{tabular}
     \caption{
-      \protect\label{tab:ssm}
+      \protect\label{tab:SBC_ssm}
       Ocean variables provided by the ocean to the surface module (SBC).
       The variable are averaged over \np{nn\_fsbc} time-step,
@@ -264 +264 @@
   This stem will be completed automatically by the model, with the addition of a '.nc' at its end and
   by date information and possibly a prefix (when using AGRIF).
-  \autoref{tab:fldread} provides the resulting file name in all possible cases according to
+  \autoref{tab:SBC_fldread} provides the resulting file name in all possible cases according to
   whether it is a climatological file or not, and to the open/close frequency (see below for definition).
 
@@ -278 +278 @@
     \end{center}
     \caption{
-      \protect\label{tab:fldread}
+      \protect\label{tab:SBC_fldread}
       naming nomenclature for climatological or interannual input file(s), as a function of the open/close frequency.
       The stem name is assumed to be 'fn'.
@@ -515 +515 @@
 % -------------------------------------------------------------------------------------------------------------
 \subsection{Standalone surface boundary condition scheme (SAS)}
-\label{subsec:SAS}
+\label{subsec:SBC_SAS}
 
 %---------------------------------------namsbc_sas--------------------------------------------------
@@ -649 +649 @@
 %--------------------------------------------------TABLE--------------------------------------------------
 \begin{table}[htbp]
-  \label{tab:BULK}
+  \label{tab:SBC_BULK}
   \begin{center}
     \begin{tabular}{|l|c|c|c|}
@@ -852 +852 @@
 The tidal forcing, generated by the gravity forces of the Earth-Moon and Earth-Sun sytems,
 is activated if \np{ln\_tide} and \np{ln\_tide\_pot} are both set to \forcode{.true.} in \nam{\_tide}.
-This translates as an additional barotropic force in the momentum equations \ref{eq:PE_dyn} such that:
-\[
-  % \label{eq:PE_dyn_tides}
+This translates as an additional barotropic force in the momentum \autoref{eq:MB_PE_dyn} such that:
+\[
+  % \label{eq:SBC_PE_dyn_tides}
   \frac{\partial {\mathrm {\mathbf U}}_h }{\partial t}= ...
   +g\nabla (\Pi_{eq} + \Pi_{sal})
@@ -895 +895 @@
 %        River runoffs
 % ================================================================
-\section[River runoffs (\textit{sbcrnf.F90})]
-{River runoffs (\protect\mdl{sbcrnf})}
+\section[River runoffs (\textit{sbcrnf.F90})]{River runoffs (\protect\mdl{sbcrnf})}
 \label{sec:SBC_rnf}
 %------------------------------------------namsbc_rnf----------------------------------------------------
@@ -1022 +1021 @@
 %        Ice shelf melting
 % ================================================================
-\section[Ice shelf melting (\textit{sbcisf.F90})]
-{Ice shelf melting (\protect\mdl{sbcisf})}
+\section[Ice shelf melting (\textit{sbcisf.F90})]{Ice shelf melting (\protect\mdl{sbcisf})}
 \label{sec:SBC_isf}
 %------------------------------------------namsbc_isf----------------------------------------------------
@@ -1066 +1064 @@
      The salt and heat exchange coefficients are constant and defined by \np{rn\_gammas0} and \np{rn\_gammat0}.
 \[
-  % \label{eq:sbc_isf_gamma_iso}
+  % \label{eq:SBC_isf_gamma_iso}
 \gamma^{T} = \np{rn\_gammat0}
 \]
@@ -1213 +1211 @@
 % ================================================================
 \section{Handling of icebergs (ICB)}
-\label{sec:ICB_icebergs}
+\label{sec:SBC_ICB_icebergs}
 %------------------------------------------namberg----------------------------------------------------
 
@@ -1282 +1280 @@
 %        Interactions with waves (sbcwave.F90, ln_wave)
 % =============================================================================================================
-\section[Interactions with waves (\textit{sbcwave.F90}, \texttt{ln\_wave})]
-{Interactions with waves (\protect\mdl{sbcwave}, \protect\np{ln\_wave})}
+\section[Interactions with waves (\textit{sbcwave.F90}, \texttt{ln\_wave})]{Interactions with waves (\protect\mdl{sbcwave}, \protect\np{ln\_wave})}
 \label{sec:SBC_wave}
 %------------------------------------------namsbc_wave--------------------------------------------------------
@@ -1314 +1311 @@
 
 % ----------------------------------------------------------------
-\subsection[Neutral drag coefficient from wave model (\texttt{ln\_cdgw})]
-{Neutral drag coefficient from wave model (\protect\np{ln\_cdgw})}
+\subsection[Neutral drag coefficient from wave model (\texttt{ln\_cdgw})]{Neutral drag coefficient from wave model (\protect\np{ln\_cdgw})}
 \label{subsec:SBC_wave_cdgw}
 
@@ -1328 +1324 @@
 % 3D Stokes Drift (ln_sdw, nn_sdrift)
 % ----------------------------------------------------------------
-\subsection[3D Stokes Drift (\texttt{ln\_sdw}, \texttt{nn\_sdrift})]
-{3D Stokes Drift (\protect\np{ln\_sdw, nn\_sdrift})}
+\subsection[3D Stokes Drift (\texttt{ln\_sdw}, \texttt{nn\_sdrift})]{3D Stokes Drift (\protect\np{ln\_sdw, nn\_sdrift})}
 \label{subsec:SBC_wave_sdw}
 
@@ -1343 +1338 @@
 
 \[
-  % \label{eq:sbc_wave_sdw}
+  % \label{eq:SBC_wave_sdw}
   \mathbf{U}_{st} = \frac{16{\pi^3}} {g}
   \int_0^\infty \int_{-\pi}^{\pi} (cos{\theta},sin{\theta}) {f^3}
@@ -1368 +1363 @@
 
 \[
-  % \label{eq:sbc_wave_sdw_0a}
+  % \label{eq:SBC_wave_sdw_0a}
   \mathbf{U}_{st} \cong \mathbf{U}_{st |_{z=0}} \frac{\mathrm{e}^{-2k_ez}} {1-8k_ez}
 \]
@@ -1375 +1370 @@
 
 \[
-  % \label{eq:sbc_wave_sdw_0b}
+  % \label{eq:SBC_wave_sdw_0b}
   k_e = \frac{|\mathbf{U}_{\left.st\right|_{z=0}}|} {|T_{st}|}
   \quad \text{and }\
@@ -1388 +1383 @@
 
 \[
-  % \label{eq:sbc_wave_sdw_1}
+  % \label{eq:SBC_wave_sdw_1}
   \mathbf{U}_{st} \cong \mathbf{U}_{st |_{z=0}} \Big[exp(2k_pz)-\beta \sqrt{-2 \pi k_pz}
   \textit{ erf } \Big(\sqrt{-2 k_pz}\Big)\Big]
@@ -1404 +1399 @@
 
 \[
-  % \label{eq:sbc_wave_eta_sdw}
+  % \label{eq:SBC_wave_eta_sdw}
   \frac{\partial{\eta}}{\partial{t}} =
   -\nabla_h \int_{-H}^{\eta} (\mathbf{U} + \mathbf{U}_{st}) dz
@@ -1416 +1411 @@
 
 \[
-  % \label{eq:sbc_wave_tra_sdw}
+  % \label{eq:SBC_wave_tra_sdw}
   \frac{\partial{c}}{\partial{t}} =
   - (\mathbf{U} + \mathbf{U}_{st}) \cdot \nabla{c}
@@ -1425 +1420 @@
 % Stokes-Coriolis term (ln_stcor)
 % ----------------------------------------------------------------
-\subsection[Stokes-Coriolis term (\texttt{ln\_stcor})]
-{Stokes-Coriolis term (\protect\np{ln\_stcor})}
+\subsection[Stokes-Coriolis term (\texttt{ln\_stcor})]{Stokes-Coriolis term (\protect\np{ln\_stcor})}
 \label{subsec:SBC_wave_stcor}
 
@@ -1440 +1434 @@
 % Waves modified stress (ln_tauwoc, ln_tauw)
 % ----------------------------------------------------------------
-\subsection[Wave modified stress (\texttt{ln\_tauwoc}, \texttt{ln\_tauw})]
-{Wave modified sress (\protect\np{ln\_tauwoc, ln\_tauw})}
+\subsection[Wave modified stress (\texttt{ln\_tauwoc}, \texttt{ln\_tauw})]{Wave modified sress (\protect\np{ln\_tauwoc, ln\_tauw})}
 \label{subsec:SBC_wave_tauw}
 
@@ -1453 +1446 @@
 
 \[
-  % \label{eq:sbc_wave_tauoc}
+  % \label{eq:SBC_wave_tauoc}
   \tau_{oc,a} = \tau_a - \tau_w
 \]
@@ -1461 +1454 @@
 
 \[
-  % \label{eq:sbc_wave_tauw}
+  % \label{eq:SBC_wave_tauw}
   \tau_w = \rho g \int {\frac{dk}{c_p} (S_{in}+S_{nl}+S_{diss})}
 \]
@@ -1490 +1483 @@
 %        Diurnal cycle
 % -------------------------------------------------------------------------------------------------------------
-\subsection[Diurnal cycle (\textit{sbcdcy.F90})]
-{Diurnal cycle (\protect\mdl{sbcdcy})}
+\subsection[Diurnal cycle (\textit{sbcdcy.F90})]{Diurnal cycle (\protect\mdl{sbcdcy})}
 \label{subsec:SBC_dcy}
 %------------------------------------------namsbc-------------------------------------------------------------
@@ -1577 +1569 @@
 %        Surface restoring to observed SST and/or SSS
 % -------------------------------------------------------------------------------------------------------------
-\subsection[Surface restoring to observed SST and/or SSS (\textit{sbcssr.F90})]
-{Surface restoring to observed SST and/or SSS (\protect\mdl{sbcssr})}
+\subsection[Surface restoring to observed SST and/or SSS (\textit{sbcssr.F90})]{Surface restoring to observed SST and/or SSS (\protect\mdl{sbcssr})}
 \label{subsec:SBC_ssr}
 %------------------------------------------namsbc_ssr----------------------------------------------------
@@ -1589 +1580 @@
 a feedback term \emph{must} be added to the surface heat flux $Q_{ns}^o$:
 \[
-  % \label{eq:sbc_dmp_q}
+  % \label{eq:SBC_dmp_q}
   Q_{ns} = Q_{ns}^o + \frac{dQ}{dT} \left( \left. T \right|_{k=1} - SST_{Obs} \right)
 \]
@@ -1602 +1593 @@
 
 \begin{equation}
-  \label{eq:sbc_dmp_emp}
+  \label{eq:SBC_dmp_emp}
   \textit{emp} = \textit{emp}_o + \gamma_s^{-1} e_{3t}  \frac{  \left(\left.S\right|_{k=1}-SSS_{Obs}\right)}
   {\left.S\right|_{k=1}}
@@ -1613 +1604 @@
 $\left.S\right|_{k=1}$ is the model surface layer salinity and
 $\gamma_s$ is a negative feedback coefficient which is provided as a namelist parameter.
-Unlike heat flux, there is no physical justification for the feedback term in \autoref{eq:sbc_dmp_emp} as
+Unlike heat flux, there is no physical justification for the feedback term in \autoref{eq:SBC_dmp_emp} as
 the atmosphere does not care about ocean surface salinity \citep{madec.delecluse_IWN97}.
 The SSS restoring term should be viewed as a flux correction on freshwater fluxes to
@@ -1663 +1654 @@
 %        CICE-ocean Interface
 % -------------------------------------------------------------------------------------------------------------
-\subsection[Interface to CICE (\textit{sbcice\_cice.F90})]
-{Interface to CICE (\protect\mdl{sbcice\_cice})}
+\subsection[Interface to CICE (\textit{sbcice\_cice.F90})]{Interface to CICE (\protect\mdl{sbcice\_cice})}
 \label{subsec:SBC_cice}
 
@@ -1698 +1688 @@
 %        Freshwater budget control
 % -------------------------------------------------------------------------------------------------------------
-\subsection[Freshwater budget control (\textit{sbcfwb.F90})]
-{Freshwater budget control (\protect\mdl{sbcfwb})}
+\subsection[Freshwater budget control (\textit{sbcfwb.F90})]{Freshwater budget control (\protect\mdl{sbcfwb})}
 \label{subsec:SBC_fwb}