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

Diff of /MITgcm/pkg/diagnostics/diagnostics_utils.F

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

revision 1.10 by edhill, Wed Jul 7 03:47:05 2004 UTC revision 1.29 by jmc, Fri Jan 15 00:25:58 2010 UTC
# Line 3  C $Name$ Line 3  C $Name$
3    
4  #include "DIAG_OPTIONS.h"  #include "DIAG_OPTIONS.h"
5    
6        subroutine getdiag (myThid,lev,ipoint,undef,qtmp)  C--   File diagnostics_utils.F: General purpose support routines
7  C***********************************************************************          C--    Contents:
8  C  PURPOSE                                                                        C--    o GETDIAG
9    C--    o DIAGNOSTICS_COUNT
10    C--    o DIAGNOSTICS_GET_POINTERS
11    C--    o DIAGNOSTICS_SETKLEV
12    C--    o DIAGS_GET_PARMS_I (Function)
13    C--    o DIAGS_MK_UNITS (Function)
14    C--    o DIAGS_MK_TITLE (Function)
15    
16    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
17    CBOP 0
18    C     !ROUTINE: GETDIAG
19    
20    C     !INTERFACE:
21          SUBROUTINE GETDIAG(
22         I                    levreal, undef,
23         O                    qtmp,
24         I                    ndId, mate, ip, im, bi, bj, myThid )
25    
26    C     !DESCRIPTION:
27  C     Retrieve averaged model diagnostic  C     Retrieve averaged model diagnostic
28  C  INPUT:                                                                        
29  C     lev ..... Diagnostic LEVEL  C     !USES:
30  C  ipoint ..... DIAGNOSTIC NUMBER FROM MENU                                            IMPLICIT NONE
 C   undef ..... UNDEFINED VALUE                                                  
 C      bi ..... X-direction process(or) number  
 C      bj ..... Y-direction process(or) number  
 C                                                                                
 C  OUTPUT:                                                                        
 C    qtmp ..... AVERAGED DIAGNOSTIC QUANTITY  
 C                                                                                
 C***********************************************************************          
       implicit none  
31  #include "EEPARAMS.h"  #include "EEPARAMS.h"
 #include "CPP_OPTIONS.h"  
32  #include "SIZE.h"  #include "SIZE.h"
33    #include "DIAGNOSTICS_SIZE.h"
34    #include "DIAGNOSTICS.h"
35    
36  #ifdef ALLOW_FIZHI  C     !INPUT PARAMETERS:
37  #include "fizhi_SIZE.h"  C     levreal :: Diagnostic LEVEL
38  #else  C     undef   :: UNDEFINED VALUE
39        integer Nrphys  C     ndId    :: DIAGNOSTIC NUMBER FROM MENU
40        parameter (Nrphys=0)  C     mate    :: counter DIAGNOSTIC NUMBER if any ; 0 otherwise
41  #endif  C     ip      :: pointer to storage array location for diag.
42    C     im      :: pointer to storage array location for mate
43  #include "diagnostics_SIZE.h"  C     bi      :: X-direction tile number
44  #include "diagnostics.h"  C     bj      :: Y-direction tile number
45          C     myThid  :: my thread Id number
46        integer myThid,lev,ipoint        _RL levreal
47        _RL undef        _RL undef
48        _RL qtmp(1-OLx:sNx+Olx,1-Oly:sNy+Oly,Nr+Nrphys,Nsx,Nsy)        INTEGER ndId, mate, ip, im
49                INTEGER bi,bj, myThid
50    
51    C     !OUTPUT PARAMETERS:
52    C     qtmp    ..... AVERAGED DIAGNOSTIC QUANTITY
53          _RL qtmp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
54    CEOP
55    
56    C     !LOCAL VARIABLES:
57        _RL factor        _RL factor
58        integer i,j,ipnt,klev        INTEGER i, j, ipnt,ipCt
59        integer bi,bj        INTEGER lev, levCt, klev
         
       if (ipoint.lt.1) go to 999  
         
       klev = kdiag(ipoint)  
       if(klev.ge.lev) then  
         ipnt = idiag(ipoint) + lev - 1  
         factor = 1.0  
         if(ndiag(ipoint).ne.0) factor = 1.0/ndiag(ipoint)  
   
         do bj=myByLo(myThid), myByHi(myThid)  
           do bi=myBxLo(myThid), myBxHi(myThid)  
               
             do j = 1,sNy  
               do i = 1,sNx  
                 if( qdiag(i,j,ipnt,bi,bj).ne.undef ) then  
                   qtmp(i,j,lev,bi,bj) = qdiag(i,j,ipnt,bi,bj)*factor  
                 else  
                   qtmp(i,j,lev,bi,bj) = undef  
                 endif  
               enddo  
             enddo  
               
           enddo  
         enddo  
   
       endif  
   
  999  return  
       end  
   
       subroutine getdiag2 (myThid,lev,ipoint,undef,qtmp)  
 C***********************************************************************          
 C  PURPOSE                                                                        
 C     Retrieve averaged model diagnostic  
 C  INPUT:                                                                        
 C     lev ..... Diagnostic LEVEL  
 C  ipoint ..... DIAGNOSTIC NUMBER FROM MENU                                      
 C   undef ..... UNDEFINED VALUE                                                  
 C                                                                                
 C  OUTPUT:                                                                        
 C    qtmp ..... AVERAGED DIAGNOSTIC QUANTITY  
 C                                                                                
 C***********************************************************************          
       implicit none  
