/[MITgcm]/MITgcm/pkg/diagnostics/DIAGNOSTICS.h
ViewVC logotype

Annotation of /MITgcm/pkg/diagnostics/DIAGNOSTICS.h

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


Revision 1.17 - (hide annotations) (download)
Mon Jun 27 22:23:09 2011 UTC (12 years, 10 months ago) by jmc
Branch: MAIN
Changes since 1.16: +32 -29 lines
File MIME type: text/plain
add run-time parameter "useMissingValue" (def=False) to fill land-point
 (i.e., where mask=0) with MissingValue ; used only in MNC output file.
this replace CPP-option DIAGNOSTICS_MISSING_VALUE.

1 jmc 1.17 C $Header: /u/gcmpack/MITgcm/pkg/diagnostics/DIAGNOSTICS.h,v 1.16 2010/01/15 00:24:37 jmc Exp $
2 jmc 1.1 C $Name: $
3    
4     C ======================================================================
5     C Common blocks for diagnostics package.
6 jmc 1.13 C - DIAG_DEFINE contains the definition of all available diagnostics
7 jmc 1.1 C ndiagt :: total number of available diagnostics
8 jmc 1.13 C kdiag :: number of levels associated with the diagnostic
9 jmc 1.16 C hdiag :: mate number (in available diag. list) of the diagnostic
10 jmc 1.14 C cdiag :: list of available diagnostic names
11 jmc 1.16 C gdiag :: parser field with characteristics of the diagnostics
12 jmc 1.13 C tdiag :: description of field in diagnostic
13     C udiag :: physical units of the diagnostic field
14     C - DIAG_STORE contains the large array to store diagnostic fields
15 jmc 1.14 C qdiag :: storage array for 2D/3D diagnostic fields
16 jmc 1.13 C qSdiag :: storage array for diagnostics of (per level) statistics
17 jmc 1.14 C ndiag :: holds number of times a diagnostic is filled (for time-mean diag)
18 jmc 1.13 C - DIAG_SELECT contains the user selection of diagnostics to write
19     C idiag :: slot number in large diagnostic array
20     C mdiag :: slot number in large diagnostic array for the mate
21     C jdiag :: short-list (active diag.) to long-list (available diag.)
22     C pointer
23     C - DIAG_STATIS contains the user selection of statistics to write
24 jmc 1.1 C ======================================================================
25    
26 jmc 1.13 C-- DIAG_DEFINE common block:
27 jmc 1.14 C ndiagt :: total number of available diagnostics
28     C kdiag :: number of levels associated with the diagnostic
29 jmc 1.16 C hdiag :: mate number (in available diag. list) of the diagnostic
30 jmc 1.14 C cdiag :: list of available diagnostic names
31 jmc 1.16 C gdiag :: parser field with characteristics of the diagnostics
32 jmc 1.14 C tdiag :: description of field in diagnostic
33     C udiag :: physical units of the diagnostic field
34 jmc 1.13
35     INTEGER ndiagt
36     INTEGER kdiag(ndiagMax)
37 jmc 1.14 INTEGER hdiag(ndiagMax)
38 jmc 1.13 CHARACTER*8 cdiag(ndiagMax)
39     CHARACTER*80 tdiag(ndiagMax)
40     CHARACTER*16 gdiag(ndiagMax)
41     CHARACTER*16 udiag(ndiagMax)
42    
43 jmc 1.16 COMMON / DIAG_DEFINE_I /
44     & ndiagt, kdiag, hdiag
45     COMMON / DIAG_DEFINE_C /
46     & cdiag, gdiag, tdiag, udiag
47 jmc 1.13
48     C-- DIAG_STORE common block:
49 jmc 1.14 C qdiag :: storage array for 2D/3D diagnostic fields
50 jmc 1.13 C qSdiag :: storage array for (per level) statistics
51 jmc 1.14 C ndiag :: holds number of times a diagnostic is filled (for time-mean diag)
52 jmc 1.13 C pdiag :: index of current averaging interval within the averaging-cycle
53 jmc 1.1
54 jmc 1.14 _RL qdiag(1-OLx:sNx+Olx,1-Oly:sNy+Oly,numDiags,nSx,nSy)
55 jmc 1.8 _RL qSdiag(0:nStats,0:nRegions,diagSt_size,nSx,nSy)
56 jmc 1.14 INTEGER ndiag(numDiags,nSx,nSy)
57 jmc 1.17 INTEGER pdiag(numLists,nSx,nSy)
58 jmc 1.1
59 jmc 1.16 COMMON / DIAG_STORE_R / qdiag, qSdiag
60     COMMON / DIAG_STORE_I / ndiag, pdiag
61 jmc 1.1
62 jmc 1.13 C-- DIAG_SELECT common block:
63 jmc 1.16 C freq(n) :: frequency (in s) to write output stream # n
64     C phase(n) :: phase (in s) to write output stream # n
65 jmc 1.13 C averageFreq :: frequency (in s) for periodic averaging interval
66     C averagePhase:: phase (in s) for periodic averaging interval
67     C averageCycle:: number of averaging intervals in 1 cycle
68 mlosch 1.15 C misvalFlt(n):: missing value for floats to use in output stream #n
69     C misvalInt(n):: missing value for integers to use in output stream #n
70 jmc 1.16 C levs(:,n) :: list of selected levels to write for output stream # n
71     C nlevels(n) :: number of levels to write for output stream # n
72 jmc 1.13 C nfields(n) :: number of active diagnostics for output stream # n
73     C nActive(n) :: number of active diagnostics (including counters)
74     C for output stream # n
75     C nlists :: effective number of output streams
76 jmc 1.16 C idiag(:,n) :: list of diag slot number in long-list of available diag.
77     C mdiag(:,n) :: list of mate slot number in long-list of available diag.
78     C jdiag(:,n) :: short-list (active diag.) to long-list (available diag.) pointer
79 jmc 1.13 C flds(:,n) :: list of field names in output stream # n
80     C fnames(n) :: output file name for output stream # n
81     C fflags(n) :: character string with per-file flags
82 jmc 1.16 C settingDiags :: internal flag: enable adding/changing available diagnostics list
83     C dumpAtLast :: always write time-ave (freq>0) diagnostics at the end of the run
84 jmc 1.17 C useMissingValue :: put MissingValue where mask = 0 (NetCDF output only)
85 jmc 1.1
86 jmc 1.17 _RL freq(numLists), phase(numLists)
87     _RL averageFreq(numLists), averagePhase(numLists)
88     _RL misvalFlt(numLists)
89     _RL levs (numLevels,numLists)
90     INTEGER averageCycle(numLists)
91     INTEGER misvalInt(numLists)
92     INTEGER nlevels(numLists)
93     INTEGER nfields(numLists)
94     INTEGER nActive(numLists)
95 jmc 1.13 INTEGER nlists
96 jmc 1.17 INTEGER idiag(numperList,numLists)
97     INTEGER mdiag(numperList,numLists)
98     INTEGER jdiag(numperList,numLists)
99     CHARACTER*8 flds (numperList,numLists)
100     CHARACTER*80 fnames(numLists)
101     CHARACTER*8 fflags(numLists)
102 jmc 1.16 LOGICAL settingDiags
103 jmc 1.17 LOGICAL dumpAtLast
104     LOGICAL diag_mdsio, diag_mnc, useMissingValue
105 jmc 1.13 LOGICAL diag_pickup_read, diag_pickup_write
106     LOGICAL diag_pickup_read_mdsio, diag_pickup_write_mdsio
107     LOGICAL diag_pickup_read_mnc, diag_pickup_write_mnc
108    
109 jmc 1.16 COMMON / DIAG_SELECT_R /
110     & freq, phase, averageFreq, averagePhase,
111     & misvalFlt, levs
112     COMMON / DIAG_SELECT_I /
113     & averageCycle, misvalInt,
114     & nlevels, nfields, nActive,
115     & nlists, idiag, mdiag, jdiag
116     COMMON / DIAG_SELECT_C /
117     & flds, fnames, fflags
118     COMMON / DIAG_SELECT_L /
119 jmc 1.17 & settingDiags, dumpAtLast,
120     & diag_mdsio, diag_mnc, useMissingValue,
121 edhill 1.3 & diag_pickup_read, diag_pickup_write,
122     & diag_pickup_read_mdsio, diag_pickup_write_mdsio,
123 jmc 1.16 & diag_pickup_read_mnc, diag_pickup_write_mnc
124 jmc 1.1
125 jmc 1.8 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
126    
127 jmc 1.13 C-- DIAG_STATIS common block:
128 jmc 1.16 C diagSt_freq(n) :: frequency (in s) to write output stream # n
129     C diagSt_phase(n) :: phase (in s) to write output stream # n
130     C iSdiag(:,n) :: list of diag slot number in long-list of available diag.
131     C mSdiag(:,n) :: list of mate slot number in long-list of available diag.
132     C jSdiag(:,n) :: short-list (active diag.) to long-list (available
133     C diag.) pointer
134 jmc 1.12 C diagSt_region(j,n) :: flag to perform (=1) or not (=0) regional-statistics
135     C over region # j for output stream # n
136     C diagSt_nbFlds(n) :: number of active diagnostics for output stream # n
137     C diagSt_nbActv(n) :: number of active diagnostics (including counters)
138     C for output stream # n
139     C diagSt_nbLists :: effective number of output streams
140     C diagSt_ioUnit(n) :: fortran IO unit for output stream # n (ascii output)
141     C diagSt_Flds(:,n) :: list of field names in output stream # n
142     C diagSt_Fname(n) :: output file name for output stream # n
143    
144 jmc 1.17 _RL diagSt_freq(numLists), diagSt_phase(numLists)
145     INTEGER iSdiag(numperList,numLists)
146     INTEGER mSdiag(numperList,numLists)
147     INTEGER jSdiag(numperList,numLists)
148     INTEGER diagSt_region(0:nRegions,numLists)
149     INTEGER diagSt_nbFlds(numLists)
150     INTEGER diagSt_nbActv(numLists)
151 jmc 1.8 INTEGER diagSt_nbLists
152 jmc 1.17 INTEGER diagSt_ioUnit(numLists)
153     CHARACTER*8 diagSt_Flds(numperList,numLists)
154     CHARACTER*80 diagSt_Fname(numLists)
155 jmc 1.8 LOGICAL diagSt_ascii, diagSt_mnc
156 jmc 1.16
157     COMMON / DIAG_STATIS_R /
158     & diagSt_freq, diagSt_phase
159     COMMON / DIAG_STATIS_I /
160     & iSdiag, mSdiag, jSdiag, diagSt_region,
161 jmc 1.8 & diagSt_nbFlds, diagSt_nbActv, diagSt_nbLists,
162 jmc 1.16 & diagSt_ioUnit
163     COMMON / DIAG_STATIS_C /
164 jmc 1.10 & diagSt_Flds, diagSt_Fname
165 jmc 1.16 COMMON / DIAG_STATIS_L /
166     & diagSt_Ascii, diagSt_mnc
167 jmc 1.1
168     CEH3 ;;; Local Variables: ***
169     CEH3 ;;; mode:fortran ***
170     CEH3 ;;; End: ***

  ViewVC Help
Powered by ViewVC 1.1.22