/[MITgcm]/manual/s_phys_pkgs/diagnostics.tex
ViewVC logotype

Diff of /manual/s_phys_pkgs/diagnostics.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.2 by edhill, Tue Oct 12 18:16:03 2004 UTC revision 1.3 by molod, Thu Oct 14 15:28:53 2004 UTC
# Line 6  Line 6 
6    
7  \subsection{Introduction}  \subsection{Introduction}
8    
9  This section of the documentation describes the Diagnostics Utilities available within the GCM.    This section of the documentation describes the Diagnostics Utilities available within
10  In addition to  the GCM.  In addition to a description on how to set and extract diagnostic quantities,
11  a description on how to set and extract diagnostic quantities, this document also provides a  this document also provides a comprehensive list of all available diagnostic quantities
12  comprehensive list of all available diagnostic quantities and a short description of how they are  and a short description of how they are computed.  It should be noted that this document
13  computed.  It should be noted that this document is not intended to be a complete documentation  is not intended to be a complete documentation of the various packages used in the GCM,
14  of the various packages used in the GCM, and the reader should  and the reader should refer to original publications and the appropriate sections of this
15  refer to original publications for further insight.  documentation for further insight.
   
16    
17  \subsection{Equations}  \subsection{Equations}
18  Not relevant.  Not relevant.
# Line 22  Not relevant. Line 21  Not relevant.
21  \label{sec:diagnostics:diagover}  \label{sec:diagnostics:diagover}
22    
23  A large selection of model diagnostics is available in the GCM.  At the time of  A large selection of model diagnostics is available in the GCM.  At the time of
24  this writing there are 92 different diagnostic quantities which can be enabled for an  this writing there are 280 different diagnostic quantities which can be enabled for an
25  experiment.  As a matter of philosophy, no diagnostic is enabled as default, thus each user must  experiment.  As a matter of philosophy, no diagnostic is enabled as default, thus each user must
26  specify the exact diagnostic information required for an experiment.  This is accomplished by  specify the exact diagnostic information required for an experiment.  This is accomplished by
27  enabling the specific diagnostic of interest cataloged in the  enabling the specific diagnostic of interest cataloged in the
# Line 68  Array & Value & Description \\ Line 67  Array & Value & Description \\
67    parse(2)   & $\rightarrow$ U &  C-Grid U-Point                    \\    parse(2)   & $\rightarrow$ U &  C-Grid U-Point                    \\
68               & $\rightarrow$ V &  C-Grid V-Point                    \\               & $\rightarrow$ V &  C-Grid V-Point                    \\
69               & $\rightarrow$ M &  C-Grid Mass Point                 \\               & $\rightarrow$ M &  C-Grid Mass Point                 \\
70               & $\rightarrow$ Z &  C-Grid Vorticity Point            \\ \hline               & $\rightarrow$ Z &  C-Grid Vorticity (Corner) Point   \\ \hline
71    parse(3)   & $\rightarrow$ R &  Computed on the Rotated Grid      \\    parse(3)   & $\rightarrow$ R &  Not Currently in Use              \\ \hline
              & $\rightarrow$ G &  Computed on the Geophysical Grid  \\ \hline  
72    parse(4)   & $\rightarrow$ P &  Positive Definite Diagnostic      \\ \hline    parse(4)   & $\rightarrow$ P &  Positive Definite Diagnostic      \\ \hline
73    parse(5)   & $\rightarrow$ C &  Counter Diagnostic                \\    parse(5)   & $\rightarrow$ C &  Counter Diagnostic                \\
74               & $\rightarrow$ D &  Disabled Diagnostic for output    \\ \hline               & $\rightarrow$ D &  Disabled Diagnostic for output    \\ \hline
# Line 82  Array & Value & Description \\ Line 80  Array & Value & Description \\
80  \end{table}  \end{table}
81    
82  As an example, consider a diagnostic whose associated GDIAG parameter is equal  As an example, consider a diagnostic whose associated GDIAG parameter is equal
83  to ``UUR 002''.  From GDIAG we can determine that this diagnostic is a  to ``UU  002''.  From GDIAG we can determine that this diagnostic is a
84  U-vector component located at the C-grid U-point within the Rotated framework.  U-vector component located at the C-grid U-point.
85  Its corresponding V-component diagnostic is located in Diagnostic \# 002.  Its corresponding V-component diagnostic is located in Diagnostic \# 002.
86    
87  In this way, each Diagnostic in the model has its attributes (ie. vector or scalar,  In this way, each Diagnostic in the model has its attributes (ie. vector or scalar,
88  rotated or geophysical, A-Grid or C-grid, etc.) defined internally.  The Output routines  A-Grid or C-grid, etc.) defined internally.  The Output routines
89  use this information in order to determine  use this information in order to determine
90  what type of rotations and/or transformations need to be performed.  Thus, all Diagnostic  what type of transformations need to be performed.  Thus, all Diagnostic
91  interpolations are done at the time of output rather than during each model dynamic step.  interpolations are done at the time of output rather than during each model dynamic step.
92  In this way the User now has more flexibility  In this way the User now has more flexibility
93  in determining the type of gridded data which is output.  in determining the type of gridded data which is output.
# Line 160  where \>  NUM   \>= Diagnostic number fr Line 158  where \>  NUM   \>= Diagnostic number fr
158  {\bf DIAGSIZE}:  We end this section with a discussion on the manner in which computer memory    {\bf DIAGSIZE}:  We end this section with a discussion on the manner in which computer memory  
159  is allocated for diagnostics.    is allocated for diagnostics.  
160  All GCM diagnostic quantities are stored in the single  All GCM diagnostic quantities are stored in the single
161  diagnostic array QDIAG which is located in the DIAG COMMON, having the form:  diagnostic array QDIAG which is located in diagnostics.h, and has the form:
162    
163  \begin{tabbing}  common /diagnostics/ qdiag(1-Olx,sNx+Olx,1-Olx,sNx+Olx,numdiags,Nsx,Nsy)
 XXXXXXXXX\=XXXXXX\= \kill  
 \>        COMMON /DIAG/ NDIAG\_MAX,QDIAG(IM,JM,1) \\  
 \\  
 \end{tabbing}  