60    
61  #include "EEPARAMS.h"        IF (ndId.GE.1) THEN
62  #include "CPP_OPTIONS.h"         lev = NINT(levreal)
63  #include "SIZE.h"         klev = kdiag(ndId)
64           IF (lev.LE.klev) THEN
65    
66            IF ( mate.EQ.0 ) THEN
67    C-      No counter diagnostics => average = Sum / ndiag :
68    
69              ipnt = ip + lev - 1
70              factor = FLOAT(ndiag(ip,bi,bj))
71              IF (ndiag(ip,bi,bj).NE.0) factor = 1. _d 0 / factor
72    
73  #ifdef ALLOW_FIZHI  #ifdef ALLOW_FIZHI
74  #include "fizhi_SIZE.h"            DO j = 1,sNy+1
75  #else              DO i = 1,sNx+1
76         integer Nrphys                IF ( qdiag(i,j,ipnt,bi,bj) .LE. undef ) THEN
77         parameter (Nrphys=0)                  qtmp(i,j) = qdiag(i,j,ipnt,bi,bj)*factor
78  #endif                ELSE
79                    qtmp(i,j) = undef
80                  ENDIF
81                ENDDO
82              ENDDO
83    #else /* ALLOW_FIZHI */
84              DO j = 1,sNy+1
85                DO i = 1,sNx+1
86                  qtmp(i,j) = qdiag(i,j,ipnt,bi,bj)*factor
87                ENDDO
88              ENDDO
89    #endif /* ALLOW_FIZHI */
90    
91  #include "diagnostics_SIZE.h"          ELSE
92  #include "diagnostics.h"  C-      With counter diagnostics => average = Sum / counter:
93    
94        integer myThid,lev,ipoint            ipnt = ip + lev - 1
95        _RL undef            levCt= MIN(lev,kdiag(mate))
96        _RL qtmp(1-OLx:sNx+Olx,1-Oly:sNy+Oly,Nr+Nrphys,Nsx,Nsy)            ipCt = im + levCt - 1
97              DO j = 1,sNy+1
98                DO i = 1,sNx+1
99                  IF ( qdiag(i,j,ipCt,bi,bj) .NE. 0. ) THEN
100                    qtmp(i,j) = qdiag(i,j,ipnt,bi,bj)
101         &                    / qdiag(i,j,ipCt,bi,bj)
102                  ELSE
103                    qtmp(i,j) = undef
104                  ENDIF
105                ENDDO
106              ENDDO
107    
108        integer i,j,ipnt,klev          ENDIF
109        integer bi,bj         ENDIF
110          ENDIF
111    
112        if (ipoint.lt.1) go to 999        RETURN
113                END
       klev = kdiag(ipoint)  
       if (klev .ge. lev) then  
         ipnt = idiag(ipoint) + lev - 1  
           
         do bj=myByLo(myThid), myByHi(myThid)  
           do bi=myBxLo(myThid), myBxHi(myThid)  
               
             do j = 1,sNy  
               do i = 1,sNx  
                 qtmp(i,j,lev,bi,bj) = qdiag(i,j,ipnt,bi,bj)  
               enddo  
             enddo  
               
           enddo  
         enddo  
           
       endif  
