/[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.24 by edhill, Mon Mar 29 03:33:51 2004 UTC revision 1.44 by adcroft, Sat Jan 20 21:20:11 2007 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,rTransKp1,maskUp,       I           xA, yA, maskUp, uFld, vFld, wFld,
13       I           uVel, vVel, wVel,       I           uTrans, vTrans, rTrans, rTransKp1,
14       I           diffKh, diffK4, KappaRT, Tracer,       I           diffKh, diffK4, KappaR, TracerN, TracAB,
15       I           tracerIdentity, advectionScheme,       I           tracerIdentity, advectionScheme, vertAdvecScheme,
16       I           calcAdvection, implicitAdvection,       I           calcAdvection, implicitAdvection, applyAB_onTracer,
17       U           fVerT, gTracer,       U           fVerT, gTracer,
18       I           myThid )       I           myTime, myIter, myThid )
19    
20  C !DESCRIPTION:  C !DESCRIPTION:
21  C Calculates the tendancy of a tracer due to advection and diffusion.  C Calculates the tendency of a tracer due to advection and diffusion.
22  C It calculates the fluxes in each direction indepentently and then  C It calculates the fluxes in each direction indepentently and then
23  C sets the tendancy to the divergence of these fluxes. The advective  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  C fluxes are only calculated here when using the linear advection schemes
25  C otherwise only the diffusive and parameterized fluxes are calculated.  C otherwise only the diffusive and parameterized fluxes are calculated.
26  C  C
# Line 29  C \begin{equation*} Line 29  C \begin{equation*}
29  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}
30  C \end{equation*}  C \end{equation*}
31  C  C
32  C The tendancy is the divergence of the fluxes:  C The tendency is the divergence of the fluxes:
33  C \begin{equation*}  C \begin{equation*}
34  C G_\theta = G_\theta + \nabla \cdot {\bf F}  C G_\theta = G_\theta + \nabla \cdot {\bf F}
35  C \end{equation*}  C \end{equation*}
36  C  C
37  C The tendancy is assumed to contain data on entry.  C The tendency is assumed to contain data on entry.
38    
39  C !USES: ===============================================================  C !USES: ===============================================================
40        IMPLICIT NONE        IMPLICIT NONE
# Line 54  C !INPUT PARAMETERS: =================== Line 54  C !INPUT PARAMETERS: ===================
54  C bi,bj            :: tile indices  C bi,bj            :: tile indices
55  C iMin,iMax        :: loop range for called routines  C iMin,iMax        :: loop range for called routines
56  C jMin,jMax        :: loop range for called routines  C jMin,jMax        :: loop range for called routines
57  C kup              :: index into 2 1/2D array, toggles between 1|2  C k                :: vertical index
58  C kdown            :: index into 2 1/2D array, toggles between 2|1  C kM1              :: =k-1 for k>1, =1 for k=1
59  C kp1              :: =k+1 for k<Nr, =Nr for k=Nr  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  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  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  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  C rTransKp1        :: 2-D array of volume trans at W pts, interf k+1
 C maskUp           :: 2-D array for mask at W points  
 C uVel,vVel,wVel   :: 3 components of the velcity field (3-D array)  
