/[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.16 by jmc, Mon Dec 20 01:53:54 2004 UTC revision 1.23 by jmc, Sun Jun 25 23:03:55 2006 UTC
# Line 8  CBOP 0 Line 8  CBOP 0
8  C     !ROUTINE: GETDIAG  C     !ROUTINE: GETDIAG
9    
10  C     !INTERFACE:  C     !INTERFACE:
11        SUBROUTINE GETDIAG (levreal,ipoint,undef,qtmp,myThid)        SUBROUTINE GETDIAG(
12         I                    levreal, undef,
13         O                    qtmp,
14         I                    ndId, mate, ip, im, bi, bj, myThid )
15    
16  C     !DESCRIPTION:  C     !DESCRIPTION:
17  C     Retrieve averaged model diagnostic  C     Retrieve averaged model diagnostic
18    
19  C     !USES:  C     !USES:
20        implicit none        IMPLICIT NONE
21  #include "EEPARAMS.h"  #include "EEPARAMS.h"
22  #include "SIZE.h"  #include "SIZE.h"
23  #include "DIAGNOSTICS_SIZE.h"  #include "DIAGNOSTICS_SIZE.h"
24  #include "DIAGNOSTICS.h"  #include "DIAGNOSTICS.h"
 CEOP  
25    
26  #ifdef ALLOW_FIZHI  C     !INPUT PARAMETERS:
27  #include "fizhi_SIZE.h"  C     levreal :: Diagnostic LEVEL
28  #else  C     undef   :: UNDEFINED VALUE
29        integer Nrphys  C     ndId    :: DIAGNOSTIC NUMBER FROM MENU
30        parameter (Nrphys=0)  C     mate    :: counter DIAGNOSTIC NUMBER if any ; 0 otherwise
31  #endif  C     ip      :: pointer to storage array location for diag.
32    C     im      :: pointer to storage array location for mate
33  C     INPUT:  C     bi      :: X-direction tile number
34  C     levreal .... Diagnostic LEVEL  C     bj      :: Y-direction tile number
35  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  
36        _RL levreal        _RL levreal
       integer myThid,ipoint  
37        _RL undef        _RL undef
38          INTEGER ndId, mate, ip, im
39          INTEGER bi,bj, myThid
40    
41  C     OUTPUT:  C     !OUTPUT PARAMETERS:
42  C     qtmp    ..... AVERAGED DIAGNOSTIC QUANTITY  C     qtmp    ..... AVERAGED DIAGNOSTIC QUANTITY
43        _RL qtmp(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr+Nrphys,nSx,nSy)        _RL qtmp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
44    CEOP
45    
46    C     !LOCAL VARIABLES:
47        _RL factor        _RL factor
48        integer i,j,ipnt,klev        INTEGER i, j, ipnt,ipCt
49        integer bi,bj        INTEGER lev, levCt, klev
       integer lev  
50    
51        if (ipoint.ge.1) then        IF (ndId.GE.1) THEN
52         lev = NINT(levreal)         lev = NINT(levreal)
53           klev = kdiag(ndId)
54           IF (lev.LE.klev) THEN
55    
56         klev = kdiag(ipoint)          IF ( mate.EQ.0 ) THEN
57         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  
58    
59            enddo            ipnt = ip + lev - 1
60          enddo            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         endif          ENDIF
91        endif         ENDIF
92          ENDIF
93    
94        RETURN        RETURN
95        END        END
96    
97  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
 CBOP 0  
 C     !ROUTINE: GETDIAG2  
98    
99    CBOP 0
100    C     !ROUTINE: DIAGNOSTICS_COUNT
101  C     !INTERFACE:  C     !INTERFACE:
102        SUBROUTINE GETDIAG2 (levreal,ipoint,undef,qtmp,myThid)        SUBROUTINE DIAGNOSTICS_COUNT (chardiag,
103         I                              biArg, bjArg, myThid)
104    
105  C     !DESCRIPTION:  C     !DESCRIPTION:
106  C***********************************************************************  C***********************************************************************
107  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  
108  C***********************************************************************  C***********************************************************************
   
109  C     !USES:  C     !USES:
110        implicit none        IMPLICIT NONE
111    
112    C     == Global variables ===
113  #include "EEPARAMS.h"  #include "EEPARAMS.h"
114  #include "SIZE.h"  #include "SIZE.h"
115  #include "DIAGNOSTICS_SIZE.h"  #include "DIAGNOSTICS_SIZE.h"
116  #include "DIAGNOSTICS.h"  #include "DIAGNOSTICS.h"
117    
118    C     !INPUT PARAMETERS:
119    C***********************************************************************
120    C  Arguments Description
121    C  ----------------------
122    C     chardiag :: Character expression for diag to increment the counter
123    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***********************************************************************
127          CHARACTER*8 chardiag
128          INTEGER biArg, bjArg
129          INTEGER myThid
130  CEOP  CEOP
131    
132  #ifdef ALLOW_FIZHI  C     !LOCAL VARIABLES:
133  #include "fizhi_SIZE.h"  C ===============
134  #else        INTEGER m, n
135         integer Nrphys        INTEGER bi, bj
136         parameter (Nrphys=0)        INTEGER ipt
137  #endif  c     CHARACTER*(MAX_LEN_MBUF) msgBuf
138    
139        _RL levreal  C--   Run through list of active diagnostics to find which counter
140        integer myThid,ipoint  C     to increment (needs to be a valid & active diagnostic-counter)
141        _RL undef        DO n=1,nlists
142        _RL qtmp(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr+Nrphys,nSx,nSy)         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        integer i,j,ipnt,klev        RETURN
165        integer bi,bj        END
       integer lev  
166    
167        if (ipoint.ge.1) then  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
        lev = NINT(levreal)  
168    
169         klev = kdiag(ipoint)  CBOP 0
170         if (klev.ge.lev) then  C     !ROUTINE: DIAGS_MK_UNITS
         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  
                 if ( qdiag(i,j,ipnt,bi,bj) .le. undef ) then  
                   qtmp(i,j,lev,bi,bj) = qdiag(i,j,ipnt,bi,bj)  
                 else  
                   qtmp(i,j,lev,bi,bj) = undef  
                 endif  
               enddo  
             enddo  
171    
172            enddo  C     !INTERFACE:
173          enddo        CHARACTER*16 FUNCTION DIAGS_MK_UNITS(
174         I                            diagUnitsInPieces, myThid )
175    
176         endif  C     !DESCRIPTION:
177        endif  C     *==========================================================*
178    C     | FUNCTION DIAGS_MK_UNITS
179    C     | o Return the diagnostic units string (16c) removing
180    C     |   blanks from the input string
181    C     *==========================================================*
182    
183        RETURN  C     !USES:
184        END        IMPLICIT NONE
185    #include "EEPARAMS.h"
186    
187  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C     !INPUT PARAMETERS:
188    C     diagUnitsInPieces :: string for diagnostic units: in several
189    C                          pieces, with blanks in between
190    C     myThid            ::  my thread Id number
191          CHARACTER*(*) diagUnitsInPieces
192          INTEGER      myThid
193    CEOP
194    
195        subroutine clrindx (listnum, myThid)  C     !LOCAL VARIABLES:
196  C***********************************************************************        CHARACTER*(MAX_LEN_MBUF) msgBuf
197  C        INTEGER i,j,n
 C  PURPOSE  
 C     DRIVER TO CLEAR DIAGNOSTICS SPECIFIED IN DIAGNOSTIC INDEX LIST  
 C  
 C  ARGUMENT DESCRIPTION  
 C     listnum ....  diagnostics list number  
 C  
 C***********************************************************************  
198    
199        implicit none        DIAGS_MK_UNITS = '          '
200  #include "EEPARAMS.h"        n = LEN(diagUnitsInPieces)
 #include "SIZE.h"  
 #include "DIAGNOSTICS_SIZE.h"  
 #include "DIAGNOSTICS.h"  
201    
202        integer myThid, listnum        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        integer m, n        IF ( j.GT.16 ) THEN
211        character*8 parms1           WRITE(msgBuf,'(2A,I4,A)') '**WARNING** ',
212        character*3 mate_index       &   'DIAGS_MK_UNITS: too long (',j,' >16) input string'
213        integer mate          CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
214         &       SQUEEZE_RIGHT , myThid)
215        do n=1,nfields(listnum)           WRITE(msgBuf,'(3A)') '**WARNING** ',
216         do m=1,ndiagt       &   'DIAGS_MK_UNITS: input=', diagUnitsInPieces
217          if( flds(n,listnum).eq.cdiag(m) .and. idiag(m).ne.0 ) then          CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
218           call clrdiag (m, myThid)       &       SQUEEZE_RIGHT , myThid)
219          ENDIF
 c Check for Counter Diagnostic  
 c ----------------------------  
          parms1 =  gdiag(m)(1:8)  
          if ( parms1(5:5).eq.'C' ) then  
           mate_index = parms1(6:8)  
           read (mate_index,'(I3)') mate  
           call clrdiag (mate, myThid)  
          endif  
         endif  
        enddo  
       enddo  
