Changeset 11597 for NEMO/trunk/doc/latex/NEMO/subfiles/chap_LDF.tex

Timestamp:

2019-09-25T20:20:19+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Continuation of coding rules application
Recovery of some sections deleted by the previous commit

File:

• NEMO/trunk/doc/latex/NEMO/subfiles/chap_LDF.tex (modified) (21 diffs)

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

@@ -22 +22 @@
 is described in \autoref{apdx:TRIADS}
 
-%-----------------------------------namtra_ldf - namdyn_ldf--------------------------------------------
-
-%--------------------------------------------------------------------------------------------------------------
-
+
+
+%% =================================================================================================
 \section[Lateral mixing operators]{Lateral mixing operators}
 \label{sec:LDF_op}
 We remind here the different lateral mixing operators that can be used. Further details can be found in \autoref{subsec:TRA_ldf_op} and  \autoref{sec:DYN_ldf}.
 
+%% =================================================================================================
 \subsection[No lateral mixing (\forcode{ln_traldf_OFF} \& \forcode{ln_dynldf_OFF})]{No lateral mixing (\protect\np{ln_traldf_OFF}{ln\_traldf\_OFF} \& \protect\np{ln_dynldf_OFF}{ln\_dynldf\_OFF})}
 
@@ -37 +37 @@
 see \autoref{subsec:DYN_adv_ubs}) and can be useful for testing purposes.
 
+%% =================================================================================================
 \subsection[Laplacian mixing (\forcode{ln_traldf_lap} \& \forcode{ln_dynldf_lap})]{Laplacian mixing (\protect\np{ln_traldf_lap}{ln\_traldf\_lap} \& \protect\np{ln_dynldf_lap}{ln\_dynldf\_lap})}
 Setting \protect\np[=.true.]{ln_traldf_lap}{ln\_traldf\_lap} and/or \protect\np[=.true.]{ln_dynldf_lap}{ln\_dynldf\_lap} enables
@@ -42 +43 @@
 Laplacian and Bilaplacian operators for the same variable.
 
+%% =================================================================================================
 \subsection[Bilaplacian mixing (\forcode{ln_traldf_blp} \& \forcode{ln_dynldf_blp})]{Bilaplacian mixing (\protect\np{ln_traldf_blp}{ln\_traldf\_blp} \& \protect\np{ln_dynldf_blp}{ln\_dynldf\_blp})}
 Setting \protect\np[=.true.]{ln_traldf_blp}{ln\_traldf\_blp} and/or \protect\np[=.true.]{ln_dynldf_blp}{ln\_dynldf\_blp} enables
@@ -47 +49 @@
 We stress again that from \NEMO\ 4, the simultaneous use Laplacian and Bilaplacian operators is not allowed.
 
+%% =================================================================================================
 \section[Direction of lateral mixing (\textit{ldfslp.F90})]{Direction of lateral mixing (\protect\mdl{ldfslp})}
 \label{sec:LDF_slp}
@@ -69 +72 @@
 %gm% add here afigure of the slope in i-direction
 
+%% =================================================================================================
 \subsection{Slopes for tracer geopotential mixing in the $s$-coordinate}
 
@@ -99 +103 @@
 and either \np[=.true.]{ln_traldf_hor}{ln\_traldf\_hor} or \np[=.true.]{ln_dynldf_hor}{ln\_dynldf\_hor}.
 
+%% =================================================================================================
 \subsection{Slopes for tracer iso-neutral mixing}
 \label{subsec:LDF_slp_iso}
@@ -273 +278 @@
 \colorbox{yellow}{add here a discussion about the flattening of the slopes, vs tapering the coefficient.}
 
+%% =================================================================================================
 \subsection{Slopes for momentum iso-neutral mixing}
 
@@ -299 +305 @@
 (see \autoref{sec:LBC_coast}).
 
+%% =================================================================================================
 \section[Lateral mixing coefficient (\forcode{nn_aht_ijk_t} \& \forcode{nn_ahm_ijk_t})]{Lateral mixing coefficient (\protect\np{nn_aht_ijk_t}{nn\_aht\_ijk\_t} \& \protect\np{nn_ahm_ijk_t}{nn\_ahm\_ijk\_t})}
 \label{sec:LDF_coef}
@@ -305 +312 @@
 The way the mixing coefficients are set in the reference version can be described as follows:
 
+%% =================================================================================================
 \subsection[Mixing coefficients read from file (\forcode{=-20, -30})]{ Mixing coefficients read from file (\protect\np[=-20, -30]{nn_aht_ijk_t}{nn\_aht\_ijk\_t} \& \protect\np[=-20, -30]{nn_ahm_ijk_t}{nn\_ahm\_ijk\_t})}
 
@@ -313 +321 @@
 The provided fields can either be 2d (\np[=-20]{nn_aht_ijk_t}{nn\_aht\_ijk\_t}, \np[=-20]{nn_ahm_ijk_t}{nn\_ahm\_ijk\_t}) or 3d (\np[=-30]{nn_aht_ijk_t}{nn\_aht\_ijk\_t},  \np[=-30]{nn_ahm_ijk_t}{nn\_ahm\_ijk\_t}). They must be given at U, V points for tracers and T, F points for momentum (see \autoref{tab:LDF_files}).
 
