/[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.17 by jmc, Fri Jan 28 01:06:12 2005 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    C--   File diagnostics_utils.F: General purpose support routines
7    C--    Contents:
8    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-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
17  CBOP 0  CBOP 0
18  C     !ROUTINE: GETDIAG  C     !ROUTINE: GETDIAG
19    
20  C     !INTERFACE:  C     !INTERFACE:
21        SUBROUTINE GETDIAG (levreal,ipoint,undef,qtmp,myThid)        SUBROUTINE GETDIAG(
22         I                    levreal, undef,
23         O                    qtmp,
24         I                    ndId, mate, ip, im, bi, bj, myThid )
25    
26  C     !DESCRIPTION:  C     !DESCRIPTION:
27  C     Retrieve averaged model diagnostic  C     Retrieve averaged model diagnostic
28    
29  C     !USES:  C     !USES:
30        implicit none        IMPLICIT NONE
31  #include "EEPARAMS.h"  #include "EEPARAMS.h"
32  #include "SIZE.h"  #include "SIZE.h"
33  #include "DIAGNOSTICS_SIZE.h"  #include "DIAGNOSTICS_SIZE.h"
34  #include "DIAGNOSTICS.h"  #include "DIAGNOSTICS.h"
 CEOP  
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  C     INPUT:  C     bi      :: X-direction tile number
44  C     levreal .... Diagnostic LEVEL  C     bj      :: Y-direction tile number
45  C     ipoint ..... DIAGNOSTIC NUMBER FROM MENU  C     myThid  :: my thread Id number
 C     undef  ..... UNDEFINED VALUE  
 C     bi     ..... X-direction process(or) number  
 C     bj     ..... Y-direction process(or) number  
46        _RL levreal        _RL levreal
       integer myThid,ipoint  
47        _RL undef        _RL undef
48          INTEGER ndId, mate, ip, im
49          INTEGER bi,bj, myThid
50    
51  C     OUTPUT:  C     !OUTPUT PARAMETERS:
52  C     qtmp    ..... AVERAGED DIAGNOSTIC QUANTITY  C     qtmp    ..... AVERAGED DIAGNOSTIC QUANTITY
53        _RL qtmp(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr+Nrphys,nSx,nSy)        _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
       integer lev  
60    
61        if (ipoint.ge.1) then        IF (ndId.GE.1) THEN
62         lev = NINT(levreal)         lev = NINT(levreal)
63           klev = kdiag(ndId)
64           IF (lev.LE.klev) THEN
65    
66         klev = kdiag(ipoint)          IF ( mate.EQ.0 ) THEN
67         if (klev.ge.lev) then  C-      No counter diagnostics => average = Sum / ndiag :
         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) .le. 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  
68    
69            enddo            ipnt = ip + lev - 1
70          enddo            factor = FLOAT(ndiag(ip,bi,bj))
71              IF (ndiag(ip,bi,bj).NE.0) factor = 1. _d 0 / factor
72    
73    #ifdef ALLOW_FIZHI
74              DO j = 1,sNy+1
75                DO i = 1,sNx+1
76                  IF ( qdiag(i,j,ipnt,bi,bj) .LE. undef ) THEN
77                    qtmp(i,j) = qdiag(i,j,ipnt,bi,bj)*factor
78                  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            ELSE
92    C-      With counter diagnostics => average = Sum / counter:
93    
94              ipnt = ip + lev - 1
95              levCt= MIN(lev,kdiag(mate))
96              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         endif          ENDIF
109        endif         ENDIF
110          ENDIF
111    
112        RETURN        RETURN
113        END        END
114    
115  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
 CBOP 0  
 C     !ROUTINE: GETDIAG2  