67  C diffKh           :: horizontal diffusion coefficient  C diffKh           :: horizontal diffusion coefficient
68  C diffK4           :: bi-harmonic diffusion coefficient  C diffK4           :: bi-harmonic diffusion coefficient
69  C KappaRT          :: 3-D array for vertical diffusion coefficient  C KappaR           :: 2-D array for vertical diffusion coefficient, interf k
70  C Tracer           :: tracer field  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)  C tracerIdentity   :: tracer identifier (required for KPP,GM)
75  C advectionScheme  :: advection scheme to use  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  C calcAdvection    :: =False if Advec computed with multiDim scheme
78  C implicitAdvection:: =True if vertical Advec computed implicitly  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  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        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        _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
       _RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL uVel  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)  
       _RL vVel  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)  
       _RL wVel  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)  
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        LOGICAL calcAdvection        LOGICAL calcAdvection
102        LOGICAL implicitAdvection        LOGICAL implicitAdvection, applyAB_onTracer
103        INTEGER myThid        _RL     myTime
104          INTEGER myIter, myThid
105    
106  C !OUTPUT PARAMETERS: ==================================================  C !OUTPUT PARAMETERS: ==================================================
107  C gTracer          :: tendancy array  C gTracer          :: tendency array
108  C fVerT            :: 2 1/2D arrays for vertical advective flux  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        _RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
# Line 103  C !LOCAL VARIABLES: ==================== Line 113  C !LOCAL VARIABLES: ====================
113  C i,j              :: loop indices  C i,j              :: loop indices
114  C df4              :: used for storing del^2 T for bi-harmonic term  C df4              :: used for storing del^2 T for bi-harmonic term
115  C fZon             :: zonal flux  C fZon             :: zonal flux
116  C fmer             :: meridional flux  C fMer             :: meridional flux
117  C af               :: advective flux  C af               :: advective flux
118  C df               :: diffusive flux  C df               :: diffusive flux
119  C localT           :: local copy of tracer field  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
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)
# Line 114  C localT           :: local copy of trac Line 130  C localT           :: local copy of trac
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        _RL advFac, rAdvFac
135  CEOP  CEOP
136    
# Line 123  C--   the kDown is still required Line 140  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
142    
143    #ifdef ALLOW_DIAGNOSTICS
144    C--   Set diagnostic suffix for the current tracer
145          IF ( useDiagnostics ) THEN
146            diagSufx = GAD_DIAG_SUFX( tracerIdentity, myThid )
147          ENDIF
148    #endif
149    
150        advFac  = 0. _d 0        advFac  = 0. _d 0
151        IF (calcAdvection) advFac = 1. _d 0        IF (calcAdvection) advFac = 1. _d 0
152        rAdvFac = rkFac*advFac        rAdvFac = rkSign*advFac
153        IF (implicitAdvection) rAdvFac = 0. _d 0        IF (implicitAdvection) rAdvFac = 0. _d 0
154    
155        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
# Line 139  C--   the kDown is still required Line 163  C--   the kDown is still required
163        ENDDO        ENDDO
164    
165  C--   Make local copy of tracer array  C--   Make local copy of tracer array
166        DO j=1-OLy,sNy+OLy        IF ( applyAB_onTracer ) THEN
167         DO i=1-OLx,sNx+OLx          DO j=1-OLy,sNy+OLy
168          localT(i,j)=tracer(i,j,k,bi,bj)           DO i=1-OLx,sNx+OLx
169         ENDDO            localT(i,j)=TracerN(i,j,k,bi,bj)
170        ENDDO            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  C--   Unless we have already calculated the advection terms we initialize
183  C     the tendency to zero.  C     the tendency to zero.
# Line 172  C--   Initialize net flux in X direction Line 206  C--   Initialize net flux in X direction
206    
207  C-    Advective flux in X  C-    Advective flux in X
208        IF (calcAdvection) THEN        IF (calcAdvection) THEN
209        IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN          IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
210         CALL GAD_C2_ADV_X(bi,bj,k,uTrans,localT,af,myThid)            CALL GAD_C2_ADV_X(bi,bj,k,uTrans,locABT,af,myThid)
211        ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN          ELSEIF ( advectionScheme.EQ.ENUM_UPWIND_1RST
212         CALL GAD_FLUXLIMIT_ADV_X(       &          .OR. advectionScheme.EQ.ENUM_DST2 ) THEN
213       &      bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)            CALL GAD_DST2U1_ADV_X( bi,bj,k, advectionScheme,
214        ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN       I            dTtracerLev(k), uTrans, uFld, locABT,
215         CALL GAD_U3_ADV_X(bi,bj,k,uTrans,localT,af,myThid)       O            af, myThid )
216        ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN          ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
217         CALL GAD_C4_ADV_X(bi,bj,k,uTrans,localT,af,myThid)            CALL GAD_FLUXLIMIT_ADV_X( bi,bj,k, dTtracerLev(k),
218        ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN       I            uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,
219         CALL GAD_DST3_ADV_X(       O            af, myThid )
220       &       bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
221        ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN            CALL GAD_U3_ADV_X(bi,bj,k,uTrans,locABT,af,myThid)
222         CALL GAD_DST3FL_ADV_X(          ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
223       &       bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)            CALL GAD_C4_ADV_X(bi,bj,k,uTrans,locABT,af,myThid)
224        ELSE          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
225         STOP 'GAD_CALC_RHS: Bad advectionScheme (X)'            CALL GAD_DST3_ADV_X( bi,bj,k, dTtracerLev(k),
226        ENDIF       I            uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,
227        DO j=1-Oly,sNy+Oly       O            af, myThid )
228         DO i=1-Olx,sNx+Olx          ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
229          fZon(i,j) = fZon(i,j) + af(i,j)           IF ( inAdMode ) THEN
230         ENDDO  cph This block is to trick the adjoint:
231        ENDDO  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            ELSEIF (advectionScheme.EQ.ENUM_OS7MP ) THEN
242              CALL GAD_OS7MP_ADV_X( bi,bj,k, dTtracerLev(k),
243         I            uTrans, uFld, maskW(1-Olx,1-Oly,k,bi,bj), locABT,
244         O            af, myThid )
245            ELSE
246             STOP 'GAD_CALC_RHS: Bad advectionScheme (X)'
247            ENDIF
248            DO j=1-Oly,sNy+Oly
249             DO i=1-Olx,sNx+Olx
250              fZon(i,j) = fZon(i,j) + af(i,j)
251             ENDDO
252            ENDDO
253    #ifdef ALLOW_DIAGNOSTICS
254            IF ( useDiagnostics ) THEN
255              diagName = 'ADVx'//diagSufx
256              CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)
257            ENDIF
258    #endif
259        ENDIF        ENDIF
260    
261  C-    Diffusive flux in X  C-    Diffusive flux in X
# Line 208  C-    Diffusive flux in X Line 269  C-    Diffusive flux in X
269         ENDDO         ENDDO
270        ENDIF        ENDIF
271    
272    C-    Add bi-harmonic diffusive flux in X
273          IF (diffK4 .NE. 0.) THEN
274           CALL GAD_BIHARM_X(bi,bj,k,xA,df4,diffK4,df,myThid)
275          ENDIF
276    
277  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
278  C-    GM/Redi flux in X  C-    GM/Redi flux in X
279        IF (useGMRedi) THEN        IF (useGMRedi) THEN
280  C *note* should update GMREDI_XTRANSPORT to use localT and set df  *aja*  C *note* should update GMREDI_XTRANSPORT to set df  *aja*
281          CALL GMREDI_XTRANSPORT(          IF ( applyAB_onTracer ) THEN
282       I     iMin,iMax,jMin,jMax,bi,bj,K,            CALL GMREDI_XTRANSPORT(
283       I     xA,Tracer,tracerIdentity,       I         iMin,iMax,jMin,jMax,bi,bj,k,
284       U     df,       I         xA,TracerN,tracerIdentity,
285       I     myThid)       U         df,
286         I         myThid)
287            ELSE
288              CALL GMREDI_XTRANSPORT(
289         I         iMin,iMax,jMin,jMax,bi,bj,k,
290         I         xA,TracAB, tracerIdentity,
291         U         df,
292         I         myThid)
293            ENDIF
294        ENDIF        ENDIF
295  #endif  #endif
296    C     anelastic: advect.fluxes are scaled by rhoFac but hor.diff. flx are not
297        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
298         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx
299          fZon(i,j) = fZon(i,j) + df(i,j)          fZon(i,j) = fZon(i,j) + df(i,j)*rhoFacC(k)
300         ENDDO         ENDDO
301        ENDDO        ENDDO
302    
303  C-    Bi-harmonic duffusive flux in X  #ifdef ALLOW_DIAGNOSTICS
304        IF (diffK4 .NE. 0.) THEN  C-    Diagnostics of Tracer flux in X dir (mainly Diffusive term),
305         CALL GAD_BIHARM_X(bi,bj,k,xA,df4,diffK4,df,myThid)  C       excluding advective terms:
306         DO j=1-Oly,sNy+Oly        IF ( useDiagnostics .AND.
307          DO i=1-Olx,sNx+Olx       &    (diffKh.NE.0. .OR. diffK4 .NE.0. .OR. useGMRedi) ) THEN
308           fZon(i,j) = fZon(i,j) + df(i,j)            diagName = 'DFxE'//diagSufx
309          ENDDO            CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)
        ENDDO  
