/[MITgcm]/MITgcm/pkg/diagnostics/diagnostics_out.F
ViewVC logotype

Contents of /MITgcm/pkg/diagnostics/diagnostics_out.F

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


Revision 1.33 - (show annotations) (download)
Wed Jan 31 21:47:55 2007 UTC (17 years, 3 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint58w_post, checkpoint58x_post, checkpoint59e, checkpoint59d, checkpoint59g, checkpoint59f, checkpoint59a, checkpoint59c, checkpoint59b, checkpoint59i, checkpoint59h, checkpoint59j, checkpoint59, checkpoint58y_post, checkpoint58v_post
Changes since 1.32: +2 -7 lines
set maximum size of array to write to "numLevels" (consistent with
length of level list that is read from data.diagnostics)

1 C $Header: /u/gcmpack/MITgcm/pkg/diagnostics/diagnostics_out.F,v 1.32 2006/12/29 23:57:15 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_OUT
9
10 C !INTERFACE:
11 SUBROUTINE DIAGNOSTICS_OUT(
12 I listId,
13 I myIter,
14 I myTime,
15 I myThid )
16
17 C !DESCRIPTION:
18 C Write output for diagnostics fields.
19
20 C !USES:
21 IMPLICIT NONE
22 #include "SIZE.h"
23 #include "EEPARAMS.h"
24 #include "PARAMS.h"
25 #include "GRID.h"
26 #include "DIAGNOSTICS_SIZE.h"
27 #include "DIAGNOSTICS.h"
28
29 INTEGER NrMax
30 PARAMETER( NrMax = numLevels )
31
32 C !INPUT PARAMETERS:
33 C listId :: Diagnostics list number being written
34 C myIter :: current iteration number
35 C myTime :: current time of simulation (s)
36 C myThid :: my Thread Id number
37 _RL myTime
38 INTEGER listId, myIter, myThid
39 CEOP
40
41 C !LOCAL VARIABLES:
42 C i,j,k :: loop indices
43 C lm :: loop index (averageCycle)
44 C md :: field number in the list "listId".
45 C ndId :: diagnostics Id number (in available diagnostics list)
46 C mate :: counter mate Id number (in available diagnostics list)
47 C ip :: diagnostics pointer to storage array
48 C im :: counter-mate pointer to storage array
49 C
50 C-- COMMON /LOCAL_DIAGNOSTICS_OUT/ local common block (for multi-threaded)
51 C qtmp1 :: thread-shared temporary array (needs to be in common block):
52 C to write a diagnostic field to file, copy it first from (big)
53 C diagnostic storage qdiag into it.
54 COMMON /LOCAL_DIAGNOSTICS_OUT/ qtmp1
55 _RL qtmp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,NrMax,nSx,nSy)
56
57 INTEGER i, j, k, lm
58 INTEGER bi, bj
59 INTEGER md, ndId, ip, im
60 INTEGER mate, mVec
61 CHARACTER*8 parms1
62 _RL undef, getcon
63 _RL tmpLev
64 EXTERNAL getcon
65 INTEGER ILNBLNK
66 EXTERNAL ILNBLNK
67 INTEGER ilen
68
69 INTEGER ioUnit
70 CHARACTER*(MAX_LEN_FNAM) fn
71 CHARACTER*(MAX_LEN_MBUF) suff
72 CHARACTER*(MAX_LEN_MBUF) msgBuf
73 #ifdef ALLOW_MDSIO
74 LOGICAL glf
75 INTEGER nRec
76 INTEGER prec
77 #endif
78 #ifdef ALLOW_MNC
79 INTEGER ii
80 CHARACTER*(MAX_LEN_FNAM) diag_mnc_bn
81 INTEGER CW_DIMS, NLEN
82 PARAMETER ( CW_DIMS = 10 )
83 PARAMETER ( NLEN = 80 )
84 INTEGER dim(CW_DIMS), ib(CW_DIMS), ie(CW_DIMS)
85 CHARACTER*(NLEN) dn(CW_DIMS)
86 CHARACTER*(NLEN) d_cw_name
87 CHARACTER*(NLEN) dn_blnk
88 #ifdef DIAG_MNC_COORD_NEEDSWORK
89 CHARACTER*(5) ctmp
90 _RS ztmp(NrMax)
91 #endif
92 #endif /* ALLOW_MNC */
93
94 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
95
96 ioUnit= standardMessageUnit
97 undef = getcon('UNDEF')
98 WRITE(suff,'(I10.10)') myIter
99 ilen = ILNBLNK(fnames(listId))
100 WRITE( fn, '(A,A,A)' ) fnames(listId)(1:ilen),'.',suff(1:10)
101
102 #ifdef ALLOW_MNC
103 IF (useMNC .AND. diag_mnc) THEN
104 DO i = 1,MAX_LEN_FNAM
105 diag_mnc_bn(i:i) = ' '
106 ENDDO
107 DO i = 1,NLEN
108 dn_blnk(i:i) = ' '
109 ENDDO
110 WRITE( diag_mnc_bn, '(A)' ) fnames(listId)(1:ilen)
111
112 C Update the record dimension by writing the iteration number
113 CALL MNC_CW_SET_UDIM(diag_mnc_bn, -1, myThid)
114 CALL MNC_CW_RL_W_S('D',diag_mnc_bn,0,0,'T',myTime,myThid)
115 CALL MNC_CW_SET_UDIM(diag_mnc_bn, 0, myThid)
116 CALL MNC_CW_I_W_S('I',diag_mnc_bn,0,0,'iter',myIter,myThid)
117
118 C NOTE: at some point it would be a good idea to add a time_bounds
119 C variable that has dimension (2,T) and clearly denotes the
120 C beginning and ending times for each diagnostics period
121
122 dn(1)(1:NLEN) = dn_blnk(1:NLEN)
123 WRITE(dn(1),'(a,i6.6)') 'Zmd', nlevels(listId)
124 dim(1) = nlevels(listId)
125 ib(1) = 1
126 ie(1) = nlevels(listId)
127
128 CALL MNC_CW_ADD_GNAME('diag_levels', 1,
129 & dim, dn, ib, ie, myThid)
130 CALL MNC_CW_ADD_VNAME('diag_levels', 'diag_levels',
131 & 0,0, myThid)
132 CALL MNC_CW_ADD_VATTR_TEXT('diag_levels','description',
133 & 'Idicies of vertical levels within the source arrays',
134 & myThid)
135
136 CALL MNC_CW_RL_W('D',diag_mnc_bn,0,0,
137 & 'diag_levels', levs(1,listId), myThid)
138
139 CALL MNC_CW_DEL_VNAME('diag_levels', myThid)
140 CALL MNC_CW_DEL_GNAME('diag_levels', myThid)
141
142 #ifdef DIAG_MNC_COORD_NEEDSWORK
143 C This part has been placed in an #ifdef because, as its currently
144 C written, it will only work with variables defined on a dynamics
145 C grid. As we start using diagnostics for physics grids, ice
146 C levels, land levels, etc. the different vertical coordinate
147 C dimensions will have to be taken into account.
148
149 C 20051021 JMC & EH3 : We need to extend this so that a few
150 C variables each defined on different grids do not have the same
151 C vertical dimension names so we should be using a pattern such
152 C as: Z[uml]td000000 where the 't' is the type as specified by
153 C gdiag(10)
154
155 C Now define: Zmdxxxxxx, Zudxxxxxx, Zldxxxxxx
156 ctmp(1:5) = 'mul '
157 DO i = 1,3
158 dn(1)(1:NLEN) = dn_blnk(1:NLEN)
159 WRITE(dn(1),'(3a,i6.6)') 'Z',ctmp(i:i),'d',nlevels(listId)
160 CALL MNC_CW_ADD_GNAME(dn(1), 1, dim, dn, ib, ie, myThid)
161 CALL MNC_CW_ADD_VNAME(dn(1), dn(1), 0,0, myThid)
162
163 C The following three ztmp() loops should eventually be modified
164 C to reflect the fractional nature of levs(j,l) -- they should
165 C do something like:
166 C ztmp(j) = rC(INT(FLOOR(levs(j,l))))
167 C + ( rC(INT(FLOOR(levs(j,l))))
168 C + rC(INT(CEIL(levs(j,l)))) )
169 C / ( levs(j,l) - FLOOR(levs(j,l)) )
170 C for averaged levels.
171 IF (i .EQ. 1) THEN
172 DO j = 1,nlevels(listId)
173 ztmp(j) = rC(NINT(levs(j,listId)))
174 ENDDO
175 CALL MNC_CW_ADD_VATTR_TEXT(dn(1),'description',
176 & 'Dimensional coordinate value at the mid point',
177 & myThid)
178 ELSEIF (i .EQ. 2) THEN
179 DO j = 1,nlevels(listId)
180 ztmp(j) = rF(NINT(levs(j,listId)) + 1)
181 ENDDO
182 CALL MNC_CW_ADD_VATTR_TEXT(dn(1),'description',
183 & 'Dimensional coordinate value at the upper point',
184 & myThid)
185 ELSEIF (i .EQ. 3) THEN
186 DO j = 1,nlevels(listId)
187 ztmp(j) = rF(NINT(levs(j,listId)))
188 ENDDO
189 CALL MNC_CW_ADD_VATTR_TEXT(dn(1),'description',
190 & 'Dimensional coordinate value at the lower point',
191 & myThid)
192 ENDIF
193 CALL MNC_CW_RS_W('D',diag_mnc_bn,0,0, dn(1), ztmp, myThid)
194 CALL MNC_CW_DEL_VNAME(dn(1), myThid)
195 CALL MNC_CW_DEL_GNAME(dn(1), myThid)
196 ENDDO
197 #endif /* DIAG_MNC_COORD_NEEDSWORK */
198
199 ENDIF
200 #endif /* ALLOW_MNC */
201
202 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
203
204 DO md = 1,nfields(listId)
205 ndId = jdiag(md,listId)
206 parms1 = gdiag(ndId)(1:8)
207 mate = 0
208 mVec = 0
209 IF ( parms1(5:5).EQ.'C' ) THEN
210 C- Check for Mate of a Counter Diagnostic
211 READ(parms1,'(5X,I3)') mate
212 ELSEIF ( parms1(1:1).EQ.'U' .OR. parms1(1:1).EQ.'V' ) THEN
213 C- Check for Mate of a Vector Diagnostic
214 READ(parms1,'(5X,I3)') mVec
215 ENDIF
216 IF ( idiag(md,listId).NE.0 .AND. parms1(5:5).NE.'D' ) THEN
217 C-- Start processing 1 Fld :
218 DO lm=1,averageCycle(listId)
219
220 ip = ABS(idiag(md,listId)) + kdiag(ndId)*(lm-1)
221 im = mdiag(md,listId)
222 IF (mate.GT.0) im = im + kdiag(mate)*(lm-1)
223 IF (mVec.GT.0) im = im + kdiag(mVec)*(lm-1)
224
225 IF ( ndiag(ip,1,1).EQ.0 ) THEN
226 C- Empty diagnostics case :
227
228 _BEGIN_MASTER( myThid )
229 WRITE(msgBuf,'(A,I10)')
230 & '- WARNING - from DIAGNOSTICS_OUT at iter=', myIter
231 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
232 & SQUEEZE_RIGHT, myThid)
233 WRITE(msgBuf,'(A,I4,3A,I3,2A)')
234 & '- WARNING - diag.#',ndId, ' : ',flds(md,listId),
235 & ' (#',md,' ) in outp.Stream: ',fnames(listId)
236 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
237 & SQUEEZE_RIGHT, myThid)
238 IF ( averageCycle(listId).GT.1 ) THEN
239 WRITE(msgBuf,'(A,2(I2,A))')
240 & '- WARNING - has not been filled (ndiag(lm=',lm,')=',
241 & ndiag(ip,1,1), ' )'
242 ELSE
243 WRITE(msgBuf,'(A,2(I2,A))')
244 & '- WARNING - has not been filled (ndiag=',
245 & ndiag(ip,1,1), ' )'
246 ENDIF
247 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
248 & SQUEEZE_RIGHT, myThid)
249 WRITE(msgBuf,'(A)')
250 & 'WARNING DIAGNOSTICS_OUT => write ZEROS instead'
251 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
252 & SQUEEZE_RIGHT, myThid)
253 _END_MASTER( myThid )
254 DO bj = myByLo(myThid), myByHi(myThid)
255 DO bi = myBxLo(myThid), myBxHi(myThid)
256 DO k = 1,nlevels(listId)
257 DO j = 1-OLy,sNy+OLy
258 DO i = 1-OLx,sNx+OLx
259 qtmp1(i,j,k,bi,bj) = 0. _d 0
260 ENDDO
261 ENDDO
262 ENDDO
263 ENDDO
264 ENDDO
265
266 ELSE
267 C- diagnostics is not empty :
268
269 IF ( debugLevel.GE.debLevA .AND. myThid.EQ.1 ) THEN
270 WRITE(ioUnit,'(A,I3,3A,I8,2A)')
271 & ' Computing Diagnostic # ', ndId, ' ', cdiag(ndId),
272 & ' Counter:',ndiag(ip,1,1),' Parms: ',gdiag(ndId)
273 IF ( mate.GT.0 ) THEN
274 WRITE(ioUnit,'(3A,I3,2A)')
275 & ' use Counter Mate for ', cdiag(ndId),
276 & ' Diagnostic # ',mate, ' ', cdiag(mate)
277 ELSEIF ( mVec.GT.0 ) THEN
278 IF ( im.GT.0 .AND. ndiag(MAX(1,im),1,1).GT.0 ) THEN
279 WRITE(ioUnit,'(3A,I3,3A)')
280 & ' Vector Mate for ', cdiag(ndId),
281 & ' Diagnostic # ',mVec, ' ', cdiag(mVec),
282 & ' exists '
283 ELSE
284 WRITE(ioUnit,'(3A,I3,3A)')
285 & ' Vector Mate for ', cdiag(ndId),
286 & ' Diagnostic # ',mVec, ' ', cdiag(mVec),
287 & ' not enabled'
288 ENDIF
289 ENDIF
290 ENDIF
291
292 IF ( fflags(listId)(2:2).EQ.'P' ) THEN
293 C- get all the levels (for vertical interpolation)
294 DO bj = myByLo(myThid), myByHi(myThid)
295 DO bi = myBxLo(myThid), myBxHi(myThid)
296 DO k = 1,kdiag(ndId)
297 tmpLev = k
298 CALL GETDIAG(
299 I tmpLev,undef,
300 O qtmp1(1-OLx,1-OLy,k,bi,bj),
301 I ndId,mate,ip,im,bi,bj,myThid)
302 ENDDO
303 ENDDO
304 ENDDO
305 ELSE
306 C- get only selected levels:
307 DO bj = myByLo(myThid), myByHi(myThid)
308 DO bi = myBxLo(myThid), myBxHi(myThid)
309 DO k = 1,nlevels(listId)
310 CALL GETDIAG(
311 I levs(k,listId),undef,
312 O qtmp1(1-OLx,1-OLy,k,bi,bj),
313 I ndId,mate,ip,im,bi,bj,myThid)
314 ENDDO
315 ENDDO
316 ENDDO
317 ENDIF
318
319 C- end of empty diag / not empty block
320 ENDIF
321
322 C-----------------------------------------------------------------------
323 C Check to see if we need to interpolate before output
324 C-----------------------------------------------------------------------
325 IF ( fflags(listId)(2:2).EQ.'P' ) THEN
326 C- Do vertical interpolation:
327 IF ( fluidIsAir ) THEN
328 C jmc: for now, this can only work in an atmospheric set-up (fluidIsAir);
329 CALL DIAGNOSTICS_INTERP_VERT(
330 I listId, md, ndId, ip, im, lm,
331 U qtmp1,
332 I undef, myTime, myIter, myThid )
333 ELSE
334 WRITE(msgBuf,'(2A)') 'DIAGNOSTICS_OUT: ',
335 & 'INTERP_VERT not allowed in this config'
336 CALL PRINT_ERROR( msgBuf , myThid )
337 STOP 'ABNORMAL END: S/R DIAGNOSTICS_OUT'
338 ENDIF
339 ENDIF
340
341 C-- Ready to write field "md", element "lm" in averageCycle(listId)
342
343 #ifdef ALLOW_MDSIO
344 C- write to binary file, using MDSIO pkg:
345 IF (diag_mdsio) THEN
346 glf = globalFiles
347 nRec = lm + (md-1)*averageCycle(listId)
348 C default precision for output files
349 prec = writeBinaryPrec
350 C fFlag(1)=R(or D): force it to be 32-bit(or 64) precision
351 IF ( fflags(listId)(1:1).EQ.'R' ) prec = precFloat32
352 IF ( fflags(listId)(1:1).EQ.'D' ) prec = precFloat64
353 c CALL MDS_WRITE_FIELD(fn,prec,glf,.FALSE.,'RL',
354 c & NrMax,nlevels(listId),qtmp1,nRec,myIter,myThid)
355 C a hack not to write meta files now:
356 CALL MDS_WRITE_FIELD(fn,prec,glf,.FALSE.,'RL',
357 & NrMax,nlevels(listId),qtmp1,-nRec,myIter,myThid)
358 ENDIF
359 #endif /* ALLOW_MDSIO */
360
361 #ifdef ALLOW_MNC
362 IF (useMNC .AND. diag_mnc) THEN
363
364 _BEGIN_MASTER( myThid )
365
366 DO ii = 1,CW_DIMS
367 d_cw_name(1:NLEN) = dn_blnk(1:NLEN)
368 dn(ii)(1:NLEN) = dn_blnk(1:NLEN)
369 ENDDO
370
371 C Note that the "d_cw_name" variable is a hack that hides a
372 C subtlety within MNC. Basically, each MNC-wrapped file is
373 C caching its own concept of what each "grid name" (that is, a
374 C dimension group name) means. So one cannot re-use the same
375 C "grid" name for different collections of dimensions within a
376 C given file. By appending the "ndId" values to each name, we
377 C guarantee uniqueness within each MNC-produced file.
378 WRITE(d_cw_name,'(a,i6.6)') 'd_cw_',ndId
379
380 C XY dimensions
381 dim(1) = sNx + 2*OLx
382 dim(2) = sNy + 2*OLy
383 ib(1) = OLx + 1
384 ib(2) = OLy + 1
385 IF (gdiag(ndId)(2:2) .EQ. 'M') THEN
386 dn(1)(1:2) = 'X'
387 ie(1) = OLx + sNx
388 dn(2)(1:2) = 'Y'
389 ie(2) = OLy + sNy
390 ELSEIF (gdiag(ndId)(2:2) .EQ. 'U') THEN
391 dn(1)(1:3) = 'Xp1'
392 ie(1) = OLx + sNx + 1
393 dn(2)(1:2) = 'Y'
394 ie(2) = OLy + sNy
395 ELSEIF (gdiag(ndId)(2:2) .EQ. 'V') THEN
396 dn(1)(1:2) = 'X'
397 ie(1) = OLx + sNx
398 dn(2)(1:3) = 'Yp1'
399 ie(2) = OLy + sNy + 1
400 ELSEIF (gdiag(ndId)(2:2) .EQ. 'Z') THEN
401 dn(1)(1:3) = 'Xp1'
402 ie(1) = OLx + sNx + 1
403 dn(2)(1:3) = 'Yp1'
404 ie(2) = OLy + sNy + 1
405 ENDIF
406
407 C Z is special since it varies
408 WRITE(dn(3),'(a,i6.6)') 'Zd', nlevels(listId)
409 IF ( (gdiag(ndId)(10:10) .EQ. 'R')
410 & .AND. (gdiag(ndId)(9:9) .EQ. 'M') ) THEN
411 WRITE(dn(3),'(a,i6.6)') 'Zmd', nlevels(listId)
412 ENDIF
413 IF ( (gdiag(ndId)(10:10) .EQ. 'R')
414 & .AND. (gdiag(ndId)(9:9) .EQ. 'L') ) THEN
415 WRITE(dn(3),'(a,i6.6)') 'Zld', nlevels(listId)
416 ENDIF
417 IF ( (gdiag(ndId)(10:10) .EQ. 'R')
418 & .AND. (gdiag(ndId)(9:9) .EQ. 'U') ) THEN
419 WRITE(dn(3),'(a,i6.6)') 'Zud', nlevels(listId)
420 ENDIF
421 dim(3) = NrMax
422 ib(3) = 1
423 ie(3) = nlevels(listId)
424
425 C Time dimension
426 dn(4)(1:1) = 'T'
427 dim(4) = -1
428 ib(4) = 1
429 ie(4) = 1
430
431 CALL MNC_CW_ADD_GNAME(d_cw_name, 4,
432 & dim, dn, ib, ie, myThid)
433 CALL MNC_CW_ADD_VNAME(cdiag(ndId), d_cw_name,
434 & 4,5, myThid)
435 CALL MNC_CW_ADD_VATTR_TEXT(cdiag(ndId),'description',
436 & tdiag(ndId),myThid)
437 CALL MNC_CW_ADD_VATTR_TEXT(cdiag(ndId),'units',
438 & udiag(ndId),myThid)
439
440 C Per the observations of Baylor, this has been commented out
441 C until we have code that can write missing_value attributes
442 C in a way thats compatible with most of the more popular
443 C netCDF tools including ferret. Using all-zeros completely
444 C breaks ferret.
445
446 C CALL MNC_CW_ADD_VATTR_DBL(cdiag(ndId),'missing_value',
447 C & 0.0 _d 0,myThid)
448
449 IF ( ( (writeBinaryPrec .EQ. precFloat32)
450 & .AND. (fflags(listId)(1:1) .NE. 'D')
451 & .AND. (fflags(listId)(1:1) .NE. 'R') )
452 & .OR. (fflags(listId)(1:1) .EQ. 'R')) THEN
453 CALL MNC_CW_RL_W('R',diag_mnc_bn,0,0,
454 & cdiag(ndId), qtmp1, myThid)
455 ELSEIF ( (writeBinaryPrec .EQ. precFloat64)
456 & .OR. (fflags(listId)(1:1) .EQ. 'D') ) THEN
457 CALL MNC_CW_RL_W('D',diag_mnc_bn,0,0,
458 & cdiag(ndId), qtmp1, myThid)
459 ENDIF
460
461 CALL MNC_CW_DEL_VNAME(cdiag(ndId), myThid)
462 CALL MNC_CW_DEL_GNAME(d_cw_name, myThid)
463
464 _END_MASTER( myThid )
465
466 ENDIF
467 #endif /* ALLOW_MNC */
468
469 ENDDO
470 C-- end of Processing Fld # md
471 ENDIF
472 ENDDO
473
474 #ifdef ALLOW_MDSIO
475 IF (diag_mdsio) THEN
476 C- Note: temporary: since it's a pain to add more arguments to
477 C all MDSIO S/R, uses instead this specific S/R to write only
478 C meta files but with more informations in it.
479 nRec = nfields(listId)*averageCycle(listId)
480 CALL MDS_WR_METAFILES(fn, prec, glf, .FALSE.,
481 & 0, 0, nlevels(listId), ' ',
482 & nfields(listId), flds(1,listId), 1, myTime,
483 & nRec, myIter, myThid)
484 ENDIF
485 #endif /* ALLOW_MDSIO */
486
487 RETURN
488 END
489
490 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|

  ViewVC Help
Powered by ViewVC 1.1.22