116    
117    CBOP 0
118    C     !ROUTINE: DIAGNOSTICS_COUNT
119  C     !INTERFACE:  C     !INTERFACE:
120        SUBROUTINE GETDIAG2 (levreal,ipoint,undef,qtmp,myThid)        SUBROUTINE DIAGNOSTICS_COUNT (chardiag,
121         I                              biArg, bjArg, myThid)
122    
123  C     !DESCRIPTION:  C     !DESCRIPTION:
124  C***********************************************************************  C***********************************************************************
125  C  PURPOSE  C   routine to increment the diagnostic counter only
 C     Retrieve averaged model diagnostic  
 C  INPUT:  
 C  levreal .... Diagnostic LEVEL  
 C  ipoint ..... DIAGNOSTIC NUMBER FROM MENU  
 C   undef ..... UNDEFINED VALUE  
 C  
 C  OUTPUT:  
 C    qtmp ..... AVERAGED DIAGNOSTIC QUANTITY  
 C  
126  C***********************************************************************  C***********************************************************************
   
127  C     !USES:  C     !USES:
128        implicit none        IMPLICIT NONE
129    
130    C     == Global variables ===
131  #include "EEPARAMS.h"  #include "EEPARAMS.h"
132  #include "SIZE.h"  #include "SIZE.h"
133  #include "DIAGNOSTICS_SIZE.h"  #include "DIAGNOSTICS_SIZE.h"
134  #include "DIAGNOSTICS.h"  #include "DIAGNOSTICS.h"
 CEOP  
   
 #ifdef ALLOW_FIZHI  
 #include "fizhi_SIZE.h"  
 #else  
        integer Nrphys  
        parameter (Nrphys=0)  
 #endif  
   
       _RL levreal  
       integer myThid,ipoint  
       _RL undef  
       _RL qtmp(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr+Nrphys,nSx,nSy)  
   
       integer i,j,ipnt,klev  
       integer bi,bj  
       integer lev  
   
       if (ipoint.ge.1) then  
        lev = NINT(levreal)  
135    
136         klev = kdiag(ipoint)  C     !INPUT PARAMETERS:
137         if (klev.ge.lev) then  C***********************************************************************
138          ipnt = idiag(ipoint) + lev - 1  C  Arguments Description
139    C  ----------------------
140          do bj=myByLo(myThid), myByHi(myThid)  C     chardiag :: Character expression for diag to increment the counter
141            do bi=myBxLo(myThid), myBxHi(myThid)  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              do j = 1,sNy  C     myThid   :: my thread Id number
144                do i = 1,sNx  C***********************************************************************
145                  if ( qdiag(i,j,ipnt,bi,bj) .le. undef ) then        CHARACTER*8 chardiag
146                    qtmp(i,j,lev,bi,bj) = qdiag(i,j,ipnt,bi,bj)        INTEGER biArg, bjArg
147                  else        INTEGER myThid
148                    qtmp(i,j,lev,bi,bj) = undef  CEOP
                 endif  
               enddo  
             enddo  
