/[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.12.6.1 by heimbach, Sun Mar 24 17:22:22 2002 UTC revision 1.54 by jmc, Fri Apr 2 19:29:01 2010 UTC
# Line 7  CBOP Line 7  CBOP
7  C !ROUTINE: GAD_CALC_RHS  C !ROUTINE: GAD_CALC_RHS
8    
9  C !INTERFACE: ==========================================================  C !INTERFACE: ==========================================================
10        SUBROUTINE GAD_CALC_RHS(        SUBROUTINE GAD_CALC_RHS(
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,uTrans,vTrans,rTrans,maskUp,       I           xA, yA, maskUp, uFld, vFld, wFld,
13       I           diffKh, diffK4, KappaRT, Tracer,       I           uTrans, vTrans, rTrans, rTransKp1,
14       I           tracerIdentity, advectionScheme,       I           diffKh, diffK4, KappaR, TracerN, TracAB,
15         I           deltaTLev, tracerIdentity,
16         I           advectionScheme, vertAdvecScheme,
17         I           calcAdvection, implicitAdvection, applyAB_onTracer,
18         I           trUseGMRedi, trUseKPP,
19       U           fVerT, gTracer,       U           fVerT, gTracer,
20       I           myThid )       I           myTime, myIter, myThid )
21    
22  C !DESCRIPTION:  C !DESCRIPTION:
23  C Calculates the tendancy of a tracer due to advection and diffusion.  C Calculates the tendency of a tracer due to advection and diffusion.
24  C It calculates the fluxes in each direction indepentently and then  C It calculates the fluxes in each direction indepentently and then
25  C sets the tendancy to the divergence of these fluxes. The advective  C sets the tendency to the divergence of these fluxes. The advective
26  C fluxes are only calculated here when using the linear advection schemes  C fluxes are only calculated here when using the linear advection schemes
27  C otherwise only the diffusive and parameterized fluxes are calculated.  C otherwise only the diffusive and parameterized fluxes are calculated.
28  C  C
# Line 27  C \begin{equation*} Line 31  C \begin{equation*}
31  C {\bf F} = {\bf F}_{adv} + {\bf F}_{diff} +{\bf F}_{GM} + {\bf F}_{KPP}  C {\bf F} = {\bf F}_{adv} + {\bf F}_{diff} +{\bf F}_{GM} + {\bf F}_{KPP}
32  C \end{equation*}  C \end{equation*}
33  C  C
34  C The tendancy is the divergence of the fluxes:  C The tendency is the divergence of the fluxes:
35  C \begin{equation*}  C \begin{equation*}
36  C G_\theta = G_\theta + \nabla \cdot {\bf F}  C G_\theta = G_\theta + \nabla \cdot {\bf F}
37  C \end{equation*}  C \end{equation*}
38  C  C
39  C The tendancy is assumed to contain data on entry.  C The tendency is assumed to contain data on entry.
40    
41  C !USES: ===============================================================  C !USES: ===============================================================
42        IMPLICIT NONE        IMPLICIT NONE
# Line 40  C !USES: =============================== Line 44  C !USES: ===============================
44  #include "EEPARAMS.h"  #include "EEPARAMS.h"
45  #include "PARAMS.h"  #include "PARAMS.h"
46  #include "GRID.h"  #include "GRID.h"
47  #include "DYNVARS.h"  #include "SURFACE.h"
48  #include "GAD.h"  #include "GAD.h"
49    
50  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
# Line 49  C !USES: =============================== Line 53  C !USES: ===============================
53  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
54    
55  C !INPUT PARAMETERS: ===================================================  C !INPUT PARAMETERS: ===================================================
56  C  bi,bj                :: tile indices  C bi,bj            :: tile indices
57  C  iMin,iMax,jMin,jMax  :: loop range for called routines  C iMin,iMax        :: loop range for called routines
58  C  kup                  :: index into 2 1/2D array, toggles between 1 and 2  C jMin,jMax        :: loop range for called routines
59  C  kdown                :: index into 2 1/2D array, toggles between 2 and 1  C k                :: vertical index
60  C  kp1                  :: =k+1 for k<Nr, =Nr for k=Nr  C kM1              :: =k-1 for k>1, =1 for k=1
61  C  xA,yA                :: areas of X and Y face of tracer cells  C kUp              :: index into 2 1/2D array, toggles between 1|2
62  C  uTrans,vTrans,rTrans :: 2-D arrays of volume transports at U,V and W points  C kDown            :: index into 2 1/2D array, toggles between 2|1
63  C  maskUp               :: 2-D array for mask at W points  C xA,yA            :: areas of X and Y face of tracer cells
64  C  diffKh               :: horizontal diffusion coefficient  C maskUp           :: 2-D array for mask at W points
65  C  diffK4               :: bi-harmonic diffusion coefficient  C uFld,vFld,wFld   :: Local copy of velocity field (3 components)
66  C  KappaRT              :: 3-D array for vertical diffusion coefficient  C uTrans,vTrans    :: 2-D arrays of volume transports at U,V points
67  C  Tracer               :: tracer field  C rTrans           :: 2-D arrays of volume transports at W points
68  C  tracerIdentity       :: identifier for the tracer (required only for KPP)  C rTransKp1        :: 2-D array of volume trans at W pts, interf k+1
69  C  advectionScheme      :: advection scheme to use  C diffKh           :: horizontal diffusion coefficient
70  C  myThid               :: thread number  C diffK4           :: bi-harmonic diffusion coefficient
71    C KappaR           :: 2-D array for vertical diffusion coefficient, interf k
72    C TracerN          :: tracer field @ time-step n (Note: only used
73    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
75    C                     or extrapolated fwd in time to n+1/2 if applying AB on Tr)
76    C tracerIdentity   :: tracer identifier (required for KPP,GM)
77    C advectionScheme  :: advection scheme to use (Horizontal plane)
78    C vertAdvecScheme  :: advection scheme to use (Vertical direction)
79    C calcAdvection    :: =False if Advec computed with multiDim scheme
80    C implicitAdvection:: =True if vertical Advec computed implicitly
81    C applyAB_onTracer :: apply Adams-Bashforth on Tracer (rather than on gTr)
82    C trUseGMRedi      :: true if this tracer uses GM-Redi
83    C trUseKPP         :: true if this tracer uses KPP
84    C myTime           :: current time
85    C myIter           :: iteration number
86    C myThid           :: thread number
87        INTEGER bi,bj,iMin,iMax,jMin,jMax        INTEGER bi,bj,iMin,iMax,jMin,jMax
88        INTEGER k,kUp,kDown,kM1        INTEGER k,kUp,kDown,kM1
89        _RS xA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS xA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
90        _RS yA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS yA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
91          _RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
92          _RL uFld  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
93          _RL vFld  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
94          _RL wFld  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
95        _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
96        _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
97        _RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
98        _RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
99        _RL diffKh, diffK4        _RL diffKh, diffK4
100        _RL KappaRT(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaR(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
101        _RL Tracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)        _RL TracerN(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
102          _RL TracAB (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
103          _RL deltaTLev(Nr)
104        INTEGER tracerIdentity        INTEGER tracerIdentity
105        INTEGER advectionScheme        INTEGER advectionScheme, vertAdvecScheme
106        INTEGER myThid        LOGICAL calcAdvection
107          LOGICAL implicitAdvection, applyAB_onTracer
108          LOGICAL trUseGMRedi, trUseKPP
109          _RL     myTime
110          INTEGER myIter, myThid
111    
112  C !OUTPUT PARAMETERS: ==================================================  C !OUTPUT PARAMETERS: ==================================================
113  C  gTracer              :: tendancy array  C gTracer          :: tendency array
114  C  fVerT                :: 2 1/2D arrays for vertical advective flux  C fVerT            :: 2 1/2D arrays for vertical advective flux
115        _RL gTracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)        _RL gTracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
116        _RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
117    
118  C !LOCAL VARIABLES: ====================================================  C !LOCAL VARIABLES: ====================================================
119  C  i,j                  :: loop indices  C i,j              :: loop indices
120  C  df4                  :: used for storing del^2 T for bi-harmonic term  C df4              :: used for storing del^2 T for bi-harmonic term
121  C  fZon                 :: zonal flux  C fZon             :: zonal flux
122  C  fmer                 :: meridional flux  C fMer             :: meridional flux
123  C  af                   :: advective flux  C af               :: advective flux
124  C  df                   :: diffusive flux  C df               :: diffusive flux
125  C  localT               :: local copy of tracer field  C localT           :: local copy of tracer field
126    C locABT           :: local copy of (AB-extrapolated) tracer field
127    #ifdef ALLOW_DIAGNOSTICS
128          CHARACTER*8 diagName
129          CHARACTER*4 GAD_DIAG_SUFX, diagSufx
130          EXTERNAL    GAD_DIAG_SUFX
131    #endif
132        INTEGER i,j        INTEGER i,j
133        _RL df4   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL df4   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
134        _RL fZon  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL fZon  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
# Line 100  C  localT               :: local copy of Line 136  C  localT               :: local copy of
136        _RL af    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL af    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
137        _RL df    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL df    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
138        _RL localT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL localT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
139          _RL locABT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
140          _RL advFac, rAdvFac
141    #ifdef GAD_SMOLARKIEWICZ_HACK
142          _RL outFlux, trac, fac, gTrFac
143    #endif
144  CEOP  CEOP
145    
146  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
# Line 108  C--   the kDown is still required Line 149  C--   the kDown is still required
149        fVerT(1,1,kDown) = fVerT(1,1,kDown)        fVerT(1,1,kDown) = fVerT(1,1,kDown)
150  #endif  #endif
151    
152    #ifdef ALLOW_DIAGNOSTICS
153    C--   Set diagnostic suffix for the current tracer
154          IF ( useDiagnostics ) THEN
155            diagSufx = GAD_DIAG_SUFX( tracerIdentity, myThid )
156          ENDIF
157    #endif
158    
159          advFac  = 0. _d 0
160          IF (calcAdvection) advFac = 1. _d 0
161          rAdvFac = rkSign*advFac
162          IF (implicitAdvection) rAdvFac = 0. _d 0
163    
164        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
165         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
166          fZon(i,j)      = 0. _d 0          fZon(i,j)      = 0. _d 0
# Line 115  C--   the kDown is still required Line 168  C--   the kDown is still required
168          fVerT(i,j,kUp) = 0. _d 0          fVerT(i,j,kUp) = 0. _d 0
169          df(i,j)        = 0. _d 0          df(i,j)        = 0. _d 0
170          df4(i,j)       = 0. _d 0          df4(i,j)       = 0. _d 0
         localT(i,j)    = 0. _d 0  
171         ENDDO         ENDDO
172        ENDDO        ENDDO
173    
174  C--   Make local copy of tracer array  C--   Make local copy of tracer array
175        DO j=1-OLy,sNy+OLy        IF ( applyAB_onTracer ) THEN
176         DO i=1-OLx,sNx+OLx          DO j=1-OLy,sNy+OLy
177          localT(i,j)=tracer(i,j,k,bi,bj)           DO i=1-OLx,sNx+OLx
178         ENDDO            localT(i,j)=TracerN(i,j,k,bi,bj)
179        ENDDO            locABT(i,j)= TracAB(i,j,k,bi,bj)
180             ENDDO
181            ENDDO
182          ELSE
183            DO j=1-OLy,sNy+OLy
184             DO i=1-OLx,sNx+OLx
185              localT(i,j)= TracAB(i,j,k,bi,bj)
186              locABT(i,j)= TracAB(i,j,k,bi,bj)
187             ENDDO
188            ENDDO
189          ENDIF
190    
191  C--   Unless we have already calculated the advection terms we initialize  C--   Unless we have already calculated the advection terms we initialize
192  C     the tendency to zero.  C     the tendency to zero.
193        IF (.NOT. multiDimAdvection .OR.  C     <== now done earlier at the beginning of thermodynamics.
194       &    advectionScheme.EQ.ENUM_CENTERED_2ND .OR.  c     IF (calcAdvection) THEN
195       &    advectionScheme.EQ.ENUM_UPWIND_3RD .OR.  c      DO j=1-Oly,sNy+Oly
196       &    advectionScheme.EQ.ENUM_CENTERED_4TH ) THEN  c       DO i=1-Olx,sNx+Olx
197         DO j=1-Oly,sNy+Oly  c        gTracer(i,j,k,bi,bj)=0. _d 0
198          DO i=1-Olx,sNx+Olx  c       ENDDO
199           gTracer(i,j,k,bi,bj)=0. _d 0  c      ENDDO
200          ENDDO  c     ENDIF
        ENDDO  
       ENDIF  
201    
202  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
203        IF (diffK4 .NE. 0.) THEN        IF (diffK4 .NE. 0.) THEN
# Line 154  C--   Initialize net flux in X direction Line 214  C--   Initialize net flux in X direction
214        ENDDO        ENDDO
215    
216  C-    Advective flux in X  C-    Advective flux in X
217        IF (.NOT. multiDimAdvection .OR.        IF (calcAdvection) THEN
218       &    advectionScheme.EQ.ENUM_CENTERED_2ND .OR.          IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
219       &    advectionScheme.EQ.ENUM_UPWIND_3RD .OR.            CALL GAD_C2_ADV_X(bi,bj,k,uTrans,locABT,af,myThid)
220       &    advectionScheme.EQ.ENUM_CENTERED_4TH ) THEN          ELSEIF ( advectionScheme.EQ.ENUM_UPWIND_1RST
221        IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN       &          .OR. advectionScheme.EQ.ENUM_DST2 ) THEN
222         CALL GAD_C2_ADV_X(bi,bj,k,uTrans,localT,af,myThid)            CALL GAD_DST2U1_ADV_X( bi,bj,k, advectionScheme, .TRUE.,
223        ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN       I            deltaTLev(k), uTrans, uFld, locABT,
224         CALL GAD_FLUXLIMIT_ADV_X(       O            af, myThid )
225       &      bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
226        ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN            CALL GAD_FLUXLIMIT_ADV_X( bi,bj,k, .TRUE., deltaTLev(k),
227         CALL GAD_U3_ADV_X(bi,bj,k,uTrans,localT,af,myThid)       I            uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,
228        ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN       O            af, myThid )
229         CALL GAD_C4_ADV_X(bi,bj,k,uTrans,localT,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
230        ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN            CALL GAD_U3_ADV_X(bi,bj,k,uTrans,locABT,af,myThid)
231         CALL GAD_DST3_ADV_X(          ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
232       &       bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)            CALL GAD_C4_ADV_X(bi,bj,k,uTrans,locABT,af,myThid)
233        ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
234         CALL GAD_DST3FL_ADV_X(            CALL GAD_DST3_ADV_X( bi,bj,k, .TRUE., deltaTLev(k),
235       &       bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)       I            uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,
236        ELSE       O            af, myThid )
237         STOP 'GAD_CALC_RHS: Bad advectionScheme (X)'          ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
238        ENDIF           IF ( inAdMode ) THEN
239        DO j=1-Oly,sNy+Oly  cph This block is to trick the adjoint:
240         DO i=1-Olx,sNx+Olx  cph IF inAdExact=.FALSE., we want to use DST3
241          fZon(i,j) = fZon(i,j) + af(i,j)  cph with limiters in forward, but without limiters in reverse.
242         ENDDO            CALL GAD_DST3_ADV_X( bi,bj,k, .TRUE., deltaTLev(k),
243        ENDDO       I           uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,
244         O           af, myThid )
245             ELSE
246              CALL GAD_DST3FL_ADV_X( bi,bj,k, .TRUE., deltaTLev(k),
247         I           uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,
248         O           af, myThid )
249             ENDIF
250            ELSEIF (advectionScheme.EQ.ENUM_OS7MP ) THEN
251              CALL GAD_OS7MP_ADV_X( bi,bj,k, .TRUE., deltaTLev(k),
252         I            uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,
253         O            af, myThid )
254            ELSE
255             STOP 'GAD_CALC_RHS: Bad advectionScheme (X)'
256            ENDIF
257            DO j=1-Oly,sNy+Oly
258             DO i=1-Olx,sNx+Olx
259              fZon(i,j) = fZon(i,j) + af(i,j)
260             ENDDO
261            ENDDO
262    #ifdef ALLOW_DIAGNOSTICS
263            IF ( useDiagnostics ) THEN
264              diagName = 'ADVx'//diagSufx
265              CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)
266            ENDIF
267    #endif
268        ENDIF        ENDIF
269    
270  C-    Diffusive flux in X  C-    Diffusive flux in X
# Line 194  C-    Diffusive flux in X Line 278  C-    Diffusive flux in X
278         ENDDO         ENDDO
279        ENDIF        ENDIF
280    
281    C-    Add bi-harmonic diffusive flux in X
282          IF (diffK4 .NE. 0.) THEN
283           CALL GAD_BIHARM_X(bi,bj,k,xA,df4,diffK4,df,myThid)
284          ENDIF
285    
286  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
287  C-    GM/Redi flux in X  C-    GM/Redi flux in X
288        IF (useGMRedi) THEN        IF ( trUseGMRedi ) THEN
289  C *note* should update GMREDI_XTRANSPORT to use localT and set df  *aja*  C *note* should update GMREDI_XTRANSPORT to set df  *aja*
290          CALL GMREDI_XTRANSPORT(          IF ( applyAB_onTracer ) THEN
291       I     iMin,iMax,jMin,jMax,bi,bj,K,            CALL GMREDI_XTRANSPORT(
292       I     xA,Tracer,       I         iMin,iMax,jMin,jMax,bi,bj,k,
293       U     df,       I         xA,TracerN,tracerIdentity,
294       I     myThid)       U         df,
295         I         myThid)
296            ELSE
297              CALL GMREDI_XTRANSPORT(
298         I         iMin,iMax,jMin,jMax,bi,bj,k,
299         I         xA,TracAB, tracerIdentity,
300         U         df,
301         I         myThid)
302            ENDIF
303        ENDIF        ENDIF
304  #endif  #endif
305    C     anelastic: advect.fluxes are scaled by rhoFac but hor.diff. flx are not
306        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
307         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx
308          fZon(i,j) = fZon(i,j) + df(i,j)          fZon(i,j) = fZon(i,j) + df(i,j)*rhoFacC(k)
309         ENDDO         ENDDO
310        ENDDO        ENDDO
311    
312  C-    Bi-harmonic duffusive flux in X  #ifdef ALLOW_DIAGNOSTICS
313        IF (diffK4 .NE. 0.) THEN  C-    Diagnostics of Tracer flux in X dir (mainly Diffusive term),
314         CALL GAD_BIHARM_X(bi,bj,k,xA,df4,diffK4,df,myThid)  C       excluding advective terms:
315         DO j=1-Oly,sNy+Oly        IF ( useDiagnostics .AND.
316          DO i=1-Olx,sNx+Olx       &    (diffKh.NE.0. .OR. diffK4 .NE.0. .OR. trUseGMRedi) ) THEN
317           fZon(i,j) = fZon(i,j) + df(i,j)            diagName = 'DFxE'//diagSufx
318          ENDDO            CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)
        ENDDO  
319        ENDIF        ENDIF
320    #endif
321    
322  C--   Initialize net flux in Y direction  C--   Initialize net flux in Y direction
323        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
# Line 229  C--   Initialize net flux in Y direction Line 327  C--   Initialize net flux in Y direction
327        ENDDO        ENDDO
328    
329  C-    Advective flux in Y  C-    Advective flux in Y
330        IF (.NOT. multiDimAdvection .OR.        IF (calcAdvection) THEN
331       &    advectionScheme.EQ.ENUM_CENTERED_2ND .OR.          IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
332       &    advectionScheme.EQ.ENUM_UPWIND_3RD .OR.            CALL GAD_C2_ADV_Y(bi,bj,k,vTrans,locABT,af,myThid)
333       &    advectionScheme.EQ.ENUM_CENTERED_4TH ) THEN          ELSEIF ( advectionScheme.EQ.ENUM_UPWIND_1RST
334        IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN       &          .OR. advectionScheme.EQ.ENUM_DST2 ) THEN
335         CALL GAD_C2_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)            CALL GAD_DST2U1_ADV_Y( bi,bj,k, advectionScheme, .TRUE.,
336        ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN       I            deltaTLev(k), vTrans, vFld, locABT,
337         CALL GAD_FLUXLIMIT_ADV_Y(       O            af, myThid )
338       &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
339        ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN            CALL GAD_FLUXLIMIT_ADV_Y( bi,bj,k, .TRUE., deltaTLev(k),
340         CALL GAD_U3_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)       I            vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,
341        ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN       O            af, myThid )
342         CALL GAD_C4_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
343        ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN            CALL GAD_U3_ADV_Y(bi,bj,k,vTrans,locABT,af,myThid)
344         CALL GAD_DST3_ADV_Y(          ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
345       &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)            CALL GAD_C4_ADV_Y(bi,bj,k,vTrans,locABT,af,myThid)
346        ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
347         CALL GAD_DST3FL_ADV_Y(            CALL GAD_DST3_ADV_Y( bi,bj,k, .TRUE., deltaTLev(k),
348       &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)       I            vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,
349        ELSE       O            af, myThid )
350         STOP 'GAD_CALC_RHS: Bad advectionScheme (Y)'          ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
351        ENDIF           IF ( inAdMode ) THEN
352        DO j=1-Oly,sNy+Oly  cph This block is to trick the adjoint:
353         DO i=1-Olx,sNx+Olx  cph IF inAdExact=.FALSE., we want to use DST3
354          fMer(i,j) = fMer(i,j) + af(i,j)  cph with limiters in forward, but without limiters in reverse.
355         ENDDO            CALL GAD_DST3_ADV_Y( bi,bj,k, .TRUE., deltaTLev(k),
356        ENDDO       I           vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,
357         O           af, myThid )
358             ELSE
359              CALL GAD_DST3FL_ADV_Y( bi,bj,k, .TRUE., deltaTLev(k),
360         I           vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,
361         O           af, myThid )
362             ENDIF
363            ELSEIF (advectionScheme.EQ.ENUM_OS7MP ) THEN
364              CALL GAD_OS7MP_ADV_Y( bi,bj,k, .TRUE., deltaTLev(k),
365         I            vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,
366         O            af, myThid )
367            ELSE
368              STOP 'GAD_CALC_RHS: Bad advectionScheme (Y)'
369            ENDIF
370            DO j=1-Oly,sNy+Oly
371             DO i=1-Olx,sNx+Olx
372              fMer(i,j) = fMer(i,j) + af(i,j)
373             ENDDO
374            ENDDO
375    #ifdef ALLOW_DIAGNOSTICS
376            IF ( useDiagnostics ) THEN
377              diagName = 'ADVy'//diagSufx
378              CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)
379            ENDIF
380    #endif
381        ENDIF        ENDIF
382    
383  C-    Diffusive flux in Y  C-    Diffusive flux in Y
# Line 269  C-    Diffusive flux in Y Line 391  C-    Diffusive flux in Y
391         ENDDO         ENDDO
392        ENDIF        ENDIF
393    
394    C-    Add bi-harmonic flux in Y
395          IF (diffK4 .NE. 0.) THEN
396           CALL GAD_BIHARM_Y(bi,bj,k,yA,df4,diffK4,df,myThid)
397          ENDIF
398    
399  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
400  C-    GM/Redi flux in Y  C-    GM/Redi flux in Y
401        IF (useGMRedi) THEN        IF ( trUseGMRedi ) THEN
402  C *note* should update GMREDI_YTRANSPORT to use localT and set df  *aja*  C *note* should update GMREDI_YTRANSPORT to set df  *aja*
403         CALL GMREDI_YTRANSPORT(          IF ( applyAB_onTracer ) THEN
404       I     iMin,iMax,jMin,jMax,bi,bj,K,            CALL GMREDI_YTRANSPORT(
405       I     yA,Tracer,       I         iMin,iMax,jMin,jMax,bi,bj,k,
406       U     df,       I         yA,TracerN,tracerIdentity,
407       I     myThid)       U         df,
408         I         myThid)
409            ELSE
410              CALL GMREDI_YTRANSPORT(
411         I         iMin,iMax,jMin,jMax,bi,bj,k,
412         I         yA,TracAB, tracerIdentity,
413         U         df,
414         I         myThid)
415            ENDIF
416        ENDIF        ENDIF
417  #endif  #endif
418    C     anelastic: advect.fluxes are scaled by rhoFac but hor.diff. flx are not
419        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
420         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx
421          fMer(i,j) = fMer(i,j) + df(i,j)          fMer(i,j) = fMer(i,j) + df(i,j)*rhoFacC(k)
422         ENDDO         ENDDO
423        ENDDO        ENDDO
424    
425  C-    Bi-harmonic flux in Y  #ifdef ALLOW_DIAGNOSTICS
426        IF (diffK4 .NE. 0.) THEN  C-    Diagnostics of Tracer flux in Y dir (mainly Diffusive terms),
427         CALL GAD_BIHARM_Y(bi,bj,k,yA,df4,diffK4,df,myThid)  C       excluding advective terms:
428         DO j=1-Oly,sNy+Oly        IF ( useDiagnostics .AND.
429          DO i=1-Olx,sNx+Olx       &    (diffKh.NE.0. .OR. diffK4 .NE.0. .OR. trUseGMRedi) ) THEN
430           fMer(i,j) = fMer(i,j) + df(i,j)            diagName = 'DFyE'//diagSufx
431          ENDDO            CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)
        ENDDO  
