New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Changeset 11596 for NEMO/trunk/doc/latex/NEMO/subfiles/chap_DIA.tex – NEMO

Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/doc/latex/NEMO/subfiles/chap_DIA.tex

    r11584 r11596  
    22 
    33\begin{document} 
    4 % ================================================================ 
    5 % Chapter I/O & Diagnostics 
    6 % ================================================================ 
    74\chapter{Output and Diagnostics (IOM, DIA, TRD, FLO)} 
    85\label{chap:DIA} 
     
    2320\end{figure} 
    2421 
    25 \newpage 
    26  
    27 % ================================================================ 
    28 %       Old Model Output 
    29 % ================================================================ 
    3022\section{Model output} 
    3123\label{sec:DIA_io_old} 
     
    5345%\gmcomment{                    % start of gmcomment 
    5446 
    55 % ================================================================ 
    56 % Diagnostics 
    57 % ================================================================ 
    5847\section{Standard model output (IOM)} 
    5948\label{sec:DIA_iom} 
     
    6453 
    6554\begin{enumerate} 
    66 \item 
    67   The complete and flexible control of the output files through external XML files adapted by 
     55\item The complete and flexible control of the output files through external XML files adapted by 
    6856  the user from standard templates. 
    69 \item 
    70   To achieve high performance and scalable output through the optional distribution of 
     57\item To achieve high performance and scalable output through the optional distribution of 
    7158  all diagnostic output related tasks to dedicated processes. 
    7259\end{enumerate} 
     
    7663 
    7764\begin{itemize} 
    78 \item 
    79   The choice of output frequencies that can be different for each file (including real months and years). 
    80 \item 
    81   The choice of file contents; includes complete flexibility over which data are written in which files 
     65\item The choice of output frequencies that can be different for each file (including real months and years). 
     66\item The choice of file contents; includes complete flexibility over which data are written in which files 
    8267  (the same data can be written in different files). 
    83 \item 
    84   The possibility to split output files at a chosen frequency. 
    85 \item 
    86   The possibility to extract a vertical or an horizontal subdomain. 
    87 \item 
    88   The choice of the temporal operation to perform, \eg: average, accumulate, instantaneous, min, max and once. 
    89 \item 
    90   Control over metadata via a large XML "database" of possible output fields. 
     68\item The possibility to split output files at a chosen frequency. 
     69\item The possibility to extract a vertical or an horizontal subdomain. 
     70\item The choice of the temporal operation to perform, \eg: average, accumulate, instantaneous, min, max and once. 
     71\item Control over metadata via a large XML "database" of possible output fields. 
    9172\end{itemize} 
    9273 
     
    150131If an additional variable must be written to a restart file, the following steps are needed: 
    151132\begin{description} 
    152    \item[step 1:] add variable name to a list of restart variables (in subroutine \rou{iom\_set\_rst\_vars,} \mdl{iom}) and 
     133   \item [step 1:] add variable name to a list of restart variables (in subroutine \rou{iom\_set\_rst\_vars,} \mdl{iom}) and 
    153134define correct grid for the variable (\forcode{grid_N_3D} - 3D variable, \forcode{grid_N} - 2D variable, \forcode{grid_vector} - 
    1541351D variable, \forcode{grid_scalar} - scalar), 
    155    \item[step 2:] add variable to the list of fields written by restart.  This can be done either in subroutine 
     136   \item [step 2:] add variable to the list of fields written by restart.  This can be done either in subroutine 
    156137\rou{iom\_set\_rstw\_core} (\mdl{iom}) or by calling  \rou{iom\_set\_rstw\_active} (\mdl{iom}) with the name of a variable 
    157138as an argument. This convention follows approach for writing restart using iom, where variables are 
     
    159140\end{description} 
    160141 
    161  
    162142An older versions of XIOS do not support reading functionality. It's recommended to use at least XIOS2@1451. 
    163  
    164143 
    165144\subsection{XIOS: XML Inputs-Outputs Server} 
     
    276255 
    277256\begin{enumerate} 
    278 \item[1.] 
     257\item [1.] 
    279258  in \NEMO\ code, add a \forcode{CALL iom_put( 'identifier', array )} where you want to output a 2D or 3D array. 
    280 \item[2.] 
     259\item [2.] 
    281260  If necessary, add \forcode{USE iom ! I/O manager library} to the list of used modules in 
    282261  the upper part of your module. 
    283 \item[3.] 
     262\item [3.] 
    284263  in the field\_def.xml file, add the definition of your variable using the same identifier you used in the f90 code 
    285264  (see subsequent sections for a details of the XML syntax and rules). 
     
    310289\xmlcode{<field_group id="SBC" ...>} which has been defined with the correct frequency of operations 
    311290(iom\_set\_field\_attr in \mdl{iom}) 
    312 \item[4.] 
     291\item [4.] 
    313292  add your field in one of the output files defined in iodef.xml 
    314293  (again see subsequent sections for syntax and rules) 
     
    737716 
    738717\begin{enumerate} 
    739 \item 
    740   Simple computation: directly define the computation when refering to the variable in the file definition. 
     718\item Simple computation: directly define the computation when refering to the variable in the file definition. 
    741719 
    742720\begin{xmllines} 
     
    746724\end{xmllines} 
    747725 
    748 \item 
    749   Simple computation: define a new variable and use it in the file definition. 
     726\item Simple computation: define a new variable and use it in the file definition. 
    750727 
    751728in field\_definition: 
     
    764741sst2 won't be evaluated. 
    765742 
    766 \item 
    767   Change of variable precision: 
     743\item Change of variable precision: 
    768744 
    769745\begin{xmllines} 
     
    778754Forcing double precision outputs with prec="8" (for example in the field\_definition) will avoid this problem. 
    779755 
    780 \item 
    781   add user defined attributes: 
     756\item add user defined attributes: 
    782757 
    783758\begin{xmllines} 
     
    794769\end{xmllines} 
    795770 
    796 \item 
    797   use of the ``@'' function: example 1, weighted temporal average 
     771\item use of the ``@'' function: example 1, weighted temporal average 
    798772 
    799773 - define a new variable in field\_definition 
     
    823797Note that in this case, freq\_op must be equal to the file output\_freq. 
    824798 
    825 \item 
    826   use of the ``@'' function: example 2, monthly SSH standard deviation 
     799\item use of the ``@'' function: example 2, monthly SSH standard deviation 
    827800 
    828801 - define a new variable in field\_definition 
     
    854827Note that in this case, freq\_op must be equal to the file output\_freq. 
    855828 
    856 \item 
    857   use of the ``@'' function: example 3, monthly average of SST diurnal cycle 
     829\item use of the ``@'' function: example 3, monthly average of SST diurnal cycle 
    858830 
    859831 - define 2 new variables in field\_definition 
     
    13261298This must be set to true if these metadata are to be included in the output files. 
    13271299 
    1328  
    1329 % ================================================================ 
    1330 %       NetCDF4 support 
    1331 % ================================================================ 
    13321300\section[NetCDF4 support (\texttt{\textbf{key\_netcdf4}})]{NetCDF4 support (\protect\key{netcdf4})} 
    13331301\label{sec:DIA_nc4} 
     
    14461414the invidual processing regions and different chunking choices may be desired. 
    14471415 
    1448 % ------------------------------------------------------------------------------------------------------------- 
    1449 %       Tracer/Dynamics Trends 
    1450 % ------------------------------------------------------------------------------------------------------------- 
    14511416\section[Tracer/Dynamics trends (\forcode{&namtrd})]{Tracer/Dynamics trends (\protect\nam{trd}{trd})} 
    14521417\label{sec:DIA_trd} 
     
    14701435 
    14711436\begin{description} 
    1472 \item[{\np{ln_glo_trd}{ln\_glo\_trd}}]: 
     1437\item [{\np{ln_glo_trd}{ln\_glo\_trd}}]: 
    14731438  at each \np{nn_trd}{nn\_trd} time-step a check of the basin averaged properties of 
    14741439  the momentum and tracer equations is performed. 
    14751440  This also includes a check of $T^2$, $S^2$, $\tfrac{1}{2} (u^2+v2)$, 
    14761441  and potential energy time evolution equations properties; 
    1477 \item[{\np{ln_dyn_trd}{ln\_dyn\_trd}}]: 
     1442\item [{\np{ln_dyn_trd}{ln\_dyn\_trd}}]: 
    14781443  each 3D trend of the evolution of the two momentum components is output; 
    1479 \item[{\np{ln_dyn_mxl}{ln\_dyn\_mxl}}]: 
     1444\item [{\np{ln_dyn_mxl}{ln\_dyn\_mxl}}]: 
    14801445  each 3D trend of the evolution of the two momentum components averaged over the mixed layer is output; 
    1481 \item[{\np{ln_vor_trd}{ln\_vor\_trd}}]: 
     1446\item [{\np{ln_vor_trd}{ln\_vor\_trd}}]: 
    14821447  a vertical summation of the moment tendencies is performed, 
    14831448  then the curl is computed to obtain the barotropic vorticity tendencies which are output; 
    1484 \item[{\np{ln_KE_trd}{ln\_KE\_trd}}] : 
     1449\item [{\np{ln_KE_trd}{ln\_KE\_trd}}] : 
    14851450  each 3D trend of the Kinetic Energy equation is output; 
    1486 \item[{\np{ln_tra_trd}{ln\_tra\_trd}}]: 
     1451\item [{\np{ln_tra_trd}{ln\_tra\_trd}}]: 
    14871452  each 3D trend of the evolution of temperature and salinity is output; 
    1488 \item[{\np{ln_tra_mxl}{ln\_tra\_mxl}}]: 
     1453\item [{\np{ln_tra_mxl}{ln\_tra\_mxl}}]: 
    14891454  each 2D trend of the evolution of temperature and salinity averaged over the mixed layer is output; 
    14901455\end{description} 
     
    14971462and none of the options have been tested with variable volume (\ie\ \np[=.true.]{ln_linssh}{ln\_linssh}). 
    14981463 
    1499 % ------------------------------------------------------------------------------------------------------------- 
    1500 %       On-line Floats trajectories 
    1501 % ------------------------------------------------------------------------------------------------------------- 
    15021464\section[FLO: On-Line Floats trajectories (\texttt{\textbf{key\_floats}})]{FLO: On-Line Floats trajectories (\protect\key{floats})} 
    15031465\label{sec:DIA_FLO} 
     
    16021564\end{xmllines} 
    16031565 
    1604  
    1605 % ------------------------------------------------------------------------------------------------------------- 
    1606 %       Harmonic analysis of tidal constituents 
    1607 % ------------------------------------------------------------------------------------------------------------- 
    16081566\section[Harmonic analysis of tidal constituents (\texttt{\textbf{key\_diaharm}})]{Harmonic analysis of tidal constituents (\protect\key{diaharm})} 
    16091567\label{sec:DIA_diag_harm} 
     
    16541612We obtain in output $C_{j}$ and $S_{j}$ for each tidal wave. 
    16551613 
    1656 % ------------------------------------------------------------------------------------------------------------- 
    1657 %       Sections transports 
    1658 % ------------------------------------------------------------------------------------------------------------- 
    16591614\section[Transports across sections (\texttt{\textbf{key\_diadct}})]{Transports across sections (\protect\key{diadct})} 
    16601615\label{sec:DIA_diag_dct} 
     
    18001755\end{table} 
    18011756 
    1802 % ================================================================ 
    1803 % Steric effect in sea surface height 
    1804 % ================================================================ 
    18051757\section{Diagnosing the steric effect in sea surface height} 
    18061758\label{sec:DIA_steric} 
    1807  
    18081759 
    18091760Changes in steric sea level are caused when changes in the density of the water column imply an expansion or 
     
    19801931Both steric and thermosteric sea level are computed in \mdl{diaar5}. 
    19811932 
    1982 % ------------------------------------------------------------------------------------------------------------- 
    1983 %       Other Diagnostics 
    1984 % ------------------------------------------------------------------------------------------------------------- 
    19851933\section{Other diagnostics} 
    19861934\label{sec:DIA_diag_others} 
     
    20011949- the depth of the thermocline (maximum of the vertical temperature gradient) (\mdl{diahth}) 
    20021950 
    2003  
    2004 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    20051951\begin{figure}[!t] 
    20061952  \centering 
     
    20191965  \label{fig:DIA_mask_subasins} 
    20201966\end{figure} 
    2021 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    20221967 
    20231968% ----------------------------------------------------------- 
Note: See TracChangeset for help on using the changeset viewer.