/[MITgcm]/MITgcm/pkg/generic_advdiff/gad_calc_rhs.F
ViewVC logotype

Diff of /MITgcm/pkg/generic_advdiff/gad_calc_rhs.F

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

revision 1.42 by jmc, Sun Nov 19 22:04:09 2006 UTC revision 1.70 by jmc, Mon Aug 18 12:22:46 2014 UTC
# Line 11  C !INTERFACE: ========================== Line 11  C !INTERFACE: ==========================
11       I           bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,       I           bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,
12       I           xA, yA, maskUp, uFld, vFld, wFld,       I           xA, yA, maskUp, uFld, vFld, wFld,
13       I           uTrans, vTrans, rTrans, rTransKp1,       I           uTrans, vTrans, rTrans, rTransKp1,
14       I           diffKh, diffK4, KappaR, TracerN, TracAB,       I           diffKh, diffK4, KappaR, diffKr4, TracerN, TracAB,
15       I           tracerIdentity, advectionScheme, vertAdvecScheme,       I           deltaTLev, trIdentity,
16         I           advectionScheme, vertAdvecScheme,
17       I           calcAdvection, implicitAdvection, applyAB_onTracer,       I           calcAdvection, implicitAdvection, applyAB_onTracer,
18         I           trUseDiffKr4, trUseGMRedi, trUseKPP,
19         O           fZon, fMer,
20       U           fVerT, gTracer,       U           fVerT, gTracer,
21       I           myTime, myIter, myThid )       I           myTime, myIter, myThid )
22    
# Line 44  C !USES: =============================== Line 47  C !USES: ===============================
47  #include "GRID.h"  #include "GRID.h"
48  #include "SURFACE.h"  #include "SURFACE.h"
49  #include "GAD.h"  #include "GAD.h"
50    #ifdef ALLOW_AUTODIFF
51  #ifdef ALLOW_AUTODIFF_TAMC  # include "AUTODIFF_PARAMS.h"
52  #include "tamc.h"  #endif /* ALLOW_AUTODIFF */
 #include "tamc_keys.h"  
 #endif /* ALLOW_AUTODIFF_TAMC */  