310        ENDIF        ENDIF
311    #endif
312    
313  C--   Initialize net flux in Y direction  C--   Initialize net flux in Y direction
314        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
# Line 244  C--   Initialize net flux in Y direction Line 319  C--   Initialize net flux in Y direction
319    
320  C-    Advective flux in Y  C-    Advective flux in Y
321        IF (calcAdvection) THEN        IF (calcAdvection) THEN
322        IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN          IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
323         CALL GAD_C2_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)            CALL GAD_C2_ADV_Y(bi,bj,k,vTrans,locABT,af,myThid)
324        ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN          ELSEIF ( advectionScheme.EQ.ENUM_UPWIND_1RST
325         CALL GAD_FLUXLIMIT_ADV_Y(       &          .OR. advectionScheme.EQ.ENUM_DST2 ) THEN
326       &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)            CALL GAD_DST2U1_ADV_Y( bi,bj,k, advectionScheme,
327        ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN       I            dTtracerLev(k), vTrans, vFld, locABT,
328         CALL GAD_U3_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)       O            af, myThid )
329        ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN          ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
330         CALL GAD_C4_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)            CALL GAD_FLUXLIMIT_ADV_Y( bi,bj,k, dTtracerLev(k),
331        ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN       I            vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,
332         CALL GAD_DST3_ADV_Y(       O            af, myThid )
333       &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
334        ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN            CALL GAD_U3_ADV_Y(bi,bj,k,vTrans,locABT,af,myThid)
335         CALL GAD_DST3FL_ADV_Y(          ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
336       &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)            CALL GAD_C4_ADV_Y(bi,bj,k,vTrans,locABT,af,myThid)
337        ELSE          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
338         STOP 'GAD_CALC_RHS: Bad advectionScheme (Y)'            CALL GAD_DST3_ADV_Y( bi,bj,k, dTtracerLev(k),
339        ENDIF       I            vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,
340        DO j=1-Oly,sNy+Oly       O            af, myThid )
341         DO i=1-Olx,sNx+Olx          ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
342          fMer(i,j) = fMer(i,j) + af(i,j)           IF ( inAdMode ) THEN
343         ENDDO  cph This block is to trick the adjoint:
344        ENDDO  cph IF inAdExact=.FALSE., we want to use DST3
345    cph with limiters in forward, but without limiters in reverse.
346              CALL GAD_DST3_ADV_Y( bi,bj,k, dTtracerLev(k),
347         I           vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,
348         O           af, myThid )
349             ELSE
350              CALL GAD_DST3FL_ADV_Y( bi,bj,k, dTtracerLev(k),
351         I           vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,
352         O           af, myThid )
353             ENDIF
354            ELSEIF (advectionScheme.EQ.ENUM_OS7MP ) THEN
355              CALL GAD_OS7MP_ADV_Y( bi,bj,k, dTtracerLev(k),
356         I            vTrans, vFld, maskS(1-Olx,1-Oly,k,bi,bj), locABT,
357         O            af, myThid )
358            ELSE
359              STOP 'GAD_CALC_RHS: Bad advectionScheme (Y)'
360            ENDIF
361            DO j=1-Oly,sNy+Oly
362             DO i=1-Olx,sNx+Olx
363              fMer(i,j) = fMer(i,j) + af(i,j)
364             ENDDO
365            ENDDO
366    #ifdef ALLOW_DIAGNOSTICS
367            IF ( useDiagnostics ) THEN
368              diagName = 'ADVy'//diagSufx
369              CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)
370            ENDIF
371    #endif
372        ENDIF        ENDIF
373    
374  C-    Diffusive flux in Y  C-    Diffusive flux in Y
# Line 280  C-    Diffusive flux in Y Line 382  C-    Diffusive flux in Y
382         ENDDO         ENDDO
383        ENDIF        ENDIF
384    
385    C-    Add bi-harmonic flux in Y
386          IF (diffK4 .NE. 0.) THEN
387           CALL GAD_BIHARM_Y(bi,bj,k,yA,df4,diffK4,df,myThid)
388          ENDIF
389    
390  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
391  C-    GM/Redi flux in Y  C-    GM/Redi flux in Y
392        IF (useGMRedi) THEN        IF (useGMRedi) THEN
393  C *note* should update GMREDI_YTRANSPORT to use localT and set df  *aja*  C *note* should update GMREDI_YTRANSPORT to set df  *aja*
394         CALL GMREDI_YTRANSPORT(          IF ( applyAB_onTracer ) THEN
395       I     iMin,iMax,jMin,jMax,bi,bj,K,            CALL GMREDI_YTRANSPORT(
396       I     yA,Tracer,tracerIdentity,       I         iMin,iMax,jMin,jMax,bi,bj,k,
397       U     df,       I         yA,TracerN,tracerIdentity,
398       I     myThid)       U         df,
399         I         myThid)
400            ELSE
401              CALL GMREDI_YTRANSPORT(
402         I         iMin,iMax,jMin,jMax,bi,bj,k,
403         I         yA,TracAB, tracerIdentity,
404         U         df,
405         I         myThid)
406            ENDIF
407        ENDIF        ENDIF
408  #endif  #endif
409    C     anelastic: advect.fluxes are scaled by rhoFac but hor.diff. flx are not
410        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
411         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx
412          fMer(i,j) = fMer(i,j) + df(i,j)          fMer(i,j) = fMer(i,j) + df(i,j)*rhoFacC(k)
413         ENDDO         ENDDO
414        ENDDO        ENDDO
415    
416  C-    Bi-harmonic flux in Y  #ifdef ALLOW_DIAGNOSTICS
417        IF (diffK4 .NE. 0.) THEN  C-    Diagnostics of Tracer flux in Y dir (mainly Diffusive terms),
418         CALL GAD_BIHARM_Y(bi,bj,k,yA,df4,diffK4,df,myThid)  C       excluding advective terms:
419         DO j=1-Oly,sNy+Oly        IF ( useDiagnostics .AND.
420          DO i=1-Olx,sNx+Olx       &    (diffKh.NE.0. .OR. diffK4 .NE.0. .OR. useGMRedi) ) THEN
421           fMer(i,j) = fMer(i,j) + df(i,j)            diagName = 'DFyE'//diagSufx
422          ENDDO            CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)
        ENDDO  
