/[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.6 by adcroft, Tue Sep 4 17:16:11 2001 UTC revision 1.42 by jmc, Sun Nov 19 22:04:09 2006 UTC
# Line 3  C $Name$ Line 3  C $Name$
3    
4  #include "GAD_OPTIONS.h"  #include "GAD_OPTIONS.h"
5    
6        SUBROUTINE GAD_CALC_RHS(  CBOP
7    C !ROUTINE: GAD_CALC_RHS
8    
9    C !INTERFACE: ==========================================================
10          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           tracerIdentity, advectionScheme, vertAdvecScheme,
16         I           calcAdvection, implicitAdvection, applyAB_onTracer,
17       U           fVerT, gTracer,       U           fVerT, gTracer,
18       I           myThid )       I           myTime, myIter, myThid )
 C     /==========================================================\  
 C     | SUBROUTINE GAD_CALC_RHS                                  |  
 C     |==========================================================|  
 C     \==========================================================/  
       IMPLICIT NONE  
19    
20  C     == GLobal variables ==  C !DESCRIPTION:
21    C Calculates the tendency of a tracer due to advection and diffusion.
22    C It calculates the fluxes in each direction indepentently and then
23    C sets the tendency to the divergence of these fluxes. The advective
24    C fluxes are only calculated here when using the linear advection schemes
25    C otherwise only the diffusive and parameterized fluxes are calculated.
26    C
27    C Contributions to the flux are calculated and added:
28    C \begin{equation*}
29    C {\bf F} = {\bf F}_{adv} + {\bf F}_{diff} +{\bf F}_{GM} + {\bf F}_{KPP}
30    C \end{equation*}
31    C
32    C The tendency is the divergence of the fluxes:
33    C \begin{equation*}
34    C G_\theta = G_\theta + \nabla \cdot {\bf F}
35    C \end{equation*}
36    C
37    C The tendency is assumed to contain data on entry.
38    
39    C !USES: ===============================================================
40          IMPLICIT NONE
41  #include "SIZE.h"  #include "SIZE.h"
42  #include "EEPARAMS.h"  #include "EEPARAMS.h"
43  #include "PARAMS.h"  #include "PARAMS.h"
44  #include "GRID.h"  #include "GRID.h"
45  #include "DYNVARS.h"  #include "SURFACE.h"
46  #include "GAD.h"  #include "GAD.h"
47    
48  C     == Routine arguments ==  #ifdef ALLOW_AUTODIFF_TAMC
49        INTEGER k,kUp,kDown,kM1  #include "tamc.h"
50    #include "tamc_keys.h"
51    #endif /* ALLOW_AUTODIFF_TAMC */
52    
53    C !INPUT PARAMETERS: ===================================================
54    C bi,bj            :: tile indices
55    C iMin,iMax        :: loop range for called routines
56    C jMin,jMax        :: loop range for called routines
57    C k                :: vertical index
58    C kM1              :: =k-1 for k>1, =1 for k=1
59    C kUp              :: index into 2 1/2D array, toggles between 1|2
60    C kDown            :: index into 2 1/2D array, toggles between 2|1
61    C xA,yA            :: areas of X and Y face of tracer cells
62    C maskUp           :: 2-D array for mask at W points
63    C uFld,vFld,wFld   :: Local copy of velocity field (3 components)
64    C uTrans,vTrans    :: 2-D arrays of volume transports at U,V points
65    C rTrans           :: 2-D arrays of volume transports at W points
66    C rTransKp1        :: 2-D array of volume trans at W pts, interf k+1
67    C diffKh           :: horizontal diffusion coefficient
68    C diffK4           :: bi-harmonic diffusion coefficient
69    C KappaR           :: 2-D array for vertical diffusion coefficient, interf k
70    C TracerN          :: tracer field @ time-step n (Note: only used
71    C                     if applying AB on tracer field rather than on tendency gTr)
72    C TracAB           :: current tracer field (@ time-step n if applying AB on gTr
73    C                     or extrapolated fwd in time to n+1/2 if applying AB on Tr)
74    C tracerIdentity   :: tracer identifier (required for KPP,GM)
75    C advectionScheme  :: advection scheme to use (Horizontal plane)
76    C vertAdvecScheme  :: advection scheme to use (Vertical direction)
77    C calcAdvection    :: =False if Advec computed with multiDim scheme
78    C implicitAdvection:: =True if vertical Advec computed implicitly
79    C applyAB_onTracer :: apply Adams-Bashforth on Tracer (rather than on gTr)
80    C myTime           :: current time
81    C myIter           :: iteration number
82    C myThid           :: thread number
83        INTEGER bi,bj,iMin,iMax,jMin,jMax        INTEGER bi,bj,iMin,iMax,jMin,jMax
84          INTEGER k,kUp,kDown,kM1
85        _RS xA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS xA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
86        _RS yA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS yA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
87          _RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
88          _RL uFld  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
89          _RL vFld  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
90          _RL wFld  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
91        _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
92        _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
93        _RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
94        _RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
95        _RL diffKh, diffK4        _RL diffKh, diffK4
96        _RL KappaRT(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaR(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
97        _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)
98          _RL TracAB (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
99        INTEGER tracerIdentity        INTEGER tracerIdentity
100        INTEGER advectionScheme        INTEGER advectionScheme, vertAdvecScheme
101        _RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        LOGICAL calcAdvection
102          LOGICAL implicitAdvection, applyAB_onTracer
103          _RL     myTime
104          INTEGER myIter, myThid
105    
106    C !OUTPUT PARAMETERS: ==================================================
107    C gTracer          :: tendency array
108    C fVerT            :: 2 1/2D arrays for vertical advective flux
109        _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)
110        INTEGER myThid        _RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
111    
112  C     == Local variables ==  C !LOCAL VARIABLES: ====================================================
113  C     I, J, K - Loop counters  C i,j              :: loop indices
114    C df4              :: used for storing del^2 T for bi-harmonic term
115    C fZon             :: zonal flux
116    C fMer             :: meridional flux
117    C af               :: advective flux
118    C df               :: diffusive flux
119    C localT           :: local copy of tracer field
120    C locABT           :: local copy of (AB-extrapolated) tracer field
121    #ifdef ALLOW_DIAGNOSTICS
122          CHARACTER*8 diagName
123          CHARACTER*4 GAD_DIAG_SUFX, diagSufx
124          EXTERNAL    GAD_DIAG_SUFX
125    #endif
126        INTEGER i,j        INTEGER i,j
       LOGICAL TOP_LAYER  
       _RL afFacT, dfFacT  
127        _RL df4   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL df4   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
128        _RL fZon  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL fZon  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
129        _RL fMer  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL fMer  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
130        _RL af    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL af    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
131        _RL df    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL df    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
132        _RL localT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL localT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
133          _RL locABT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
134          _RL advFac, rAdvFac
135    CEOP
136    
137  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
138  C--   only the kUp part of fverT is set in this subroutine  C--   only the kUp part of fverT is set in this subroutine
139  C--   the kDown is still required  C--   the kDown is still required
140        fVerT(1,1,kDown) = fVerT(1,1,kDown)        fVerT(1,1,kDown) = fVerT(1,1,kDown)
141  #endif  #endif
       DO j=1-OLy,sNy+OLy  
        DO i=1-OLx,sNx+OLx  
         fZon(i,j)      = 0.0  
         fMer(i,j)      = 0.0  
         fVerT(i,j,kUp) = 0.0  
        ENDDO  
       ENDDO  
142    
143        afFacT = 1. _d 0  #ifdef ALLOW_DIAGNOSTICS
144        dfFacT = 1. _d 0  C--   Set diagnostic suffix for the current tracer
145        TOP_LAYER = K .EQ. 1        IF ( useDiagnostics ) THEN
146            diagSufx = GAD_DIAG_SUFX( tracerIdentity, myThid )
147          ENDIF
148    #endif
149    
150          advFac  = 0. _d 0
151          IF (calcAdvection) advFac = 1. _d 0
152          rAdvFac = rkSign*advFac
153          IF (implicitAdvection) rAdvFac = 0. _d 0
154    
 C--   Make local copy of tracer array  
155        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
156         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
157          localT(i,j)=tracer(i,j,k,bi,bj)          fZon(i,j)      = 0. _d 0
158            fMer(i,j)      = 0. _d 0
159            fVerT(i,j,kUp) = 0. _d 0
160            df(i,j)        = 0. _d 0
161            df4(i,j)       = 0. _d 0
162         ENDDO         ENDDO
163        ENDDO        ENDDO
164    
165    C--   Make local copy of tracer array
166          IF ( applyAB_onTracer ) THEN
167            DO j=1-OLy,sNy+OLy
168             DO i=1-OLx,sNx+OLx
169              localT(i,j)=TracerN(i,j,k,bi,bj)
170              locABT(i,j)= TracAB(i,j,k,bi,bj)
171             ENDDO
172            ENDDO
173          ELSE
174            DO j=1-OLy,sNy+OLy
175             DO i=1-OLx,sNx+OLx
176              localT(i,j)= TracAB(i,j,k,bi,bj)
177              locABT(i,j)= TracAB(i,j,k,bi,bj)
178             ENDDO
179            ENDDO
180          ENDIF
181    
182    C--   Unless we have already calculated the advection terms we initialize
183    C     the tendency to zero.
184    C     <== now done earlier at the beginning of thermodynamics.
185    c     IF (calcAdvection) THEN
186    c      DO j=1-Oly,sNy+Oly
187    c       DO i=1-Olx,sNx+Olx
188    c        gTracer(i,j,k,bi,bj)=0. _d 0
189    c       ENDDO
190    c      ENDDO
191    c     ENDIF
192    
193  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
194        IF (diffK4 .NE. 0.) THEN        IF (diffK4 .NE. 0.) THEN
# Line 89  C--   Pre-calculate del^2 T if bi-harmon Line 200  C--   Pre-calculate del^2 T if bi-harmon
200  C--   Initialize net flux in X direction  C--   Initialize net flux in X direction
201        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
202         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx
203          fZon(i,j) = 0.          fZon(i,j) = 0. _d 0
204         ENDDO         ENDDO
205        ENDDO        ENDDO
206    
207  C-    Advective flux in X  C-    Advective flux in X
208        IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN        IF (calcAdvection) THEN
209         CALL GAD_C2_ADV_X(bi,bj,k,uTrans,localT,af,myThid)          IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
210        ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN            CALL GAD_C2_ADV_X(bi,bj,k,uTrans,locABT,af,myThid)
211         CALL GAD_FLUXLIMIT_ADV_X(          ELSEIF ( advectionScheme.EQ.ENUM_UPWIND_1RST
212       &      bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)       &          .OR. advectionScheme.EQ.ENUM_DST2 ) THEN
213        ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN            CALL GAD_DST2U1_ADV_X( bi,bj,k, advectionScheme,
214         CALL GAD_U3_ADV_X(bi,bj,k,uTrans,localT,af,myThid)       I            dTtracerLev(k), uTrans, uFld, locABT,
215        ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN       O            af, myThid )
216         CALL GAD_C4_ADV_X(bi,bj,k,uTrans,localT,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
217        ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN            CALL GAD_FLUXLIMIT_ADV_X( bi,bj,k, dTtracerLev(k),
218         CALL GAD_DST3_ADV_X(       I            uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,
219       &       bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)       O            af, myThid )
220        ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN          ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
221         CALL GAD_DST3FL_ADV_X(            CALL GAD_U3_ADV_X(bi,bj,k,uTrans,locABT,af,myThid)
222       &       bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
223        ELSE            CALL GAD_C4_ADV_X(bi,bj,k,uTrans,locABT,af,myThid)
224         STOP 'GAD_CALC_RHS: Bad advectionScheme (X)'          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
225              CALL GAD_DST3_ADV_X( bi,bj,k, dTtracerLev(k),
226         I            uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,
227         O            af, myThid )
228            ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
229             IF ( inAdMode ) THEN
230    cph This block is to trick the adjoint:
231    cph IF inAdExact=.FALSE., we want to use DST3
232    cph with limiters in forward, but without limiters in reverse.
233              CALL GAD_DST3_ADV_X( bi,bj,k, dTtracerLev(k),
234         I           uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,
235         O           af, myThid )
236             ELSE
237              CALL GAD_DST3FL_ADV_X( bi,bj,k, dTtracerLev(k),
238         I           uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,
239         O           af, myThid )
240             ENDIF
241            ELSE
242             STOP 'GAD_CALC_RHS: Bad advectionScheme (X)'
243            ENDIF
244            DO j=1-Oly,sNy+Oly
245             DO i=1-Olx,sNx+Olx
246              fZon(i,j) = fZon(i,j) + af(i,j)
247             ENDDO
248            ENDDO
249    #ifdef ALLOW_DIAGNOSTICS
250            IF ( useDiagnostics ) THEN
251              diagName = 'ADVx'//diagSufx
252              CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)
253            ENDIF
254    #endif
255        ENDIF        ENDIF
       DO j=1-Oly,sNy+Oly  
        DO i=1-Olx,sNx+Olx  
         fZon(i,j) = fZon(i,j) + af(i,j)  
        ENDDO  
       ENDDO  
256    
257  C-    Diffusive flux in X  C-    Diffusive flux in X
258        IF (diffKh.NE.0.) THEN        IF (diffKh.NE.0.) THEN
# Line 124  C-    Diffusive flux in X Line 260  C-    Diffusive flux in X
260        ELSE        ELSE
261         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
262          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
263           df(i,j) = 0.           df(i,j) = 0. _d 0
264          ENDDO          ENDDO
265         ENDDO         ENDDO
266        ENDIF        ENDIF
267    
268    C-    Add bi-harmonic diffusive flux in X
269          IF (diffK4 .NE. 0.) THEN
270           CALL GAD_BIHARM_X(bi,bj,k,xA,df4,diffK4,df,myThid)
271          ENDIF
272    
273  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
274  C-    GM/Redi flux in X  C-    GM/Redi flux in X
275        IF (useGMRedi) THEN        IF (useGMRedi) THEN
276  C *note* should update GMREDI_XTRANSPORT to use localT and set df  *aja*  C *note* should update GMREDI_XTRANSPORT to set df  *aja*
277          CALL GMREDI_XTRANSPORT(          IF ( applyAB_onTracer ) THEN
278       I     iMin,iMax,jMin,jMax,bi,bj,K,            CALL GMREDI_XTRANSPORT(
279       I     xA,Tracer,       I         iMin,iMax,jMin,jMax,bi,bj,k,
280       U     df,       I         xA,TracerN,tracerIdentity,
281       I     myThid)       U         df,
282         I         myThid)
283            ELSE
284              CALL GMREDI_XTRANSPORT(
285         I         iMin,iMax,jMin,jMax,bi,bj,k,
286         I         xA,TracAB, tracerIdentity,
287         U         df,
288         I         myThid)
289            ENDIF
290        ENDIF        ENDIF
291  #endif  #endif
292        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
# Line 146  C *note* should update GMREDI_XTRANSPORT Line 295  C *note* should update GMREDI_XTRANSPORT
295         ENDDO         ENDDO
296        ENDDO        ENDDO
297    
298  C-    Bi-harmonic duffusive flux in X  #ifdef ALLOW_DIAGNOSTICS
299        IF (diffK4 .NE. 0.) THEN  C-    Diagnostics of Tracer flux in X dir (mainly Diffusive term),
300         CALL GAD_BIHARM_X(bi,bj,k,xA,df4,diffK4,df,myThid)  C       excluding advective terms:
301         DO j=1-Oly,sNy+Oly        IF ( useDiagnostics .AND.
302          DO i=1-Olx,sNx+Olx       &    (diffKh.NE.0. .OR. diffK4 .NE.0. .OR. useGMRedi) ) THEN
303           fZon(i,j) = fZon(i,j) + df(i,j)            diagName = 'DFxE'//diagSufx
304          ENDDO            CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)
        ENDDO  
305        ENDIF        ENDIF
306    #endif
307    
308  C--   Initialize net flux in Y direction  C--   Initialize net flux in Y direction
309        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
310         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx
311          fMer(i,j) = 0.          fMer(i,j) = 0. _d 0
312         ENDDO         ENDDO
313        ENDDO        ENDDO
314    
315  C-    Advective flux in Y  C-    Advective flux in Y
316        IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN        IF (calcAdvection) THEN
317         CALL GAD_C2_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)          IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
318        ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN            CALL GAD_C2_ADV_Y(bi,bj,k,vTrans,locABT,af,myThid)
319         CALL GAD_FLUXLIMIT_ADV_Y(          ELSEIF ( advectionScheme.EQ.ENUM_UPWIND_1RST
320       &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)       &          .OR. advectionScheme.EQ.ENUM_DST2 ) THEN
321        ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN            CALL GAD_DST2U1_ADV_Y( bi,bj,k, advectionScheme,
322         CALL GAD_U3_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)       I            dTtracerLev(k), vTrans, vFld, locABT,
323        ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN       O            af, myThid )
324         CALL GAD_C4_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
325        ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN            CALL GAD_FLUXLIMIT_ADV_Y( bi,bj,k, dTtracerLev(k),
326         CALL GAD_DST3_ADV_Y(       I            vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,
327       &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)       O            af, myThid )
328        ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN          ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
329         CALL GAD_DST3FL_ADV_Y(            CALL GAD_U3_ADV_Y(bi,bj,k,vTrans,locABT,af,myThid)
330       &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
331        ELSE            CALL GAD_C4_ADV_Y(bi,bj,k,vTrans,locABT,af,myThid)
332         STOP 'GAD_CALC_RHS: Bad advectionScheme (Y)'          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
333              CALL GAD_DST3_ADV_Y( bi,bj,k, dTtracerLev(k),
334         I            vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,
335         O            af, myThid )
336            ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
337             IF ( inAdMode ) THEN
338    cph This block is to trick the adjoint:
339    cph IF inAdExact=.FALSE., we want to use DST3
340    cph with limiters in forward, but without limiters in reverse.
341              CALL GAD_DST3_ADV_Y( bi,bj,k, dTtracerLev(k),
342         I           vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,
343         O           af, myThid )
344             ELSE
345              CALL GAD_DST3FL_ADV_Y( bi,bj,k, dTtracerLev(k),
346         I           vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,
347         O           af, myThid )
348             ENDIF
349            ELSE
350              STOP 'GAD_CALC_RHS: Bad advectionScheme (Y)'
351            ENDIF
352            DO j=1-Oly,sNy+Oly
353             DO i=1-Olx,sNx+Olx
354              fMer(i,j) = fMer(i,j) + af(i,j)
355             ENDDO
356            ENDDO
357    #ifdef ALLOW_DIAGNOSTICS
358            IF ( useDiagnostics ) THEN
359              diagName = 'ADVy'//diagSufx
360              CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)
361            ENDIF
362    #endif
363        ENDIF        ENDIF
       DO j=1-Oly,sNy+Oly  
        DO i=1-Olx,sNx+Olx  
         fMer(i,j) = fMer(i,j) + af(i,j)  
        ENDDO  
       ENDDO  
