Changeset 11598 for NEMO/trunk/doc/latex/NEMO/subfiles/chap_DIA.tex

Timestamp:

2019-09-25T22:00:42+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Add template of versioning record at the beginning of chapters

File:

• NEMO/trunk/doc/latex/NEMO/subfiles/chap_DIA.tex (modified) (15 diffs)

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

@@ -2 +2 @@
 
 \begin{document}
+
 \chapter{Output and Diagnostics (IOM, DIA, TRD, FLO)}
 \label{chap:DIA}
 
+%    {\em 4.0} & {\em Mirek Andrejczuk, Massimiliano Drudi} & {\em }  \\
+%    {\em }      & {\em Dorotea Iovino, Nicolas Martin} & {\em }  \\
+%    {\em 3.6} & {\em Gurvan Madec, Sebastien Masson } & {\em }  \\
+%    {\em 3.4} & {\em Gurvan Madec, Rachid Benshila, Andrew Coward } & {\em }  \\
+%    {\em }      & {\em Christian Ethe, Sebastien Masson } & {\em }  \\
+
+\thispagestyle{plain}
+
 \chaptertoc
 
-\vfill
-\begin{figure}[b]
-%% =================================================================================================
-\subsubsection*{Changes record}
-\begin{tabular}{l||l|m{0.65\linewidth}}
-    Release   & Author        & Modifications \\
-    {\em 4.0} & {\em Mirek Andrejczuk, Massimiliano Drudi} & {\em }  \\
-    {\em }      & {\em Dorotea Iovino, Nicolas Martin} & {\em }  \\
-    {\em 3.6} & {\em Gurvan Madec, Sebastien Masson } & {\em }  \\
-    {\em 3.4} & {\em Gurvan Madec, Rachid Benshila, Andrew Coward } & {\em }  \\
-    {\em }      & {\em Christian Ethe, Sebastien Masson } & {\em }  \\
-\end{tabular}
-\end{figure}
+\paragraph{Changes record} ~\\
+
+{\footnotesize
+  \begin{tabularx}{\textwidth}{l||X|X}
+    Release & Author(s) & Modifications \\
+    \hline
+    {\em   4.0} & {\em ...} & {\em ...} \\
+    {\em   3.6} & {\em ...} & {\em ...} \\
+    {\em   3.4} & {\em ...} & {\em ...} \\
+    {\em <=3.4} & {\em ...} & {\em ...}
+  \end{tabularx}
+}
+
+\clearpage
 
 %% =================================================================================================
@@ -134 +144 @@
 
 If an additional variable must be written to a restart file, the following steps are needed:
-\begin{description}
-   \item [step 1:] add variable name to a list of restart variables (in subroutine \rou{iom\_set\_rst\_vars,} \mdl{iom}) and
+\begin{enumerate}
+\item Add variable name to a list of restart variables (in subroutine \rou{iom\_set\_rst\_vars,} \mdl{iom}) and
 define correct grid for the variable (\forcode{grid_N_3D} - 3D variable, \forcode{grid_N} - 2D variable, \forcode{grid_vector} -
 1D variable, \forcode{grid_scalar} - scalar),
-   \item [step 2:] add variable to the list of fields written by restart.  This can be done either in subroutine
+\item Add variable to the list of fields written by restart.  This can be done either in subroutine
 \rou{iom\_set\_rstw\_core} (\mdl{iom}) or by calling  \rou{iom\_set\_rstw\_active} (\mdl{iom}) with the name of a variable
 as an argument. This convention follows approach for writing restart using iom, where variables are
 written either by \rou{rst\_write} or by calling \rou{iom\_rstput} from individual routines.
-\end{description}
+\end{enumerate}
 
 An older versions of XIOS do not support reading functionality. It's recommended to use at least XIOS2@1451.
@@ -266 +276 @@
 
 \begin{enumerate}
-\item [1.]
-  in \NEMO\ code, add a \forcode{CALL iom_put( 'identifier', array )} where you want to output a 2D or 3D array.
-\item [2.]
-  If necessary, add \forcode{USE iom ! I/O manager library} to the list of used modules in
+\item in \NEMO\ code, add a \forcode{CALL iom_put( 'identifier', array )} where you want to output a 2D or 3D array.
+\item If necessary, add \forcode{USE iom ! I/O manager library} to the list of used modules in
   the upper part of your module.
-\item [3.]
-  in the field\_def.xml file, add the definition of your variable using the same identifier you used in the f90 code
+\item in the field\_def.xml file, add the definition of your variable using the same identifier you used in the f90 code
   (see subsequent sections for a details of the XML syntax and rules).
   For example:
-
 \begin{xmllines}
 <field_definition>
@@ -284 +290 @@
 </field_definition>
 \end{xmllines}
-
 Note your definition must be added to the field\_group whose reference grid is consistent with the size of
 the array passed to iomput.
@@ -291 +296 @@
 (iom\_set\_domain\_attr and iom\_set\_axis\_attr in \mdl{iom}) or defined in the domain\_def.xml file.
 \eg:
-
 \begin{xmllines}
 <grid id="grid_T_3D" domain_ref="grid_T" axis_ref="deptht"/>
 \end{xmllines}