423        ENDIF        ENDIF
424    #endif
425    
426  C--   Compute vertical flux fVerT(kUp) at interface k (between k-1 & k):  C--   Compute vertical flux fVerT(kUp) at interface k (between k-1 & k):
427  C-    Advective flux in R  C-    Advective flux in R
428        IF (calcAdvection .AND. .NOT.implicitAdvection .AND. K.GE.2) THEN  #ifdef ALLOW_AIM
429    C- a hack to prevent Water-Vapor vert.transport into the stratospheric level Nr
430          IF (calcAdvection .AND. .NOT.implicitAdvection .AND. k.GE.2 .AND.
431         &     (.NOT.useAIM .OR.tracerIdentity.NE.GAD_SALINITY .OR.k.LT.Nr)
432         &   ) THEN
433    #else
434          IF (calcAdvection .AND. .NOT.implicitAdvection .AND. k.GE.2) THEN
435    #endif
436  C-    Compute vertical advective flux in the interior:  C-    Compute vertical advective flux in the interior:
437         IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN          IF (vertAdvecScheme.EQ.ENUM_CENTERED_2ND) THEN
438          CALL GAD_C2_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)            CALL GAD_C2_ADV_R(bi,bj,k,rTrans,TracAB,af,myThid)
439         ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN          ELSEIF ( vertAdvecScheme.EQ.ENUM_UPWIND_1RST
440          CALL GAD_FLUXLIMIT_ADV_R(       &          .OR. vertAdvecScheme.EQ.ENUM_DST2 ) THEN
441       &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)            CALL GAD_DST2U1_ADV_R( bi,bj,k, vertAdvecScheme,
442         ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN       I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
443          CALL GAD_U3_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)       O         af, myThid )
444         ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN          ELSEIF (vertAdvecScheme.EQ.ENUM_FLUX_LIMIT) THEN
445          CALL GAD_C4_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)            CALL GAD_FLUXLIMIT_ADV_R( bi,bj,k,
446         ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN       I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
447          CALL GAD_DST3_ADV_R(       O         af, myThid )
448       &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)          ELSEIF (vertAdvecScheme.EQ.ENUM_UPWIND_3RD ) THEN
449         ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN            CALL GAD_U3_ADV_R(bi,bj,k,rTrans,TracAB,af,myThid)
450          CALL GAD_DST3FL_ADV_R(          ELSEIF (vertAdvecScheme.EQ.ENUM_CENTERED_4TH) THEN
451       &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)            CALL GAD_C4_ADV_R(bi,bj,k,rTrans,TracAB,af,myThid)
452         ELSE          ELSEIF (vertAdvecScheme.EQ.ENUM_DST3 ) THEN
453          STOP 'GAD_CALC_RHS: Bad advectionScheme (R)'            CALL GAD_DST3_ADV_R( bi,bj,k,
454         ENDIF       I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
455         O         af, myThid )
456            ELSEIF (vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
457    cph This block is to trick the adjoint:
458    cph IF inAdExact=.FALSE., we want to use DST3
459    cph with limiters in forward, but without limiters in reverse.
460              IF ( inAdMode ) THEN
461               CALL GAD_DST3_ADV_R( bi,bj,k,
462         I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
463         O         af, myThid )
464              ELSE
465               CALL GAD_DST3FL_ADV_R( bi,bj,k,
466         I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
467         O         af, myThid )
468              ENDIF
469            ELSEIF (vertAdvecScheme.EQ.ENUM_OS7MP ) THEN
470               CALL GAD_OS7MP_ADV_R( bi,bj,k,
471         I         dTtracerLev(k),rTrans,wFld,TracAB(1-Olx,1-Oly,1,bi,bj),
472         O         af, myThid )
473            ELSE
474              STOP 'GAD_CALC_RHS: Bad vertAdvecScheme (R)'
475            ENDIF
476  C-     add the advective flux to fVerT  C-     add the advective flux to fVerT
477         DO j=1-Oly,sNy+Oly          DO j=1-Oly,sNy+Oly
478          DO i=1-Olx,sNx+Olx           DO i=1-Olx,sNx+Olx
479           fVerT(i,j,kUp) = fVerT(i,j,kUp) + af(i,j)            fVerT(i,j,kUp) = fVerT(i,j,kUp) + af(i,j)
480             ENDDO
481          ENDDO          ENDDO
482         ENDDO  #ifdef ALLOW_DIAGNOSTICS
483            IF ( useDiagnostics ) THEN
484              diagName = 'ADVr'//diagSufx
485              CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)
486    C- note: needs to explicitly increment the counter since DIAGNOSTICS_FILL
487    C        does it only if k=1 (never the case here)
488              IF ( k.EQ.2 ) CALL DIAGNOSTICS_COUNT(diagName,bi,bj,myThid)
489            ENDIF
490    #endif
491        ENDIF        ENDIF
492    
493  C-    Diffusive flux in R  C-    Diffusive flux in R
# Line 347  C           boundary condition. Line 500  C           boundary condition.
500          ENDDO          ENDDO
501         ENDDO         ENDDO
502        ELSE        ELSE
503         CALL GAD_DIFF_R(bi,bj,k,KappaRT,tracer,df,myThid)         IF ( applyAB_onTracer ) THEN
504             CALL GAD_DIFF_R(bi,bj,k,KappaR,TracerN,df,myThid)
505           ELSE
506             CALL GAD_DIFF_R(bi,bj,k,KappaR,TracAB, df,myThid)
507           ENDIF
508        ENDIF        ENDIF
509    
510  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
511  C-    GM/Redi flux in R  C-    GM/Redi flux in R
512        IF (useGMRedi) THEN        IF (useGMRedi) THEN
513  C *note* should update GMREDI_RTRANSPORT to set df  *aja*  C *note* should update GMREDI_RTRANSPORT to set df  *aja*
514         CALL GMREDI_RTRANSPORT(          IF ( applyAB_onTracer ) THEN
515       I     iMin,iMax,jMin,jMax,bi,bj,K,            CALL GMREDI_RTRANSPORT(
516       I     Tracer,tracerIdentity,       I         iMin,iMax,jMin,jMax,bi,bj,k,
517       U     df,       I         TracerN,tracerIdentity,
518       I     myThid)       U         df,
519         I         myThid)
520            ELSE
521              CALL GMREDI_RTRANSPORT(
522         I         iMin,iMax,jMin,jMax,bi,bj,k,
523         I         TracAB, tracerIdentity,
524         U         df,
525         I         myThid)
526            ENDIF
527        ENDIF        ENDIF
528  #endif  #endif
529    
# Line 368  C *note* should update GMREDI_RTRANSPORT Line 533  C *note* should update GMREDI_RTRANSPORT
533         ENDDO         ENDDO
534        ENDDO        ENDDO
535    
536    #ifdef ALLOW_DIAGNOSTICS
537    C-    Diagnostics of Tracer flux in R dir (mainly Diffusive terms),
538    C       Explicit terms only & excluding advective terms:
539          IF ( useDiagnostics .AND.
540         &    (.NOT.implicitDiffusion .OR. useGMRedi) ) THEN
541              diagName = 'DFrE'//diagSufx
542              CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)
543          ENDIF
544    #endif
545    
546  #ifdef ALLOW_KPP  #ifdef ALLOW_KPP
547  C-    Add non local KPP transport term (ghat) to diffusive T flux.  C-    Set non local KPP transport term (ghat):
548        IF (useKPP) THEN        IF ( useKPP .AND. k.GE.2 ) THEN
549         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
550          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
551           df(i,j) = 0. _d 0           df(i,j) = 0. _d 0
552          ENDDO          ENDDO
553         ENDDO         ENDDO
554         IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN         IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
 C *note* should update KPP_TRANSPORT_T to set df  *aja*  