364    
365  C-    Diffusive flux in Y  C-    Diffusive flux in Y
366        IF (diffKh.NE.0.) THEN        IF (diffKh.NE.0.) THEN
# Line 194  C-    Diffusive flux in Y Line 368  C-    Diffusive flux in Y
368        ELSE        ELSE
369         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
370          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
371           df(i,j) = 0.           df(i,j) = 0. _d 0
372          ENDDO          ENDDO
373         ENDDO         ENDDO
374        ENDIF        ENDIF
375    
376    C-    Add bi-harmonic flux in Y
377          IF (diffK4 .NE. 0.) THEN
378           CALL GAD_BIHARM_Y(bi,bj,k,yA,df4,diffK4,df,myThid)
379          ENDIF
380    
381  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
382  C-    GM/Redi flux in Y  C-    GM/Redi flux in Y
383        IF (useGMRedi) THEN        IF (useGMRedi) THEN
384         CALL GMREDI_YTRANSPORT(  C *note* should update GMREDI_YTRANSPORT to set df  *aja*
385  C *note* should update GMREDI_YTRANSPORT to use localT and set df  *aja*          IF ( applyAB_onTracer ) THEN
386       I     iMin,iMax,jMin,jMax,bi,bj,K,            CALL GMREDI_YTRANSPORT(
387       I     yA,Tracer,       I         iMin,iMax,jMin,jMax,bi,bj,k,
388       U     df,       I         yA,TracerN,tracerIdentity,
389       I     myThid)       U         df,
390         I         myThid)
391            ELSE
392              CALL GMREDI_YTRANSPORT(
393         I         iMin,iMax,jMin,jMax,bi,bj,k,
394         I         yA,TracAB, tracerIdentity,
395         U         df,
396         I         myThid)
397            ENDIF
398        ENDIF        ENDIF
399  #endif  #endif
400        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
# Line 216  C *note* should update GMREDI_YTRANSPORT Line 403  C *note* should update GMREDI_YTRANSPORT
403         ENDDO         ENDDO
404        ENDDO        ENDDO
405    
406  C-    Bi-harmonic flux in Y  #ifdef ALLOW_DIAGNOSTICS
407        IF (diffK4 .NE. 0.) THEN  C-    Diagnostics of Tracer flux in Y dir (mainly Diffusive terms),
408         CALL GAD_BIHARM_Y(bi,bj,k,yA,df4,diffK4,df,myThid)  C       excluding advective terms:
409         DO j=1-Oly,sNy+Oly        IF ( useDiagnostics .AND.
410          DO i=1-Olx,sNx+Olx       &    (diffKh.NE.0. .OR. diffK4 .NE.0. .OR. useGMRedi) ) THEN
411           fMer(i,j) = fMer(i,j) + df(i,j)            diagName = 'DFyE'//diagSufx
412          ENDDO            CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)
        ENDDO  
