Changeset 11596 for NEMO/trunk/doc/latex/NEMO/subfiles/chap_misc.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_misc.tex (modified) (17 diffs)

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

@@ -2 +2 @@
 
 \begin{document}
-% ================================================================
-% Chapter --- Miscellaneous Topics
-% ================================================================
 \chapter{Miscellaneous Topics}
 \label{chap:MISC}
@@ -10 +7 @@
 \chaptertoc
 
-\newpage
-
-% ================================================================
-% Representation of Unresolved Straits
-% ================================================================
 \section{Representation of unresolved straits}
 \label{sec:MISC_strait}
@@ -36 +28 @@
 lateral friction.
 
-% -------------------------------------------------------------------------------------------------------------
-%       Hand made geometry changes
-% -------------------------------------------------------------------------------------------------------------
 \subsection{Hand made geometry changes}
 \label{subsec:MISC_strait_hand}
@@ -83 +72 @@
 \texttt{fmask} for any other configuration.
 
-%>>>>>>>>>>>>>>>>>>>>>>>>>>>>
 \begin{figure}[!tbp]
   \centering
@@ -100 +88 @@
   \label{fig:MISC_strait_hand}
 \end{figure}
-%>>>>>>>>>>>>>>>>>>>>>>>>>>>>
-
-%>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+
 \begin{figure}[!tbp]
   \centering
@@ -116 +102 @@
   \label{fig:MISC_closea_mask_example}
 \end{figure}
-%>>>>>>>>>>>>>>>>>>>>>>>>>>>>
-
-% ================================================================
-% Closed seas
-% ================================================================
+
 \section[Closed seas (\textit{closea.F90})]{Closed seas (\protect\mdl{closea})}
 \label{sec:MISC_closea}
@@ -141 +123 @@
 
 \begin{enumerate}
-\item{{\bfseries No ``closea\_mask'' field is included in domain configuration
+\item {{\bfseries No ``closea\_mask'' field is included in domain configuration
   file.} In this case the closea module does nothing.}
 
-\item{{\bfseries A field called closea\_mask is included in the domain
+\item {{\bfseries A field called closea\_mask is included in the domain
 configuration file and ln\_closea=.false. in namelist namcfg.} In this
 case the inland seas defined by the closea\_mask field are filled in
@@ -150 +132 @@
 closea\_mask that is nonzero is set to be a land point.}
 
-\item{{\bfseries A field called closea\_mask is included in the domain
+\item {{\bfseries A field called closea\_mask is included in the domain
 configuration file and ln\_closea=.true. in namelist namcfg.} Each
 inland sea or group of inland seas is set to a positive integer value
@@ -159 +141 @@
 closea\_mask is zero).}
 
-\item{{\bfseries Fields called closea\_mask and closea\_mask\_rnf are
+\item {{\bfseries Fields called closea\_mask and closea\_mask\_rnf are
 included in the domain configuration file and ln\_closea=.true. in
 namelist namcfg.} This option works as for option 3, except that if
@@ -173 +155 @@
 ocean.}
 
-\item{{\bfseries Fields called closea\_mask and closea\_mask\_emp are
+\item {{\bfseries Fields called closea\_mask and closea\_mask\_emp are
 included in the domain configuration file and ln\_closea=.true. in
 namelist namcfg.} This option works the same as option 4 except that
@@ -185 +167 @@
 them to the domain configuration file in the utils/tools/DOMAINcfg directory.
 
-% ================================================================
-% Sub-Domain Functionality
-% ================================================================
 \section{Sub-domain functionality}
 \label{sec:MISC_zoom}
@@ -213 +192 @@
 
 \begin{itemize}
-\item  Add the new attribute to any input files requiring a j-row offset, i.e:
+\item Add the new attribute to any input files requiring a j-row offset, i.e:
 \begin{cmds}
 ncatted  -a open_ocean_jstart,global,a,d,41 eORCA1_domcfg.nc
@@ -251 +230 @@
 conditions. Experimenting with this remains an exercise for the user.
 
-% ================================================================
-% Accuracy and Reproducibility
-% ================================================================
 \section[Accuracy and reproducibility (\textit{lib\_fortran.F90})]{Accuracy and reproducibility (\protect\mdl{lib\_fortran})}
 \label{sec:MISC_fortran}
@@ -281 +257 @@
 We use a CPP key as the overwritting of a intrinsic function can present performance issues with
 some computers/compilers.
-
 
 \subsection{MPP reproducibility}
@@ -336 +311 @@
 non-reference configuration.
 
-% ================================================================
-% Model optimisation, Control Print and Benchmark
-% ================================================================
 \section{Model optimisation, control print and benchmark}
 \label{sec:MISC_opt}
@@ -367 +339 @@
 
 \begin{enumerate}
-\item{\np{ln_ctl}{ln\_ctl}: compute and print the trends averaged over the interior domain in all TRA, DYN, LDF and
+\item {\np{ln_ctl}{ln\_ctl}: compute and print the trends averaged over the interior domain in all TRA, DYN, LDF and
 ZDF modules.
 This option is very helpful when diagnosing the origin of an undesired change in model results. }
 
-\item{also \np{ln_ctl}{ln\_ctl} but using the nictl and njctl namelist parameters to check the source of differences between
+\item {also \np{ln_ctl}{ln\_ctl} but using the nictl and njctl namelist parameters to check the source of differences between
 mono and multi processor runs.}
 \end{enumerate}
@@ -415 +387 @@
 increment also applies to the time.step file which is otherwise updated every timestep.
 
-% ================================================================
-
-\onlyinsubfile{\input{../../global/epilogue}}
-
-\end{document}