/[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.2 by molod, Thu Feb 26 02:21:18 2004 UTC revision 1.23 by jmc, Sun Jun 25 23:03:55 2006 UTC
# Line 1  Line 1 
1        subroutine getdiag (lev,ipoint,bi,bj,undef,qtmp)  C $Header$
2  C***********************************************************************          C $Name$
 C  PURPOSE                                                                        
 C     Retrieve averaged model diagnostic  
 C  INPUT:                                                                        
 C     lev ..... Diagnostic LEVEL  
 C  ipoint ..... DIAGNOSTIC NUMBER FROM MENU                                      
 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  
3    
4  #include "CPP_OPTIONS.h"  #include "DIAG_OPTIONS.h"
 #include "SIZE.h"  
 #include "fizhi_SIZE.h"  
 #include "diagnostics_SIZE.h"  
 #include "diagnostics.h"  
   
       integer bi,bj  
       integer lev,ipoint  
       integer i,j,ipnt,klev  
       _RL undef, factor  
       _RL qtmp(1-OLx:sNx+Olx,1-Oly:sNy+Oly,Nsx,Nsy)  
   
       do j = 1,sNy  
       do i = 1,sNx  
        qtmp(i,j,bi,bj) = undef  
       enddo  
       enddo  
   
       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 j = 1,sNy  
       do i = 1,sNx  
       if( qdiag(i,j,ipnt,bi,bj).ne.undef )  
      .     qtmp(i,j,bi,bj) = qdiag(i,j,ipnt,bi,bj)*factor  
       enddo  
       enddo  
       ENDIF  
5    
6   999  RETURN  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
7        END  CBOP 0
8    C     !ROUTINE: GETDIAG
9    
10    C     !INTERFACE:
11          SUBROUTINE GETDIAG(
12         I                    levreal, undef,
13         O                    qtmp,
14         I                    ndId, mate, ip, im, bi, bj, myThid )
15    
16        subroutine getdiag2 (lev,ipoint,bi,bj,undef,qtmp)  C     !DESCRIPTION:
17  C***********************************************************************          C     Retrieve averaged model diagnostic
 C                                                                                
 C  PURPOSE                                                                        
 C     Retrieve model diagnostic (No Averaging)  
 C  INPUT:                                                                        
 C     lev ..... Model LEVEL                                                      
 C  ipoint ..... DIAGNOSTIC NUMBER FROM MENU                                      
 C   undef ..... UNDEFINED VALUE                                                  
 C      im ..... X-DIMENSION  
 C      jm ..... Y-DIMENSION  
 C      nd ..... Number of 2-D Diagnostics  
 C                                                                                
 C  OUTPUT:                                                                        
 C    qtmp ..... DIAGNOSTIC QUANTITY                                              
 C                                                                                
 C***********************************************************************          
       implicit none  
18    
19  #include "CPP_OPTIONS.h"  C     !USES:
20          IMPLICIT NONE
21    #include "EEPARAMS.h"
22  #include "SIZE.h"  #include "SIZE.h"
23  #include "fizhi_SIZE.h"  #include "DIAGNOSTICS_SIZE.h"
24  #include "diagnostics_SIZE.h"  #include "DIAGNOSTICS.h"
 #include "diagnostics.h"  
25    
26        integer bi,bj  C     !INPUT PARAMETERS:
27    C     levreal :: Diagnostic LEVEL
28        integer lev,ipoint  C     undef   :: UNDEFINED VALUE
29        integer i,j,ipnt,klev  C     ndId    :: DIAGNOSTIC NUMBER FROM MENU
30    C     mate    :: counter DIAGNOSTIC NUMBER if any ; 0 otherwise
31    C     ip      :: pointer to storage array location for diag.
32    C     im      :: pointer to storage array location for mate
33    C     bi      :: X-direction tile number
34    C     bj      :: Y-direction tile number
35    C     myThid  :: my thread Id number
36          _RL levreal
37        _RL undef        _RL undef
38        _RL qtmp(1-OLx:sNx+Olx,1-Oly:sNy+Oly,Nsx,Nsy)        INTEGER ndId, mate, ip, im
39          INTEGER bi,bj, myThid
40    
41    C     !OUTPUT PARAMETERS:
42    C     qtmp    ..... AVERAGED DIAGNOSTIC QUANTITY
43          _RL qtmp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
44    CEOP
45    
46    C     !LOCAL VARIABLES:
47          _RL factor
48          INTEGER i, j, ipnt,ipCt
49          INTEGER lev, levCt, klev
50    
51          IF (ndId.GE.1) THEN
52           lev = NINT(levreal)
53           klev = kdiag(ndId)
54           IF (lev.LE.klev) THEN
55    
56            IF ( mate.EQ.0 ) THEN
57    C-      No counter diagnostics => average = Sum / ndiag :
58    
59              ipnt = ip + lev - 1
60              factor = FLOAT(ndiag(ip,bi,bj))
61              IF (ndiag(ip,bi,bj).NE.0) factor = 1. _d 0 / factor
62    
63              DO j = 1,sNy+1
64                DO i = 1,sNx+1
65                  IF ( qdiag(i,j,ipnt,bi,bj) .LE. undef ) THEN
66                    qtmp(i,j) = qdiag(i,j,ipnt,bi,bj)*factor
67                  ELSE
68                    qtmp(i,j) = undef
69                  ENDIF
70                ENDDO
71              ENDDO
72    
73            ELSE
74    C-      With counter diagnostics => average = Sum / counter:
75    
76              ipnt = ip + lev - 1
77              levCt= MIN(lev,kdiag(mate))
78              ipCt = im + levCt - 1
79              DO j = 1,sNy+1
80                DO i = 1,sNx+1
81                  IF ( qdiag(i,j,ipCt,bi,bj) .NE. 0. ) THEN
82                    qtmp(i,j) = qdiag(i,j,ipnt,bi,bj)
83         &                    / qdiag(i,j,ipCt,bi,bj)
84                  ELSE
85                    qtmp(i,j) = undef
86                  ENDIF
87                ENDDO
88              ENDDO
89    
90        do j = 1,sNy          ENDIF
91        do i = 1,sNx         ENDIF
        qtmp(i,j,bi,bj) = undef  
       enddo  
       enddo  
   
       IF (IPOINT.LT.1) GO TO 999  
   
       KLEV = KDIAG(IPOINT)  
       IF(KLEV.GE.LEV) THEN  
       IPNT = IDIAG(IPOINT) + LEV - 1  
       do j = 1,sNy  
       do i = 1,sNx  
        qtmp(i,j,bi,bj) = qdiag(i,j,ipnt,bi,bj)  
       enddo  
       enddo  
92        ENDIF        ENDIF
93    
94   999  RETURN        RETURN
95        END        END
96                                                                                    
97        subroutine clrindx (myThid,listnum)  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
98    
99    CBOP 0
100    C     !ROUTINE: DIAGNOSTICS_COUNT
101    C     !INTERFACE:
102          SUBROUTINE DIAGNOSTICS_COUNT (chardiag,
103         I                              biArg, bjArg, myThid)
104    
105    C     !DESCRIPTION:
106  C***********************************************************************  C***********************************************************************
107  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  
108  C***********************************************************************  C***********************************************************************
109    C     !USES:
110          IMPLICIT NONE
111    
112        implicit none  C     == Global variables ===
 #include "EEPARAMS.h"  
 #include "CPP_OPTIONS.h"  
 #include "SIZE.h"  
 #include "fizhi_SIZE.h"  
 #include "diagnostics_SIZE.h"  
 #include "diagnostics.h"  
   
       integer myThid, listnum  
   
       integer m, n  
       character*8 parms1  
       character*1 parse1(8)  
       character*3 mate_index  
       integer mate  
   
       equivalence (     parms1 , parse1(1) )  
       equivalence ( mate_index , parse1(6) )  
   
       do n=1,nfields(listnum)  
        do m=1,ndiagt  
         if( flds(n,listnum).eq.cdiag(m) .and. idiag(m).ne.0 ) then  
          call clrdiag (myThid,m)  
   
 c Check for Counter Diagnostic  
 c ----------------------------  
          parms1 =  gdiag(m)  
          if( parse1(5).eq.'C' ) then  
           read (mate_index,100) mate  
           call clrdiag (myThid,mate)  
          endif  
         endif  
        enddo  
       enddo  
                     
   100 format(i3)  
       RETURN        
       END            
   
   
       subroutine clrdiag (myThid,index)  
 C***********************************************************************          
 C  PURPOSE                                                                        
 C     ZERO OUT MODEL DIAGNOSTIC ARRAY ELEMENTS  
 C***********************************************************************          
                                                                                   
       implicit none  
113  #include "EEPARAMS.h"  #include "EEPARAMS.h"
 #include "CPP_OPTIONS.h"  
114  #include "SIZE.h"  #include "SIZE.h"
115  #include "fizhi_SIZE.h"  #include "DIAGNOSTICS_SIZE.h"
116  #include "diagnostics_SIZE.h"  #include "DIAGNOSTICS.h"
 #include "diagnostics.h"  
   
       integer myThid, index  
   
       integer bi,bj  
       integer i,j,k  
   
 C **********************************************************************          
 C ****              SET DIAGNOSTIC AND COUNTER TO ZERO              ****          
 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.0  
         enddo  
         enddo  
        enddo  
       enddo  
       enddo  
   
       ndiag(index) = 0  
   
       return  
       end  
117    
118        subroutine setdiag (myThid,num,ndiagmx)  C     !INPUT PARAMETERS:
119  C***********************************************************************  C***********************************************************************
120  C  C  Arguments Description
121  C  PURPOSE  C  ----------------------
122  C     SET POINTER LOCATIONS, NAMES, LEVELS and TITLES FOR DIAGNOSTIC NUM  C     chardiag :: Character expression for diag to increment the counter
123  C  C     biArg    :: X-direction tile number, or 0 if called outside bi,bj loops
124    C     bjArg    :: Y-direction tile number, or 0 if called outside bi,bj loops
125    C     myThid   :: my thread Id number
126  C***********************************************************************  C***********************************************************************
127          CHARACTER*8 chardiag
128          INTEGER biArg, bjArg
129          INTEGER myThid
130    CEOP
131    
132    C     !LOCAL VARIABLES:
133    C ===============
134          INTEGER m, n
135          INTEGER bi, bj
136          INTEGER ipt
137    c     CHARACTER*(MAX_LEN_MBUF) msgBuf
138    
139    C--   Run through list of active diagnostics to find which counter
140    C     to increment (needs to be a valid & active diagnostic-counter)
141          DO n=1,nlists
142           DO m=1,nActive(n)
143            IF ( chardiag.EQ.flds(m,n) .AND. idiag(m,n).GT.0 ) THEN
144             ipt = idiag(m,n)
145             IF (ndiag(ipt,1,1).GE.0) THEN
146    C-    Increment the counter for the diagnostic
147              IF ( biArg.EQ.0 .AND. bjArg.EQ.0 ) THEN
148               DO bj=myByLo(myThid), myByHi(myThid)
149                DO bi=myBxLo(myThid), myBxHi(myThid)
150                 ndiag(ipt,bi,bj) = ndiag(ipt,bi,bj) + 1
151                ENDDO
152               ENDDO
153              ELSE
154                 bi = MIN(biArg,nSx)
155                 bj = MIN(bjArg,nSy)
156                 ndiag(ipt,bi,bj) = ndiag(ipt,bi,bj) + 1
157              ENDIF
158    C-    Increment is done
159             ENDIF
160            ENDIF
161           ENDDO
162          ENDDO
163    
164        implicit none        RETURN
165  #include "CPP_OPTIONS.h"        END
166  #include "SIZE.h"  
167  #include "fizhi_SIZE.h"  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
168  #include "diagnostics_SIZE.h"  
169  #include "diagnostics.h"  CBOP 0
170    C     !ROUTINE: DIAGS_MK_UNITS
171        integer num,myThid,ndiagmx  
172        integer ipointer  C     !INTERFACE:
173          CHARACTER*16 FUNCTION DIAGS_MK_UNITS(
174        DATA IPOINTER / 1 /       I                            diagUnitsInPieces, myThid )
175    
176        character*8 parms1  C     !DESCRIPTION:
177        character*1 parse1(8)  C     *==========================================================*
178        character*3 mate_index  C     | FUNCTION DIAGS_MK_UNITS
179        integer     mate  C     | o Return the diagnostic units string (16c) removing
180    C     |   blanks from the input string
181        equivalence (     parms1 , parse1(1) )  C     *==========================================================*
182        equivalence ( mate_index , parse1(6) )  
183    C     !USES:
184  C **********************************************************************        IMPLICIT NONE
185  C ****                SET POINTERS FOR DIAGNOSTIC NUM               ****  #include "EEPARAMS.h"
186  C **********************************************************************  
187    C     !INPUT PARAMETERS:
188        parms1 = gdiag(num)  C     diagUnitsInPieces :: string for diagnostic units: in several
189    C                          pieces, with blanks in between
190        IF( IDIAG(NUM).EQ.0 ) THEN  C     myThid            ::  my thread Id number
191          if(ndiagmx+kdiag(num).gt.numdiags) then        CHARACTER*(*) diagUnitsInPieces
192            write(6,4000)num,cdiag(num)        INTEGER      myThid
193          else  CEOP
194            IDIAG(NUM) = IPOINTER  
195            IPOINTER   = IPOINTER + KDIAG(NUM)  C     !LOCAL VARIABLES:
196            ndiagmx    = ndiagmx  + KDIAG(NUM)        CHARACTER*(MAX_LEN_MBUF) msgBuf
197            if(myThid.eq.0) WRITE(6,2000)KDIAG(NUM),NUM,CDIAG(NUM),ndiagmx        INTEGER i,j,n
198          endif  
199        ELSE        DIAGS_MK_UNITS = '          '
200            if(myThid.eq.0) WRITE(6,3000) NUM, CDIAG(NUM)        n = LEN(diagUnitsInPieces)
201    
202          j = 0
203          DO i=1,n
204           IF (diagUnitsInPieces(i:i) .NE. ' ' ) THEN
205             j = j+1
206             IF ( j.LE.16 ) DIAGS_MK_UNITS(j:j) = diagUnitsInPieces(i:i)
207           ENDIF
208          ENDDO
209    
210          IF ( j.GT.16 ) THEN
211             WRITE(msgBuf,'(2A,I4,A)') '**WARNING** ',
212         &   'DIAGS_MK_UNITS: too long (',j,' >16) input string'
213            CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
214         &       SQUEEZE_RIGHT , myThid)
215             WRITE(msgBuf,'(3A)') '**WARNING** ',
216         &   'DIAGS_MK_UNITS: input=', diagUnitsInPieces
217            CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
218         &       SQUEEZE_RIGHT , myThid)
219        ENDIF        ENDIF
220    
221  c Check for Counter Diagnostic        RETURN
222  c ----------------------------        END
223        if( parse1(5).eq.'C') then  
224        read (mate_index,100) mate  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
225    
226        IF( IDIAG(mate).EQ.0 ) THEN  CBOP 0
227         if(ndiagmx+kdiag(num).gt.numdiags) then  C     !ROUTINE: DIAGS_MK_TITLE
228          write(6,5000)num,cdiag(num)  
229         else  C     !INTERFACE:
230          IDIAG(mate) = IPOINTER        CHARACTER*80 FUNCTION DIAGS_MK_TITLE(
231          IPOINTER    = IPOINTER + KDIAG(mate)       I                            diagTitleInPieces, myThid )
232          ndiagmx     = ndiagmx  + KDIAG(mate)  
233          if(myThid.eq.0)WRITE(6,2000)KDIAG(mate),mate,CDIAG(mate),ndiagmx  C     !DESCRIPTION:
234         endif  C     *==========================================================*
235        ELSE  C     | FUNCTION DIAGS_MK_TITLE
236            if(myThid.eq.0) WRITE(6,3000) mate, CDIAG(mate)  C     | o Return the diagnostic title string (80c) removing
237    C     |   consecutive blanks from the input string
238    C     *==========================================================*
239    
240    C     !USES:
241          IMPLICIT NONE
242    #include "EEPARAMS.h"
243    
244    C     !INPUT PARAMETERS:
245    C     diagTitleInPieces :: string for diagnostic units: in several
246    C                          pieces, with blanks in between
247    C     myThid            ::  my Thread Id number
248          CHARACTER*(*) diagTitleInPieces
249          INTEGER      myThid
250    CEOP
251    
252    C     !LOCAL VARIABLES:
253          CHARACTER*(MAX_LEN_MBUF) msgBuf
254          LOGICAL flag
255          INTEGER i,j,n
256    
257    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
258    
259          DIAGS_MK_TITLE = '                                        '
260         &               //'                                        '
261          n = LEN(diagTitleInPieces)
262    
263          j = 0
264          flag = .FALSE.
265          DO i=1,n
266           IF (diagTitleInPieces(i:i) .NE. ' ' ) THEN
267             IF ( flag ) THEN
268               j = j+1
269               IF (j.LE.80) DIAGS_MK_TITLE(j:j) = ' '
270             ENDIF
271             j = j+1
272             IF ( j.LE.80 ) DIAGS_MK_TITLE(j:j) = diagTitleInPieces(i:i)
273             flag = .FALSE.
274           ELSE
275             flag = j.GE.1
276           ENDIF
277          ENDDO
278    
279          IF ( j.GT.80 ) THEN
280             WRITE(msgBuf,'(2A,I4,A)') '**WARNING** ',
281         &   'DIAGS_MK_TITLE: too long (',j,' >80) input string'
282            CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
283         &       SQUEEZE_RIGHT , myThid)
284             WRITE(msgBuf,'(3A)') '**WARNING** ',
285         &   'DIAGS_MK_TITLE: input=', diagTitleInPieces
286            CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
287         &       SQUEEZE_RIGHT , myThid)
288        ENDIF        ENDIF
       endif  