114    
115   999  return  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
       end  
116    
117    CBOP 0
118    C     !ROUTINE: DIAGNOSTICS_COUNT
119    C     !INTERFACE:
120          SUBROUTINE DIAGNOSTICS_COUNT (chardiag,
121         I                              biArg, bjArg, myThid)
122    
123        subroutine clrindx (myThid,listnum)  C     !DESCRIPTION:
124  C***********************************************************************  C***********************************************************************
125  C  C   routine to increment the diagnostic counter only
 C  PURPOSE  
 C     DRIVER TO CLEAR DIAGNOSTICS SPECIFIED IN DIAGNOSTIC INDEX LIST  
 C  
 C  ARGUMENT DESCRIPTION  
 C     listnum ....  diagnostics list number  
 C  
126  C***********************************************************************  C***********************************************************************
127    C     !USES:
128          IMPLICIT NONE
129    
130        implicit none  C     == Global variables ===
131  #include "EEPARAMS.h"  #include "EEPARAMS.h"
 #include "CPP_OPTIONS.h"  
132  #include "SIZE.h"  #include "SIZE.h"
133  #include "diagnostics_SIZE.h"  #include "DIAGNOSTICS_SIZE.h"
134  #include "diagnostics.h"  #include "DIAGNOSTICS.h"
135    
136    C     !INPUT PARAMETERS:
137    C***********************************************************************
138    C  Arguments Description
139    C  ----------------------
140    C     chardiag :: Character expression for diag to increment the counter
141    C     biArg    :: X-direction tile number, or 0 if called outside bi,bj loops
142    C     bjArg    :: Y-direction tile number, or 0 if called outside bi,bj loops
143    C     myThid   :: my thread Id number
144    C***********************************************************************
145          CHARACTER*8 chardiag
146          INTEGER biArg, bjArg
147          INTEGER myThid
148    CEOP
149    
150    C     !LOCAL VARIABLES:
151    C ===============
152          INTEGER m, n
153          INTEGER bi, bj
154          INTEGER ipt, ndId
155    c     CHARACTER*(MAX_LEN_MBUF) msgBuf
156    
157          IF ( biArg.EQ.0 .AND. bjArg.EQ.0 ) THEN
158            bi = myBxLo(myThid)
159            bj = myByLo(myThid)
160          ELSE
161            bi = MIN(biArg,nSx)
162            bj = MIN(bjArg,nSy)
163          ENDIF
164    
165    C--   Run through list of active diagnostics to find which counter
166    C     to increment (needs to be a valid & active diagnostic-counter)
167          DO n=1,nlists
168           DO m=1,nActive(n)
169            IF ( chardiag.EQ.flds(m,n) .AND. idiag(m,n).GT.0 ) THEN
170             ipt = idiag(m,n)
171             IF (ndiag(ipt,bi,bj).GE.0) THEN
172              ndId = jdiag(m,n)
173              ipt = ipt + pdiag(n,bi,bj)*kdiag(ndId)
174    C-    Increment the counter for the diagnostic
175              IF ( biArg.EQ.0 .AND. bjArg.EQ.0 ) THEN
176               DO bj=myByLo(myThid), myByHi(myThid)
177                DO bi=myBxLo(myThid), myBxHi(myThid)
178                 ndiag(ipt,bi,bj) = ndiag(ipt,bi,bj) + 1
179                ENDDO
180               ENDDO
181              ELSE
182                 ndiag(ipt,bi,bj) = ndiag(ipt,bi,bj) + 1
183              ENDIF
184    C-    Increment is done
185             ENDIF
186            ENDIF
187           ENDDO
188          ENDDO
189    
190        integer myThid, listnum        RETURN
191          END
192    
193        integer m, n  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
194        character*8 parms1  
195        character*1 parse1(8)  CBOP 0
196        character*3 mate_index  C     !ROUTINE: DIAGNOSTICS_GET_POINTERS
197        integer mate  C     !INTERFACE:
198          SUBROUTINE DIAGNOSTICS_GET_POINTERS(
199        equivalence (     parms1 , parse1(1) )       I                       diagName, listId,
200        equivalence ( mate_index , parse1(6) )       O                       ndId, ip,
201         I                       myThid )
202        do n = 1,nfields(listnum)  
203          do m = 1,ndiagt  C     !DESCRIPTION:
204            if( flds(n,listnum).eq.cdiag(m) .and. idiag(m).ne.0 ) then  C     *================================================================*
205              call clrdiag (myThid,m)  C     | o Returns the diagnostic Id number and diagnostic
206    C     |   pointer to storage array for a specified diagnostic.
207  C           Check for Counter Diagnostic  C     *================================================================*
208              parms1 =  gdiag(m)  C     | Note: A diagnostics field can be stored multiple times
209              if ( parse1(5).eq.'C' ) then  C     |       (for different output frequency,phase, ...).
210                read (mate_index,100) mate  C     | operates in 2 ways:
211                call clrdiag (myThid,mate)  C     | o listId =0 => find 1 diagnostics Id & pointer which name matches.
212              endif  C     | o listId >0 => find the unique diagnostic Id & pointer with
213            endif  C     |      the right name and same output time as "listId" output-list
214          enddo  C     | o return ip=0 if did not find the right diagnostic;
215        enddo  C     |   (ndId <>0 if diagnostic exist but output time does not match)
216                      C     *================================================================*
217    100 format(i3)  
218        RETURN        C     !USES:
219        END                  IMPLICIT NONE
   
   
       subroutine clrdiag (myThid,index)  
 C***********************************************************************          
 C  PURPOSE                                                                        
 C     ZERO OUT MODEL DIAGNOSTIC ARRAY ELEMENTS  
 C***********************************************************************          
                                                                                   
       implicit none  