432        ENDIF        ENDIF
433    #endif
434    
435    C--   Compute vertical flux fVerT(kUp) at interface k (between k-1 & k):
436  C-    Advective flux in R  C-    Advective flux in R
437        IF (.NOT. multiDimAdvection .OR.  #ifdef ALLOW_AIM
438       &    advectionScheme.EQ.ENUM_CENTERED_2ND .OR.  C- a hack to prevent Water-Vapor vert.transport into the stratospheric level Nr
439       &    advectionScheme.EQ.ENUM_UPWIND_3RD .OR.        IF (calcAdvection .AND. .NOT.implicitAdvection .AND. k.GE.2 .AND.
440       &    advectionScheme.EQ.ENUM_CENTERED_4TH ) THEN       &     (.NOT.useAIM .OR.tracerIdentity.NE.GAD_SALINITY .OR.k.LT.Nr)
441  C     Note: wVel needs to be masked       &   ) THEN
442        IF (K.GE.2) THEN  #else
443          IF (calcAdvection .AND. .NOT.implicitAdvection .AND. k.GE.2) THEN
444    #endif
445  C-    Compute vertical advective flux in the interior:  C-    Compute vertical advective flux in the interior:
446         IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN          IF (vertAdvecScheme.EQ.ENUM_CENTERED_2ND) THEN
447          CALL GAD_C2_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)            CALL GAD_C2_ADV_R(bi,bj,k,rTrans,TracAB,af,myThid)
448         ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN          ELSEIF ( vertAdvecScheme.EQ.ENUM_UPWIND_1RST
449          CALL GAD_FLUXLIMIT_ADV_R(       &          .OR. vertAdvecScheme.EQ.ENUM_DST2 ) THEN
450       &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)            CALL GAD_DST2U1_ADV_R( bi,bj,k, vertAdvecScheme,
451         ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN       I         deltaTLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
452          CALL GAD_U3_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)       O         af, myThid )
453         ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN          ELSEIF (vertAdvecScheme.EQ.ENUM_FLUX_LIMIT) THEN
454          CALL GAD_C4_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)            CALL GAD_FLUXLIMIT_ADV_R( bi,bj,k,
455         ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN       I         deltaTLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
456          CALL GAD_DST3_ADV_R(       O         af, myThid )
457       &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)          ELSEIF (vertAdvecScheme.EQ.ENUM_UPWIND_3RD ) THEN
458         ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN            CALL GAD_U3_ADV_R(bi,bj,k,rTrans,TracAB,af,myThid)
459          CALL GAD_DST3FL_ADV_R(          ELSEIF (vertAdvecScheme.EQ.ENUM_CENTERED_4TH) THEN
460       &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)            CALL GAD_C4_ADV_R(bi,bj,k,rTrans,TracAB,af,myThid)
461         ELSE          ELSEIF (vertAdvecScheme.EQ.ENUM_DST3 ) THEN
462          STOP 'GAD_CALC_RHS: Bad advectionScheme (R)'            CALL GAD_DST3_ADV_R( bi,bj,k,
463         ENDIF       I         deltaTLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
464  C-    Surface "correction" term at k>1 :       O         af, myThid )
465         DO j=1-Oly,sNy+Oly          ELSEIF (vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
466          DO i=1-Olx,sNx+Olx  cph This block is to trick the adjoint:
467           af(i,j) = af(i,j)  cph IF inAdExact=.FALSE., we want to use DST3
468       &           + (maskC(i,j,k,bi,bj)-maskC(i,j,k-1,bi,bj))*  cph with limiters in forward, but without limiters in reverse.
469       &             rTrans(i,j)*Tracer(i,j,k,bi,bj)            IF ( inAdMode ) THEN
470               CALL GAD_DST3_ADV_R( bi,bj,k,
471         I         deltaTLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
472         O         af, myThid )
473              ELSE
474               CALL GAD_DST3FL_ADV_R( bi,bj,k,
475         I         deltaTLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
476         O         af, myThid )
477              ENDIF
478            ELSEIF (vertAdvecScheme.EQ.ENUM_OS7MP ) THEN
479               CALL GAD_OS7MP_ADV_R( bi,bj,k,
480         I         deltaTLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
481         O         af, myThid )
482            ELSE
483              STOP 'GAD_CALC_RHS: Bad vertAdvecScheme (R)'
484            ENDIF
485    C-     add the advective flux to fVerT
486            DO j=1-Oly,sNy+Oly
487             DO i=1-Olx,sNx+Olx
488              fVerT(i,j,kUp) = fVerT(i,j,kUp) + af(i,j)
489             ENDDO
490          ENDDO          ENDDO
491         ENDDO  #ifdef ALLOW_DIAGNOSTICS
492        ELSE          IF ( useDiagnostics ) THEN
493  C-    Surface "correction" term at k=1 :            diagName = 'ADVr'//diagSufx
494         DO j=1-Oly,sNy+Oly            CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)
495          DO i=1-Olx,sNx+Olx  C- note: needs to explicitly increment the counter since DIAGNOSTICS_FILL
496           af(i,j) = rTrans(i,j)*Tracer(i,j,k,bi,bj)  C        does it only if k=1 (never the case here)
497          ENDDO            IF ( k.EQ.2 ) CALL DIAGNOSTICS_COUNT(diagName,bi,bj,myThid)
498         ENDDO          ENDIF
499        ENDIF  #endif
 C-    add the advective flux to fVerT  
       DO j=1-Oly,sNy+Oly  
        DO i=1-Olx,sNx+Olx  
         fVerT(i,j,kUp) = fVerT(i,j,kUp) + af(i,j)  
        ENDDO  
       ENDDO  
