1 |
C $Header: /u/gcmpack/MITgcm/pkg/diagnostics/diagnostics_main_init.F,v 1.6 2004/12/18 23:53:04 jmc Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#include "DIAG_OPTIONS.h" |
5 |
|
6 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
7 |
CBOP 0 |
8 |
C !ROUTINE: DIAGNOSTICS_MAIN_INIT |
9 |
|
10 |
C !INTERFACE: |
11 |
SUBROUTINE DIAGNOSTICS_MAIN_INIT( myThid ) |
12 |
|
13 |
C !DESCRIPTION: |
14 |
C Initialize available diagnostics list for variables of the main code |
15 |
C (not part of a package): set the following attributes: |
16 |
C name (=cdiag), parsing code (=gdiag), units (=udiag), and title (=tdiag) |
17 |
C Notes: 1) diagnostics defined here do not require any EQUIVALENCE |
18 |
C since they get filled-in with S/R FILL_DIAGNOSTICS |
19 |
C 2) GDIAG is defined as character*16 and can be to character*1 |
20 |
C parse(16) with the following codes currently defined: |
21 |
|
22 |
C \begin{center} |
23 |
C \begin{tabular}[h]{|c|c|}\hline |
24 |
C \textbf{Positions} & \textbf{Characters} |
25 |
C & \textbf{Meanings} \\\hline |
26 |
C parse(1) & S & scalar \\ |
27 |
C & U & vector component in X direction \\ |
28 |
C & V & vector component in Y direction \\ |
29 |
C & W & vector component in vertical direction \\ |
30 |
C parse(2) & U & C-grid U-Point \\ |
31 |
C & V & C-grid V-Point \\ |
32 |
C & M & C-grid Mass Point \\ |
33 |
C & Z & C-grid Corner Point \\ |
34 |
C parse(3) & -- & --Unused-- \\ |
35 |
C parse(4) & P & positive definite \\ |
36 |
C parse(5 ) & C & with counter array \\ |
37 |
C & D & disable an array for output \\ |
38 |
C parse(6--8) & '123' & 3-digit mate number \\ |
39 |
C parse(9) & U & model-level plus 1/2 \\ |
40 |
C & M & model-level middle \\ |
41 |
C & L & model-level minus 1/2 \\ |
42 |
C parse(10) & 0 & levels = 0 \\ |
43 |
C & 1 & levels = 1 \\ |
44 |
C & R & levels = Nr \\ |
45 |
C & L & levels = MAX(Nr,NrPhys) \\ |
46 |
C & M & levels = MAX(Nr,NrPhys) - 1 \\ |
47 |
C \end{tabular} |
48 |
C \end{center} |
49 |
|
50 |
C !USES: |
51 |
IMPLICIT NONE |
52 |
#include "SIZE.h" |
53 |
#include "EEPARAMS.h" |
54 |
c #include "EESUPPORT.h" |
55 |
#include "PARAMS.h" |
56 |
|
57 |
C !INPUT PARAMETERS: |
58 |
INTEGER myThid |
59 |
CEOP |
60 |
|
61 |
C !LOCAL VARIABLES: |
62 |
INTEGER diagNum |
63 |
CHARACTER*8 diagName |
64 |
CHARACTER*16 diagCode |
65 |
CHARACTER*16 diagUnits |
66 |
CHARACTER*(80) diagTitle |
67 |
|
68 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
69 |
C For each output variable, |
70 |
C specify Name (cdiag, 8c), Descriptions (tdiag, *c), Units (udiag, 16c) |
71 |
C and Type/Parms (location on C grid, 2D/3D, ...) (gdiag, 16c) |
72 |
C---------------------------------------------------------------------- |
73 |
|
74 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
75 |
C- state variables of the main code (and related quadratic var): |
76 |
|
77 |
diagName = 'ETAN ' |
78 |
diagTitle = 'Perturbation of Surface (pressure, height) (hPa,m)' |
79 |
diagUnits = 'm or hPa ' |
80 |
diagCode = 'SM M1 ' |
81 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
82 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
83 |
|
84 |
diagName = 'ETANSQ ' |
85 |
diagTitle = 'Square of Perturbation of Sfc (hPa^2,m^2)' |
86 |
diagUnits = 'm2 or hPa2 ' |
87 |
diagCode = 'SM M1 ' |
88 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
89 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
90 |
|
91 |
diagName = 'DETADT2 ' |
92 |
diagTitle = 'Square of Eta (Surf.P,SSH) Tendency ((r_unit/s)^2)' |
93 |
diagUnits = 'm2 or Pa2 /sec2 ' |
94 |
diagCode = 'SM M1 ' |
95 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
96 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
97 |
|
98 |
diagName = 'THETA ' |
99 |
diagTitle = 'Potential Temperature (K)' |
100 |
diagUnits = 'K ' |
101 |
diagCode = 'SM MR ' |
102 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
103 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
104 |
|
105 |
diagName = 'SALT ' |
106 |
diagTitle = 'Salt or Water Vapor mixing ratio (g/kg)' |
107 |
diagUnits = 'g/kg ' |
108 |
diagCode = 'SM MR ' |
109 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
110 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
111 |
|
112 |
diagName = 'UVEL ' |
113 |
diagTitle = 'Zonal Component of Velocity (m/s)' |
114 |
diagUnits = 'm/sec ' |
115 |
WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR ' |
116 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
117 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
118 |
|
119 |
diagName = 'VVEL ' |
120 |
diagTitle = 'Meridional Component of Velocity (m/s)' |
121 |
diagUnits = 'm/sec ' |
122 |
WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum ,'MR ' |
123 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
124 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
125 |
|
126 |
diagName = 'WVEL ' |
127 |
diagTitle = 'Vertical Component of Velocity (m/s)' |
128 |
diagUnits = 'm/sec ' |
129 |
diagCode = 'WM LR ' |
130 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
131 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
132 |
|
133 |
diagName = 'THETASQ ' |
134 |
diagTitle = 'Square of Potential Temperature (K^2)' |
135 |
diagUnits = 'K2 ' |
136 |
diagCode = 'SM MR ' |
137 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
138 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
139 |
|
140 |
diagName = 'SALTSQ ' |
141 |
diagTitle = 'Square of Salt or Water Vapor mix rat (g^2/kg^2)' |
142 |
diagUnits = 'g2/kg2 ' |
143 |
diagCode = 'SM MR ' |
144 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
145 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
146 |
|
147 |
diagName = 'UVELSQ ' |
148 |
diagTitle = 'Square of Zonal Comp of Velocity (m^2/s^2)' |
149 |
diagUnits = 'm2/sec2 ' |
150 |
WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR ' |
151 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
152 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
153 |
|
154 |
diagName = 'VVELSQ ' |
155 |
diagTitle = 'Square of Meridional Comp of Velocity (m^2/s^2)' |
156 |
diagUnits = 'm2/sec2 ' |
157 |
WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum ,'MR ' |
158 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
159 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
160 |
|
161 |
diagName = 'WVELSQ ' |
162 |
diagTitle = 'Square of Vertical Comp of Velocity (m^2/s^2)' |
163 |
diagUnits = 'm2/sec2 ' |
164 |
diagCode = 'WM LR ' |
165 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
166 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
167 |
|
168 |
diagName = 'UVELVVEL' |
169 |
diagTitle = 'Meridional Transport of Zonal Momentum (m^2/s^2)' |
170 |
diagUnits = 'm2/sec2 ' |
171 |
WRITE(diagCode,'(A,I3.3,A)') 'UZ ', diagNum+1 ,'MR ' |
172 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
173 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
174 |
|
175 |
diagName = 'UVELMASS' |
176 |
diagTitle = 'Zonal Mass-Weighted Comp of Velocity (m/s)' |
177 |
diagUnits = 'm/sec ' |
178 |
WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR ' |
179 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
180 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
181 |
|
182 |
diagName = 'VVELMASS' |
183 |
diagTitle = 'Meridional Mass-Weighted Comp of Velocity (m/s)' |
184 |
diagUnits = 'm/sec ' |
185 |
WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum ,'MR ' |
186 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
187 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
188 |
|
189 |
diagName = 'WVELMASS' |
190 |
diagTitle = 'Vertical Mass-Weighted Comp of Velocity (m/s)' |
191 |
diagUnits = 'm/sec ' |
192 |
diagCode = 'WM MR ' |
193 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
194 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
195 |
|
196 |
diagName = 'UTHMASS ' |
197 |
diagTitle = 'Zonal Mass-Weight Transp of Pot Temp (m-K/s)' |
198 |
diagUnits = 'm-K/sec ' |
199 |
WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR ' |
200 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
201 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
202 |
|
203 |
diagName = 'VTHMASS ' |
204 |
diagTitle = 'Meridional Mass-Weight Transp of Pot Temp (m-K/s)' |
205 |
diagUnits = 'm-K/sec ' |
206 |
WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum ,'MR ' |
207 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
208 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
209 |
|
210 |
diagName = 'WTHMASS ' |
211 |
diagTitle = 'Vertical Mass-Weight Transp of Pot Temp (m-K/s)' |
212 |
diagUnits = 'm-K/sec ' |
213 |
diagCode = 'WM MR ' |
214 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
215 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
216 |
|
217 |
diagName = 'USLTMASS' |
218 |
diagTitle = 'Zonal Mass-Weight Transp of Salt (m-kg/s-kg)' |
219 |
diagUnits = 'm-kg/s-kg ' |
220 |
WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR ' |
221 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
222 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
223 |
|
224 |
diagName = 'VSLTMASS' |
225 |
diagTitle = 'Meridional Mass-Weight Transp of Salt (m-kg/s-kg)' |
226 |
diagUnits = 'm-kg/s-kg ' |
227 |
WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum ,'MR ' |
228 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
229 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
230 |
|
231 |
diagName = 'WSLTMASS' |
232 |
diagTitle = 'Vertical Mass-Weight Transp of Salt (m-kg/s-kg)' |
233 |
diagUnits = 'm-kg/s-kg ' |
234 |
diagCode = 'WM MR ' |
235 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
236 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
237 |
|
238 |
diagName = 'UVELTH ' |
239 |
diagTitle = 'Zonal Transp of Pot Temp (m-K/s)' |
240 |
diagUnits = 'm-K/sec ' |
241 |
WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR ' |
242 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
243 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
244 |
|
245 |
diagName = 'VVELTH ' |
246 |
diagTitle = 'Meridional Transp of Pot Temp (m-K/s)' |
247 |
diagUnits = 'm-K/sec ' |
248 |
WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum ,'MR ' |
249 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
250 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
251 |
|
252 |
diagName = 'WVELTH ' |
253 |
diagTitle = 'Vertical Transp of Pot Temp (m-K/s)' |
254 |
diagUnits = 'm-K/sec ' |
255 |
diagCode = 'WM MR ' |
256 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
257 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
258 |
|
259 |
diagName = 'UVELSLT ' |
260 |
diagTitle = 'Zonal Transp of Salt (m-kg/s-kg)' |
261 |
diagUnits = 'm-kg/s-kg ' |
262 |
WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR ' |
263 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
264 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
265 |
|
266 |
diagName = 'VVELSLT ' |
267 |
diagTitle = 'Meridional Transp of Salt (m-kg/s-kg)' |
268 |
diagUnits = 'm-kg/s-kg ' |
269 |
WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum ,'MR ' |
270 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
271 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
272 |
|
273 |
diagName = 'WVELSLT ' |
274 |
diagTitle = 'Vertical Transp of Salt (m-kg/s-kg)' |
275 |
diagUnits = 'm-kg/s-kg ' |
276 |
diagCode = 'WM MR ' |
277 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
278 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
279 |
|
280 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
281 |
|
282 |
diagName = 'RHOAnoma' |
283 |
diagTitle = 'Density Anomaly (=Rho-rhoConst)' |
284 |
diagUnits = 'kg/m^3 ' |
285 |
diagCode = 'SM MR ' |
286 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
287 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
288 |
|
289 |
diagName = 'PHIHYD ' |
290 |
diagTitle = 'Hydrostatic (ocean) pressure / (atmos) geo-Potential' |
291 |
diagUnits = 'm2/s2 ' |
292 |
diagCode = 'SM MR ' |
293 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
294 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
295 |
|
296 |
diagName = 'PHIBOT ' |
297 |
diagTitle = 'ocean bottom pressure / top. atmos geo-Potential' |
298 |
diagUnits = 'm2/s2 ' |
299 |
diagCode = 'SM M1 ' |
300 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
301 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
302 |
|
303 |
diagName = 'PHIBOTSQ' |
304 |
diagTitle = 'Square of ocean bottom pressure / top. geo-Potential' |
305 |
diagUnits = 'm4/s4 ' |
306 |
diagCode = 'SM M1 ' |
307 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
308 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
309 |
|
310 |
diagName = 'DRHODR ' |
311 |
diagTitle = 'Stratification: d.Sigma/dr (kg/m3/r_unit) ' |
312 |
diagUnits = 'kg/m4 ' |
313 |
diagCode = 'SM LR ' |
314 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
315 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
316 |
|
317 |
C-- Momentum terms: |
318 |
diagName = 'VISCA4 ' |
319 |
diagTitle = 'Biharmonic Viscosity Coefficient in (m4/s) ' |
320 |
diagUnits = 'm4/sec ' |
321 |
diagCode = 'SM MR ' |
322 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
323 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
324 |
|
325 |
diagName = 'VISCAH ' |
326 |
diagTitle = 'Harmonic Viscosity Coefficient in (m2/s) ' |
327 |
diagUnits = 'm2/sec ' |
328 |
diagCode = 'SM MR ' |
329 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
330 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
331 |
|
332 |
C-- surface fluxes: |
333 |
diagName = 'TAUX ' |
334 |
diagTitle = 'zonal surface wind stress, >0 increases uVel ' |
335 |
diagUnits = 'N/m2 ' |
336 |
diagCode = 'SU U1 ' |
337 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
338 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
339 |
|
340 |
diagName = 'TAUY ' |
341 |
diagTitle = 'meridional surf. wind stress, >0 increases vVel ' |
342 |
diagUnits = 'N/m2 ' |
343 |
diagCode = 'SV U1 ' |
344 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
345 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
346 |
|
347 |
diagName = 'TFLUX ' |
348 |
diagTitle = 'net surface heat flux, >0 increases theta ' |
349 |
diagUnits = 'W/m2 ' |
350 |
diagCode = 'SM U1 ' |
351 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
352 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
353 |
|
354 |
diagName = 'TRELAX ' |
355 |
diagTitle = 'surface temperature relaxation, >0 increases theta' |
356 |
diagUnits = 'W/m2 ' |
357 |
diagCode = 'SM U1 ' |
358 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
359 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
360 |
|
361 |
diagName = 'TICE ' |
362 |
diagTitle = 'heat from melt/freeze of sea-ice, >0 increases theta' |
363 |
diagUnits = 'W/m2 ' |
364 |
diagCode = 'SM U1 ' |
365 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
366 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
367 |
|
368 |
diagName = 'SFLUX ' |
369 |
diagTitle = 'net surface salt flux, >0 increases salt ' |
370 |
diagUnits = 'g/m2/s ' |
371 |
diagCode = 'SM U1 ' |
372 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
373 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
374 |
|
375 |
diagName = 'SRELAX ' |
376 |
diagTitle = 'surface salinity relaxation, >0 increases salt ' |
377 |
diagUnits = 'g/m2/s ' |
378 |
diagCode = 'SM U1 ' |
379 |
CALL DIAGNOSTICS_ADD2LIST( diagNum, |
380 |
I diagName, diagCode, diagUnits, diagTitle, myThid ) |
381 |
|
382 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
383 |
|
384 |
RETURN |
385 |
END |