413        ENDIF        ENDIF
414    #endif
415    
416  C--   Initialize net flux in R  C--   Compute vertical flux fVerT(kUp) at interface k (between k-1 & k):
       DO j=1-Oly,sNy+Oly  
        DO i=1-Olx,sNx+Olx  
         fVerT(i,j,kUp) = 0.  
        ENDDO  
       ENDDO  
   
417  C-    Advective flux in R  C-    Advective flux in R
418  C     Note: wVel needs to be masked  #ifdef ALLOW_AIM
419        IF (K.GE.2) THEN  C- a hack to prevent Water-Vapor vert.transport into the stratospheric level Nr
420          IF (calcAdvection .AND. .NOT.implicitAdvection .AND. k.GE.2 .AND.
421         &     (.NOT.useAIM .OR.tracerIdentity.NE.GAD_SALINITY .OR.k.LT.Nr)
422         &   ) THEN
423    #else
424          IF (calcAdvection .AND. .NOT.implicitAdvection .AND. k.GE.2) THEN
425    #endif
426  C-    Compute vertical advective flux in the interior:  C-    Compute vertical advective flux in the interior:
427         IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN          IF (vertAdvecScheme.EQ.ENUM_CENTERED_2ND) THEN
428          CALL GAD_C2_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)            CALL GAD_C2_ADV_R(bi,bj,k,rTrans,TracAB,af,myThid)
429         ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN          ELSEIF ( vertAdvecScheme.EQ.ENUM_UPWIND_1RST
430          CALL GAD_FLUXLIMIT_ADV_R(       &          .OR. vertAdvecScheme.EQ.ENUM_DST2 ) THEN
431       &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)            CALL GAD_DST2U1_ADV_R( bi,bj,k, vertAdvecScheme,
432         ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN       I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
433          CALL GAD_U3_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)       O         af, myThid )
434         ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN          ELSEIF (vertAdvecScheme.EQ.ENUM_FLUX_LIMIT) THEN
435          CALL GAD_C4_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)            CALL GAD_FLUXLIMIT_ADV_R( bi,bj,k,
436         ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN       I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
437  c       CALL GAD_DST3_ADV_R(       O         af, myThid )
438  c    &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)          ELSEIF (vertAdvecScheme.EQ.ENUM_UPWIND_3RD ) THEN
439          STOP 'GAD_CALC_RHS: GAD_DST3_ADV_R not coded yet'            CALL GAD_U3_ADV_R(bi,bj,k,rTrans,TracAB,af,myThid)
440         ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN          ELSEIF (vertAdvecScheme.EQ.ENUM_CENTERED_4TH) THEN
441  c       CALL GAD_DST3FL_ADV_R(            CALL GAD_C4_ADV_R(bi,bj,k,rTrans,TracAB,af,myThid)
442  c    &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)          ELSEIF (vertAdvecScheme.EQ.ENUM_DST3 ) THEN
443          STOP 'GAD_CALC_RHS: GAD_DST3FL_ADV_R not coded yet'            CALL GAD_DST3_ADV_R( bi,bj,k,
444         ELSE       I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
445          STOP 'GAD_CALC_RHS: Bad advectionScheme (R)'       O         af, myThid )
446         ENDIF          ELSEIF (vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
447  C-    Surface "correction" term at k>1 :  cph This block is to trick the adjoint:
448         DO j=1-Oly,sNy+Oly  cph IF inAdExact=.FALSE., we want to use DST3
449          DO i=1-Olx,sNx+Olx  cph with limiters in forward, but without limiters in reverse.
450           af(i,j) = af(i,j)            IF ( inAdMode ) THEN
451       &           + (maskC(i,j,k,bi,bj)-maskC(i,j,k-1,bi,bj))*             CALL GAD_DST3_ADV_R( bi,bj,k,
452       &             rTrans(i,j)*Tracer(i,j,k,bi,bj)       I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
453         O         af, myThid )
454              ELSE
455               CALL GAD_DST3FL_ADV_R( bi,bj,k,
456         I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
457         O         af, myThid )
458              ENDIF
459            ELSE
460              STOP 'GAD_CALC_RHS: Bad vertAdvecScheme (R)'
461            ENDIF
462    C-     add the advective flux to fVerT
463            DO j=1-Oly,sNy+Oly
464             DO i=1-Olx,sNx+Olx
465              fVerT(i,j,kUp) = fVerT(i,j,kUp) + af(i,j)
466             ENDDO
467          ENDDO          ENDDO
468         ENDDO  #ifdef ALLOW_DIAGNOSTICS
469        ELSE          IF ( useDiagnostics ) THEN
470  C-    Surface "correction" term at k=1 :            diagName = 'ADVr'//diagSufx
471         DO j=1-Oly,sNy+Oly            CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)
472          DO i=1-Olx,sNx+Olx  C- note: needs to explicitly increment the counter since DIAGNOSTICS_FILL
473           af(i,j) = rTrans(i,j)*Tracer(i,j,k,bi,bj)  C        does it only if k=1 (never the case here)
474          ENDDO            IF ( k.EQ.2 ) CALL DIAGNOSTICS_COUNT(diagName,bi,bj,myThid)
475         ENDDO          ENDIF
476    #endif
477        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) + afFacT*af(i,j)  
        ENDDO  
       ENDDO  