500        ENDIF        ENDIF
501    
502  C-    Diffusive flux in R  C-    Diffusive flux in R
# Line 356  C           boundary condition. Line 509  C           boundary condition.
509          ENDDO          ENDDO
510         ENDDO         ENDDO
511        ELSE        ELSE
512         CALL GAD_DIFF_R(bi,bj,k,KappaRT,tracer,df,myThid)         IF ( applyAB_onTracer ) THEN
513             CALL GAD_DIFF_R(bi,bj,k,KappaR,TracerN,df,myThid)
514           ELSE
515             CALL GAD_DIFF_R(bi,bj,k,KappaR,TracAB, df,myThid)
516           ENDIF
517        ENDIF        ENDIF
 c     DO j=1-Oly,sNy+Oly  
 c      DO i=1-Olx,sNx+Olx  
 c       fVerT(i,j,kUp) = fVerT(i,j,kUp) + df(i,j)*maskUp(i,j)  
 c      ENDDO  
 c     ENDDO  
518    
519  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
520  C-    GM/Redi flux in R  C-    GM/Redi flux in R
521        IF (useGMRedi) THEN        IF ( trUseGMRedi ) THEN
522  C *note* should update GMREDI_RTRANSPORT to set df  *aja*  C *note* should update GMREDI_RTRANSPORT to set df  *aja*
523         CALL GMREDI_RTRANSPORT(          IF ( applyAB_onTracer ) THEN
524       I     iMin,iMax,jMin,jMax,bi,bj,K,            CALL GMREDI_RTRANSPORT(
525       I     Tracer,       I         iMin,iMax,jMin,jMax,bi,bj,k,
526       U     df,       I         TracerN,tracerIdentity,
527       I     myThid)       U         df,
528  c      DO j=1-Oly,sNy+Oly       I         myThid)
529  c       DO i=1-Olx,sNx+Olx          ELSE
530  c        fVerT(i,j,kUp) = fVerT(i,j,kUp) + df(i,j)*maskUp(i,j)            CALL GMREDI_RTRANSPORT(
531  c       ENDDO       I         iMin,iMax,jMin,jMax,bi,bj,k,
532  c      ENDDO       I         TracAB, tracerIdentity,
533         U         df,
534         I         myThid)
535            ENDIF
536        ENDIF        ENDIF
537  #endif  #endif
538    
# Line 387  c      ENDDO Line 542  c      ENDDO
542         ENDDO         ENDDO
543        ENDDO        ENDDO
544    
545    #ifdef ALLOW_DIAGNOSTICS
546    C-    Diagnostics of Tracer flux in R dir (mainly Diffusive terms),
547    C       Explicit terms only & excluding advective terms:
548          IF ( useDiagnostics .AND.
549         &    (.NOT.implicitDiffusion .OR. trUseGMRedi) ) THEN
550              diagName = 'DFrE'//diagSufx
551              CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)
552          ENDIF
553    #endif
554    
555  #ifdef ALLOW_KPP  #ifdef ALLOW_KPP
556  C-    Add non local KPP transport term (ghat) to diffusive T flux.  C-    Set non local KPP transport term (ghat):
557        IF (useKPP) THEN        IF ( trUseKPP .AND. k.GE.2 ) THEN
558         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
559          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
560           df(i,j) = 0. _d 0           df(i,j) = 0. _d 0
561          ENDDO          ENDDO
562         ENDDO         ENDDO
563         IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN         IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
 C *note* should update KPP_TRANSPORT_T to set df  *aja*  