555          CALL KPP_TRANSPORT_T(          CALL KPP_TRANSPORT_T(
556       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,
557       I     KappaRT,       O     df )
      U     df )  
558         ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN         ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
559          CALL KPP_TRANSPORT_S(          CALL KPP_TRANSPORT_S(
560       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,
561       I     KappaRT,       O     df )
      U     df )  
562  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
563         ELSEIF (tracerIdentity .GE. GAD_TR1) THEN         ELSEIF (tracerIdentity .GE. GAD_TR1) THEN
564          CALL KPP_TRANSPORT_PTR(          CALL KPP_TRANSPORT_PTR(
565       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,
566       I     tracerIdentity-GAD_TR1+1,KappaRT,       I     tracerIdentity-GAD_TR1+1,
567       U     df )       O     df )
568  #endif  #endif
569         ELSE         ELSE
570          PRINT*,'invalid tracer indentity: ', tracerIdentity          PRINT*,'invalid tracer indentity: ', tracerIdentity
# Line 400  C *note* should update KPP_TRANSPORT_T t Line 572  C *note* should update KPP_TRANSPORT_T t
572         ENDIF         ENDIF
573         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
574          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
575           fVerT(i,j,kUp) = fVerT(i,j,kUp) + df(i,j)*maskUp(i,j)           fVerT(i,j,kUp) = fVerT(i,j,kUp)
576         &                  + df(i,j)*maskUp(i,j)*rhoFacF(k)
577          ENDDO          ENDDO
578         ENDDO         ENDDO
579        ENDIF        ENDIF
580  #endif  #endif
581    
582  C--   Divergence of fluxes  C--   Divergence of fluxes
583    C     Anelastic: scale vertical fluxes by rhoFac and leave Horizontal fluxes unchanged
584        DO j=1-Oly,sNy+Oly-1        DO j=1-Oly,sNy+Oly-1
585         DO i=1-Olx,sNx+Olx-1         DO i=1-Olx,sNx+Olx-1
586          gTracer(i,j,k,bi,bj)=gTracer(i,j,k,bi,bj)          gTracer(i,j,k,bi,bj)=gTracer(i,j,k,bi,bj)
587       &   -_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)*recip_rA(i,j,bi,bj)       &   -_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
588         &   *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)*recip_rhoFacC(k)
589       &   *( (fZon(i+1,j)-fZon(i,j))       &   *( (fZon(i+1,j)-fZon(i,j))
590       &     +(fMer(i,j+1)-fMer(i,j))       &     +(fMer(i,j+1)-fMer(i,j))
591       &     +(fVerT(i,j,kUp)-fVerT(i,j,kDown))*rkFac       &     +(fVerT(i,j,kDown)-fVerT(i,j,kUp))*rkSign
592       &     -localT(i,j)*( (uTrans(i+1,j)-uTrans(i,j))       &     -localT(i,j)*( (uTrans(i+1,j)-uTrans(i,j))
593       &                   +(vTrans(i,j+1)-vTrans(i,j))       &                   +(vTrans(i,j+1)-vTrans(i,j))
594       &                   +(rTrans(i,j)-rTransKp1(i,j))*rAdvFac       &                   +(rTransKp1(i,j)-rTrans(i,j))*rAdvFac
595       &                  )*advFac       &                  )*advFac
596       &    )       &    )
597         ENDDO         ENDDO
598        ENDDO        ENDDO
599    
600    #ifdef ALLOW_DEBUG
601          IF ( debugLevel .GE. debLevB
602         &   .AND. tracerIdentity.EQ.GAD_TEMPERATURE
603         &   .AND. k.EQ.2 .AND. myIter.EQ.1+nIter0
604         &   .AND. nPx.EQ.1 .AND. nPy.EQ.1
605         &   .AND. useCubedSphereExchange ) THEN
606            CALL DEBUG_CS_CORNER_UV( ' fZon,fMer from GAD_CALC_RHS',
607         &             fZon,fMer, k, standardMessageUnit,bi,bj,myThid )
608          ENDIF
609    #endif /* ALLOW_DEBUG */
610    
611        RETURN        RETURN
612        END        END
Legend:
Removed from v.1.24  
changed lines
  Added in v.1.44
  ViewVC Help
Powered by ViewVC 1.1.22