478    
479  C-    Diffusive flux in R  C-    Diffusive flux in R
480  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
# Line 286  C           boundary condition. Line 482  C           boundary condition.
482        IF (implicitDiffusion) THEN        IF (implicitDiffusion) THEN
483         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
484          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
485           df(i,j) = 0.           df(i,j) = 0. _d 0
486          ENDDO          ENDDO
487         ENDDO         ENDDO
488        ELSE        ELSE
489         CALL GAD_DIFF_R(bi,bj,k,KappaRT,tracer,df,myThid)         IF ( applyAB_onTracer ) THEN
490             CALL GAD_DIFF_R(bi,bj,k,KappaR,TracerN,df,myThid)
491           ELSE
492             CALL GAD_DIFF_R(bi,bj,k,KappaR,TracAB, df,myThid)
493           ENDIF
494        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) + dfFacT*df(i,j)*maskUp(i,j)  
 c      ENDDO  
 c     ENDDO  
495    
496  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
497  C-    GM/Redi flux in R  C-    GM/Redi flux in R
498        IF (useGMRedi) THEN        IF (useGMRedi) THEN
499  C *note* should update GMREDI_RTRANSPORT to set df  *aja*  C *note* should update GMREDI_RTRANSPORT to set df  *aja*
500         CALL GMREDI_RTRANSPORT(          IF ( applyAB_onTracer ) THEN
501       I     iMin,iMax,jMin,jMax,bi,bj,K,            CALL GMREDI_RTRANSPORT(
502       I     Tracer,       I         iMin,iMax,jMin,jMax,bi,bj,k,
503       U     df,       I         TracerN,tracerIdentity,
504       I     myThid)       U         df,
505  c      DO j=1-Oly,sNy+Oly       I         myThid)
506  c       DO i=1-Olx,sNx+Olx          ELSE
507  c        fVerT(i,j,kUp) = fVerT(i,j,kUp) + dfFacT*df(i,j)*maskUp(i,j)            CALL GMREDI_RTRANSPORT(
508  c       ENDDO       I         iMin,iMax,jMin,jMax,bi,bj,k,
509  c      ENDDO       I         TracAB, tracerIdentity,
510         U         df,
511         I         myThid)
512            ENDIF
513        ENDIF        ENDIF
514  #endif  #endif
515    
516        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
517         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx
518          fVerT(i,j,kUp) = fVerT(i,j,kUp) + dfFacT*df(i,j)*maskUp(i,j)          fVerT(i,j,kUp) = fVerT(i,j,kUp) + df(i,j)*maskUp(i,j)
519         ENDDO         ENDDO
520        ENDDO        ENDDO
521    
522    #ifdef ALLOW_DIAGNOSTICS
523    C-    Diagnostics of Tracer flux in R dir (mainly Diffusive terms),
524    C       Explicit terms only & excluding advective terms:
525          IF ( useDiagnostics .AND.
526         &    (.NOT.implicitDiffusion .OR. useGMRedi) ) THEN
527              diagName = 'DFrE'//diagSufx
528              CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)
529          ENDIF
530    #endif
531    
532  #ifdef ALLOW_KPP  #ifdef ALLOW_KPP
533  C-    Add non local KPP transport term (ghat) to diffusive T flux.  C-    Set non local KPP transport term (ghat):
534        IF (useKPP) THEN        IF ( useKPP .AND. k.GE.2 ) THEN
535         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
536          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
537           df(i,j) = 0.           df(i,j) = 0. _d 0
538          ENDDO          ENDDO
539         ENDDO         ENDDO
540         IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN         IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
 C *note* should update KPP_TRANSPORT_T to set df  *aja*  