220  #include "EEPARAMS.h"  #include "EEPARAMS.h"
 #include "CPP_OPTIONS.h"  
221  #include "SIZE.h"  #include "SIZE.h"
222  #include "diagnostics_SIZE.h"  #include "DIAGNOSTICS_SIZE.h"
223  #include "diagnostics.h"  #include "DIAGNOSTICS.h"
224    
225        integer myThid, index  C     !INPUT PARAMETERS:
226    C     diagName :: diagnostic identificator name (8 characters long)
227    C     listId   :: list number that specify the output frequency
228    C     myThid   :: my Thread Id number
229    C     !OUTPUT PARAMETERS:
230    C     ndId     :: diagnostics  Id number (in available diagnostics list)
231    C     ip       :: diagnostics  pointer to storage array
232    
233    
234          CHARACTER*8 diagName
235          INTEGER listId
236          INTEGER ndId, ip
237          INTEGER myThid
238    CEOP
239    
240    C     !LOCAL VARIABLES:
241          INTEGER n,m
242    
243          ip   = 0
244          ndId = 0
245    
246          IF ( listId.LE.0 ) THEN
247    C--   select the 1rst one which name matches:
248    
249    C-    search for this diag. in the active 2D/3D diagnostics list
250            DO n=1,nlists
251             DO m=1,nActive(n)
252               IF ( ip.EQ.0 .AND. diagName.EQ.flds(m,n)
253         &                  .AND. idiag(m,n).NE.0 ) THEN
254                ip   = ABS(idiag(m,n))
255                ndId = jdiag(m,n)
256               ENDIF
257             ENDDO
258            ENDDO
259    
260          ELSEIF ( listId.LE.nlists ) THEN
261    C--   select the unique diagnostic with output-time identical to listId
262    
263    C-    search for this diag. in the active 2D/3D diagnostics list
264            DO n=1,nlists
265             IF ( ip.EQ.0
266         &        .AND. freq(n) .EQ. freq(listId)
267         &        .AND. phase(n).EQ.phase(listId)
268         &        .AND. averageFreq(n) .EQ.averageFreq(listId)
269         &        .AND. averagePhase(n).EQ.averagePhase(listId)
270         &        .AND. averageCycle(n).EQ.averageCycle(listId)
271         &      ) THEN
272              DO m=1,nActive(n)
273               IF ( ip.EQ.0 .AND. diagName.EQ.flds(m,n)
274         &                  .AND. idiag(m,n).NE.0 ) THEN
275                ip   = ABS(idiag(m,n))
276                ndId = jdiag(m,n)
277               ENDIF
278              ENDDO
279             ELSEIF ( ip.EQ.0 ) THEN
280              DO m=1,nActive(n)
281               IF ( ip.EQ.0 .AND. diagName.EQ.flds(m,n)
282         &                  .AND. idiag(m,n).NE.0 ) THEN
283                ndId = jdiag(m,n)
284               ENDIF
285              ENDDO
286             ENDIF
287            ENDDO
288    
289        integer bi,bj        ELSE
290        integer i,j,k          STOP 'DIAGNOSTICS_GET_POINTERS: invalid listId number'
291          ENDIF
292    
293  C **********************************************************************                RETURN
294  C ****              SET DIAGNOSTIC AND COUNTER TO ZERO              ****                END
 C **********************************************************************          
                                                                                   
       do bj=myByLo(myThid), myByHi(myThid)  
         do bi=myBxLo(myThid), myBxHi(myThid)  
           do k = 1,kdiag(index)  
             do j = 1,sNy  
               do i = 1,sNx  
                 qdiag(i,j,idiag(index)+k-1,bi,bj) = 0. _d 0  
               enddo  
             enddo  
           enddo  
         enddo  
       enddo  
         
       ndiag(index) = 0  
