Changeset 11596 for NEMO/trunk/doc/latex/NEMO/subfiles/chap_cfgs.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_cfgs.tex (modified) (14 diffs)

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

@@ -2 +2 @@
 
 \begin{document}
-% ================================================================
-% Chapter Configurations
-% ================================================================
 \chapter{Configurations}
 \label{chap:CFGS}
@@ -10 +7 @@
 \chaptertoc
 
-\newpage
-
-% ================================================================
-% Introduction
-% ================================================================
 \section{Introduction}
 \label{sec:CFGS_intro}
@@ -35 +27 @@
 %-------------------------------------------------------------------------------------------------------------
 
-% ================================================================
-% 1D model configuration
-% ================================================================
 \section[C1D: 1D Water column model (\texttt{\textbf{key\_c1d}})]{C1D: 1D Water column model (\protect\key{c1d})}
 \label{sec:CFGS_c1d}
@@ -60 +49 @@
 Therefore, defining \key{c1d} changes some things in the code behaviour:
 \begin{description}
-\item[(1)]
+\item [(1)]
   a simplified \rou{stp} routine is used (\rou{stp\_c1d}, see \mdl{step\_c1d} module) in which
   both lateral tendancy terms and lateral physics are not called;
-\item[(2)]
+\item [(2)]
   the vertical velocity is zero
   (so far, no attempt at introducing a Ekman pumping velocity has been made);
-\item[(3)]
+\item [(3)]
   a simplified treatment of the Coriolis term is performed as $U$- and $V$-points are the same
   (see \mdl{dyncor\_c1d}).
@@ -75 +64 @@
 % to be added:  a test case on the yearlong Ocean Weather Station (OWS) Papa dataset of Martin (1985)
 
-% ================================================================
-% ORCA family configurations
-% ================================================================
 \section{ORCA family: global ocean with tripolar grid}
 \label{sec:CFGS_orca}
@@ -90 +76 @@
 In this namelist\_cfg the name of domain input file is set in \nam{cfg}{cfg} block of namelist.
 
-%>>>>>>>>>>>>>>>>>>>>>>>>>>>>
 \begin{figure}[!t]
   \centering
@@ -104 +89 @@
   \label{fig:CFGS_ORCA_msh}
 \end{figure}
-%>>>>>>>>>>>>>>>>>>>>>>>>>>>>
-
-% -------------------------------------------------------------------------------------------------------------
-%       ORCA tripolar grid
-% -------------------------------------------------------------------------------------------------------------
+
 \subsection{ORCA tripolar grid}
 \label{subsec:CFGS_orca_grid}
@@ -121 +102 @@
 The resulting mesh presents no loss of continuity in either the mesh lines or the scale factors,
 or even the scale factor derivatives over the whole ocean domain, as the mesh is not a composite mesh.
-%>>>>>>>>>>>>>>>>>>>>>>>>>>>>
 \begin{figure}[!tbp]
   \centering
@@ -136 +116 @@
   \label{fig:CFGS_ORCA_e1e2}
 \end{figure}
-%>>>>>>>>>>>>>>>>>>>>>>>>>>>>
 
 The method is applied to Mercator grid (\ie\ same zonal and meridional grid spacing) poleward of 20\deg{N},
@@ -149 +128 @@
 while the ratio of anisotropy remains close to one except near the Victoria Island in the Canadian Archipelago.
 
-% -------------------------------------------------------------------------------------------------------------
-%       ORCA-ICE(-PISCES) configurations
-% -------------------------------------------------------------------------------------------------------------
 \subsection{ORCA pre-defined resolution}
 \label{subsec:CFGS_orca_resolution}
@@ -182 +158 @@
 %--------------------------------------------------------------------------------------------------------------
 
-
 The ORCA\_R2 configuration has the following specificity: starting from a 2\deg\ ORCA mesh,
 local mesh refinements were applied to the Mediterranean, Red, Black and Caspian Seas,
@@ -221 +196 @@
 sponge layers at open boundaries.
 
-% -------------------------------------------------------------------------------------------------------------
-%       GYRE family: double gyre basin
-% -------------------------------------------------------------------------------------------------------------
 \section{GYRE family: double gyre basin}
 \label{sec:CFGS_gyre}
@@ -274 +246 @@
 namelist \path{./cfgs/GYRE_PISCES/EXPREF/namelist_cfg}.
 
-%>>>>>>>>>>>>>>>>>>>>>>>>>>>>
 \begin{figure}[!t]
   \centering
@@ -283 +254 @@
   \label{fig:CFGS_GYRE}
 \end{figure}
-%>>>>>>>>>>>>>>>>>>>>>>>>>>>>
-
-% -------------------------------------------------------------------------------------------------------------
-%       AMM configuration
-% -------------------------------------------------------------------------------------------------------------
+
 \section{AMM: atlantic margin configuration}
 \label{sec:CFGS_config_AMM}