149    
150            enddo  C     !LOCAL VARIABLES:
151          enddo  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         endif  C--   Run through list of active diagnostics to find which counter
166        endif  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        RETURN        RETURN
191        END        END
192    
193  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
194    
195        subroutine clrindx (listnum, myThid)  CBOP 0
196  C***********************************************************************  C     !ROUTINE: DIAGNOSTICS_GET_POINTERS
197  C  C     !INTERFACE:
198  C  PURPOSE        SUBROUTINE DIAGNOSTICS_GET_POINTERS(
199  C     DRIVER TO CLEAR DIAGNOSTICS SPECIFIED IN DIAGNOSTIC INDEX LIST       I                       diagName, listId,
200  C       O                       ndId, ip,
201  C  ARGUMENT DESCRIPTION       I                       myThid )
202  C     listnum ....  diagnostics list number  
203  C  C     !DESCRIPTION:
204  C***********************************************************************  C     *================================================================*
205    C     | o Returns the diagnostic Id number and diagnostic
206    C     |   pointer to storage array for a specified diagnostic.
207    C     *================================================================*
208    C     | Note: A diagnostics field can be stored multiple times
209    C     |       (for different output frequency,phase, ...).
210    C     | operates in 2 ways:
211    C     | o listId =0 => find 1 diagnostics Id & pointer which name matches.
212    C     | o listId >0 => find the unique diagnostic Id & pointer with
213    C     |      the right name and same output time as "listId" output-list
214    C     | o return ip=0 if did not find the right diagnostic;
215    C     |   (ndId <>0 if diagnostic exist but output time does not match)
216    C     *================================================================*
217    
218        implicit none  C     !USES:
219          IMPLICIT NONE
220  #include "EEPARAMS.h"  #include "EEPARAMS.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, listnum  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        integer m, n        IF ( listId.LE.0 ) THEN
247        character*8 parms1  C--   select the 1rst one which name matches:
248        character*3 mate_index  
249        integer mate  C-    search for this diag. in the active 2D/3D diagnostics list
250            DO n=1,nlists
251        do n=1,nfields(listnum)           DO m=1,nActive(n)
252         do m=1,ndiagt             IF ( ip.EQ.0 .AND. diagName.EQ.flds(m,n)
253          if( flds(n,listnum).eq.cdiag(m) .and. idiag(m).ne.0 ) then       &                  .AND. idiag(m,n).NE.0 ) THEN
254           call clrdiag (m, myThid)              ip   = ABS(idiag(m,n))
255                ndId = jdiag(m,n)
256  c Check for Counter Diagnostic             ENDIF
257  c ----------------------------           ENDDO
258           parms1 =  gdiag(m)(1:8)          ENDDO
259           if ( parms1(5:5).eq.'C' ) then  
260            mate_index = parms1(6:8)        ELSEIF ( listId.LE.nlists ) THEN
261            read (mate_index,'(I3)') mate  C--   select the unique diagnostic with output-time identical to listId
262            call clrdiag (mate, myThid)  
263           endif  C-    search for this diag. in the active 2D/3D diagnostics list
264          endif          DO n=1,nlists
265         enddo           IF ( ip.EQ.0
266        enddo       &        .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          ELSE
290            STOP 'DIAGNOSTICS_GET_POINTERS: invalid listId number'
291          ENDIF
292    
293        RETURN        RETURN
294        END        END
295    
296    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
297    
298        subroutine clrdiag (index, myThid)  CBOP 0
299  C***********************************************************************  C     !ROUTINE: DIAGNOSTICS_SETKLEV
300  C  PURPOSE  
301  C     ZERO OUT MODEL DIAGNOSTIC ARRAY ELEMENTS  C     !INTERFACE:
302  C***********************************************************************        SUBROUTINE DIAGNOSTICS_SETKLEV(
303         I                                diagName, nLevDiag, myThid )
304    
305        implicit none  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"  #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        integer myThid, index  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        integer bi,bj  C     !LOCAL VARIABLES:
331        integer i,j,k        CHARACTER*(MAX_LEN_MBUF) msgBuf
332          INTEGER n, ndId
333    
334    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
335    
336  C **********************************************************************  C--   Check if this S/R is called from the right place ;
337  C ****              SET DIAGNOSTIC AND COUNTER TO ZERO              ****  C     needs to be after DIAGNOSTICS_INIT_EARLY and before DIAGNOSTICS_INIT_FIXED
338  C **********************************************************************        IF ( .NOT.settingDiags ) THEN
339            WRITE(msgBuf,'(4A,I5)') 'DIAGNOSTICS_SETKLEV: ',
340        do bj=myByLo(myThid), myByHi(myThid)       &     'diagName="', diagName, '" , nLevDiag=', nLevDiag
341         do bi=myBxLo(myThid), myBxHi(myThid)          CALL PRINT_ERROR( msgBuf, myThid )
342          do k = 1,kdiag(index)          WRITE(msgBuf,'(2A)') 'DIAGNOSTICS_SETKLEV: ',
343           do j = 1-OLy,sNy+OLy       &     '<== called from the WRONG place, i.e.'
344            do i = 1-OLx,sNx+OLx          CALL PRINT_ERROR( msgBuf, myThid )
345             qdiag(i,j,idiag(index)+k-1,bi,bj) = 0.0          WRITE(msgBuf,'(2A)') 'DIAGNOSTICS_SETKLEV: ',
346            enddo       &     'outside diagnostics setting section = from'
347           enddo          CALL PRINT_ERROR( msgBuf, myThid )
348          enddo          WRITE(msgBuf,'(2A)') 'DIAGNOSTICS_SETKLEV: ',
349         enddo       &     '   Diag_INIT_EARLY down to Diag_INIT_FIXED'
350        enddo          CALL PRINT_ERROR( msgBuf, myThid )
351            STOP 'ABNORMAL END: S/R DIAGNOSTICS_SETKLEV'
352          ENDIF
353    
354    C--   Find this diagnostics in the list of available diag.
355          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        ndiag(index) = 0  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        RETURN
408        END        END
# Line 240  C ************************************** Line 410  C **************************************
410  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
411    
412  CBOP 0  CBOP 0
413  C     !ROUTINE: DIAGNOSTICS_IS_ON  C     !ROUTINE: DIAGS_GET_PARMS_I
414    
415  C     !INTERFACE:  C     !INTERFACE:
416        LOGICAL FUNCTION DIAGNOSTICS_IS_ON( diagName, myThid )        INTEGER FUNCTION DIAGS_GET_PARMS_I(
417         I                            parName, myThid )
418    
419  C     !DESCRIPTION:  C     !DESCRIPTION:
420  C     *==========================================================*  C     *==========================================================*
421  C     | FUNCTION DIAGNOSTIC_IS_ON  C     | FUNCTION DIAGS_GET_PARMS_I
422  C     | o Return TRUE if diagnostics "diagName" is Active  C     | o Return the value of integer parameter
423    C     |   from one of the DIAGNOSTICS.h common blocs
424  C     *==========================================================*  C     *==========================================================*
425    
426  C     !USES:  C     !USES:
# Line 259  C     !USES: Line 431  C     !USES:
431  #include "DIAGNOSTICS.h"  #include "DIAGNOSTICS.h"
432    
433  C     !INPUT PARAMETERS:  C     !INPUT PARAMETERS:
434  C     diagName   ::  diagnostic identificator name (8 characters long)  C     parName   :: string used to identify which parameter to get
435  C     myThid     ::  my thread Id number  C     myThid    :: my Thread Id number
436        CHARACTER*8  diagName        CHARACTER*(*) parName
437        INTEGER      myThid        INTEGER myThid
438  CEOP  CEOP
439    
440  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
441        INTEGER j,n,m        CHARACTER*(MAX_LEN_MBUF) msgBuf
442          INTEGER n
443    
444        DIAGNOSTICS_IS_ON = .FALSE.  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
445        DO n=1,nlists  
446         DO m=1,nActive(n)        n = LEN(parName)
447          IF ( diagName.EQ.flds(m,n) ) THEN  c     write(0,'(3A,I4)')
448            j = jdiag(m,n)      c    &  'DIAGS_GET_PARMS_I: parName="',parName,'" , length=',n
449            IF ( idiag(j).NE.0 .AND. ndiag(j).GE.0 )  
450       &         DIAGNOSTICS_IS_ON = .TRUE.        IF ( parName.EQ.'LAST_DIAG_ID' ) THEN
451          ENDIF           DIAGS_GET_PARMS_I = ndiagt
452         ENDDO        ELSE
453        ENDDO           WRITE(msgBuf,'(4A)') 'DIAGS_GET_PARMS_I: ',
454         &    ' parName="', parName, '" not known.'
455             CALL PRINT_ERROR( msgBuf, myThid )
456             STOP 'ABNORMAL END: S/R DIAGS_GET_PARMS_I'
457          ENDIF
458    
459        RETURN        RETURN
460        END        END
# Line 288  CBOP 0 Line 465  CBOP 0
465  C     !ROUTINE: DIAGS_MK_UNITS  C     !ROUTINE: DIAGS_MK_UNITS
466    
467  C     !INTERFACE:  C     !INTERFACE:
468        CHARACTER*16 FUNCTION DIAGS_MK_UNITS(        CHARACTER*16 FUNCTION DIAGS_MK_UNITS(
469       I                            diagUnitsInPieces, myThid )       I                            diagUnitsInPieces, myThid )
470    
471  C     !DESCRIPTION:  C     !DESCRIPTION:
472  C     *==========================================================*  C     *==========================================================*
473  C     | FUNCTION DIAGS_MK_UNITS  C     | FUNCTION DIAGS_MK_UNITS
474  C     | o Return the diagnostic units string (16c) removing  C     | o Return the diagnostic units string (16c) removing
475  C     |   blanks from the input string  C     |   blanks from the input string
476  C     *==========================================================*  C     *==========================================================*
477    
# Line 303  C     !USES: Line 480  C     !USES:
480  #include "EEPARAMS.h"  #include "EEPARAMS.h"
481    
482  C     !INPUT PARAMETERS:  C     !INPUT PARAMETERS:
483  C     diagUnitsInPieces :: string for diagnostic units: in several  C     diagUnitsInPieces :: string for diagnostic units: in several
484  C                          pieces, with blanks in between  C                          pieces, with blanks in between
485  C     myThid            ::  my thread Id number  C     myThid            ::  my thread Id number
486        CHARACTER*(*) diagUnitsInPieces        CHARACTER*(*) diagUnitsInPieces
# Line 314  C     !LOCAL VARIABLES: Line 491  C     !LOCAL VARIABLES:
491        CHARACTER*(MAX_LEN_MBUF) msgBuf        CHARACTER*(MAX_LEN_MBUF) msgBuf
492        INTEGER i,j,n        INTEGER i,j,n
493    
494        DIAGS_MK_UNITS = '          '        DIAGS_MK_UNITS = '                '
495        n = LEN(diagUnitsInPieces)        n = LEN(diagUnitsInPieces)
496          
497        j = 0        j = 0
498        DO i=1,n        DO i=1,n
499         IF (diagUnitsInPieces(i:i) .NE. ' ' ) THEN         IF (diagUnitsInPieces(i:i) .NE. ' ' ) THEN
# Line 326  C     !LOCAL VARIABLES: Line 503  C     !LOCAL VARIABLES:
503        ENDDO        ENDDO
504    
505        IF ( j.GT.16 ) THEN        IF ( j.GT.16 ) THEN
506           WRITE(msgBuf,'(2A,I4,A)') '**WARNING** ',           WRITE(msgBuf,'(2A,I4,A)') '** WARNING ** ',
507       &   'DIAGS_MK_UNITS: too long (',j,' >16) input string'       &   'DIAGS_MK_UNITS: too long (',j,' >16) input string'
508          CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,          CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
509       &       SQUEEZE_RIGHT , myThid)       &       SQUEEZE_RIGHT , myThid)
510           WRITE(msgBuf,'(3A)') '**WARNING** ',           WRITE(msgBuf,'(3A)') '** WARNING ** ',
511       &   'DIAGS_MK_UNITS: input=', diagUnitsInPieces       &   'DIAGS_MK_UNITS: input=', diagUnitsInPieces
512          CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,          CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
513       &       SQUEEZE_RIGHT , myThid)       &       SQUEEZE_RIGHT , myThid)
514        ENDIF        ENDIF
515    
516          RETURN
517          END
518    
519    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
520    
521    CBOP 0
522    C     !ROUTINE: DIAGS_MK_TITLE
523    
524    C     !INTERFACE:
525          CHARACTER*80 FUNCTION DIAGS_MK_TITLE(
526         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        RETURN
586        END        END
Legend:
Removed from v.1.17  
changed lines
  Added in v.1.29
  ViewVC Help
Powered by ViewVC 1.1.22