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

Timestamp:

2019-09-25T19:06:37+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Application of some coding rules

• Replace comments before sectioning cmds by a single line of 100 characters long to display when every line should break
• Replace multi blank lines by one single blank line
• For list environment, put \item, label and content on the same line
• Remove \newpage and comments line around figure envs

File:

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

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

@@ -3 +3 @@
 \begin{document}
 
-% ================================================================
-% Chapter Lateral Ocean Physics (LDF)
-% ================================================================
 \chapter{Lateral Ocean Physics (LDF)}
 \label{chap:LDF}
 
 \chaptertoc
-
-\newpage
 
 The lateral physics terms in the momentum and tracer equations have been described in \autoref{eq:MB_zdf} and
@@ -31 +26 @@
 %--------------------------------------------------------------------------------------------------------------
 
-% ================================================================
-% Lateral Mixing Operator
-% ================================================================
 \section[Lateral mixing operators]{Lateral mixing operators}
 \label{sec:LDF_op}
@@ -55 +47 @@
 We stress again that from \NEMO\ 4, the simultaneous use Laplacian and Bilaplacian operators is not allowed.
 
-% ================================================================
-% Direction of lateral Mixing
-% ================================================================
 \section[Direction of lateral mixing (\textit{ldfslp.F90})]{Direction of lateral mixing (\protect\mdl{ldfslp})}
 \label{sec:LDF_slp}
@@ -151 +140 @@
 \begin{description}
 
-\item[$z$-coordinate with full step: ]
+\item [$z$-coordinate with full step: ]
   in \autoref{eq:LDF_slp_iso} the densities appearing in the $i$ and $j$ derivatives  are taken at the same depth,
   thus the $in situ$ density can be used.
@@ -158 +147 @@
   (see \autoref{subsec:TRA_bn2}).
 
-\item[$z$-coordinate with partial step: ]
+\item [$z$-coordinate with partial step: ]
   this case is identical to the full step case except that at partial step level,
   the \emph{horizontal} density gradient is evaluated as described in \autoref{sec:TRA_zpshde}.
 
-\item[$s$- or hybrid $s$-$z$- coordinate: ]
+\item [$s$- or hybrid $s$-$z$- coordinate: ]
   in the current release of \NEMO, iso-neutral mixing is only employed for $s$-coordinates if
   the Griffies scheme is used (\np[=.true.]{ln_traldf_triad}{ln\_traldf\_triad};
@@ -234 +223 @@
 contrary to the \citet{griffies.gnanadesikan.ea_JPO98} operator which has that property.
 
-%>>>>>>>>>>>>>>>>>>>>>>>>>>>>
 \begin{figure}[!ht]
   \centering
@@ -241 +229 @@
   \label{fig:LDF_ZDF1}
 \end{figure}
-%>>>>>>>>>>>>>>>>>>>>>>>>>>>>
 
 %There are three additional questions about the slope calculation.
@@ -249 +236 @@
 
 %from griffies: chapter 13.1....
-
-
 
 % In addition and also for numerical stability reasons \citep{cox_OM87, griffies_bk04},
@@ -264 +249 @@
 \colorbox{yellow}{The way slopes are tapered has be checked. Not sure that this is still what is actually done.}
 
-%>>>>>>>>>>>>>>>>>>>>>>>>>>>>
 \begin{figure}[!ht]
   \centering
@@ -286 +270 @@
   \label{fig:LDF_eiv_slp}
 \end{figure}
-%>>>>>>>>>>>>>>>>>>>>>>>>>>>>
 
 \colorbox{yellow}{add here a discussion about the flattening of the slopes, vs tapering the coefficient.}
@@ -316 +299 @@
 (see \autoref{sec:LBC_coast}).
 
-
-% ================================================================
-% Lateral Mixing Coefficients
-% ================================================================
 \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}
@@ -467 +446 @@
 (\autoref{sec:INVARIANTS_dynldf_properties}).
 
-% ================================================================
-% Eddy Induced Mixing
-% ================================================================
 \section[Eddy induced velocity (\forcode{ln_ldfeiv})]{Eddy induced velocity (\protect\np{ln_ldfeiv}{ln\_ldfeiv})}
 
@@ -483 +459 @@
 
 %--------------------------------------------------------------------------------------------------------------
-
 
 %%gm  from Triad appendix  : to be incorporated....
@@ -538 +513 @@
 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}.
 
-% ================================================================
-% Mixed layer eddies
-% ================================================================
 \section[Mixed layer eddies (\forcode{ln_mle})]{Mixed layer eddies (\protect\np{ln_mle}{ln\_mle})}
 \label{sec:LDF_mle}