220    
221        RETURN        RETURN
222        END        END
223    
224    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
225    
226        subroutine clrdiag (index, myThid)  CBOP 0
227  C***********************************************************************  C     !ROUTINE: DIAGS_MK_TITLE
228  C  PURPOSE  
229  C     ZERO OUT MODEL DIAGNOSTIC ARRAY ELEMENTS  C     !INTERFACE:
230  C***********************************************************************        CHARACTER*80 FUNCTION DIAGS_MK_TITLE(
231         I                            diagTitleInPieces, myThid )
232    
233    C     !DESCRIPTION:
234    C     *==========================================================*
235    C     | FUNCTION DIAGS_MK_TITLE
236    C     | o Return the diagnostic title string (80c) removing
237    C     |   consecutive blanks from the input string
238    C     *==========================================================*
239    
240        implicit none  C     !USES:
241          IMPLICIT NONE
242  #include "EEPARAMS.h"  #include "EEPARAMS.h"
 #include "SIZE.h"  
 #include "DIAGNOSTICS_SIZE.h"  
 #include "DIAGNOSTICS.h"  
243    
244        integer myThid, index  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        integer bi,bj  C     !LOCAL VARIABLES:
253        integer i,j,k        CHARACTER*(MAX_LEN_MBUF) msgBuf
254          LOGICAL flag
255          INTEGER i,j,n
256    
257  C **********************************************************************  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
258  C ****              SET DIAGNOSTIC AND COUNTER TO ZERO              ****  
259  C **********************************************************************        DIAGS_MK_TITLE = '                                        '
260         &               //'                                        '
261        do bj=myByLo(myThid), myByHi(myThid)        n = LEN(diagTitleInPieces)
262         do bi=myBxLo(myThid), myBxHi(myThid)  
263          do k = 1,kdiag(index)        j = 0
264           do j = 1-OLy,sNy+OLy        flag = .FALSE.
265            do i = 1-OLx,sNx+OLx        DO i=1,n
266             qdiag(i,j,idiag(index)+k-1,bi,bj) = 0.0         IF (diagTitleInPieces(i:i) .NE. ' ' ) THEN
267            enddo           IF ( flag ) THEN
268           enddo             j = j+1
269          enddo             IF (j.LE.80) DIAGS_MK_TITLE(j:j) = ' '
270         enddo           ENDIF
271        enddo           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        ndiag(index) = 0        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
289    
290        RETURN        RETURN
291        END        END
# Line 240  C ************************************** Line 293  C **************************************
293  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
294    
295  CBOP 0  CBOP 0
296  C     !ROUTINE: DIAGNOSTICS_IS_ON  C     !ROUTINE: diagnostics_get_pointers
   