164    
165  where NDIAG\_MAX is an Integer variable which should be  where numdiags is an Integer variable which should be
166  set equal to the number of enabled diagnostics, and QDIAG is a three-dimensional  set equal to the number of enabled diagnostics, and QDIAG is a three-dimensional
167  array.  The first two-dimensions of QDIAG correspond to the horizontal dimension  array.  The first two-dimensions of QDIAG correspond to the horizontal dimension
168  of a given diagnostic, while the third dimension of QDIAG is used to identify  of a given diagnostic, while the third dimension of QDIAG is used to identify
169  specific diagnostic types.  specific diagnostic types.
170  In order to minimize the maximum memory requirement used by the model,  In order to minimize the memory requirement of the model for diagnostics,
171  the default GCM executable is compiled with room for only one horizontal  the default GCM executable is compiled with room for only one horizontal
172  diagnostic array, as shown in the above example.    diagnostic array, as shown in the above example.  
173  In order for the User to enable more than 1 two-dimensional diagnostic,  In order for the User to enable more than 1 two-dimensional diagnostic,
174  the size of the DIAG COMMON must be expanded to accomodate the desired diagnostics.  the size of the diagnostics common must be expanded to accomodate the desired diagnostics.
175  This can be accomplished by manually changing the parameter numdiags in the  This can be accomplished by manually changing the parameter numdiags in the
176  file \filelink{FORWARD\_STEP}{pkg-diagnostics-diagnostics_SIZE.h}, or by allowing the  file \filelink{pkg/diagnostics/diagnostics\_SIZE.h}{pkg-diagnostics-diagnostics_SIZE.h}, or by allowing the
177  shell script (???????) to make this  shell script (???????) to make this
178  change based on the choice of diagnostic output made in the namelist.  change based on the choice of diagnostic output made in the namelist.
179    
180    \subsection{Usage Notes}
181    \label{sec:diagnostics:usersguide}
182    To use the diagnostics package, other than enabling it in packages.conf
183    and turning the usediagnostics flag in data.pkg to .TRUE., a namelist
184    must be supplied in the run directory called data.diagnostics. The namelist
185    will activate a user-defined list of diagnostics quantities to be computed,
186    specify the frequency of output, the number of levels, and the name of
187    up to 10 separate output files. A sample data.diagnostics namelist file:
188    
189    \# Diagnostic Package Choices
190     \&diagnostics_list
191      frequency(1) = 10, \
192       levels(1,1) = 1.,2.,3.,4.,5., \
193       fields(1,1) = 'UVEL    ','VVEL    ', \
194       filename(1) = 'diagout1', \
195      frequency(2) = 100, \
196       levels(1,2) = 1.,2.,3.,4.,5., \
197       fields(1,2) = 'THETA   ','SALT    ', \
198       filename(2) = 'diagout2', \
199     \&end \
200    
201    In this example, there are two output files that will be generated
202    for each tile and for each output time. The first set of output files
203    has the prefix diagout1, does time averaging every 10 time steps,
204    for fields which are multiple-level fields the levels output are 1-5,
205    and the names of diagnostics quantities are UVEL and VVEL.
206    The second set of output files
207    has the prefix diagout2, does time averaging every 100 time steps,
208    for fields which are multiple-level fields the levels output are 1-5,
209    and the names of diagnostics quantities are THETA and SALT.
210    
211  \newpage  \newpage
212    
213  \subsubsection{GCM Diagnostic Menu}  \subsubsection{GCM Diagnostic Menu}
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.3
  ViewVC Help
Powered by ViewVC 1.1.22