289    
290        RETURN        RETURN
291          END
292    
293    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
294    
295    CBOP 0
296    C     !ROUTINE: diagnostics_get_pointers
297    C     !INTERFACE:
298          subroutine diagnostics_get_pointers(diagName,ipoint,jpoint,myThid)
299    
300    C     !DESCRIPTION:
301    C     *==========================================================*
302    C     | subroutine diagnostics_get_pointers
303    C     | o Returns the idiag and jdiag pointers for a
304    C     |   specified diagnostic - returns 0 if not active
305    C     *==========================================================*
306    
307    100 format(i3)  C     !USES:
308   2000 FORMAT(1X,'Allocating ',I2,' Level(s) for Diagnostic # ',I3,        IMPLICIT NONE
309       .          ' (',A8,'),  Total Number of Diagnostics: ',I5)  #include "EEPARAMS.h"
310   3000 FORMAT(1X,'Diagnostic # ',I3,' (',A8,') has already been set')  #include "SIZE.h"
311   4000 FORMAT(1X,'Unable to allocate space for Diagnostic # ',I3,  #include "DIAGNOSTICS_SIZE.h"
312       .                      ' (',A8,')')  #include "DIAGNOSTICS.h"
313   5000 FORMAT(1X,'Unable to allocate space for Counter Diagnostic # ',  
314       .    I3,' (',A8,')',' WARNING - Diag will not accumulate properly')  C     !INPUT PARAMETERS:
315    C     diagName   ::  diagnostic identificator name (8 characters long)
316    C     myThid     ::  my thread Id number
317    C     !OUTPUT PARAMETERS:
318    C     ipoint     ::  pointer value into qdiag array
319    C     jpoint     ::  pointer value into diagnostics list
320    
321          CHARACTER*8 diagName
322          INTEGER ipoint, jpoint, myThid
323    CEOP
324    
325    C     !LOCAL VARIABLES:
326          INTEGER n,m
327    
328          ipoint = 0
329          jpoint = 0
330    
331    C-    search for this diag. in the active 2D/3D diagnostics list
332          DO n=1,nlists
333           DO m=1,nActive(n)
334            IF ( diagName.EQ.flds(m,n) .AND. idiag(m,n).NE.0 ) THEN
335              ipoint = abs(idiag(m,n))
336              jpoint = jdiag(m,n)
337            ENDIF
338           ENDDO
339          ENDDO
340    
341          RETURN
342        END        END

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.23

  ViewVC Help
Powered by ViewVC 1.1.22