-%-------------------------------------------------TABLE---------------------------------------------------
 \begin{table}[htb]
   \centering
@@ -327 +334 @@
   \label{tab:LDF_files}
 \end{table}
-%--------------------------------------------------------------------------------------------------------------
-
+
+%% =================================================================================================
 \subsection[Constant mixing coefficients (\forcode{=0})]{ Constant mixing coefficients (\protect\np[=0]{nn_aht_ijk_t}{nn\_aht\_ijk\_t} \& \protect\np[=0]{nn_ahm_ijk_t}{nn\_ahm\_ijk\_t})}
 
@@ -345 +352 @@
  $U_{scl}$ and $L_{scl}$ are given by the namelist parameters \np{rn_Ud}{rn\_Ud}, \np{rn_Uv}{rn\_Uv}, \np{rn_Ld}{rn\_Ld} and \np{rn_Lv}{rn\_Lv}.
 
+%% =================================================================================================
 \subsection[Vertically varying mixing coefficients (\forcode{=10})]{Vertically varying mixing coefficients (\protect\np[=10]{nn_aht_ijk_t}{nn\_aht\_ijk\_t} \& \protect\np[=10]{nn_ahm_ijk_t}{nn\_ahm\_ijk\_t})}
 
@@ -352 +360 @@
 This profile is hard coded in module \mdl{ldfc1d\_c2d}, but can be easily modified by users.
 
+%% =================================================================================================
 \subsection[Mesh size dependent mixing coefficients (\forcode{=20})]{Mesh size dependent mixing coefficients (\protect\np[=20]{nn_aht_ijk_t}{nn\_aht\_ijk\_t} \& \protect\np[=20]{nn_ahm_ijk_t}{nn\_ahm\_ijk\_t})}
 
@@ -377 +386 @@
 \colorbox{yellow}{CASE \np{nn_aht_ijk_t}{nn\_aht\_ijk\_t} = 21 to be added}
 
+%% =================================================================================================
 \subsection[Mesh size and depth dependent mixing coefficients (\forcode{=30})]{Mesh size and depth dependent mixing coefficients (\protect\np[=30]{nn_aht_ijk_t}{nn\_aht\_ijk\_t} \& \protect\np[=30]{nn_ahm_ijk_t}{nn\_ahm\_ijk\_t})}
 
@@ -383 +393 @@
 the magnitude of the coefficient.
 
+%% =================================================================================================
 \subsection[Velocity dependent mixing coefficients (\forcode{=31})]{Flow dependent mixing coefficients (\protect\np[=31]{nn_aht_ijk_t}{nn\_aht\_ijk\_t} \& \protect\np[=31]{nn_ahm_ijk_t}{nn\_ahm\_ijk\_t})}
 In that case, the eddy coefficient is proportional to the local velocity magnitude so that the Reynolds number $Re =  \lvert U \rvert  e / A_l$ is constant (and here hardcoded to $12$):
@@ -397 +408 @@
 \end{equation}
 
+%% =================================================================================================
 \subsection[Deformation rate dependent viscosities (\forcode{nn_ahm_ijk_t=32})]{Deformation rate dependent viscosities (\protect\np[=32]{nn_ahm_ijk_t}{nn\_ahm\_ijk\_t})}
 
@@ -433 +445 @@
 where $C_{min}$ and $C_{max}$ are adimensional namelist parameters given by \np{rn_minfac}{rn\_minfac} and \np{rn_maxfac}{rn\_maxfac} respectively.
 
+%% =================================================================================================
 \subsection{About space and time varying mixing coefficients}
 
@@ -446 +459 @@
 (\autoref{sec:INVARIANTS_dynldf_properties}).
 
+%% =================================================================================================
 \section[Eddy induced velocity (\forcode{ln_ldfeiv})]{Eddy induced velocity (\protect\np{ln_ldfeiv}{ln\_ldfeiv})}
 
 \label{sec:LDF_eiv}
 
-%--------------------------------------------namtra_eiv---------------------------------------------------
 
 \begin{listing}
@@ -458 +471 @@
 \end{listing}
 
-%--------------------------------------------------------------------------------------------------------------
 
 %%gm  from Triad appendix  : to be incorporated....
@@ -513 +525 @@
 In case of setting \np[=.true.]{ln_traldf_triad}{ln\_traldf\_triad}, a skew form of the eddy induced advective fluxes is used, which is described in \autoref{apdx:TRIADS}.
 
+%% =================================================================================================
 \section[Mixed layer eddies (\forcode{ln_mle})]{Mixed layer eddies (\protect\np{ln_mle}{ln\_mle})}
 \label{sec:LDF_mle}
 
-%--------------------------------------------namtra_eiv---------------------------------------------------
 
 \begin{listing}
@@ -524 +536 @@
 \end{listing}
 
-%--------------------------------------------------------------------------------------------------------------
 
 If  \np[=.true.]{ln_mle}{ln\_mle} in \nam{tra_mle}{tra\_mle} namelist, a parameterization of the mixing due to unresolved mixed layer instabilities is activated (\citet{foxkemper.ferrari_JPO08}). Additional transport is computed in \rou{ldf\_mle\_trp} and added to the eulerian transport in \rou{tra\_adv} as done for eddy induced advection.