Changeset 2922

Timestamp:

2011-10-14T15:47:24+02:00 (13 years ago)

Author:

cbricaud

Message:

correction of diadct documentation

File:

• branches/2011/dev_r2802_MERCATOR10_diadct/DOC/TexFiles/Chapters/Chap_DIA.tex (modified) (9 diffs)

branches/2011/dev_r2802_MERCATOR10_diadct/DOC/TexFiles/Chapters/Chap_DIA.tex

@@ -691 +691 @@
 \label{DIA_diag_dct}
 
-A module is available to compute volume, heat and salt tranports through sections. This diagnostic
+A module is available to compute the transport of volume, heat and salt through sections. This diagnostic
 is actived with \key{diadct}.
 
-Each section is defined by the coordinates of its 2 extremities. The pathway between them is contructed
-with the tools \texttt{SECTIONS\_DIADCT} and is written in binary file \texttt{section\_ijglobal.diadct\_ORCA2\_LIM } 
-which might be read by NEMO to compute on-line transports.
-
-On-line transports module will create three ascii files for outputs: 
+Each section is defined by the coordinates of its 2 extremities. The pathways between them are contructed
+using tools which can be found in  \texttt{NEMOGCM/TOOLS/SECTIONS\_DIADCT} and are written in a binary file
+ \texttt{section\_ijglobal.diadct\_ORCA2\_LIM} which is later read in by NEMO to compute on-line transports.
+
+The on-line transports module creates three output ascii files: 
 
 - \texttt{volume\_transport} for volume transports (  unit: $10^{6} m^{3} s^{-1}$ )
@@ -704 +704 @@
 - \texttt{heat\_transport}   for heat transports   (  unit: $10^{15} W $ )
 
-- \texttt{salt\_transport}   for salt transports   (  unit: $10^{9}g s^{-1}$ )
-
+- \texttt{salt\_transport}   for salt transports   (  unit: $10^{9}g s^{-1}$ )\\
+
+
+Namelist parameters control how frequently the flows are summed and the time scales over which
+ they are averaged, as well as the level of output for debugging:
 
 %------------------------------------------namdct----------------------------------------------------
@@ -711 +714 @@
 %-------------------------------------------------------------------------------------------------------------
 
-Concerning the on-line transports computing, some parameters are available in namelist:
-
-- \texttt{nn\_dct} is the frequency of instantaneous transports computing
-
-- \texttt{nn\_dctwri} is the frequency of writing ( mean of instantaneous transports )
-
-- \texttt{nn\_debug} to debug a section
-
-
-
-\subsubsection{ How to compute sections pathway and create the binary file? }
-
-In \texttt{NEMOGCM/TOOLS/SECTIONS\_DIADCT/run}, \texttt{ {list\_sections.ascii\_global}}
-contains all the sections we want to compute; this list of sections is inspired from MERSEA project metrics.
-
-Another file is available for GYRE configuration (\texttt{ {list\_sections.ascii\_GYRE}}). 
+\texttt{nn\_dct}: frequency of instantaneous transports computing
+
+\texttt{nn\_dctwri}: frequency of writing ( mean of instantaneous transports )
+
+\texttt{nn\_debug}: debugging of the section
+
+\subsubsection{ To create a binary file containing the pathway of each section }
+
+In \texttt{NEMOGCM/TOOLS/SECTIONS\_DIADCT/run}, the file \texttt{ {list\_sections.ascii\_global}}
+contains a list of all the sections that are to be computed (this list of sections is based on MERSEA project metrics).
+
+Another file is available for the GYRE configuration (\texttt{ {list\_sections.ascii\_GYRE}}). 
 
 Each section is defined by:
@@ -737 +736 @@
 - \texttt{long2 lat2} , coordinates of the second extremity of the section;
 
-- \texttt{nclass} the number of bounds of your classes ( 3 bounds for 2 classes, for example);
+- \texttt{nclass} the number of bounds of your classes (e.g. 3 bounds for 2 classes);
 
 - \texttt{okstrpond} to compute heat and salt transport, \texttt{nostrpond} if no;
@@ -744 +743 @@
 
 
-\noindent Results of transports computing don't depend of the order of the 2 extremities in this file.\\ 
-
-
-\noindent If nclass =/ 0,the next lines will containes the class type and the nclass bounds:
+\noindent The results of the computing of transports, and the directions of positive
+ and negative flow do not depend on the order of the 2 extremities in this file.\\ 
+
+
+\noindent If nclass =/ 0,the next lines contain the class type and the nclass bounds:
 
 \texttt{long1 lat1 long2 lat2 nclass (ok/no)strpond (no)ice section\_name}
@@ -778 +778 @@
 
   
-job.ksh compute the pathway for each section and create a binary file 
-\texttt{section\_ijglobal.diadct\_ORCA2\_LIM } which will be read by NEMO. \\
-
-
-Example of two sections:
-
+The script \texttt{job.ksh} computes the pathway for each section and creates a binary file 
+\texttt{section\_ijglobal.diadct\_ORCA2\_LIM} which is read by NEMO. \\
+
+
+Examples of two sections, the ACC\_Drake\_Passage with no classes, and the
+ ATL\_Cuba\_Florida with 4 temperature clases (5 class bounds), are shown:
 
 \noindent \texttt{ -68.    -54.5   -60.    -64.7  00 okstrpond noice ACC\_Drake\_Passage}
@@ -802 +802 @@
 
 
-\subsubsection{ How to read the output files ? }
+\subsubsection{ To read the output files }
 
 The output format is :
@@ -810 +810 @@
 
 
-If some sections have classes, the first lines correspond to the transport for each class 
-and the last line corresponds to the total transport for all classes. If the other case, class number
-\texttt{ 1 } corresponds to \texttt{ total class } and this class is called  \texttt{N}, like \texttt{none}.\\
+For sections with classes, the first \texttt{nclass-1} lines correspond to the transport for each class 
+and the last line corresponds to the total transport summed over all classes. For sections with no classes, class number
+\texttt{ 1 } corresponds to \texttt{ total class } and this class is called  \texttt{N}, meaning \texttt{none}.\\
 
 
@@ -820 +820 @@
 
 
-\noindent \texttt{section slope coefficient} gives some informations about the significations of transports signs and direction:\\
+\noindent The \texttt{section slope coefficient} gives information about the significance of transports signs and direction:\\