53    
54  C !INPUT PARAMETERS: ===================================================  C !INPUT PARAMETERS: ===================================================
55  C bi,bj            :: tile indices  C bi,bj            :: tile indices
# Line 65  C uTrans,vTrans    :: 2-D arrays of volu Line 66  C uTrans,vTrans    :: 2-D arrays of volu
66  C rTrans           :: 2-D arrays of volume transports at W points  C rTrans           :: 2-D arrays of volume transports at W points
67  C rTransKp1        :: 2-D array of volume trans at W pts, interf k+1  C rTransKp1        :: 2-D array of volume trans at W pts, interf k+1
68  C diffKh           :: horizontal diffusion coefficient  C diffKh           :: horizontal diffusion coefficient
69  C diffK4           :: bi-harmonic diffusion coefficient  C diffK4           :: horizontal bi-harmonic diffusion coefficient
70  C KappaR           :: 2-D array for vertical diffusion coefficient, interf k  C KappaR           :: 2-D array for vertical diffusion coefficient, interf k
71    C diffKr4          :: 1-D array for vertical bi-harmonic diffusion coefficient
72  C TracerN          :: tracer field @ time-step n (Note: only used  C TracerN          :: tracer field @ time-step n (Note: only used
73  C                     if applying AB on tracer field rather than on tendency gTr)  C                     if applying AB on tracer field rather than on tendency gTr)
74  C TracAB           :: current tracer field (@ time-step n if applying AB on gTr  C TracAB           :: current tracer field (@ time-step n if applying AB on gTr
75  C                     or extrapolated fwd in time to n+1/2 if applying AB on Tr)  C                     or extrapolated fwd in time to n+1/2 if applying AB on Tr)
76  C tracerIdentity   :: tracer identifier (required for KPP,GM)  C trIdentity       :: tracer identifier (required for KPP,GM)
77  C advectionScheme  :: advection scheme to use (Horizontal plane)  C advectionScheme  :: advection scheme to use (Horizontal plane)
78  C vertAdvecScheme  :: advection scheme to use (Vertical direction)  C vertAdvecScheme  :: advection scheme to use (Vertical direction)
79  C calcAdvection    :: =False if Advec computed with multiDim scheme  C calcAdvection    :: =False if Advec computed with multiDim scheme
80  C implicitAdvection:: =True if vertical Advec computed implicitly  C implicitAdvection:: =True if vertical Advec computed implicitly
81  C applyAB_onTracer :: apply Adams-Bashforth on Tracer (rather than on gTr)  C applyAB_onTracer :: apply Adams-Bashforth on Tracer (rather than on gTr)
82    C trUseDiffKr4     :: true if this tracer uses vertical bi-harmonic diffusion
83    C trUseGMRedi      :: true if this tracer uses GM-Redi
84    C trUseKPP         :: true if this tracer uses KPP
85  C myTime           :: current time  C myTime           :: current time
86  C myIter           :: iteration number  C myIter           :: iteration number
87  C myThid           :: thread number  C myThid           :: thread number
# Line 94  C myThid           :: thread number Line 99  C myThid           :: thread number
99        _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
100        _RL diffKh, diffK4        _RL diffKh, diffK4
101        _RL KappaR(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL KappaR(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
102        _RL TracerN(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)        _RL diffKr4(Nr)
103        _RL TracAB (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)        _RL TracerN(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
104        INTEGER tracerIdentity        _RL TracAB (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
105          _RL deltaTLev(Nr)
106          INTEGER trIdentity
107        INTEGER advectionScheme, vertAdvecScheme        INTEGER advectionScheme, vertAdvecScheme
108        LOGICAL calcAdvection        LOGICAL calcAdvection
109        LOGICAL implicitAdvection, applyAB_onTracer        LOGICAL implicitAdvection, applyAB_onTracer
110          LOGICAL trUseDiffKr4, trUseGMRedi, trUseKPP
111        _RL     myTime        _RL     myTime
112        INTEGER myIter, myThid        INTEGER myIter, myThid
113    
114  C !OUTPUT PARAMETERS: ==================================================  C !OUTPUT PARAMETERS: ==================================================
115  C gTracer          :: tendency array  C gTracer          :: tendency array
116    C fZon             :: zonal flux
117    C fMer             :: meridional flux
118  C fVerT            :: 2 1/2D arrays for vertical advective flux  C fVerT            :: 2 1/2D arrays for vertical advective flux
119        _RL gTracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)        _RL gTracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
120          _RL fZon  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
121          _RL fMer  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
122        _RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
123    
124    C !FUNCTIONS:       ====================================================
125    #ifdef ALLOW_DIAGNOSTICS
126          CHARACTER*4 GAD_DIAG_SUFX
127          EXTERNAL    GAD_DIAG_SUFX
128    #endif /* ALLOW_DIAGNOSTICS */
129    
130  C !LOCAL VARIABLES: ====================================================  C !LOCAL VARIABLES: ====================================================
131  C i,j              :: loop indices  C i,j              :: loop indices
132  C df4              :: used for storing del^2 T for bi-harmonic term  C df4              :: used for storing del^2 T for bi-harmonic term
 C fZon             :: zonal flux  
 C fMer             :: meridional flux  
133  C af               :: advective flux  C af               :: advective flux
134  C df               :: diffusive flux  C df               :: diffusive flux
135  C localT           :: local copy of tracer field  C localT           :: local copy of tracer field
136  C locABT           :: local copy of (AB-extrapolated) tracer field  C locABT           :: local copy of (AB-extrapolated) tracer field
 #ifdef ALLOW_DIAGNOSTICS  
       CHARACTER*8 diagName  
       CHARACTER*4 GAD_DIAG_SUFX, diagSufx  
       EXTERNAL    GAD_DIAG_SUFX  
 #endif  
137        INTEGER i,j        INTEGER i,j
138          _RS maskLocW(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
139          _RS maskLocS(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
140        _RL df4   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL df4   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
       _RL fZon  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL fMer  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
141        _RL af    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL af    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
142        _RL df    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL df    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
143        _RL localT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL localT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
144        _RL locABT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL locABT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
145        _RL advFac, rAdvFac        _RL advFac, rAdvFac
146    #ifdef GAD_SMOLARKIEWICZ_HACK
147          _RL outFlux, trac, fac, gTrFac
148    #endif
149    #ifdef ALLOW_DIAGNOSTICS
150          CHARACTER*8 diagName
151          CHARACTER*4 diagSufx
152    #endif
153  CEOP  CEOP
154    
155  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF
156  C--   only the kUp part of fverT is set in this subroutine  C--   only the kUp part of fverT is set in this subroutine
157  C--   the kDown is still required  C--   the kDown is still required
158        fVerT(1,1,kDown) = fVerT(1,1,kDown)        fVerT(1,1,kDown) = fVerT(1,1,kDown)
# Line 143  C--   the kDown is still required Line 161  C--   the kDown is still required
161  #ifdef ALLOW_DIAGNOSTICS  #ifdef ALLOW_DIAGNOSTICS
162  C--   Set diagnostic suffix for the current tracer  C--   Set diagnostic suffix for the current tracer
163        IF ( useDiagnostics ) THEN        IF ( useDiagnostics ) THEN
164          diagSufx = GAD_DIAG_SUFX( tracerIdentity, myThid )          diagSufx = GAD_DIAG_SUFX( trIdentity, myThid )
165        ENDIF        ENDIF
166  #endif  #endif
167    
168        advFac  = 0. _d 0        advFac  = 0. _d 0
169        IF (calcAdvection) advFac = 1. _d 0        IF (calcAdvection) advFac = 1. _d 0
170        rAdvFac = rkSign*advFac        rAdvFac = rkSign*advFac
171        IF (implicitAdvection) rAdvFac = 0. _d 0        IF (implicitAdvection) rAdvFac = rkSign
172    
173        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
174         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
# Line 166  C--   Make local copy of tracer array Line 184  C--   Make local copy of tracer array
184        IF ( applyAB_onTracer ) THEN        IF ( applyAB_onTracer ) THEN
185          DO j=1-OLy,sNy+OLy          DO j=1-OLy,sNy+OLy
186           DO i=1-OLx,sNx+OLx           DO i=1-OLx,sNx+OLx
187            localT(i,j)=TracerN(i,j,k,bi,bj)            localT(i,j)=TracerN(i,j,k)
188            locABT(i,j)= TracAB(i,j,k,bi,bj)            locABT(i,j)= TracAB(i,j,k)
189           ENDDO           ENDDO
190          ENDDO          ENDDO
191        ELSE        ELSE
192          DO j=1-OLy,sNy+OLy          DO j=1-OLy,sNy+OLy
193           DO i=1-OLx,sNx+OLx           DO i=1-OLx,sNx+OLx
194            localT(i,j)= TracAB(i,j,k,bi,bj)            localT(i,j)=TracerN(i,j,k)
195            locABT(i,j)= TracAB(i,j,k,bi,bj)            locABT(i,j)=TracerN(i,j,k)
196           ENDDO           ENDDO
197          ENDDO          ENDDO
198        ENDIF        ENDIF
199    
 C--   Unless we have already calculated the advection terms we initialize  
 C     the tendency to zero.  
 C     <== now done earlier at the beginning of thermodynamics.  
 c     IF (calcAdvection) THEN  
 c      DO j=1-Oly,sNy+Oly  
 c       DO i=1-Olx,sNx+Olx  
 c        gTracer(i,j,k,bi,bj)=0. _d 0  
 c       ENDDO  
 c      ENDDO  
 c     ENDIF  
   
200  C--   Pre-calculate del^2 T if bi-harmonic coefficient is non-zero  C--   Pre-calculate del^2 T if bi-harmonic coefficient is non-zero
201        IF (diffK4 .NE. 0.) THEN        IF (diffK4 .NE. 0.) THEN
202         CALL GAD_GRAD_X(bi,bj,k,xA,localT,fZon,myThid)         CALL GAD_GRAD_X(bi,bj,k,xA,localT,fZon,myThid)
# Line 198  C--   Pre-calculate del^2 T if bi-harmon Line 205  C--   Pre-calculate del^2 T if bi-harmon
205        ENDIF        ENDIF
206    
207  C--   Initialize net flux in X direction  C--   Initialize net flux in X direction
208        DO j=1-Oly,sNy+Oly        DO j=1-OLy,sNy+OLy
209         DO i=1-Olx,sNx+Olx         DO i=1-OLx,sNx+OLx
210          fZon(i,j) = 0. _d 0          fZon(i,j) = 0. _d 0
211         ENDDO         ENDDO
212        ENDDO        ENDDO
# Line 207  C--   Initialize net flux in X direction Line 214  C--   Initialize net flux in X direction
214  C-    Advective flux in X  C-    Advective flux in X
215        IF (calcAdvection) THEN        IF (calcAdvection) THEN
216          IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN          IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
217            CALL GAD_C2_ADV_X(bi,bj,k,uTrans,locABT,af,myThid)             CALL GAD_C2_ADV_X( bi,bj,k, uTrans, locABT, af, myThid )
218          ELSEIF ( advectionScheme.EQ.ENUM_UPWIND_1RST          ELSEIF ( advectionScheme.EQ.ENUM_UPWIND_1RST
219       &          .OR. advectionScheme.EQ.ENUM_DST2 ) THEN       &          .OR. advectionScheme.EQ.ENUM_DST2 ) THEN
220            CALL GAD_DST2U1_ADV_X( bi,bj,k, advectionScheme,             CALL GAD_DST2U1_ADV_X( bi,bj,k, advectionScheme, .TRUE.,
221       I            dTtracerLev(k), uTrans, uFld, locABT,       I              deltaTLev(k), uTrans, uFld, locABT,
222       O            af, myThid )       O              af, myThid )
223          ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN          ELSE
224            CALL GAD_FLUXLIMIT_ADV_X( bi,bj,k, dTtracerLev(k),           DO j=1-OLy,sNy+OLy
225       I            uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,            DO i=1-OLx,sNx+OLx
226       O            af, myThid )  #ifdef ALLOW_OBCS
227          ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN             maskLocW(i,j) = _maskW(i,j,k,bi,bj)*maskInW(i,j,bi,bj)
228            CALL GAD_U3_ADV_X(bi,bj,k,uTrans,locABT,af,myThid)  #else /* ALLOW_OBCS */
229          ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN             maskLocW(i,j) = _maskW(i,j,k,bi,bj)
230            CALL GAD_C4_ADV_X(bi,bj,k,uTrans,locABT,af,myThid)  #endif /* ALLOW_OBCS */
231          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN            ENDDO
232            CALL GAD_DST3_ADV_X( bi,bj,k, dTtracerLev(k),           ENDDO
233       I            uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,           IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
234       O            af, myThid )             CALL GAD_FLUXLIMIT_ADV_X( bi,bj,k, .TRUE., deltaTLev(k),
235          ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN       I              uTrans, uFld, maskLocW, locABT,
236           IF ( inAdMode ) THEN       O              af, myThid )
237             ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
238               CALL GAD_U3_ADV_X( bi,bj,k, uTrans, maskLocW, locABT,
239         O              af, myThid )
240             ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
241               CALL GAD_C4_ADV_X( bi,bj,k, uTrans, maskLocW, locABT,
242         O              af, myThid )
243    #ifdef ALLOW_AUTODIFF
244             ELSEIF( advectionScheme.EQ.ENUM_DST3 .OR.
245         &          (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT .AND. inAdMode)
246         &         ) THEN
247  cph This block is to trick the adjoint:  cph This block is to trick the adjoint:
248  cph IF inAdExact=.FALSE., we want to use DST3  cph If inAdExact=.FALSE., we want to use DST3
249  cph with limiters in forward, but without limiters in reverse.  cph with limiters in forward, but without limiters in reverse.
250            CALL GAD_DST3_ADV_X( bi,bj,k, dTtracerLev(k),  #else /* ALLOW_AUTODIFF */
251       I           uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,           ELSEIF( advectionScheme.EQ.ENUM_DST3 ) THEN
252       O           af, myThid )  #endif /* ALLOW_AUTODIFF */
253               CALL GAD_DST3_ADV_X( bi,bj,k, .TRUE., deltaTLev(k),
254         I              uTrans, uFld, maskLocW, locABT,
255         O              af, myThid )
256             ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
257               CALL GAD_DST3FL_ADV_X( bi,bj,k, .TRUE., deltaTLev(k),
258         I              uTrans, uFld, maskLocW, locABT,
259         O              af, myThid )
260    #ifndef ALLOW_AUTODIFF
261             ELSEIF (advectionScheme.EQ.ENUM_OS7MP ) THEN
262               CALL GAD_OS7MP_ADV_X( bi,bj,k, .TRUE., deltaTLev(k),
263         I              uTrans, uFld, maskLocW, locABT,
264         O              af, myThid )
265    #endif
266           ELSE           ELSE
267            CALL GAD_DST3FL_ADV_X( bi,bj,k, dTtracerLev(k),            STOP 'GAD_CALC_RHS: Bad advectionScheme (X)'
      I           uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,  
      O           af, myThid )  
268           ENDIF           ENDIF
         ELSE  
          STOP 'GAD_CALC_RHS: Bad advectionScheme (X)'  
269          ENDIF          ENDIF
270          DO j=1-Oly,sNy+Oly  #ifdef ALLOW_OBCS
271           DO i=1-Olx,sNx+Olx          IF ( useOBCS ) THEN
272    C-      replace advective flux with 1st order upwind scheme estimate
273              CALL OBCS_U1_ADV_TRACER( .TRUE., trIdentity, bi, bj, k,
274         I                             maskW(1-OLx,1-OLy,k,bi,bj),
275         I                             uTrans, locABT,
276         U                             af, myThid )
277            ENDIF
278    #endif /* ALLOW_OBCS */
279            DO j=1-OLy,sNy+OLy
280             DO i=1-OLx,sNx+OLx
281            fZon(i,j) = fZon(i,j) + af(i,j)            fZon(i,j) = fZon(i,j) + af(i,j)
282           ENDDO           ENDDO
283          ENDDO          ENDDO
284  #ifdef ALLOW_DIAGNOSTICS  #ifdef ALLOW_DIAGNOSTICS
285          IF ( useDiagnostics ) THEN          IF ( useDiagnostics ) THEN
286            diagName = 'ADVx'//diagSufx            diagName = 'ADVx'//diagSufx
287            CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)            CALL DIAGNOSTICS_FILL( af, diagName, k,1, 2,bi,bj, myThid )
288          ENDIF          ENDIF
289  #endif  #endif
290        ENDIF        ENDIF
# Line 258  C-    Diffusive flux in X Line 293  C-    Diffusive flux in X
293        IF (diffKh.NE.0.) THEN        IF (diffKh.NE.0.) THEN
294         CALL GAD_DIFF_X(bi,bj,k,xA,diffKh,localT,df,myThid)         CALL GAD_DIFF_X(bi,bj,k,xA,diffKh,localT,df,myThid)
295        ELSE        ELSE
296         DO j=1-Oly,sNy+Oly         DO j=1-OLy,sNy+OLy
297          DO i=1-Olx,sNx+Olx          DO i=1-OLx,sNx+OLx
298           df(i,j) = 0. _d 0           df(i,j) = 0. _d 0
299          ENDDO          ENDDO
300         ENDDO         ENDDO
# Line 272  C-    Add bi-harmonic diffusive flux in Line 307  C-    Add bi-harmonic diffusive flux in
307    
308  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
309  C-    GM/Redi flux in X  C-    GM/Redi flux in X
310        IF (useGMRedi) THEN        IF ( trUseGMRedi ) THEN
311  C *note* should update GMREDI_XTRANSPORT to set df  *aja*          CALL GMREDI_XTRANSPORT(
312          IF ( applyAB_onTracer ) THEN       I         trIdentity, bi, bj, k, iMin, iMax, jMin, jMax,
313            CALL GMREDI_XTRANSPORT(       I         xA, TracerN,
      I         iMin,iMax,jMin,jMax,bi,bj,k,  
      I         xA,TracerN,tracerIdentity,  
      U         df,  
      I         myThid)  
         ELSE  
           CALL GMREDI_XTRANSPORT(  
      I         iMin,iMax,jMin,jMax,bi,bj,k,  
      I         xA,TracAB, tracerIdentity,  
314       U         df,       U         df,
315       I         myThid)       I         myThid )
         ENDIF  
316        ENDIF        ENDIF
317  #endif  #endif
318        DO j=1-Oly,sNy+Oly  C     anelastic: advect.fluxes are scaled by rhoFac but hor.diff. flx are not
319         DO i=1-Olx,sNx+Olx        DO j=1-OLy,sNy+OLy
320          fZon(i,j) = fZon(i,j) + df(i,j)         DO i=1-OLx,sNx+OLx
321            fZon(i,j) = fZon(i,j) + df(i,j)*rhoFacC(k)
322         ENDDO         ENDDO
323        ENDDO        ENDDO
324    
# Line 299  C *note* should update GMREDI_XTRANSPORT Line 326  C *note* should update GMREDI_XTRANSPORT
326  C-    Diagnostics of Tracer flux in X dir (mainly Diffusive term),  C-    Diagnostics of Tracer flux in X dir (mainly Diffusive term),
327  C       excluding advective terms:  C       excluding advective terms:
328        IF ( useDiagnostics .AND.        IF ( useDiagnostics .AND.
329       &    (diffKh.NE.0. .OR. diffK4 .NE.0. .OR. useGMRedi) ) THEN       &    (diffKh.NE.0. .OR. diffK4 .NE.0. .OR. trUseGMRedi) ) THEN
330            diagName = 'DFxE'//diagSufx            diagName = 'DFxE'//diagSufx
331            CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)            CALL DIAGNOSTICS_FILL( df, diagName, k,1, 2,bi,bj, myThid )
332    #ifdef ALLOW_LAYERS
333              IF ( useLayers ) THEN
334               CALL LAYERS_FILL_DFX( df, trIdentity, k, 1, 2,bi,bj, myThid )
335              ENDIF
336    #endif /* ALLOW_LAYERS */
337        ENDIF        ENDIF
338  #endif  #endif
339    
340  C--   Initialize net flux in Y direction  C--   Initialize net flux in Y direction
341        DO j=1-Oly,sNy+Oly        DO j=1-OLy,sNy+OLy
342         DO i=1-Olx,sNx+Olx         DO i=1-OLx,sNx+OLx
343          fMer(i,j) = 0. _d 0          fMer(i,j) = 0. _d 0
344         ENDDO         ENDDO
345        ENDDO        ENDDO
# Line 315  C--   Initialize net flux in Y direction Line 347  C--   Initialize net flux in Y direction
347  C-    Advective flux in Y  C-    Advective flux in Y
348        IF (calcAdvection) THEN        IF (calcAdvection) THEN
349          IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN          IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
350            CALL GAD_C2_ADV_Y(bi,bj,k,vTrans,locABT,af,myThid)             CALL GAD_C2_ADV_Y( bi,bj,k, vTrans, locABT, af, myThid )
351          ELSEIF ( advectionScheme.EQ.ENUM_UPWIND_1RST          ELSEIF ( advectionScheme.EQ.ENUM_UPWIND_1RST
352       &          .OR. advectionScheme.EQ.ENUM_DST2 ) THEN       &          .OR. advectionScheme.EQ.ENUM_DST2 ) THEN
353            CALL GAD_DST2U1_ADV_Y( bi,bj,k, advectionScheme,             CALL GAD_DST2U1_ADV_Y( bi,bj,k, advectionScheme, .TRUE.,
354       I            dTtracerLev(k), vTrans, vFld, locABT,       I              deltaTLev(k), vTrans, vFld, locABT,
355       O            af, myThid )       O              af, myThid )
356          ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN          ELSE
357            CALL GAD_FLUXLIMIT_ADV_Y( bi,bj,k, dTtracerLev(k),           DO j=1-OLy,sNy+OLy
358       I            vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,            DO i=1-OLx,sNx+OLx
359       O            af, myThid )  #ifdef ALLOW_OBCS
360          ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN             maskLocS(i,j) = _maskS(i,j,k,bi,bj)*maskInS(i,j,bi,bj)
361            CALL GAD_U3_ADV_Y(bi,bj,k,vTrans,locABT,af,myThid)  #else /* ALLOW_OBCS */
362          ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN             maskLocS(i,j) = _maskS(i,j,k,bi,bj)
363            CALL GAD_C4_ADV_Y(bi,bj,k,vTrans,locABT,af,myThid)  #endif /* ALLOW_OBCS */
364          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN            ENDDO
365            CALL GAD_DST3_ADV_Y( bi,bj,k, dTtracerLev(k),           ENDDO
366       I            vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,           IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
367       O            af, myThid )             CALL GAD_FLUXLIMIT_ADV_Y( bi,bj,k, .TRUE., deltaTLev(k),
368          ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN       I              vTrans, vFld, maskLocS, locABT,
369           IF ( inAdMode ) THEN       O              af, myThid )
370             ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
371               CALL GAD_U3_ADV_Y( bi,bj,k, vTrans, maskLocS, locABT,
372         O              af, myThid )
373             ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
374               CALL GAD_C4_ADV_Y( bi,bj,k, vTrans, maskLocS, locABT,
375         O              af, myThid )
376    #ifdef ALLOW_AUTODIFF
377             ELSEIF( advectionScheme.EQ.ENUM_DST3 .OR.
378         &          (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT .AND. inAdMode)
379         &         ) THEN
380  cph This block is to trick the adjoint:  cph This block is to trick the adjoint:
381  cph IF inAdExact=.FALSE., we want to use DST3  cph If inAdExact=.FALSE., we want to use DST3
382  cph with limiters in forward, but without limiters in reverse.  cph with limiters in forward, but without limiters in reverse.
383            CALL GAD_DST3_ADV_Y( bi,bj,k, dTtracerLev(k),  #else /* ALLOW_AUTODIFF */
384       I           vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,           ELSEIF( advectionScheme.EQ.ENUM_DST3 ) THEN
385       O           af, myThid )  #endif /* ALLOW_AUTODIFF */
386               CALL GAD_DST3_ADV_Y( bi,bj,k, .TRUE., deltaTLev(k),
387         I              vTrans, vFld, maskLocS, locABT,
388         O              af, myThid )
389             ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
390               CALL GAD_DST3FL_ADV_Y( bi,bj,k, .TRUE., deltaTLev(k),
391         I              vTrans, vFld, maskLocS, locABT,
392         O              af, myThid )
393    #ifndef ALLOW_AUTODIFF
394             ELSEIF (advectionScheme.EQ.ENUM_OS7MP ) THEN
395               CALL GAD_OS7MP_ADV_Y( bi,bj,k, .TRUE., deltaTLev(k),
396         I              vTrans, vFld, maskLocS, locABT,
397         O              af, myThid )
398    #endif
399           ELSE           ELSE
400            CALL GAD_DST3FL_ADV_Y( bi,bj,k, dTtracerLev(k),             STOP 'GAD_CALC_RHS: Bad advectionScheme (Y)'
      I           vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,  
      O           af, myThid )  
401           ENDIF           ENDIF
         ELSE  
           STOP 'GAD_CALC_RHS: Bad advectionScheme (Y)'  
402          ENDIF          ENDIF
403          DO j=1-Oly,sNy+Oly  #ifdef ALLOW_OBCS
404           DO i=1-Olx,sNx+Olx          IF ( useOBCS ) THEN
405    C-      replace advective flux with 1st order upwind scheme estimate
406              CALL OBCS_U1_ADV_TRACER( .FALSE., trIdentity, bi, bj, k,
407         I                             maskS(1-OLx,1-OLy,k,bi,bj),
408         I                             vTrans, locABT,
409         U                             af, myThid )
410            ENDIF
411    #endif /* ALLOW_OBCS */
412            DO j=1-OLy,sNy+OLy
413             DO i=1-OLx,sNx+OLx
414            fMer(i,j) = fMer(i,j) + af(i,j)            fMer(i,j) = fMer(i,j) + af(i,j)
415           ENDDO           ENDDO
416          ENDDO          ENDDO
417  #ifdef ALLOW_DIAGNOSTICS  #ifdef ALLOW_DIAGNOSTICS
418          IF ( useDiagnostics ) THEN          IF ( useDiagnostics ) THEN
419            diagName = 'ADVy'//diagSufx            diagName = 'ADVy'//diagSufx
420            CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)            CALL DIAGNOSTICS_FILL( af, diagName, k,1, 2,bi,bj, myThid )
421          ENDIF          ENDIF
422  #endif  #endif
423        ENDIF        ENDIF
# Line 366  C-    Diffusive flux in Y Line 426  C-    Diffusive flux in Y
426        IF (diffKh.NE.0.) THEN        IF (diffKh.NE.0.) THEN
427         CALL GAD_DIFF_Y(bi,bj,k,yA,diffKh,localT,df,myThid)         CALL GAD_DIFF_Y(bi,bj,k,yA,diffKh,localT,df,myThid)
428        ELSE        ELSE
429         DO j=1-Oly,sNy+Oly         DO j=1-OLy,sNy+OLy
430          DO i=1-Olx,sNx+Olx          DO i=1-OLx,sNx+OLx
431           df(i,j) = 0. _d 0           df(i,j) = 0. _d 0
432          ENDDO          ENDDO
433         ENDDO         ENDDO
# Line 380  C-    Add bi-harmonic flux in Y Line 440  C-    Add bi-harmonic flux in Y
440    
441  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
442  C-    GM/Redi flux in Y  C-    GM/Redi flux in Y
443        IF (useGMRedi) THEN        IF ( trUseGMRedi ) THEN
444  C *note* should update GMREDI_YTRANSPORT to set df  *aja*          CALL GMREDI_YTRANSPORT(
445          IF ( applyAB_onTracer ) THEN       I         trIdentity, bi, bj, k, iMin, iMax, jMin, jMax,
446            CALL GMREDI_YTRANSPORT(       I         yA, TracerN,
      I         iMin,iMax,jMin,jMax,bi,bj,k,  
      I         yA,TracerN,tracerIdentity,  
      U         df,  
      I         myThid)  
         ELSE  
           CALL GMREDI_YTRANSPORT(  
      I         iMin,iMax,jMin,jMax,bi,bj,k,  
      I         yA,TracAB, tracerIdentity,  
447       U         df,       U         df,
448       I         myThid)       I         myThid )
         ENDIF  
449        ENDIF        ENDIF
450  #endif  #endif
451        DO j=1-Oly,sNy+Oly  C     anelastic: advect.fluxes are scaled by rhoFac but hor.diff. flx are not
452         DO i=1-Olx,sNx+Olx        DO j=1-OLy,sNy+OLy
453          fMer(i,j) = fMer(i,j) + df(i,j)         DO i=1-OLx,sNx+OLx
454            fMer(i,j) = fMer(i,j) + df(i,j)*rhoFacC(k)
455         ENDDO         ENDDO
456        ENDDO        ENDDO
457    
# Line 407  C *note* should update GMREDI_YTRANSPORT Line 459  C *note* should update GMREDI_YTRANSPORT
459  C-    Diagnostics of Tracer flux in Y dir (mainly Diffusive terms),  C-    Diagnostics of Tracer flux in Y dir (mainly Diffusive terms),
460  C       excluding advective terms:  C       excluding advective terms:
461        IF ( useDiagnostics .AND.        IF ( useDiagnostics .AND.
462       &    (diffKh.NE.0. .OR. diffK4 .NE.0. .OR. useGMRedi) ) THEN       &    (diffKh.NE.0. .OR. diffK4 .NE.0. .OR. trUseGMRedi) ) THEN
463            diagName = 'DFyE'//diagSufx            diagName = 'DFyE'//diagSufx
464            CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)            CALL DIAGNOSTICS_FILL( df, diagName, k,1, 2,bi,bj, myThid )
465    #ifdef ALLOW_LAYERS
466              IF ( useLayers ) THEN
467               CALL LAYERS_FILL_DFY( df, trIdentity,k, 1, 2,bi,bj, myThid )
468              ENDIF
469    #endif /* ALLOW_LAYERS */
470        ENDIF        ENDIF
471  #endif  #endif
472    
# Line 418  C-    Advective flux in R Line 475  C-    Advective flux in R
475  #ifdef ALLOW_AIM  #ifdef ALLOW_AIM
476  C- a hack to prevent Water-Vapor vert.transport into the stratospheric level Nr  C- a hack to prevent Water-Vapor vert.transport into the stratospheric level Nr
477        IF (calcAdvection .AND. .NOT.implicitAdvection .AND. k.GE.2 .AND.        IF (calcAdvection .AND. .NOT.implicitAdvection .AND. k.GE.2 .AND.
478       &     (.NOT.useAIM .OR.tracerIdentity.NE.GAD_SALINITY .OR.k.LT.Nr)       &     (.NOT.useAIM .OR. trIdentity.NE.GAD_SALINITY .OR. k.LT.Nr)
479       &   ) THEN       &   ) THEN
480  #else  #else
481        IF (calcAdvection .AND. .NOT.implicitAdvection .AND. k.GE.2) THEN        IF (calcAdvection .AND. .NOT.implicitAdvection .AND. k.GE.2) THEN
482  #endif  #endif
483  C-    Compute vertical advective flux in the interior:         IF ( applyAB_onTracer ) THEN
484    C-    Compute vertical advective flux in the interior using TracAB:
485          IF (vertAdvecScheme.EQ.ENUM_CENTERED_2ND) THEN          IF (vertAdvecScheme.EQ.ENUM_CENTERED_2ND) THEN
486            CALL GAD_C2_ADV_R(bi,bj,k,rTrans,TracAB,af,myThid)             CALL GAD_C2_ADV_R( bi,bj,k, rTrans, TracAB, af, myThid )
487          ELSEIF ( vertAdvecScheme.EQ.ENUM_UPWIND_1RST          ELSEIF ( vertAdvecScheme.EQ.ENUM_UPWIND_1RST
488       &          .OR. vertAdvecScheme.EQ.ENUM_DST2 ) THEN       &          .OR. vertAdvecScheme.EQ.ENUM_DST2 ) THEN
489            CALL GAD_DST2U1_ADV_R( bi,bj,k, vertAdvecScheme,             CALL GAD_DST2U1_ADV_R( bi,bj,k,vertAdvecScheme,deltaTLev(k),
490       I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),       I              rTrans, wFld, TracAB,
491       O         af, myThid )       O              af, myThid )
492          ELSEIF (vertAdvecScheme.EQ.ENUM_FLUX_LIMIT) THEN          ELSEIF (vertAdvecScheme.EQ.ENUM_FLUX_LIMIT) THEN
493            CALL GAD_FLUXLIMIT_ADV_R( bi,bj,k,             CALL GAD_FLUXLIMIT_ADV_R( bi,bj,k, deltaTLev(k),
494       I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),       I              rTrans, wFld, TracAB,
495       O         af, myThid )       O              af, myThid )
496          ELSEIF (vertAdvecScheme.EQ.ENUM_UPWIND_3RD ) THEN          ELSEIF (vertAdvecScheme.EQ.ENUM_UPWIND_3RD ) THEN
497            CALL GAD_U3_ADV_R(bi,bj,k,rTrans,TracAB,af,myThid)             CALL GAD_U3_ADV_R( bi,bj,k, rTrans, TracAB, af, myThid )
498          ELSEIF (vertAdvecScheme.EQ.ENUM_CENTERED_4TH) THEN          ELSEIF (vertAdvecScheme.EQ.ENUM_CENTERED_4TH) THEN
499            CALL GAD_C4_ADV_R(bi,bj,k,rTrans,TracAB,af,myThid)             CALL GAD_C4_ADV_R( bi,bj,k, rTrans, TracAB, af, myThid )
500          ELSEIF (vertAdvecScheme.EQ.ENUM_DST3 ) THEN  #ifdef ALLOW_AUTODIFF
501            CALL GAD_DST3_ADV_R( bi,bj,k,          ELSEIF( vertAdvecScheme.EQ.ENUM_DST3 .OR.
502       I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),       &         (vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT .AND. inAdMode)
503       O         af, myThid )       &        ) THEN
504    cph This block is to trick the adjoint:
505    cph If inAdExact=.FALSE., we want to use DST3
506    cph with limiters in forward, but without limiters in reverse.
507    #else /* ALLOW_AUTODIFF */
508            ELSEIF( vertAdvecScheme.EQ.ENUM_DST3 ) THEN
509    #endif /* ALLOW_AUTODIFF */
510               CALL GAD_DST3_ADV_R( bi,bj,k, deltaTLev(k),
511         I              rTrans, wFld, TracAB,
512         O              af, myThid )
513          ELSEIF (vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN          ELSEIF (vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
514               CALL GAD_DST3FL_ADV_R( bi,bj,k, deltaTLev(k),
515         I              rTrans, wFld, TracAB,
516         O              af, myThid )
517    #ifndef ALLOW_AUTODIFF
518            ELSEIF (vertAdvecScheme.EQ.ENUM_OS7MP ) THEN
519               CALL GAD_OS7MP_ADV_R( bi,bj,k, deltaTLev(k),
520         I              rTrans, wFld, TracAB,
521         O              af, myThid )
522    #endif
523            ELSE
524              STOP 'GAD_CALC_RHS: Bad vertAdvecScheme (R)'
525            ENDIF
526           ELSE
527    C-    Compute vertical advective flux in the interior using TracerN:
528            IF (vertAdvecScheme.EQ.ENUM_CENTERED_2ND) THEN
529               CALL GAD_C2_ADV_R( bi,bj,k, rTrans, TracerN, af, myThid )
530            ELSEIF ( vertAdvecScheme.EQ.ENUM_UPWIND_1RST
531         &          .OR. vertAdvecScheme.EQ.ENUM_DST2 ) THEN
532               CALL GAD_DST2U1_ADV_R( bi,bj,k,vertAdvecScheme,deltaTLev(k),
533         I              rTrans, wFld, TracerN,
534         O              af, myThid )
535            ELSEIF (vertAdvecScheme.EQ.ENUM_FLUX_LIMIT) THEN
536               CALL GAD_FLUXLIMIT_ADV_R( bi,bj,k, deltaTLev(k),
537         I              rTrans, wFld, TracerN,
538         O              af, myThid )
539            ELSEIF (vertAdvecScheme.EQ.ENUM_UPWIND_3RD ) THEN
540               CALL GAD_U3_ADV_R( bi,bj,k, rTrans, TracerN, af, myThid )
541            ELSEIF (vertAdvecScheme.EQ.ENUM_CENTERED_4TH) THEN
542               CALL GAD_C4_ADV_R( bi,bj,k, rTrans, TracerN, af, myThid )
543    #ifdef ALLOW_AUTODIFF
544            ELSEIF( vertAdvecScheme.EQ.ENUM_DST3 .OR.
545         &         (vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT .AND. inAdMode)
546         &        ) THEN
547  cph This block is to trick the adjoint:  cph This block is to trick the adjoint:
548  cph IF inAdExact=.FALSE., we want to use DST3  cph If inAdExact=.FALSE., we want to use DST3
549  cph with limiters in forward, but without limiters in reverse.  cph with limiters in forward, but without limiters in reverse.
550            IF ( inAdMode ) THEN  #else /* ALLOW_AUTODIFF */
551             CALL GAD_DST3_ADV_R( bi,bj,k,          ELSEIF( vertAdvecScheme.EQ.ENUM_DST3 ) THEN
552       I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),  #endif /* ALLOW_AUTODIFF */
553       O         af, myThid )             CALL GAD_DST3_ADV_R( bi,bj,k, deltaTLev(k),
554            ELSE       I              rTrans, wFld, TracerN,
555             CALL GAD_DST3FL_ADV_R( bi,bj,k,       O              af, myThid )
556       I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),          ELSEIF (vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
557       O         af, myThid )             CALL GAD_DST3FL_ADV_R( bi,bj,k, deltaTLev(k),
558            ENDIF       I              rTrans, wFld, TracerN,
559         O              af, myThid )
560    #ifndef ALLOW_AUTODIFF
561            ELSEIF (vertAdvecScheme.EQ.ENUM_OS7MP ) THEN
562               CALL GAD_OS7MP_ADV_R( bi,bj,k, deltaTLev(k),
563         I              rTrans, wFld, TracerN,
564         O              af, myThid )
565    #endif
566          ELSE          ELSE
567            STOP 'GAD_CALC_RHS: Bad vertAdvecScheme (R)'            STOP 'GAD_CALC_RHS: Bad vertAdvecScheme (R)'
568          ENDIF          ENDIF
569           ENDIF
570  C-     add the advective flux to fVerT  C-     add the advective flux to fVerT
571          DO j=1-Oly,sNy+Oly         DO j=1-OLy,sNy+OLy
572           DO i=1-Olx,sNx+Olx          DO i=1-OLx,sNx+OLx
573            fVerT(i,j,kUp) = fVerT(i,j,kUp) + af(i,j)            fVerT(i,j,kUp) = fVerT(i,j,kUp) + af(i,j)*maskInC(i,j,bi,bj)
          ENDDO  
574          ENDDO          ENDDO
575           ENDDO
576  #ifdef ALLOW_DIAGNOSTICS  #ifdef ALLOW_DIAGNOSTICS
577          IF ( useDiagnostics ) THEN         IF ( useDiagnostics ) THEN
578            diagName = 'ADVr'//diagSufx            diagName = 'ADVr'//diagSufx
579            CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)            CALL DIAGNOSTICS_FILL( af, diagName, k,1, 2,bi,bj, myThid )
580  C- note: needs to explicitly increment the counter since DIAGNOSTICS_FILL  C- note: needs to explicitly increment the counter since DIAGNOSTICS_FILL
581  C        does it only if k=1 (never the case here)  C        does it only if k=1 (never the case here)
582            IF ( k.EQ.2 ) CALL DIAGNOSTICS_COUNT(diagName,bi,bj,myThid)            IF ( k.EQ.2 ) CALL DIAGNOSTICS_COUNT(diagName,bi,bj,myThid)
583          ENDIF         ENDIF
584  #endif  #endif
585        ENDIF        ENDIF
586    
# Line 480  C-    Diffusive flux in R Line 588  C-    Diffusive flux in R
588  C     Note: For K=1 then KM1=1 and this gives a dT/dr = 0 upper  C     Note: For K=1 then KM1=1 and this gives a dT/dr = 0 upper
589  C           boundary condition.  C           boundary condition.
590        IF (implicitDiffusion) THEN        IF (implicitDiffusion) THEN
591         DO j=1-Oly,sNy+Oly         DO j=1-OLy,sNy+OLy
592          DO i=1-Olx,sNx+Olx          DO i=1-OLx,sNx+OLx
593           df(i,j) = 0. _d 0           df(i,j) = 0. _d 0
594          ENDDO          ENDDO
595         ENDDO         ENDDO
596        ELSE        ELSE
597         IF ( applyAB_onTracer ) THEN          CALL GAD_DIFF_R(bi,bj,k,KappaR,TracerN,df,myThid)
598           CALL GAD_DIFF_R(bi,bj,k,KappaR,TracerN,df,myThid)        ENDIF
599         ELSE  
600           CALL GAD_DIFF_R(bi,bj,k,KappaR,TracAB, df,myThid)        IF ( trUseDiffKr4 ) THEN
601         ENDIF          CALL GAD_BIHARM_R( bi,bj,k, diffKr4, TracerN, df, myThid )
602        ENDIF        ENDIF
603    
604  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
605  C-    GM/Redi flux in R  C-    GM/Redi flux in R
606        IF (useGMRedi) THEN        IF ( trUseGMRedi ) THEN
607  C *note* should update GMREDI_RTRANSPORT to set df  *aja*          CALL GMREDI_RTRANSPORT(
608          IF ( applyAB_onTracer ) THEN       I         trIdentity, bi, bj, k, iMin, iMax, jMin, jMax,
609            CALL GMREDI_RTRANSPORT(       I         TracerN,
      I         iMin,iMax,jMin,jMax,bi,bj,k,  
      I         TracerN,tracerIdentity,  
610       U         df,       U         df,
611       I         myThid)       I         myThid )
         ELSE  
           CALL GMREDI_RTRANSPORT(  
      I         iMin,iMax,jMin,jMax,bi,bj,k,  
      I         TracAB, tracerIdentity,  
      U         df,  
      I         myThid)  
         ENDIF  
