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

Annotation of /MITgcm/pkg/diagnostics/diagnostics_mnc_out.F

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


Revision 1.5 - (hide annotations) (download)
Wed Feb 6 16:24:29 2013 UTC (11 years, 3 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint64y, checkpoint64x, checkpoint64z, checkpoint64q, checkpoint64p, checkpoint64s, checkpoint64r, checkpoint64u, checkpoint64t, checkpoint64w, checkpoint64v, checkpoint64i, checkpoint64h, checkpoint64k, checkpoint64j, checkpoint64m, checkpoint64l, checkpoint64o, checkpoint64n, checkpoint64e, checkpoint64d, checkpoint64g, checkpoint64f, checkpoint65, checkpoint66g, checkpoint66f, checkpoint66e, checkpoint66d, checkpoint66c, checkpoint66b, checkpoint66a, checkpoint66o, checkpoint66n, checkpoint66m, checkpoint66l, checkpoint66k, checkpoint66j, checkpoint66i, checkpoint66h, checkpoint65z, checkpoint65x, checkpoint65y, checkpoint65r, checkpoint65s, checkpoint65p, checkpoint65q, checkpoint65v, checkpoint65w, checkpoint65t, checkpoint65u, checkpoint65j, checkpoint65k, checkpoint65h, checkpoint65i, checkpoint65n, checkpoint65o, checkpoint65l, checkpoint65m, checkpoint65b, checkpoint65c, checkpoint65a, checkpoint65f, checkpoint65g, checkpoint65d, checkpoint65e, HEAD
Changes since 1.4: +1 -3 lines
remove setting of misvalIntLoc (not used)

1 jmc 1.5 C $Header: /u/gcmpack/MITgcm/pkg/diagnostics/diagnostics_mnc_out.F,v 1.4 2011/06/27 22:27:23 jmc Exp $
2 jmc 1.1 C $Name: $
3    
4     #include "DIAG_OPTIONS.h"
5     #undef DIAG_MNC_COORD_NEEDSWORK
6    
7     C-- File diagnostics_mnc_out.F: Routines to write MNC diagnostics output
8     C-- Contents:
9     C-- o DIAGNOSTICS_MNC_SET
10     C-- o DIAGNOSTICS_MNC_OUT
11    
12     C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
13     CBOP 0
14     C !ROUTINE: DIAGNOSTICS_MNC_SET
15    
16     C !INTERFACE:
17     SUBROUTINE DIAGNOSTICS_MNC_SET(
18     I nLevOutp, listId, lm,
19 jmc 1.4 O diag_mnc_bn,
20 jmc 1.2 I misValLoc, myTime, myIter, myThid )
21 jmc 1.1
22     C !DESCRIPTION:
23     C Set MNC file for writing diagnostics fields.
24    
25     C !USES:
26     IMPLICIT NONE
27     #include "SIZE.h"
28     #include "EEPARAMS.h"
29     #include "PARAMS.h"
30     #include "GRID.h"
31     #include "DIAGNOSTICS_SIZE.h"
32     #include "DIAGNOSTICS.h"
33    
34    
35 jmc 1.3 C !INPUT/OUTPUT PARAMETERS:
36     C nLevOutp :: number of levels to write in output file
37     C listId :: Diagnostics list number being written
38     C lm :: loop index (averageCycle)
39     C diag_mnc_bn :: NetCDF output file name
40     C misValLoc :: local Missing Value
41     C myTime :: current time of simulation (s)
42     C myIter :: current iteration number
43     C myThid :: my Thread Id number
44 jmc 1.1 INTEGER nLevOutp
45     INTEGER listId, lm
46     CHARACTER*(MAX_LEN_FNAM) diag_mnc_bn
47 jmc 1.3 _RL misValLoc
48 jmc 1.1 _RL myTime
49     INTEGER myIter, myThid
50     CEOP
51    
52     #ifdef ALLOW_MNC
53     C !FUNCTIONS:
54     INTEGER ILNBLNK
55     EXTERNAL ILNBLNK
56    
57     C !LOCAL VARIABLES:
58     _RL tmpLev
59     INTEGER iLen
60    
61     c CHARACTER*(MAX_LEN_MBUF) msgBuf
62     INTEGER ii, klev
63     INTEGER CW_DIMS, NLEN
64     PARAMETER ( CW_DIMS = 10 )
65     PARAMETER ( NLEN = 80 )
66     INTEGER dim(CW_DIMS), ib(CW_DIMS), ie(CW_DIMS)
67     CHARACTER*(NLEN) dn(CW_DIMS)
68     c CHARACTER*(NLEN) d_cw_name
69     c CHARACTER*(NLEN) dn_blnk
70     #ifdef DIAG_MNC_COORD_NEEDSWORK
71 jmc 1.3 INTEGER NrMax
72     PARAMETER( NrMax = numLevels )
73 jmc 1.1 INTEGER i, j
74     CHARACTER*(5) ctmp
75     _RS ztmp(NrMax)
76     #endif
77     REAL*8 misval_r8(2)
78     REAL*4 misval_r4(2)
79     INTEGER misval_int(2)
80    
81     C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
82     c IF (useMNC .AND. diag_mnc) THEN
83    
84     C Handle missing value attribute (land points)
85     C Defaults to UNSET_I
86     DO ii=1,2
87     misval_r4(ii) = misValLoc
88     misval_r8(ii) = misValLoc
89     misval_int(ii) = UNSET_I
90     ENDDO
91     c DO i = 1,MAX_LEN_FNAM
92     c diag_mnc_bn(i:i) = ' '
93     c ENDDO
94     c DO i = 1,NLEN
95     c dn_blnk(i:i) = ' '
96     c ENDDO
97     iLen = ILNBLNK(fnames(listId))
98     WRITE( diag_mnc_bn, '(A)' ) fnames(listId)(1:iLen)
99    
100     C Update the record dimension by writing the iteration number
101     klev = myIter + lm - averageCycle(listId)
102     tmpLev = myTime + deltaTClock*( lm - averageCycle(listId) )
103     CALL MNC_CW_SET_UDIM(diag_mnc_bn, -1, myThid)
104     CALL MNC_CW_RL_W_S('D',diag_mnc_bn,0,0,'T',tmpLev,myThid)
105     CALL MNC_CW_SET_UDIM(diag_mnc_bn, 0, myThid)
106     CALL MNC_CW_I_W_S('I',diag_mnc_bn,0,0,'iter',klev,myThid)
107    
108     C NOTE: at some point it would be a good idea to add a time_bounds
109     C variable that has dimension (2,T) and clearly denotes the
110     C beginning and ending times for each diagnostics period
111    
112     c dn(1)(1:NLEN) = dn_blnk(1:NLEN)
113     WRITE(dn(1),'(a,i6.6)') 'Zmd', nLevOutp
114     dim(1) = nLevOutp
115     ib(1) = 1
116     ie(1) = nLevOutp
117    
118     CALL MNC_CW_ADD_GNAME('diag_levels', 1,
119     & dim, dn, ib, ie, myThid)
120     CALL MNC_CW_ADD_VNAME('diag_levels', 'diag_levels',
121     & 0,0, myThid)
122     CALL MNC_CW_ADD_VATTR_TEXT('diag_levels','description',
123     & 'Idicies of vertical levels within the source arrays',
124     & myThid)
125     C suppress the missing value attribute (iflag = 0)
126 jmc 1.3 CALL MNC_CW_VATTR_MISSING('diag_levels', 0,
127 jmc 1.1 I misval_r8, misval_r4, misval_int, myThid )
128    
129     CALL MNC_CW_RL_W('D',diag_mnc_bn,0,0,
130     & 'diag_levels', levs(1,listId), myThid)
131    
132     CALL MNC_CW_DEL_VNAME('diag_levels', myThid)
133     CALL MNC_CW_DEL_GNAME('diag_levels', myThid)
134    
135     #ifdef DIAG_MNC_COORD_NEEDSWORK
136     C This part has been placed in an #ifdef because, as its currently
137     C written, it will only work with variables defined on a dynamics
138     C grid. As we start using diagnostics for physics grids, ice
139     C levels, land levels, etc. the different vertical coordinate
140     C dimensions will have to be taken into account.
141    
142     C 20051021 JMC & EH3 : We need to extend this so that a few
143     C variables each defined on different grids do not have the same
144     C vertical dimension names so we should be using a pattern such
145     C as: Z[uml]td000000 where the 't' is the type as specified by
146     C gdiag(10)
147    
148     C Now define: Zmdxxxxxx, Zudxxxxxx, Zldxxxxxx
149     ctmp(1:5) = 'mul '
150     DO i = 1,3
151     c dn(1)(1:NLEN) = dn_blnk(1:NLEN)
152     WRITE(dn(1),'(3a,i6.6)') 'Z',ctmp(i:i),'d',nlevels(listId)
153     CALL MNC_CW_ADD_GNAME(dn(1), 1, dim, dn, ib, ie, myThid)
154     CALL MNC_CW_ADD_VNAME(dn(1), dn(1), 0,0, myThid)
155    
156     C The following three ztmp() loops should eventually be modified
157     C to reflect the fractional nature of levs(j,l) -- they should
158     C do something like:
159     C ztmp(j) = rC(INT(FLOOR(levs(j,l))))
160     C + ( rC(INT(FLOOR(levs(j,l))))
161     C + rC(INT(CEIL(levs(j,l)))) )
162     C / ( levs(j,l) - FLOOR(levs(j,l)) )
163     C for averaged levels.
164     IF (i .EQ. 1) THEN
165     DO j = 1,nlevels(listId)
166     ztmp(j) = rC(NINT(levs(j,listId)))
167     ENDDO
168     CALL MNC_CW_ADD_VATTR_TEXT(dn(1),'description',
169     & 'Dimensional coordinate value at the mid point',
170     & myThid)
171     ELSEIF (i .EQ. 2) THEN
172     DO j = 1,nlevels(listId)
173     ztmp(j) = rF(NINT(levs(j,listId)) + 1)
174     ENDDO
175     CALL MNC_CW_ADD_VATTR_TEXT(dn(1),'description',
176     & 'Dimensional coordinate value at the upper point',
177     & myThid)
178     ELSEIF (i .EQ. 3) THEN
179     DO j = 1,nlevels(listId)
180     ztmp(j) = rF(NINT(levs(j,listId)))
181     ENDDO
182     CALL MNC_CW_ADD_VATTR_TEXT(dn(1),'description',
183     & 'Dimensional coordinate value at the lower point',
184     & myThid)
185     ENDIF
186     C suppress the missing value attribute (iflag = 0)
187 jmc 1.4 IF (useMissingValue)
188 jmc 1.1 & CALL MNC_CW_VATTR_MISSING(dn(1), 0,
189     I misval_r8, misval_r4, misval_int, myThid )
190     CALL MNC_CW_RS_W('D',diag_mnc_bn,0,0, dn(1), ztmp, myThid)
191     CALL MNC_CW_DEL_VNAME(dn(1), myThid)
192     CALL MNC_CW_DEL_GNAME(dn(1), myThid)
193     ENDDO
194     #endif /* DIAG_MNC_COORD_NEEDSWORK */
195    
196     c ENDIF
197     #endif /* ALLOW_MNC */
198    
199     RETURN
200     END
201    
202     C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
203     CBOP 0
204     C !ROUTINE: DIAGNOSTICS_MNC_OUT
205    
206     C !INTERFACE:
207     SUBROUTINE DIAGNOSTICS_MNC_OUT(
208 jmc 1.3 I NrMax, nLevOutp, listId, ndId, mate,
209 jmc 1.4 I diag_mnc_bn, qtmp,
210     I misValLoc, myTime, myIter, myThid )
211 jmc 1.1
212     C !DESCRIPTION:
213     C write diagnostics fields to MNC file.
214    
215     C !USES:
216     IMPLICIT NONE
217     #include "SIZE.h"
218     #include "EEPARAMS.h"
219     #include "PARAMS.h"
220     #include "GRID.h"
221     #include "DIAGNOSTICS_SIZE.h"
222     #include "DIAGNOSTICS.h"
223    
224     C !INPUT PARAMETERS:
225 jmc 1.3 C NrMax :: 3rd dimension of output-field array to write
226     C nLevOutp :: number of levels to write in output file
227     C listId :: Diagnostics list number being written
228     C ndId :: diagnostics Id number (in available diagnostics list)
229     C mate :: counter diagnostic number if any ; 0 otherwise
230     C diag_mnc_bn :: NetCDF output file name
231 jmc 1.4 C qtmp :: output-field array to write
232 jmc 1.3 C misValLoc :: local Missing Value
233     C myTime :: current time of simulation (s)
234     C myIter :: current iteration number
235     C myThid :: my Thread Id number
236 jmc 1.1 INTEGER NrMax
237     INTEGER nLevOutp
238 jmc 1.3 INTEGER listId, ndId, mate
239 jmc 1.1 CHARACTER*(MAX_LEN_FNAM) diag_mnc_bn
240 jmc 1.4 _RL qtmp(1-OLx:sNx+OLx,1-OLy:sNy+OLy,NrMax,nSx,nSy)
241 jmc 1.3 _RL misValLoc
242 jmc 1.1 _RL myTime
243     INTEGER myIter, myThid
244     CEOP
245    
246 jmc 1.3 #ifdef ALLOW_MNC
247 jmc 1.1 C !FUNCTIONS:
248     c INTEGER ILNBLNK
249     c EXTERNAL ILNBLNK
250    
251     C !LOCAL VARIABLES:
252     C i,j,k :: loop indices
253     C bi,bj :: tile indices
254     INTEGER i, j, k
255     INTEGER bi, bj
256    
257     c CHARACTER*(MAX_LEN_MBUF) msgBuf
258     c INTEGER ll, llMx, jj, jjMx
259     INTEGER ii, klev
260     INTEGER CW_DIMS, NLEN
261     PARAMETER ( CW_DIMS = 10 )
262     PARAMETER ( NLEN = 80 )
263     INTEGER dim(CW_DIMS), ib(CW_DIMS), ie(CW_DIMS)
264     CHARACTER*(NLEN) dn(CW_DIMS)
265     CHARACTER*(NLEN) d_cw_name
266     c CHARACTER*(NLEN) dn_blnk
267     LOGICAL useMisValForThisDiag
268     REAL*8 misval_r8(2)
269     REAL*4 misval_r4(2)
270     INTEGER misval_int(2)
271    
272     C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
273     c IF (useMNC .AND. diag_mnc) THEN
274    
275     _BEGIN_MASTER( myThid )
276    
277     DO ii = 1,CW_DIMS
278     c d_cw_name(1:NLEN) = dn_blnk(1:NLEN)
279     c dn(ii)(1:NLEN) = dn_blnk(1:NLEN)
280     dn(ii) = ' '
281     ENDDO
282     DO ii=1,2
283     misval_r4(ii) = misValLoc
284     misval_r8(ii) = misValLoc
285     misval_int(ii) = UNSET_I
286     ENDDO
287    
288     C Note that the "d_cw_name" variable is a hack that hides a
289     C subtlety within MNC. Basically, each MNC-wrapped file is
290     C caching its own concept of what each "grid name" (that is, a
291     C dimension group name) means. So one cannot re-use the same
292     C "grid" name for different collections of dimensions within a
293     C given file. By appending the "ndId" values to each name, we
294     C guarantee uniqueness within each MNC-produced file.
295     WRITE(d_cw_name,'(a,i6.6)') 'd_cw_',ndId
296    
297     C XY dimensions
298     dim(1) = sNx + 2*OLx
299     dim(2) = sNy + 2*OLy
300     ib(1) = OLx + 1
301     ib(2) = OLy + 1
302     IF (gdiag(ndId)(2:2) .EQ. 'M') THEN
303     dn(1)(1:2) = 'X'
304     ie(1) = OLx + sNx
305     dn(2)(1:2) = 'Y'
306     ie(2) = OLy + sNy
307     ELSEIF (gdiag(ndId)(2:2) .EQ. 'U') THEN
308     dn(1)(1:3) = 'Xp1'
309     ie(1) = OLx + sNx + 1
310     dn(2)(1:2) = 'Y'
311     ie(2) = OLy + sNy
312     ELSEIF (gdiag(ndId)(2:2) .EQ. 'V') THEN
313     dn(1)(1:2) = 'X'
314     ie(1) = OLx + sNx
315     dn(2)(1:3) = 'Yp1'
316     ie(2) = OLy + sNy + 1
317     ELSEIF (gdiag(ndId)(2:2) .EQ. 'Z') THEN
318     dn(1)(1:3) = 'Xp1'
319     ie(1) = OLx + sNx + 1
320     dn(2)(1:3) = 'Yp1'
321     ie(2) = OLy + sNy + 1
322     ENDIF
323    
324     C Z is special since it varies
325     WRITE(dn(3),'(a,i6.6)') 'Zd', nLevOutp
326     IF ( (gdiag(ndId)(10:10) .EQ. 'R')
327     & .AND. (gdiag(ndId)(9:9) .EQ. 'M') ) THEN
328     WRITE(dn(3),'(a,i6.6)') 'Zmd', nLevOutp
329     ENDIF
330     IF ( (gdiag(ndId)(10:10) .EQ. 'R')
331     & .AND. (gdiag(ndId)(9:9) .EQ. 'L') ) THEN
332     WRITE(dn(3),'(a,i6.6)') 'Zld', nLevOutp
333     ENDIF
334     IF ( (gdiag(ndId)(10:10) .EQ. 'R')
335     & .AND. (gdiag(ndId)(9:9) .EQ. 'U') ) THEN
336     WRITE(dn(3),'(a,i6.6)') 'Zud', nLevOutp
337     ENDIF
338     dim(3) = NrMax
339     ib(3) = 1
340     ie(3) = nLevOutp
341    
342     C Time dimension
343     dn(4)(1:1) = 'T'
344     dim(4) = -1
345     ib(4) = 1
346     ie(4) = 1
347    
348     CALL MNC_CW_ADD_GNAME( d_cw_name, 4,
349     & dim, dn, ib, ie, myThid )
350     CALL MNC_CW_ADD_VNAME( cdiag(ndId), d_cw_name,
351     & 4, 5, myThid )
352     CALL MNC_CW_ADD_VATTR_TEXT( cdiag(ndId),'description',
353     & tdiag(ndId), myThid )
354     CALL MNC_CW_ADD_VATTR_TEXT( cdiag(ndId),'units',
355     & udiag(ndId), myThid )
356    
357 jmc 1.3 useMisValForThisDiag = mate.GT.0
358     C Use the missing values for masking out the land points:
359     C only for scalar diagnostics at mass points (so far)
360 jmc 1.4 IF ( useMissingValue.AND.gdiag(ndId)(1:2).EQ.'SM' ) THEN
361 jmc 1.3 useMisValForThisDiag = .TRUE.
362 jmc 1.1 C note: better to use 2-D mask if kdiag <> Nr or vert.integral
363     DO bj = myByLo(myThid), myByHi(myThid)
364     DO bi = myBxLo(myThid), myBxHi(myThid)
365     DO k = 1,nLevOutp
366     klev = NINT(levs(k,listId))
367     IF ( fflags(listId)(2:2).EQ.'I' ) kLev = 1
368     DO j = 1-OLy,sNy+OLy
369     DO i = 1-OLx,sNx+OLx
370     IF ( maskC(i,j,klev,bi,bj) .EQ. 0. )
371     & qtmp(i,j,k,bi,bj) = misValLoc
372     ENDDO
373     ENDDO
374     ENDDO
375     ENDDO
376     ENDDO
377 jmc 1.3 ENDIF
378     IF ( useMisValForThisDiag ) THEN
379     C assign missing values and set flag for adding the netCDF atttibute
380     CALL MNC_CW_VATTR_MISSING(cdiag(ndId), 2,
381     I misval_r8, misval_r4, misval_int, myThid )
382 jmc 1.1 ELSE
383     C suppress the missing value attribute (iflag = 0)
384     C Note: We have to call the following subroutine for each mnc that has
385     C been created "on the fly" by mnc_cw_add_vname and will be deleted
386     C by mnc_cw_del_vname, because all of these variables use the same
387     C identifier so that mnc_cw_vfmv(indv) needs to be overwritten for
388     C each of these variables
389     CALL MNC_CW_VATTR_MISSING( cdiag(ndId), 0,
390     I misval_r8, misval_r4, misval_int, myThid )
391     ENDIF
392    
393     IF ( ((writeBinaryPrec .EQ. precFloat32).AND.
394     & (fflags(listId)(1:1) .NE. 'D'))
395     & .OR. (fflags(listId)(1:1) .EQ. 'R') ) THEN
396     CALL MNC_CW_RL_W( 'R',diag_mnc_bn,0,0,
397     & cdiag(ndId), qtmp, myThid)
398     ELSEIF ( (writeBinaryPrec .EQ. precFloat64)
399     & .OR. (fflags(listId)(1:1) .EQ. 'D') ) THEN
400     CALL MNC_CW_RL_W( 'D',diag_mnc_bn,0,0,
401     & cdiag(ndId), qtmp, myThid)
402     ENDIF
403    
404     CALL MNC_CW_DEL_VNAME(cdiag(ndId), myThid)
405     CALL MNC_CW_DEL_GNAME(d_cw_name, myThid)
406    
407     _END_MASTER( myThid )
408    
409     c ENDIF
410     #endif /* ALLOW_MNC */
411    
412     RETURN
413     END

  ViewVC Help
Powered by ViewVC 1.1.22