/[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.32 - (show annotations) (download)
Fri Dec 29 23:57:15 2006 UTC (17 years, 4 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint58u_post, checkpoint58t_post
Changes since 1.31: +9 -4 lines
fix for multi-threaded.

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

  ViewVC Help
Powered by ViewVC 1.1.22