295    
296        return  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
       end  
297    
298        subroutine setdiag (myThid,num,ndiagmx)  CBOP 0
299  C***********************************************************************  C     !ROUTINE: DIAGNOSTICS_SETKLEV
 C  
 C  PURPOSE  
 C     SET POINTER LOCATIONS, NAMES, LEVELS and TITLES FOR DIAGNOSTIC NUM  
 C  
 C***********************************************************************  
300    
301        implicit none  C     !INTERFACE:
302  #include "CPP_OPTIONS.h"        SUBROUTINE DIAGNOSTICS_SETKLEV(
303         I                                diagName, nLevDiag, myThid )
304    
305    C     !DESCRIPTION:
306    C     *==========================================================*
307    C     | S/R DIAGNOSTICS_SETKLEV
308    C     | o Define explicitly the number of level (stored in kdiag)
309    C     |   of a diagnostic field. For most diagnostics, the number
310    C     |   of levels is derived (in S/R SET_LEVELS) from gdiag(10)
311    C     |   but occasionally one may want to set it explicitly.
312    C     *==========================================================*
313    
314    C     !USES:
315          IMPLICIT NONE
316    #include "EEPARAMS.h"
317  #include "SIZE.h"  #include "SIZE.h"
318  #include "diagnostics_SIZE.h"  #include "DIAGNOSTICS_SIZE.h"
319  #include "diagnostics.h"  #include "DIAGNOSTICS.h"
320    
321    C     !INPUT PARAMETERS:
322    C     diagName  :: diagnostic identificator name (8 characters long)
323    C     nLevDiag  :: number of level to set for this diagnostics field
324    C     myThid    :: my Thread Id number
325          CHARACTER*8  diagName
326          INTEGER nLevDiag
327          INTEGER myThid
328    CEOP
329    
330    C     !LOCAL VARIABLES:
331          CHARACTER*(MAX_LEN_MBUF) msgBuf
332          INTEGER n, ndId
333    
334    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
335    
336    C--   Check if this S/R is called from the right place ;
337    C     needs to be after DIAGNOSTICS_INIT_EARLY and before DIAGNOSTICS_INIT_FIXED
338          IF ( .NOT.settingDiags ) THEN
339            WRITE(msgBuf,'(4A,I5)') 'DIAGNOSTICS_SETKLEV: ',
340         &     'diagName="', diagName, '" , nLevDiag=', nLevDiag
341            CALL PRINT_ERROR( msgBuf, myThid )
342            WRITE(msgBuf,'(2A)') 'DIAGNOSTICS_SETKLEV: ',
343         &     '<== called from the WRONG place, i.e.'
344            CALL PRINT_ERROR( msgBuf, myThid )
345            WRITE(msgBuf,'(2A)') 'DIAGNOSTICS_SETKLEV: ',
346         &     'outside diagnostics setting section = from'
347            CALL PRINT_ERROR( msgBuf, myThid )
348            WRITE(msgBuf,'(2A)') 'DIAGNOSTICS_SETKLEV: ',
349         &     '   Diag_INIT_EARLY down to Diag_INIT_FIXED'
350            CALL PRINT_ERROR( msgBuf, myThid )
351            STOP 'ABNORMAL END: S/R DIAGNOSTICS_SETKLEV'
352          ENDIF
353    
354        integer num,myThid,ndiagmx  C--   Find this diagnostics in the list of available diag.
355        integer ipointer        ndId = 0
356          DO n = 1,ndiagt
357            IF ( diagName.EQ.cdiag(n) ) THEN
358              ndId = n
359            ENDIF
360          ENDDO
361          IF ( ndId.EQ.0 ) THEN
362            WRITE(msgBuf,'(4A)') 'DIAGNOSTICS_SETKLEV: ',
363         &     'diagName="', diagName, '" not known.'
364            CALL PRINT_ERROR( msgBuf, myThid )
365            STOP 'ABNORMAL END: S/R DIAGNOSTICS_SETKLEV'
366          ENDIF
367    
368    C-    Optional level number diagnostics (X): set number of levels
369          IF ( kdiag(ndId).EQ.0
370         &   .AND. gdiag(ndId)(10:10).EQ.'X' ) THEN
371            kdiag(ndId) = nLevDiag
372          ELSEIF ( kdiag(ndId).EQ.nLevDiag
373         &   .AND. gdiag(ndId)(10:10).EQ.'X' ) THEN
374    C-    level number already set to same value: send warning
375            WRITE(msgBuf,'(4A,I5)') '** WARNING ** DIAGNOSTICS_SETKLEV: ',
376         &     'diagName="', diagName, '" , nLevDiag=', nLevDiag
377            CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
378         &                      SQUEEZE_RIGHT , myThid )
379            WRITE(msgBuf,'(2A,I5,A)')'** WARNING ** DIAGNOSTICS_SETKLEV:',
380         &     ' level Nb (=', kdiag(ndId), ') already set.'
381            CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
382         &                      SQUEEZE_RIGHT , myThid )
383          ELSEIF ( gdiag(ndId)(10:10).EQ.'X' ) THEN
384    C-    level number already set to a different value: do not reset but stop
385            WRITE(msgBuf,'(4A,I5)') 'DIAGNOSTICS_SETKLEV: ',
386         &     'diagName="', diagName, '" , nLevDiag=', nLevDiag
387            CALL PRINT_ERROR( msgBuf, myThid )
388            WRITE(msgBuf,'(2A,I5,3A)') 'DIAGNOSTICS_SETKLEV: ',
389         &     'level Nb already set to', kdiag(ndId), ' => STOP'
390            CALL PRINT_ERROR( msgBuf, myThid )
391          ELSE
392    C-    for now, do nothing but just send a warning
393            WRITE(msgBuf,'(4A,I5)') '** WARNING ** DIAGNOSTICS_SETKLEV: ',
394         &     'diagName="', diagName, '" , nLevDiag=', nLevDiag
395            CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
396         &                      SQUEEZE_RIGHT , myThid )
397            WRITE(msgBuf,'(2A,I5,3A)') '** WARNING ** will set level Nb',
398         &     ' from diagCode(ndId=', ndId, ')="', gdiag(ndId)(1:10), '"'
399            CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
400         &                      SQUEEZE_RIGHT , myThid )
401            WRITE(msgBuf,'(4A)') '** WARNING ** DIAGNOSTICS_SETKLEV',
402         &     '("', diagName, '") <== Ignore this call.'
403            CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
404         &                      SQUEEZE_RIGHT , myThid )
405          ENDIF
406    
407          RETURN
408          END
409    
410    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
411    
412        DATA IPOINTER / 1 /  CBOP 0
413    C     !ROUTINE: DIAGS_GET_PARMS_I
414    
415        character*8 parms1  C     !INTERFACE:
416        character*1 parse1(8)        INTEGER FUNCTION DIAGS_GET_PARMS_I(
417        character*3 mate_index       I                            parName, myThid )
418        integer     mate  
419    C     !DESCRIPTION:
420        equivalence (     parms1 , parse1(1) )  C     *==========================================================*
421        equivalence ( mate_index , parse1(6) )  C     | FUNCTION DIAGS_GET_PARMS_I
422    C     | o Return the value of integer parameter
423  C **********************************************************************  C     |   from one of the DIAGNOSTICS.h common blocs
424  C ****                SET POINTERS FOR DIAGNOSTIC NUM               ****  C     *==========================================================*
425  C **********************************************************************  
426    C     !USES:
427        parms1 = gdiag(num)        IMPLICIT NONE
428    #include "EEPARAMS.h"
429        IF( IDIAG(NUM).EQ.0 ) THEN  #include "SIZE.h"
430          if(ndiagmx+kdiag(num).gt.numdiags) then  #include "DIAGNOSTICS_SIZE.h"
431            write(6,4000)num,cdiag(num)  #include "DIAGNOSTICS.h"
432          else  
433            IDIAG(NUM) = IPOINTER  C     !INPUT PARAMETERS:
434            IPOINTER   = IPOINTER + KDIAG(NUM)  C     parName   :: string used to identify which parameter to get
435            ndiagmx    = ndiagmx  + KDIAG(NUM)  C     myThid    :: my Thread Id number
436            if (myThid.eq.1)        CHARACTER*(*) parName
437       &         WRITE(6,2000)KDIAG(NUM),NUM,CDIAG(NUM),ndiagmx        INTEGER myThid
438          endif  CEOP
439    
440    C     !LOCAL VARIABLES:
441          CHARACTER*(MAX_LEN_MBUF) msgBuf
442          INTEGER n
443    
444    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
445    
446          n = LEN(parName)
447    c     write(0,'(3A,I4)')
448    c    &  'DIAGS_GET_PARMS_I: parName="',parName,'" , length=',n
449    
450          IF ( parName.EQ.'LAST_DIAG_ID' ) THEN
451             DIAGS_GET_PARMS_I = ndiagt
452        ELSE        ELSE
453            if (myThid.eq.1)           WRITE(msgBuf,'(4A)') 'DIAGS_GET_PARMS_I: ',
454       &       WRITE(6,3000) NUM, CDIAG(NUM)       &    ' parName="', parName, '" not known.'
455             CALL PRINT_ERROR( msgBuf, myThid )
456             STOP 'ABNORMAL END: S/R DIAGS_GET_PARMS_I'
457        ENDIF        ENDIF
458    
459  C     Check for Counter Diagnostic        RETURN
460        if ( parse1(5).eq.'C') then        END
461          read (mate_index,100) mate  
462    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
463          IF( IDIAG(mate).EQ.0 ) THEN  
464            if(ndiagmx+kdiag(num).gt.numdiags) then  CBOP 0
465              write(6,5000)num,cdiag(num)  C     !ROUTINE: DIAGS_MK_UNITS
466            else  
467              IDIAG(mate) = IPOINTER  C     !INTERFACE:
468              IPOINTER    = IPOINTER + KDIAG(mate)        CHARACTER*16 FUNCTION DIAGS_MK_UNITS(
469              ndiagmx     = ndiagmx  + KDIAG(mate)       I                            diagUnitsInPieces, myThid )
470              if (myThid.eq.1)  
471       &           WRITE(6,2000)KDIAG(mate),mate,CDIAG(mate),ndiagmx  C     !DESCRIPTION:
472            endif  C     *==========================================================*
473          ELSE  C     | FUNCTION DIAGS_MK_UNITS
474            if(myThid.eq.1) WRITE(6,3000) mate, CDIAG(mate)  C     | o Return the diagnostic units string (16c) removing
475          ENDIF  C     |   blanks from the input string
476        endif  C     *==========================================================*
477    
478    C     !USES:
479          IMPLICIT NONE
480    #include "EEPARAMS.h"
481    
482    C     !INPUT PARAMETERS:
483    C     diagUnitsInPieces :: string for diagnostic units: in several
484    C                          pieces, with blanks in between
485    C     myThid            ::  my thread Id number
486          CHARACTER*(*) diagUnitsInPieces
487          INTEGER      myThid
488    CEOP
489    
490    C     !LOCAL VARIABLES:
491          CHARACTER*(MAX_LEN_MBUF) msgBuf
492          INTEGER i,j,n
493    
494          DIAGS_MK_UNITS = '                '
495          n = LEN(diagUnitsInPieces)
496    
497          j = 0
498          DO i=1,n
499           IF (diagUnitsInPieces(i:i) .NE. ' ' ) THEN
500             j = j+1
501             IF ( j.LE.16 ) DIAGS_MK_UNITS(j:j) = diagUnitsInPieces(i:i)
502           ENDIF
503          ENDDO
504    
505          IF ( j.GT.16 ) THEN
506             WRITE(msgBuf,'(2A,I4,A)') '** WARNING ** ',
507         &   'DIAGS_MK_UNITS: too long (',j,' >16) input string'
508            CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
509         &       SQUEEZE_RIGHT , myThid)
510             WRITE(msgBuf,'(3A)') '** WARNING ** ',
511         &   'DIAGS_MK_UNITS: input=', diagUnitsInPieces
512            CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
513         &       SQUEEZE_RIGHT , myThid)
514          ENDIF
515    
516        RETURN        RETURN
517          END
518    
519    100 format(i3)  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
520   2000 FORMAT(1X,'Allocating ',I2,' Level(s) for Diagnostic # ',I3,  
521       .          ' (',A8,'),  Total Number of Diagnostics: ',I5)  CBOP 0
522   3000 FORMAT(1X,'Diagnostic # ',I3,' (',A8,') has already been set')  C     !ROUTINE: DIAGS_MK_TITLE
523   4000 FORMAT(1X,'Unable to allocate space for Diagnostic # ',I3,  
524       .                      ' (',A8,')')  C     !INTERFACE:
525   5000 FORMAT(1X,'Unable to allocate space for Counter Diagnostic # ',        CHARACTER*80 FUNCTION DIAGS_MK_TITLE(
526       .    I3,' (',A8,')',' WARNING - Diag will not accumulate properly')       I                            diagTitleInPieces, myThid )
527    
528    C     !DESCRIPTION:
529    C     *==========================================================*
530    C     | FUNCTION DIAGS_MK_TITLE
531    C     | o Return the diagnostic title string (80c) removing
532    C     |   consecutive blanks from the input string
533    C     *==========================================================*
534    
535    C     !USES:
536          IMPLICIT NONE
537    #include "EEPARAMS.h"
538    
539    C     !INPUT PARAMETERS:
540    C     diagTitleInPieces :: string for diagnostic units: in several
541    C                          pieces, with blanks in between
542    C     myThid            ::  my Thread Id number
543          CHARACTER*(*) diagTitleInPieces
544          INTEGER      myThid
545    CEOP
546    
547    C     !LOCAL VARIABLES:
548          CHARACTER*(MAX_LEN_MBUF) msgBuf
549          LOGICAL flag
550          INTEGER i,j,n
551    
552    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
553    
554          DIAGS_MK_TITLE = '                                        '
555         &               //'                                        '
556          n = LEN(diagTitleInPieces)
557    
558          j = 0
559          flag = .FALSE.
560          DO i=1,n
561           IF (diagTitleInPieces(i:i) .NE. ' ' ) THEN
562             IF ( flag ) THEN
563               j = j+1
564               IF (j.LE.80) DIAGS_MK_TITLE(j:j) = ' '
565             ENDIF
566             j = j+1
567             IF ( j.LE.80 ) DIAGS_MK_TITLE(j:j) = diagTitleInPieces(i:i)
568             flag = .FALSE.
569           ELSE
570             flag = j.GE.1
571           ENDIF
572          ENDDO
573    
574          IF ( j.GT.80 ) THEN
575             WRITE(msgBuf,'(2A,I4,A)') '** WARNING ** ',
576         &   'DIAGS_MK_TITLE: too long (',j,' >80) input string'
577            CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
578         &       SQUEEZE_RIGHT , myThid)
579             WRITE(msgBuf,'(3A)') '** WARNING ** ',
580         &   'DIAGS_MK_TITLE: input=', diagTitleInPieces
581            CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
582         &       SQUEEZE_RIGHT , myThid)
583          ENDIF
584    
585          RETURN
586        END        END
Legend:
Removed from v.1.10  
changed lines
  Added in v.1.29
  ViewVC Help
Powered by ViewVC 1.1.22