541          CALL KPP_TRANSPORT_T(          CALL KPP_TRANSPORT_T(
542       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,
543       I     KappaRT,       O     df )
      U     df )  
544         ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN         ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
545          CALL KPP_TRANSPORT_S(          CALL KPP_TRANSPORT_S(
546       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,
547       I     KappaRT,       O     df )
548       U     df )  #ifdef ALLOW_PTRACERS
549           ELSEIF (tracerIdentity .GE. GAD_TR1) THEN
550            CALL KPP_TRANSPORT_PTR(
551         I     iMin,iMax,jMin,jMax,bi,bj,k,km1,
552         I     tracerIdentity-GAD_TR1+1,
553         O     df )
554    #endif
555         ELSE         ELSE
556            PRINT*,'invalid tracer indentity: ', tracerIdentity
557          STOP 'GAD_CALC_RHS: Ooops'          STOP 'GAD_CALC_RHS: Ooops'
558         ENDIF         ENDIF
559         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
560          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
561           fVerT(i,j,kUp) = fVerT(i,j,kUp) + dfFacT*df(i,j)*maskUp(i,j)           fVerT(i,j,kUp) = fVerT(i,j,kUp) + df(i,j)*maskUp(i,j)
562          ENDDO          ENDDO
563         ENDDO         ENDDO
564        ENDIF        ENDIF
565  #endif  #endif
566    
567  C--   Divergence of fluxes  C--   Divergence of fluxes
568        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly-1
569         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx-1
570          gTracer(i,j,k,bi,bj)=          gTracer(i,j,k,bi,bj)=gTracer(i,j,k,bi,bj)
571       &   -_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)       &   -_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)*recip_rA(i,j,bi,bj)
572       &    *recip_rA(i,j,bi,bj)       &   *( (fZon(i+1,j)-fZon(i,j))
573       &    *(       &     +(fMer(i,j+1)-fMer(i,j))
574       &    +( fZon(i+1,j)-fZon(i,j) )       &     +(fVerT(i,j,kDown)-fVerT(i,j,kUp))*rkSign
575       &    +( fMer(i,j+1)-fMer(i,j) )       &     -localT(i,j)*( (uTrans(i+1,j)-uTrans(i,j))
576       &    +( fVerT(i,j,kUp)-fVerT(i,j,kDown) )*rkFac       &                   +(vTrans(i,j+1)-vTrans(i,j))
577         &                   +(rTransKp1(i,j)-rTrans(i,j))*rAdvFac
578         &                  )*advFac
579       &    )       &    )
580         ENDDO         ENDDO
581        ENDDO        ENDDO
582    
583    #ifdef ALLOW_DEBUG
584          IF ( debugLevel .GE. debLevB
585         &   .AND. tracerIdentity.EQ.GAD_TEMPERATURE
586         &   .AND. k.EQ.2 .AND. myIter.EQ.1+nIter0
587         &   .AND. nPx.EQ.1 .AND. nPy.EQ.1
588         &   .AND. useCubedSphereExchange ) THEN
589            CALL DEBUG_CS_CORNER_UV( ' fZon,fMer from GAD_CALC_RHS',
590         &             fZon,fMer, k, standardMessageUnit,bi,bj,myThid )
591          ENDIF
592    #endif /* ALLOW_DEBUG */
593    
594        RETURN        RETURN
595        END        END
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.42
  ViewVC Help
Powered by ViewVC 1.1.22