-
 Note, if your array is computed within the surface module each \np{nn_fsbc}{nn\_fsbc} time\_step,
 add the field definition within the field\_group defined with the id "SBC":
 \xmlcode{<field_group id="SBC" ...>} which has been defined with the correct frequency of operations
 (iom\_set\_field\_attr in \mdl{iom})
-\item [4.]
-  add your field in one of the output files defined in iodef.xml
+\item add your field in one of the output files defined in iodef.xml
   (again see subsequent sections for syntax and rules)
-
 \begin{xmllines}
 <file id="file1" .../>
@@ -311 +312 @@
 </file>
 \end{xmllines}
-
 \end{enumerate}
 
@@ -1342 +1342 @@
 \NEMO\ executables linked with NetCDF4 libraries can be made to produce NetCDF3 files by
 setting the \np{ln_nc4zip}{ln\_nc4zip} logical to false in the \nam{nc4}{nc4} namelist:
-
 
 \begin{listing}
@@ -1442 +1441 @@
 \label{sec:DIA_trd}
 
-
 \begin{listing}
   \nlst{namtrd}
@@ -1458 +1456 @@
 
 \begin{description}
-\item [{\np{ln_glo_trd}{ln\_glo\_trd}}]:
-  at each \np{nn_trd}{nn\_trd} time-step a check of the basin averaged properties of
+\item [{\np{ln_glo_trd}{ln\_glo\_trd}}]: at each \np{nn_trd}{nn\_trd} time-step a check of the basin averaged properties of
   the momentum and tracer equations is performed.
   This also includes a check of $T^2$, $S^2$, $\tfrac{1}{2} (u^2+v2)$,
   and potential energy time evolution equations properties;
-\item [{\np{ln_dyn_trd}{ln\_dyn\_trd}}]:
-  each 3D trend of the evolution of the two momentum components is output;
-\item [{\np{ln_dyn_mxl}{ln\_dyn\_mxl}}]:
-  each 3D trend of the evolution of the two momentum components averaged over the mixed layer is output;
-\item [{\np{ln_vor_trd}{ln\_vor\_trd}}]:
-  a vertical summation of the moment tendencies is performed,
+\item [{\np{ln_dyn_trd}{ln\_dyn\_trd}}]: each 3D trend of the evolution of the two momentum components is output;
+\item [{\np{ln_dyn_mxl}{ln\_dyn\_mxl}}]: each 3D trend of the evolution of the two momentum components averaged over the mixed layer is output;
+\item [{\np{ln_vor_trd}{ln\_vor\_trd}}]: a vertical summation of the moment tendencies is performed,
   then the curl is computed to obtain the barotropic vorticity tendencies which are output;
-\item [{\np{ln_KE_trd}{ln\_KE\_trd}}] :
-  each 3D trend of the Kinetic Energy equation is output;
-\item [{\np{ln_tra_trd}{ln\_tra\_trd}}]:
-  each 3D trend of the evolution of temperature and salinity is output;
-\item [{\np{ln_tra_mxl}{ln\_tra\_mxl}}]:
-  each 2D trend of the evolution of temperature and salinity averaged over the mixed layer is output;
+\item [{\np{ln_KE_trd}{ln\_KE\_trd}}]  : each 3D trend of the Kinetic Energy equation is output;
+\item [{\np{ln_tra_trd}{ln\_tra\_trd}}]: each 3D trend of the evolution of temperature and salinity is output;
+\item [{\np{ln_tra_mxl}{ln\_tra\_mxl}}]: each 2D trend of the evolution of temperature and salinity averaged over the mixed layer is output;
 \end{description}
 
@@ -1638 +1629 @@
 \section[Transports across sections (\texttt{\textbf{key\_diadct}})]{Transports across sections (\protect\key{diadct})}
 \label{sec:DIA_diag_dct}
-
 
 \begin{listing}
@@ -1993 +1983 @@
 \end{figure}
 
-% -----------------------------------------------------------
-%       CMIP specific diagnostics
-% -----------------------------------------------------------
 %% =================================================================================================
 \subsection[CMIP specific diagnostics (\textit{diaar5.F90}, \textit{diaptr.F90})]{CMIP specific diagnostics (\protect\mdl{diaar5})}
@@ -2015 +2002 @@
 the Indo-Pacific mask been deduced from the sum of the Indian and Pacific mask (\autoref{fig:DIA_mask_subasins}).
 
-
 \begin{listing}
   \nlst{namptr}
@@ -2022 +2008 @@
 \end{listing}
 
-% -----------------------------------------------------------
-%       25 hour mean and hourly Surface, Mid and Bed
-% -----------------------------------------------------------
 %% =================================================================================================
 \subsection{25 hour mean output for tidal models}
-
 
 \begin{listing}
@@ -2040 +2022 @@
 This diagnostic is actived with the logical $ln\_dia25h$.
 
-% -----------------------------------------------------------
-%     Top Middle and Bed hourly output
-% -----------------------------------------------------------
 %% =================================================================================================
 \subsection{Top middle and bed hourly output}
-
 
 \begin{listing}
@@ -2059 +2037 @@
 This diagnostic is actived with the logical $ln\_diatmb$.
 
-% -----------------------------------------------------------
-%     Courant numbers
-% -----------------------------------------------------------
 %% =================================================================================================
 \subsection{Courant numbers}