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 6275 for branches/2015/nemo_v3_6_STABLE/DOC/TexFiles/Chapters/Chap_DIA.tex – NEMO

Ignore:
Timestamp:
2016-02-01T03:35:04+01:00 (8 years ago)
Author:
gm
Message:

#1629: DOC of v3.6_stable. Upadate, see associated wiki page for description

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/2015/nemo_v3_6_STABLE/DOC/TexFiles/Chapters/Chap_DIA.tex

    r5515 r6275  
    22% Chapter I/O & Diagnostics 
    33% ================================================================ 
    4 \chapter{Ouput and Diagnostics (IOM, DIA, TRD, FLO)} 
     4\chapter{Output and Diagnostics (IOM, DIA, TRD, FLO)} 
    55\label{DIA} 
    66\minitoc 
    77 
    88\newpage 
    9 $\ $\newline    % force a new ligne 
     9$\ $\newline    % force a new line 
    1010 
    1111% ================================================================ 
     
    4848 
    4949 
    50 Since version 3.2, iomput is the NEMO output interface of choice. It has been designed to be simple to use, flexible and efficient. The two main purposes of iomput are:  
     50Since version 3.2, iomput is the NEMO output interface of choice.  
     51It has been designed to be simple to use, flexible and efficient.  
     52The two main purposes of iomput are:  
    5153\begin{enumerate} 
    5254\item The complete and flexible control of the output files through external XML files adapted by the user from standard templates.  
     
    11161118% ------------------------------------------------------------------------------------------------------------- 
    11171119\section[Tracer/Dynamics Trends (TRD)] 
    1118                   {Tracer/Dynamics Trends  (\key{trdtra}, \key{trddyn},    \\  
    1119                                                              \key{trddvor}, \key{trdmld})} 
     1120                  {Tracer/Dynamics Trends  (\ngn{namtrd})} 
    11201121\label{DIA_trd} 
    11211122 
     
    11241125%------------------------------------------------------------------------------------------------------------- 
    11251126 
    1126 When \key{trddyn} and/or \key{trddyn} CPP variables are defined, each  
    1127 trend of the dynamics and/or temperature and salinity time evolution equations  
    1128 is stored in three-dimensional arrays just after their computation ($i.e.$ at the end  
    1129 of each $dyn\cdots.F90$ and/or $tra\cdots.F90$ routines). Options are defined by 
    1130 \ngn{namtrd} namelist variables. These trends are then  
    1131 used in \mdl{trdmod} (see TRD directory) every \textit{nn\_trd } time-steps. 
    1132  
    1133 What is done depends on the CPP keys defined: 
     1127Each trend of the dynamics and/or temperature and salinity time evolution equations  
     1128can be send to \mdl{trddyn} and/or \mdl{trdtra} modules (see TRD directory) just after their computation  
     1129($i.e.$ at the end of each $dyn\cdots.F90$ and/or $tra\cdots.F90$ routines).  
     1130This capability is controlled by options offered in \ngn{namtrd} namelist.  
     1131Note that the output are done with xIOS, and therefore the \key{IOM} is required. 
     1132 
     1133What is done depends on the \ngn{namtrd} logical set to \textit{true}: 
    11341134\begin{description} 
    1135 \item[\key{trddyn}, \key{trdtra}] : a check of the basin averaged properties of the momentum  
    1136 and/or tracer equations is performed ;  
    1137 \item[\key{trdvor}] : a vertical summation of the moment tendencies is performed,  
    1138 then the curl is computed to obtain the barotropic vorticity tendencies which are output ; 
    1139 \item[\key{trdmld}] : output of the tracer tendencies averaged vertically   
    1140 either over the mixed layer (\np{nn\_ctls}=0),  
    1141 or       over a fixed number of model levels (\np{nn\_ctls}$>$1 provides the number of level),  
    1142 or       over a spatially varying but temporally fixed number of levels (typically the base  
    1143 of the winter mixed layer) read in \ifile{ctlsurf\_idx} (\np{nn\_ctls}=1) ; 
     1135\item[\np{ln\_glo\_trd}] : at each \np{nn\_trd} time-step a check of the basin averaged properties  
     1136of the momentum and tracer equations is performed. This also includes a check of $T^2$, $S^2$,  
     1137$\tfrac{1}{2} (u^2+v2)$, and potential energy time evolution equations properties ;  
     1138\item[\np{ln\_dyn\_trd}] : each 3D trend of the evolution of the two momentum components is output ;  
     1139\item[\np{ln\_dyn\_mxl}] : each 3D trend of the evolution of the two momentum components averaged  
     1140                           over the mixed layer is output  ;  
     1141\item[\np{ln\_vor\_trd}] : a vertical summation of the moment tendencies is performed,  
     1142                           then the curl is computed to obtain the barotropic vorticity tendencies which are output ; 
     1143\item[\np{ln\_KE\_trd}]  : each 3D trend of the Kinetic Energy equation is output ; 
     1144\item[\np{ln\_tra\_trd}] : each 3D trend of the evolution of temperature and salinity is output ; 
     1145\item[\np{ln\_tra\_mxl}] : each 2D trend of the evolution of temperature and salinity averaged  
     1146                           over the mixed layer is output ; 
    11441147\end{description} 
    1145  
    1146 The units in the output file can be changed using the \np{nn\_ucf} namelist parameter.  
    1147 For example, in case of salinity tendency the units are given by PSU/s/\np{nn\_ucf}. 
    1148 Setting \np{nn\_ucf}=86400 ($i.e.$ the number of second in a day) provides the tendencies in PSU/d. 
    1149  
    1150 When \key{trdmld} is defined, two time averaging procedure are proposed. 
    1151 Setting \np{ln\_trdmld\_instant} to \textit{true}, a simple time averaging is performed,  
    1152 so that the resulting tendency is the contribution to the change of a quantity between  
    1153 the two instantaneous values taken at the extremities of the time averaging period. 
    1154 Setting \np{ln\_trdmld\_instant} to \textit{false}, a double time averaging is performed,  
    1155 so that the resulting tendency is the contribution to the change of a quantity between  
    1156 two \textit{time mean} values. The later option requires the use of an extra file, \ifile{restart\_mld}   
    1157 (\np{ln\_trdmld\_restart}=true), to restart a run. 
    1158  
    11591148 
    11601149Note that the mixed layer tendency diagnostic can also be used on biogeochemical models  
    11611150via the \key{trdtrc} and \key{trdmld\_trc} CPP keys. 
     1151 
     1152\textbf{Note that} in the current version (v3.6), many changes has been introduced but not fully tested.  
     1153In particular, options associated with \np{ln\_dyn\_mxl}, \np{ln\_vor\_trd}, and \np{ln\_tra\_mxl}  
     1154are not working, and none of the option have been tested with variable volume ($i.e.$ \key{vvl} defined). 
     1155 
    11621156 
    11631157% ------------------------------------------------------------------------------------------------------------- 
     
    12801274\label{DIA_diag_harm} 
    12811275 
    1282 A module is available to compute the amplitude and phase for tidal waves.  
    1283 This diagnostic is actived with \key{diaharm}. 
    1284  
    12851276%------------------------------------------namdia_harm---------------------------------------------------- 
    12861277\namdisplay{namdia_harm} 
    12871278%---------------------------------------------------------------------------------------------------------- 
    12881279 
    1289 Concerning the on-line Harmonic analysis, some parameters are available in namelist 
    1290 \ngn{namdia\_harm} : 
    1291  
    1292 - \texttt{nit000\_han} is the first time step used for harmonic analysis 
    1293  
    1294 - \texttt{nitend\_han} is the last time step used for harmonic analysis 
    1295  
    1296 - \texttt{nstep\_han} is the time step frequency for harmonic analysis 
    1297  
    1298 - \texttt{nb\_ana} is the number of harmonics to analyse 
    1299  
    1300 - \texttt{tname} is an array with names of tidal constituents to analyse 
    1301  
    1302 \texttt{nit000\_han} and \texttt{nitend\_han} must be between \texttt{nit000} and \texttt{nitend} of the simulation. 
     1280A module is available to compute the amplitude and phase of tidal waves.  
     1281This on-line Harmonic analysis is actived with \key{diaharm}. 
     1282Some parameters are available in namelist \ngn{namdia\_harm} : 
     1283 
     1284- \np{nit000\_han} is the first time step used for harmonic analysis 
     1285 
     1286- \np{nitend\_han} is the last time step used for harmonic analysis 
     1287 
     1288- \np{nstep\_han} is the time step frequency for harmonic analysis 
     1289 
     1290- \np{nb\_ana} is the number of harmonics to analyse 
     1291 
     1292- \np{tname} is an array with names of tidal constituents to analyse 
     1293 
     1294\np{nit000\_han} and \np{nitend\_han} must be between \np{nit000} and \np{nitend} of the simulation. 
    13031295The restart capability is not implemented. 
    13041296 
    1305 The Harmonic analysis solve this equation: 
     1297The Harmonic analysis solve the following equation: 
    13061298\begin{equation} 
    13071299h_{i} - A_{0} + \sum^{nb\_ana}_{j=1}[A_{j}cos(\nu_{j}t_{j}-\phi_{j})] = e_{i} 
     
    13241316\label{DIA_diag_dct} 
    13251317 
    1326 A module is available to compute the transport of volume, heat and salt through sections. This diagnostic 
    1327 is actived with \key{diadct}. 
     1318A module is available to compute the transport of volume, heat and salt through sections.  
     1319This diagnostic is actived with \key{diadct}. 
    13281320 
    13291321Each section is defined by the coordinates of its 2 extremities. The pathways between them are contructed 
     
    13471339%------------------------------------------------------------------------------------------------------------- 
    13481340 
    1349 \texttt{nn\_dct}: frequency of instantaneous transports computing 
    1350  
    1351 \texttt{nn\_dctwri}: frequency of writing ( mean of instantaneous transports ) 
    1352  
    1353 \texttt{nn\_debug}: debugging of the section 
     1341\np{nn\_dct}: frequency of instantaneous transports computing 
     1342 
     1343\np{nn\_dctwri}: frequency of writing ( mean of instantaneous transports ) 
     1344 
     1345\np{nn\_debug}: debugging of the section 
    13541346 
    13551347\subsubsection{ To create a binary file containing the pathway of each section } 
     
    14821474the \key{diahth} CPP key:  
    14831475 
    1484 - the mixed layer depth (based on a density criterion, \citet{de_Boyer_Montegut_al_JGR04}) (\mdl{diahth}) 
     1476- the mixed layer depth (based on a density criterion \citep{de_Boyer_Montegut_al_JGR04}) (\mdl{diahth}) 
    14851477 
    14861478- the turbocline depth (based on a turbulent mixing coefficient criterion) (\mdl{diahth}) 
Note: See TracChangeset for help on using the changeset viewer.