297  C     !INTERFACE:  C     !INTERFACE:
298        LOGICAL FUNCTION DIAGNOSTICS_IS_ON( diagName, myThid )        subroutine diagnostics_get_pointers(diagName,ipoint,jpoint,myThid)
299    
300  C     !DESCRIPTION:  C     !DESCRIPTION:
301  C     *==========================================================*  C     *==========================================================*
302  C     | FUNCTION DIAGNOSTIC_IS_ON  C     | subroutine diagnostics_get_pointers
303  C     | o Return TRUE if diagnostics "diagName" is Active  C     | o Returns the idiag and jdiag pointers for a
304    C     |   specified diagnostic - returns 0 if not active
305  C     *==========================================================*  C     *==========================================================*
306    
307  C     !USES:  C     !USES:
# Line 261  C     !USES: Line 314  C     !USES:
314  C     !INPUT PARAMETERS:  C     !INPUT PARAMETERS:
315  C     diagName   ::  diagnostic identificator name (8 characters long)  C     diagName   ::  diagnostic identificator name (8 characters long)
316  C     myThid     ::  my thread Id number  C     myThid     ::  my thread Id number
317        CHARACTER*8  diagName  C     !OUTPUT PARAMETERS:
318        INTEGER      myThid  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  CEOP
324    
325  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
326        INTEGER j,n,m        INTEGER n,m
327    
328          ipoint = 0
329          jpoint = 0
330    
331        DIAGNOSTICS_IS_ON = .FALSE.  C-    search for this diag. in the active 2D/3D diagnostics list
332        DO n=1,nlists        DO n=1,nlists
333         DO m=1,nActive(n)         DO m=1,nActive(n)
334          IF ( diagName.EQ.flds(m,n) ) THEN          IF ( diagName.EQ.flds(m,n) .AND. idiag(m,n).NE.0 ) THEN
335            j = jdiag(m,n)                ipoint = abs(idiag(m,n))
336            IF ( idiag(j).NE.0 .AND. ndiag(j).GE.0 )            jpoint = jdiag(m,n)
      &         DIAGNOSTICS_IS_ON = .TRUE.  
337          ENDIF          ENDIF
338         ENDDO         ENDDO
339        ENDDO        ENDDO
Legend:
Removed from v.1.16  
changed lines
  Added in v.1.23
  ViewVC Help
Powered by ViewVC 1.1.22