612        ENDIF        ENDIF
613  #endif  #endif
614    
615        DO j=1-Oly,sNy+Oly        DO j=1-OLy,sNy+OLy
616         DO i=1-Olx,sNx+Olx         DO i=1-OLx,sNx+OLx
617          fVerT(i,j,kUp) = fVerT(i,j,kUp) + df(i,j)*maskUp(i,j)          fVerT(i,j,kUp) = fVerT(i,j,kUp) + df(i,j)*maskUp(i,j)
618         ENDDO         ENDDO
619        ENDDO        ENDDO
# Line 523  C *note* should update GMREDI_RTRANSPORT Line 622  C *note* should update GMREDI_RTRANSPORT
622  C-    Diagnostics of Tracer flux in R dir (mainly Diffusive terms),  C-    Diagnostics of Tracer flux in R dir (mainly Diffusive terms),
623  C       Explicit terms only & excluding advective terms:  C       Explicit terms only & excluding advective terms:
624        IF ( useDiagnostics .AND.        IF ( useDiagnostics .AND.
625       &    (.NOT.implicitDiffusion .OR. useGMRedi) ) THEN       &    (.NOT.implicitDiffusion .OR. trUseGMRedi) ) THEN
626            diagName = 'DFrE'//diagSufx            diagName = 'DFrE'//diagSufx
627            CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)            CALL DIAGNOSTICS_FILL( df, diagName, k,1, 2,bi,bj, myThid )
628    #ifdef ALLOW_LAYERS
629              IF ( useLayers ) THEN
630               CALL LAYERS_FILL_DFR( df, trIdentity, k, 1, 2,bi,bj, myThid )
631              ENDIF
632    #endif /* ALLOW_LAYERS */
633        ENDIF        ENDIF
634  #endif  #endif
635    
636  #ifdef ALLOW_KPP  #ifdef ALLOW_KPP
637  C-    Set non local KPP transport term (ghat):  C-    Set non local KPP transport term (ghat):
638        IF ( useKPP .AND. k.GE.2 ) THEN        IF ( trUseKPP .AND. k.GE.2 ) THEN
639         DO j=1-Oly,sNy+Oly         DO j=1-OLy,sNy+OLy
640          DO i=1-Olx,sNx+Olx          DO i=1-OLx,sNx+OLx
641           df(i,j) = 0. _d 0           df(i,j) = 0. _d 0
642          ENDDO          ENDDO
643         ENDDO         ENDDO
644         IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN         IF (trIdentity.EQ.GAD_TEMPERATURE) THEN
645          CALL KPP_TRANSPORT_T(          CALL KPP_TRANSPORT_T(
646       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,       I           iMin,iMax,jMin,jMax,bi,bj,k,km1,
647       O     df )       O           df,
648         ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN       I           myTime, myIter, myThid )
649           ELSEIF (trIdentity.EQ.GAD_SALINITY) THEN
650          CALL KPP_TRANSPORT_S(          CALL KPP_TRANSPORT_S(
651       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,       I           iMin,iMax,jMin,jMax,bi,bj,k,km1,
652       O     df )       O           df,
653         I           myTime, myIter, myThid )
654  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
655         ELSEIF (tracerIdentity .GE. GAD_TR1) THEN         ELSEIF (trIdentity .GE. GAD_TR1) THEN
656          CALL KPP_TRANSPORT_PTR(          CALL KPP_TRANSPORT_PTR(
657       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,       I           iMin,iMax,jMin,jMax,bi,bj,k,km1,
658       I     tracerIdentity-GAD_TR1+1,       I           trIdentity-GAD_TR1+1,
659       O     df )       O           df,
660         I           myTime, myIter, myThid )
661  #endif  #endif
662         ELSE         ELSE
663          PRINT*,'invalid tracer indentity: ', tracerIdentity          WRITE(errorMessageUnit,*)
664          STOP 'GAD_CALC_RHS: Ooops'       &    'tracer identity =', trIdentity, ' is not valid => STOP'
665            STOP 'ABNORMAL END: S/R GAD_CALC_RHS: invalid tracer identity'
666         ENDIF         ENDIF
667         DO j=1-Oly,sNy+Oly         DO j=1-OLy,sNy+OLy
668          DO i=1-Olx,sNx+Olx          DO i=1-OLx,sNx+OLx
669           fVerT(i,j,kUp) = fVerT(i,j,kUp) + df(i,j)*maskUp(i,j)           fVerT(i,j,kUp) = fVerT(i,j,kUp)
670         &                  + df(i,j)*maskUp(i,j)*rhoFacF(k)
671            ENDDO
672           ENDDO
673    #ifdef ALLOW_DIAGNOSTICS
674    C-    Diagnostics of Non-Local Tracer (vertical) flux
675           IF ( useDiagnostics ) THEN
676             diagName = 'KPPg'//diagSufx
677             CALL DIAGNOSTICS_FILL( df, diagName, k,1, 2,bi,bj, myThid )
678    C- note: needs to explicitly increment the counter since DIAGNOSTICS_FILL
679    C        does it only if k=1 (never the case here)
680             IF ( k.EQ.2 ) CALL DIAGNOSTICS_COUNT(diagName,bi,bj,myThid)
681    #ifdef ALLOW_LAYERS
682             IF ( useLayers ) THEN
683              CALL LAYERS_FILL_DFR( df, trIdentity, k, 1, 2,bi,bj, myThid )
684             ENDIF
685    #endif /* ALLOW_LAYERS */
686           ENDIF
687    #endif
688          ENDIF
689    #endif /* ALLOW_KPP */
690    
691    #ifdef GAD_SMOLARKIEWICZ_HACK
692    coj   Hack to make redi (and everything else in this s/r) positive
693    coj   (see Smolarkiewicz MWR 1989 and Bott MWR 1989).
694    coj   Only works if 'down' is k+1 and k loop in thermodynamics is k=Nr,1,-1
695    coj
696    coj   Apply to all tracers except temperature
697          IF ( trIdentity.NE.GAD_TEMPERATURE .AND.
698         &     trIdentity.NE.GAD_SALINITY ) THEN
699           DO j=1-OLy,sNy+OLy-1
700            DO i=1-OLx,sNx+OLx-1
701    coj   Add outgoing fluxes
702             outFlux=deltaTLev(k)*
703         &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
704         &   *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)*recip_rhoFacC(k)
705         &    *( MAX(0. _d 0,fZon(i+1,j)) + MAX(0. _d 0,-fZon(i,j))
706         &      +MAX(0. _d 0,fMer(i,j+1)) + MAX(0. _d 0,-fMer(i,j))
707         &      +MAX(0. _d 0,fVerT(i,j,kDown)*rkSign)
708         &      +MAX(0. _d 0,-fVerT(i,j,kUp)*rkSign)
709         &     )
710             trac = localT(i,j)
711    coj   If they would reduce tracer by a fraction of more than
712    coj   SmolarkiewiczMaxFrac, scale them down
713             IF (outFlux.GT.0. _d 0 .AND.
714         &       outFlux.GT.SmolarkiewiczMaxFrac*trac) THEN
715    coj   If tracer is already negative, scale flux to zero
716               fac = MAX(0. _d 0,SmolarkiewiczMaxFrac*trac/outFlux)
717    
718               IF (fZon(i+1,j).GT.0. _d 0) fZon(i+1,j)=fac*fZon(i+1,j)
719               IF (-fZon(i,j) .GT.0. _d 0) fZon(i,j)  =fac*fZon(i,j)
720               IF (fMer(i,j+1).GT.0. _d 0) fMer(i,j+1)=fac*fMer(i,j+1)
721               IF (-fMer(i,j) .GT.0. _d 0) fMer(i,j)  =fac*fMer(i,j)
722               IF (-fVerT(i,j,kUp)*rkSign .GT.0. _d 0)
723         &       fVerT(i,j,kUp)=fac*fVerT(i,j,kUp)
724    
725               IF (k.LT.Nr .AND. fVerT(i,j,kDown)*rkSign.GT.0. _d 0) THEN
726    coj   Down flux is special: it has already been applied in lower layer,
727    coj   so we have to readjust this.
728    coj   Note: for k+1, gTracer is now the updated tracer, not the tendency!
729    coj   thus it has an extra factor deltaTLev(k+1)
730                 gTrFac=deltaTLev(k+1)
731    coj   Other factors that have been applied to gTracer since the last call:
732    #ifdef NONLIN_FRSURF
733                 IF (nonlinFreeSurf.GT.0) THEN
734                  IF (select_rStar.GT.0) THEN
735    #ifndef DISABLE_RSTAR_CODE
736                    gTrFac = gTrFac/rStarExpC(i,j,bi,bj)
737    #endif /* DISABLE_RSTAR_CODE */
738                  ENDIF
739                 ENDIF
740    #endif /* NONLIN_FRSURF */
741    coj   Now: undo down flux, ...
742                 gTracer(i,j,k+1) = gTracer(i,j,k+1)
743         &        +gTrFac
744         &         *_recip_hFacC(i,j,k+1,bi,bj)*recip_drF(k+1)
745         &         *recip_rA(i,j,bi,bj)*recip_deepFac2C(k+1)
746         &         *recip_rhoFacC(k+1)
747         &         *( -fVerT(i,j,kDown)*rkSign )
748    coj   ... scale ...
749                 fVerT(i,j,kDown)=fac*fVerT(i,j,kDown)
750    coj   ... and reapply
751                 gTracer(i,j,k+1) = gTracer(i,j,k+1)
752         &        +gTrFac
753         &         *_recip_hFacC(i,j,k+1,bi,bj)*recip_drF(k+1)
754         &         *recip_rA(i,j,bi,bj)*recip_deepFac2C(k+1)
755         &         *recip_rhoFacC(k+1)
756         &         *( fVerT(i,j,kDown)*rkSign )
757               ENDIF
758    
759             ENDIF
760          ENDDO          ENDDO
761         ENDDO         ENDDO
762        ENDIF        ENDIF
763  #endif  #endif
764    
765  C--   Divergence of fluxes  C--   Divergence of fluxes
766        DO j=1-Oly,sNy+Oly-1  C     Anelastic: scale vertical fluxes by rhoFac and leave Horizontal fluxes unchanged
767         DO i=1-Olx,sNx+Olx-1  C     for Stevens OBC: keep only vertical diffusive contribution on boundaries
768          gTracer(i,j,k,bi,bj)=gTracer(i,j,k,bi,bj)        DO j=1-OLy,sNy+OLy-1
769       &   -_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)*recip_rA(i,j,bi,bj)         DO i=1-OLx,sNx+OLx-1
770       &   *( (fZon(i+1,j)-fZon(i,j))          gTracer(i,j,k) = gTracer(i,j,k)
771       &     +(fMer(i,j+1)-fMer(i,j))       &   -_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
772         &   *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)*recip_rhoFacC(k)
773         &   *( (fZon(i+1,j)-fZon(i,j))*maskInC(i,j,bi,bj)
774         &     +(fMer(i,j+1)-fMer(i,j))*maskInC(i,j,bi,bj)
775       &     +(fVerT(i,j,kDown)-fVerT(i,j,kUp))*rkSign       &     +(fVerT(i,j,kDown)-fVerT(i,j,kUp))*rkSign
776       &     -localT(i,j)*( (uTrans(i+1,j)-uTrans(i,j))       &     -localT(i,j)*( (uTrans(i+1,j)-uTrans(i,j))*advFac
777       &                   +(vTrans(i,j+1)-vTrans(i,j))       &                   +(vTrans(i,j+1)-vTrans(i,j))*advFac
778       &                   +(rTransKp1(i,j)-rTrans(i,j))*rAdvFac       &                   +(rTransKp1(i,j)-rTrans(i,j))*rAdvFac
779       &                  )*advFac       &                  )*maskInC(i,j,bi,bj)
780       &    )       &    )
781         ENDDO         ENDDO
782        ENDDO        ENDDO
783    
784  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
785        IF ( debugLevel .GE. debLevB        IF ( debugLevel .GE. debLevC
786       &   .AND. tracerIdentity.EQ.GAD_TEMPERATURE       &   .AND. trIdentity.EQ.GAD_TEMPERATURE
787       &   .AND. k.EQ.2 .AND. myIter.EQ.1+nIter0       &   .AND. k.EQ.2 .AND. myIter.EQ.1+nIter0
788       &   .AND. nPx.EQ.1 .AND. nPy.EQ.1       &   .AND. nPx.EQ.1 .AND. nPy.EQ.1
789       &   .AND. useCubedSphereExchange ) THEN       &   .AND. useCubedSphereExchange ) THEN
Legend:
Removed from v.1.42  
changed lines
  Added in v.1.70
  ViewVC Help
Powered by ViewVC 1.1.22