564          CALL KPP_TRANSPORT_T(          CALL KPP_TRANSPORT_T(
565       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,       I           iMin,iMax,jMin,jMax,bi,bj,k,km1,
566       I     KappaRT,       O           df,
567       U     df )       I           myTime, myIter, myThid )
568         ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN         ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
569          CALL KPP_TRANSPORT_S(          CALL KPP_TRANSPORT_S(
570       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,       I           iMin,iMax,jMin,jMax,bi,bj,k,km1,
571       I     KappaRT,       O           df,
572       U     df )       I           myTime, myIter, myThid )
573    #ifdef ALLOW_PTRACERS
574           ELSEIF (tracerIdentity .GE. GAD_TR1) THEN
575            CALL KPP_TRANSPORT_PTR(
576         I           iMin,iMax,jMin,jMax,bi,bj,k,km1,
577         I           tracerIdentity-GAD_TR1+1,
578         O           df,
579         I           myTime, myIter, myThid )
580    #endif
581         ELSE         ELSE
582          STOP 'GAD_CALC_RHS: Ooops'          WRITE(errorMessageUnit,*)
583         &    'tracer identity =', tracerIdentity, ' is not valid => STOP'
584            STOP 'ABNORMAL END: S/R GAD_CALC_RHS: invalid tracer identity'
585         ENDIF         ENDIF
586         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
587          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
588           fVerT(i,j,kUp) = fVerT(i,j,kUp) + df(i,j)*maskUp(i,j)           fVerT(i,j,kUp) = fVerT(i,j,kUp)
589         &                  + df(i,j)*maskUp(i,j)*rhoFacF(k)
590            ENDDO
591           ENDDO
592    #ifdef ALLOW_DIAGNOSTICS
593    C-    Diagnostics of Non-Local Tracer (vertical) flux
594           IF ( useDiagnostics ) THEN
595             diagName = 'KPPg'//diagSufx
596             CALL DIAGNOSTICS_FILL( df, diagName, k,1, 2,bi,bj, myThid )
597    C- note: needs to explicitly increment the counter since DIAGNOSTICS_FILL
598    C        does it only if k=1 (never the case here)
599             IF ( k.EQ.2 ) CALL DIAGNOSTICS_COUNT(diagName,bi,bj,myThid)
600           ENDIF
601    #endif
602          ENDIF
603    #endif /* ALLOW_KPP */
604    
605    #ifdef GAD_SMOLARKIEWICZ_HACK
606    coj   Hack to make redi (and everything else in this s/r) positive
607    coj   (see Smolarkiewicz MWR 1989 and Bott MWR 1989).
608    coj   Only works if 'down' is k+1 and k loop in thermodynamics is k=Nr,1,-1
609    coj
610    coj   Apply to all tracers except temperature
611          IF (tracerIdentity.NE.GAD_TEMPERATURE .AND.
612         &    tracerIdentity.NE.GAD_SALINITY) THEN
613           DO j=1-Oly,sNy+Oly-1
614            DO i=1-Olx,sNx+Olx-1
615    coj   Add outgoing fluxes
616             outFlux=deltaTLev(k)*
617         &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
618         &   *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)*recip_rhoFacC(k)
619         &    *( MAX(0. _d 0,fZon(i+1,j)) + MAX(0. _d 0,-fZon(i,j))
620         &      +MAX(0. _d 0,fMer(i,j+1)) + MAX(0. _d 0,-fMer(i,j))
621         &      +MAX(0. _d 0,fVerT(i,j,kDown)*rkSign)
622         &      +MAX(0. _d 0,-fVerT(i,j,kUp)*rkSign)
623         &     )
624             IF ( applyAB_onTracer ) THEN
625               trac=TracerN(i,j,k,bi,bj)
626             ELSE
627               trac=TracAB(i,j,k,bi,bj)
628             ENDIF
629    coj   If they would reduce tracer by a fraction of more than
630    coj   SmolarkiewiczMaxFrac, scale them down
631             IF (outFlux.GT.0. _d 0 .AND.
632         &       outFlux.GT.SmolarkiewiczMaxFrac*trac) THEN
633    coj   If tracer is already negative, scale flux to zero
634               fac = MAX(0. _d 0,SmolarkiewiczMaxFrac*trac/outFlux)
635    
636               IF (fZon(i+1,j).GT.0. _d 0) fZon(i+1,j)=fac*fZon(i+1,j)
637               IF (-fZon(i,j) .GT.0. _d 0) fZon(i,j)  =fac*fZon(i,j)
638               IF (fMer(i,j+1).GT.0. _d 0) fMer(i,j+1)=fac*fMer(i,j+1)
639               IF (-fMer(i,j) .GT.0. _d 0) fMer(i,j)  =fac*fMer(i,j)
640               IF (-fVerT(i,j,kUp)*rkSign .GT.0. _d 0)
641         &       fVerT(i,j,kUp)=fac*fVerT(i,j,kUp)
642    
643               IF (k.LT.Nr .AND. fVerT(i,j,kDown)*rkSign.GT.0. _d 0) THEN
644    coj   Down flux is special: it has already been applied in lower layer,
645    coj   so we have to readjust this.
646    coj   Note: for k+1, gTracer is now the updated tracer, not the tendency!
647    coj   thus it has an extra factor deltaTLev(k+1)
648                 gTrFac=deltaTLev(k+1)
649    coj   Other factors that have been applied to gTracer since the last call:
650    #ifdef NONLIN_FRSURF
651                 IF (nonlinFreeSurf.GT.0) THEN
652                  IF (select_rStar.GT.0) THEN
653    #ifndef DISABLE_RSTAR_CODE
654                    gTrFac = gTrFac/rStarExpC(i,j,bi,bj)
655    #endif /* DISABLE_RSTAR_CODE */
656                  ENDIF
657                 ENDIF
658    #endif /* NONLIN_FRSURF */
659    coj   Now: undo down flux, ...
660                 gTracer(i,j,k+1,bi,bj)=gTracer(i,j,k+1,bi,bj)
661         &        +gTrFac
662         &         *_recip_hFacC(i,j,k+1,bi,bj)*recip_drF(k+1)
663         &         *recip_rA(i,j,bi,bj)*recip_deepFac2C(k+1)
664         &         *recip_rhoFacC(k+1)
665         &         *( -fVerT(i,j,kDown)*rkSign )
666    coj   ... scale ...
667                 fVerT(i,j,kDown)=fac*fVerT(i,j,kDown)
668    coj   ... and reapply
669                 gTracer(i,j,k+1,bi,bj)=gTracer(i,j,k+1,bi,bj)
670         &        +gTrFac
671         &         *_recip_hFacC(i,j,k+1,bi,bj)*recip_drF(k+1)
672         &         *recip_rA(i,j,bi,bj)*recip_deepFac2C(k+1)
673         &         *recip_rhoFacC(k+1)
674         &         *( fVerT(i,j,kDown)*rkSign )
675               ENDIF
676    
677             ENDIF
678          ENDDO          ENDDO
679         ENDDO         ENDDO
680        ENDIF        ENDIF
681  #endif  #endif
682    
683  C--   Divergence of fluxes  C--   Divergence of fluxes
684    C     Anelastic: scale vertical fluxes by rhoFac and leave Horizontal fluxes unchanged
685        DO j=1-Oly,sNy+Oly-1        DO j=1-Oly,sNy+Oly-1
686         DO i=1-Olx,sNx+Olx-1         DO i=1-Olx,sNx+Olx-1
687          gTracer(i,j,k,bi,bj)=gTracer(i,j,k,bi,bj)          gTracer(i,j,k,bi,bj)=gTracer(i,j,k,bi,bj)
688       &   -_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)       &   -_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
689       &    *recip_rA(i,j,bi,bj)       &   *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)*recip_rhoFacC(k)
690       &    *(       &   *( (fZon(i+1,j)-fZon(i,j))
691       &    +( fZon(i+1,j)-fZon(i,j) )       &     +(fMer(i,j+1)-fMer(i,j))
692       &    +( fMer(i,j+1)-fMer(i,j) )       &     +(fVerT(i,j,kDown)-fVerT(i,j,kUp))*rkSign
693       &    +( fVerT(i,j,kUp)-fVerT(i,j,kDown) )*rkFac       &     -localT(i,j)*( (uTrans(i+1,j)-uTrans(i,j))
694         &                   +(vTrans(i,j+1)-vTrans(i,j))
695         &                   +(rTransKp1(i,j)-rTrans(i,j))*rAdvFac
696         &                  )*advFac
697       &    )       &    )
698         ENDDO         ENDDO
699        ENDDO        ENDDO
700    
701    #ifdef ALLOW_DEBUG
702          IF ( debugLevel .GE. debLevB
703         &   .AND. tracerIdentity.EQ.GAD_TEMPERATURE
704         &   .AND. k.EQ.2 .AND. myIter.EQ.1+nIter0
705         &   .AND. nPx.EQ.1 .AND. nPy.EQ.1
706         &   .AND. useCubedSphereExchange ) THEN
707            CALL DEBUG_CS_CORNER_UV( ' fZon,fMer from GAD_CALC_RHS',
708         &             fZon,fMer, k, standardMessageUnit,bi,bj,myThid )
709          ENDIF
710    #endif /* ALLOW_DEBUG */
711    
712        RETURN        RETURN
713        END        END
Legend:
Removed from v.1.12.6.1  
changed lines
  Added in v.1.54
  ViewVC Help
Powered by ViewVC 1.1.22