/[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.8 by adcroft, Mon Sep 10 01:22:48 2001 UTC revision 1.36 by jmc, Wed Jun 22 00:27:47 2005 UTC
# Line 3  C $Name$ Line 3  C $Name$
3    
4  #include "GAD_OPTIONS.h"  #include "GAD_OPTIONS.h"
5    
6    CBOP
7    C !ROUTINE: GAD_CALC_RHS
8    
9    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,uTrans,vTrans,rTrans,rTransKp1,maskUp,
13       I           diffKh, diffK4, KappaRT, Tracer,       I           uVel, vVel, wVel,
14       I           tracerIdentity, advectionScheme,       I           diffKh, diffK4, KappaR, Tracer,
15         I           tracerIdentity, advectionScheme, vertAdvecScheme,
16         I           calcAdvection, implicitAdvection,
17       U           fVerT, gTracer,       U           fVerT, gTracer,
18       I           myThid )       I           myTime, myIter, myThid )
19  C     /==========================================================\  
20  C     | SUBROUTINE GAD_CALC_RHS                                  |  C !DESCRIPTION:
21  C     |==========================================================|  C Calculates the tendancy of a tracer due to advection and diffusion.
22  C     \==========================================================/  C It calculates the fluxes in each direction indepentently and then
23        IMPLICIT NONE  C sets the tendancy 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 tendancy 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 tendancy is assumed to contain data on entry.
38    
39  C     == GLobal variables ==  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 kup              :: index into 2 1/2D array, toggles between 1|2
58    C kdown            :: index into 2 1/2D array, toggles between 2|1
59    C kp1              :: =k+1 for k<Nr, =Nr for k=Nr
60    C xA,yA            :: areas of X and Y face of tracer cells
61    C uTrans,vTrans    :: 2-D arrays of volume transports at U,V points
62    C rTrans           :: 2-D arrays of volume transports at W points
63    C rTransKp1        :: 2-D array of volume trans at W pts, interf k+1
64    C maskUp           :: 2-D array for mask at W points
65    C uVel,vVel,wVel   :: 3 components of the velcity field (3-D array)
66    C diffKh           :: horizontal diffusion coefficient
67    C diffK4           :: bi-harmonic diffusion coefficient
68    C KappaR           :: 2-D array for vertical diffusion coefficient, interf k
69    C Tracer           :: tracer field
70    C tracerIdentity   :: tracer identifier (required for KPP,GM)
71    C advectionScheme  :: advection scheme to use (Horizontal plane)
72    C vertAdvecScheme  :: advection scheme to use (Vertical direction)
73    C calcAdvection    :: =False if Advec computed with multiDim scheme
74    C implicitAdvection:: =True if vertical Advec computed implicitly
75    C myTime           :: current time
76    C myIter           :: iteration number
77    C myThid           :: thread number
78        INTEGER bi,bj,iMin,iMax,jMin,jMax        INTEGER bi,bj,iMin,iMax,jMin,jMax
79          INTEGER k,kUp,kDown,kM1
80        _RS xA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS xA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
81        _RS yA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS yA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
82        _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
83        _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
84        _RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
85          _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
86        _RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
87          _RL uVel  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
88          _RL vVel  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
89          _RL wVel  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
90        _RL diffKh, diffK4        _RL diffKh, diffK4
91        _RL KappaRT(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaR(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
92        _RL Tracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)        _RL Tracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
93        INTEGER tracerIdentity        INTEGER tracerIdentity
94        INTEGER advectionScheme        INTEGER advectionScheme, vertAdvecScheme
95        _RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        LOGICAL calcAdvection
96          LOGICAL implicitAdvection
97          _RL     myTime
98          INTEGER myIter, myThid
99    
100    C !OUTPUT PARAMETERS: ==================================================
101    C gTracer          :: tendancy array
102    C fVerT            :: 2 1/2D arrays for vertical advective flux
103        _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)
104        INTEGER myThid        _RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
105    
106  C     == Local variables ==  C !LOCAL VARIABLES: ====================================================
107  C     I, J, K - Loop counters  C i,j              :: loop indices
108    C df4              :: used for storing del^2 T for bi-harmonic term
109    C fZon             :: zonal flux
110    C fMer             :: meridional flux
111    C af               :: advective flux
112    C df               :: diffusive flux
113    C localT           :: local copy of tracer field
114    #ifdef ALLOW_DIAGNOSTICS
115          CHARACTER*8 diagName
116          CHARACTER*4 GAD_DIAG_SUFX, diagSufx
117          EXTERNAL    GAD_DIAG_SUFX
118    #endif
119        INTEGER i,j        INTEGER i,j
       LOGICAL TOP_LAYER  
       _RL afFacT, dfFacT  
120        _RL df4   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL df4   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
121        _RL fZon  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL fZon  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
122        _RL fMer  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL fMer  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
123        _RL af    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL af    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
124        _RL df    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL df    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
125        _RL localT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL localT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
126          _RL advFac, rAdvFac
127    CEOP
128    
129  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
130  C--   only the kUp part of fverT is set in this subroutine  C--   only the kUp part of fverT is set in this subroutine
131  C--   the kDown is still required  C--   the kDown is still required
132        fVerT(1,1,kDown) = fVerT(1,1,kDown)        fVerT(1,1,kDown) = fVerT(1,1,kDown)
133  #endif  #endif
134    
135    #ifdef ALLOW_DIAGNOSTICS
136    C--   Set diagnostic suffix for the current tracer
137          IF ( useDiagnostics ) THEN
138            diagSufx = GAD_DIAG_SUFX( tracerIdentity, myThid )
139          ENDIF
140    #endif
141    
142          advFac  = 0. _d 0
143          IF (calcAdvection) advFac = 1. _d 0
144          rAdvFac = rkSign*advFac
145          IF (implicitAdvection) rAdvFac = 0. _d 0
146    
147        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
148         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
149          fZon(i,j)      = 0.0          fZon(i,j)      = 0. _d 0
150          fMer(i,j)      = 0.0          fMer(i,j)      = 0. _d 0
151          fVerT(i,j,kUp) = 0.0          fVerT(i,j,kUp) = 0. _d 0
152            df(i,j)        = 0. _d 0
153            df4(i,j)       = 0. _d 0
154         ENDDO         ENDDO
155        ENDDO        ENDDO
156    
       afFacT = 1. _d 0  
       dfFacT = 1. _d 0  
       TOP_LAYER = K .EQ. 1  
   
157  C--   Make local copy of tracer array  C--   Make local copy of tracer array
158        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
159         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
# Line 80  C--   Make local copy of tracer array Line 163  C--   Make local copy of tracer array
163    
164  C--   Unless we have already calculated the advection terms we initialize  C--   Unless we have already calculated the advection terms we initialize
165  C     the tendency to zero.  C     the tendency to zero.
166        IF (.NOT. multiDimAdvection .OR.  C     <== now done earlier at the beginning of thermodynamics.
167       &    advectionScheme.EQ.ENUM_CENTERED_2ND .OR.  c     IF (calcAdvection) THEN
168       &    advectionScheme.EQ.ENUM_UPWIND_3RD .OR.  c      DO j=1-Oly,sNy+Oly
169       &    advectionScheme.EQ.ENUM_CENTERED_4TH ) THEN  c       DO i=1-Olx,sNx+Olx
170         DO j=1-Oly,sNy+Oly  c        gTracer(i,j,k,bi,bj)=0. _d 0
171          DO i=1-Olx,sNx+Olx  c       ENDDO
172           gTracer(i,j,k,bi,bj)=0.  c      ENDDO
173          ENDDO  c     ENDIF
        ENDDO  
       ENDIF  
174    
175  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
176        IF (diffK4 .NE. 0.) THEN        IF (diffK4 .NE. 0.) THEN
# Line 101  C--   Pre-calculate del^2 T if bi-harmon Line 182  C--   Pre-calculate del^2 T if bi-harmon
182  C--   Initialize net flux in X direction  C--   Initialize net flux in X direction
183        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
184         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx
185          fZon(i,j) = 0.          fZon(i,j) = 0. _d 0
186         ENDDO         ENDDO
187        ENDDO        ENDDO
188    
189  C-    Advective flux in X  C-    Advective flux in X
190        IF (.NOT. multiDimAdvection .OR.        IF (calcAdvection) THEN
191       &    advectionScheme.EQ.ENUM_CENTERED_2ND .OR.          IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
192       &    advectionScheme.EQ.ENUM_UPWIND_3RD .OR.            CALL GAD_C2_ADV_X(bi,bj,k,uTrans,localT,af,myThid)
193       &    advectionScheme.EQ.ENUM_CENTERED_4TH ) THEN          ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
194        IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN            CALL GAD_FLUXLIMIT_ADV_X( bi,bj,k, dTtracerLev(k),
195         CALL GAD_C2_ADV_X(bi,bj,k,uTrans,localT,af,myThid)       I            uTrans, uVel, maskW(1-Olx,1-Oly,k,bi,bj), localT,
196        ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN       O            af, myThid )
197         CALL GAD_FLUXLIMIT_ADV_X(          ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
198       &      bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)            CALL GAD_U3_ADV_X(bi,bj,k,uTrans,localT,af,myThid)
199        ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN          ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
200         CALL GAD_U3_ADV_X(bi,bj,k,uTrans,localT,af,myThid)            CALL GAD_C4_ADV_X(bi,bj,k,uTrans,localT,af,myThid)
201        ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
202         CALL GAD_C4_ADV_X(bi,bj,k,uTrans,localT,af,myThid)            CALL GAD_DST3_ADV_X( bi,bj,k, dTtracerLev(k),
203        ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN       I            uTrans, uVel, maskW(1-Olx,1-Oly,k,bi,bj), localT,
204         CALL GAD_DST3_ADV_X(       O            af, myThid )
205       &       bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
206        ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN           IF ( inAdMode ) THEN
207         CALL GAD_DST3FL_ADV_X(  cph This block is to trick the adjoint:
208       &       bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)  cph IF inAdExact=.FALSE., we want to use DST3
209        ELSE  cph with limiters in forward, but without limiters in reverse.
210         STOP 'GAD_CALC_RHS: Bad advectionScheme (X)'            CALL GAD_DST3_ADV_X( bi,bj,k, dTtracerLev(k),
211        ENDIF       I           uTrans, uVel, maskW(1-Olx,1-Oly,k,bi,bj), localT,
212        DO j=1-Oly,sNy+Oly       O           af, myThid )
213         DO i=1-Olx,sNx+Olx           ELSE
214          fZon(i,j) = fZon(i,j) + af(i,j)            CALL GAD_DST3FL_ADV_X( bi,bj,k, dTtracerLev(k),
215         ENDDO       I           uTrans, uVel, maskW(1-Olx,1-Oly,k,bi,bj), localT,
216        ENDDO       O           af, myThid )
217             ENDIF
218            ELSE
219             STOP 'GAD_CALC_RHS: Bad advectionScheme (X)'
220            ENDIF
221            DO j=1-Oly,sNy+Oly
222             DO i=1-Olx,sNx+Olx
223              fZon(i,j) = fZon(i,j) + af(i,j)
224             ENDDO
225            ENDDO
226    #ifdef ALLOW_DIAGNOSTICS
227            IF ( useDiagnostics ) THEN
228              diagName = 'ADVx'//diagSufx
229              CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)
230            ENDIF
231    #endif
232        ENDIF        ENDIF
233    
234  C-    Diffusive flux in X  C-    Diffusive flux in X
# Line 141  C-    Diffusive flux in X Line 237  C-    Diffusive flux in X
237        ELSE        ELSE
238         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
239          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
240           df(i,j) = 0.           df(i,j) = 0. _d 0
241          ENDDO          ENDDO
242         ENDDO         ENDDO
243        ENDIF        ENDIF
244    
245    C-    Add bi-harmonic diffusive flux in X
246          IF (diffK4 .NE. 0.) THEN
247           CALL GAD_BIHARM_X(bi,bj,k,xA,df4,diffK4,df,myThid)
248          ENDIF
249    
250  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
251  C-    GM/Redi flux in X  C-    GM/Redi flux in X
252        IF (useGMRedi) THEN        IF (useGMRedi) THEN
253  C *note* should update GMREDI_XTRANSPORT to use localT and set df  *aja*  C *note* should update GMREDI_XTRANSPORT to use localT and set df  *aja*
254          CALL GMREDI_XTRANSPORT(          CALL GMREDI_XTRANSPORT(
255       I     iMin,iMax,jMin,jMax,bi,bj,K,       I     iMin,iMax,jMin,jMax,bi,bj,K,
256       I     xA,Tracer,       I     xA,Tracer,tracerIdentity,
257       U     df,       U     df,
258       I     myThid)       I     myThid)
259        ENDIF        ENDIF
# Line 163  C *note* should update GMREDI_XTRANSPORT Line 264  C *note* should update GMREDI_XTRANSPORT
264         ENDDO         ENDDO
265        ENDDO        ENDDO
266    
267  C-    Bi-harmonic duffusive flux in X  #ifdef ALLOW_DIAGNOSTICS
268        IF (diffK4 .NE. 0.) THEN  C-    Diagnostics of Tracer flux in X dir (mainly Diffusive term),
269         CALL GAD_BIHARM_X(bi,bj,k,xA,df4,diffK4,df,myThid)  C       excluding advective terms:
270         DO j=1-Oly,sNy+Oly        IF ( useDiagnostics .AND.
271          DO i=1-Olx,sNx+Olx       &    (diffKh.NE.0. .OR. diffK4 .NE.0. .OR. useGMRedi) ) THEN
272           fZon(i,j) = fZon(i,j) + df(i,j)            diagName = 'DIFx'//diagSufx
273          ENDDO            CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)
        ENDDO  
274        ENDIF        ENDIF
275    #endif
276    
277  C--   Initialize net flux in Y direction  C--   Initialize net flux in Y direction
278        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
279         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx
280          fMer(i,j) = 0.          fMer(i,j) = 0. _d 0
281         ENDDO         ENDDO
282        ENDDO        ENDDO
283    
284  C-    Advective flux in Y  C-    Advective flux in Y
285        IF (.NOT. multiDimAdvection .OR.        IF (calcAdvection) THEN
286       &    advectionScheme.EQ.ENUM_CENTERED_2ND .OR.          IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
287       &    advectionScheme.EQ.ENUM_UPWIND_3RD .OR.            CALL GAD_C2_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)
288       &    advectionScheme.EQ.ENUM_CENTERED_4TH ) THEN          ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
289        IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN            CALL GAD_FLUXLIMIT_ADV_Y( bi,bj,k, dTtracerLev(k),
290         CALL GAD_C2_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)       I            vTrans, vVel, maskS(1-Olx,1-Oly,k,bi,bj), localT,
291        ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN       O            af, myThid )
292         CALL GAD_FLUXLIMIT_ADV_Y(          ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
293       &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)            CALL GAD_U3_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)
294        ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN          ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
295         CALL GAD_U3_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)            CALL GAD_C4_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)
296        ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
297         CALL GAD_C4_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)            CALL GAD_DST3_ADV_Y( bi,bj,k, dTtracerLev(k),
298        ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN       I            vTrans, vVel, maskS(1-Olx,1-Oly,k,bi,bj), localT,
299         CALL GAD_DST3_ADV_Y(       O            af, myThid )
300       &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
301        ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN           IF ( inAdMode ) THEN
302         CALL GAD_DST3FL_ADV_Y(  cph This block is to trick the adjoint:
303       &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)  cph IF inAdExact=.FALSE., we want to use DST3
304        ELSE  cph with limiters in forward, but without limiters in reverse.
305         STOP 'GAD_CALC_RHS: Bad advectionScheme (Y)'            CALL GAD_DST3_ADV_Y( bi,bj,k, dTtracerLev(k),
306        ENDIF       I           vTrans, vVel, maskS(1-Olx,1-Oly,k,bi,bj), localT,
307        DO j=1-Oly,sNy+Oly       O           af, myThid )
308         DO i=1-Olx,sNx+Olx           ELSE
309          fMer(i,j) = fMer(i,j) + af(i,j)            CALL GAD_DST3FL_ADV_Y( bi,bj,k, dTtracerLev(k),
310         ENDDO       I           vTrans, vVel, maskS(1-Olx,1-Oly,k,bi,bj), localT,
311        ENDDO       O           af, myThid )
312             ENDIF
313            ELSE
314              STOP 'GAD_CALC_RHS: Bad advectionScheme (Y)'
315            ENDIF
316            DO j=1-Oly,sNy+Oly
317             DO i=1-Olx,sNx+Olx
318              fMer(i,j) = fMer(i,j) + af(i,j)
319             ENDDO
320            ENDDO
321    #ifdef ALLOW_DIAGNOSTICS
322            IF ( useDiagnostics ) THEN
323              diagName = 'ADVy'//diagSufx
324              CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)
325            ENDIF
326    #endif
327        ENDIF        ENDIF
328    
329  C-    Diffusive flux in Y  C-    Diffusive flux in Y
# Line 216  C-    Diffusive flux in Y Line 332  C-    Diffusive flux in Y
332        ELSE        ELSE
333         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
334          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
335           df(i,j) = 0.           df(i,j) = 0. _d 0
336          ENDDO          ENDDO
337         ENDDO         ENDDO
338        ENDIF        ENDIF
339    
340    C-    Add bi-harmonic flux in Y
341          IF (diffK4 .NE. 0.) THEN
342           CALL GAD_BIHARM_Y(bi,bj,k,yA,df4,diffK4,df,myThid)
343          ENDIF
344    
345  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
346  C-    GM/Redi flux in Y  C-    GM/Redi flux in Y
347        IF (useGMRedi) THEN        IF (useGMRedi) THEN
348  C *note* should update GMREDI_YTRANSPORT to use localT and set df  *aja*  C *note* should update GMREDI_YTRANSPORT to use localT and set df  *aja*
349         CALL GMREDI_YTRANSPORT(         CALL GMREDI_YTRANSPORT(
350       I     iMin,iMax,jMin,jMax,bi,bj,K,       I     iMin,iMax,jMin,jMax,bi,bj,K,
351       I     yA,Tracer,       I     yA,Tracer,tracerIdentity,
352       U     df,       U     df,
353       I     myThid)       I     myThid)
354        ENDIF        ENDIF
# Line 238  C *note* should update GMREDI_YTRANSPORT Line 359  C *note* should update GMREDI_YTRANSPORT
359         ENDDO         ENDDO
360        ENDDO        ENDDO
361    
362  C-    Bi-harmonic flux in Y  #ifdef ALLOW_DIAGNOSTICS
363        IF (diffK4 .NE. 0.) THEN  C-    Diagnostics of Tracer flux in Y dir (mainly Diffusive terms),
364         CALL GAD_BIHARM_Y(bi,bj,k,yA,df4,diffK4,df,myThid)  C       excluding advective terms:
365         DO j=1-Oly,sNy+Oly        IF ( useDiagnostics .AND.
366          DO i=1-Olx,sNx+Olx       &    (diffKh.NE.0. .OR. diffK4 .NE.0. .OR. useGMRedi) ) THEN
367           fMer(i,j) = fMer(i,j) + df(i,j)            diagName = 'DIFy'//diagSufx
368          ENDDO            CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)
        ENDDO  
369        ENDIF        ENDIF
370    #endif
371    
372  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  
   
373  C-    Advective flux in R  C-    Advective flux in R
374        IF (.NOT. multiDimAdvection .OR.  #ifdef ALLOW_AIM
375       &    advectionScheme.EQ.ENUM_CENTERED_2ND .OR.  C- a hack to prevent Water-Vapor vert.transport into the stratospheric level Nr
376       &    advectionScheme.EQ.ENUM_UPWIND_3RD .OR.        IF (calcAdvection .AND. .NOT.implicitAdvection .AND. K.GE.2 .AND.
377       &    advectionScheme.EQ.ENUM_CENTERED_4TH ) THEN       &     (.NOT.useAIM .OR.tracerIdentity.NE.GAD_SALINITY .OR.K.LT.Nr)
378  C     Note: wVel needs to be masked       &   ) THEN
379        IF (K.GE.2) THEN  #else
380          IF (calcAdvection .AND. .NOT.implicitAdvection .AND. K.GE.2) THEN
381    #endif
382  C-    Compute vertical advective flux in the interior:  C-    Compute vertical advective flux in the interior:
383         IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN          IF (vertAdvecScheme.EQ.ENUM_CENTERED_2ND) THEN
384          CALL GAD_C2_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)            CALL GAD_C2_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)
385         ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN          ELSEIF (vertAdvecScheme.EQ.ENUM_FLUX_LIMIT) THEN
386          CALL GAD_FLUXLIMIT_ADV_R(            CALL GAD_FLUXLIMIT_ADV_R(
387       &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)       &         bi,bj,k,dTtracerLev(k),rTrans,wVel,tracer,af,myThid)
388         ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN          ELSEIF (vertAdvecScheme.EQ.ENUM_UPWIND_3RD ) THEN
389          CALL GAD_U3_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)            CALL GAD_U3_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)
390         ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN          ELSEIF (vertAdvecScheme.EQ.ENUM_CENTERED_4TH) THEN
391          CALL GAD_C4_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)            CALL GAD_C4_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)
392         ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN          ELSEIF (vertAdvecScheme.EQ.ENUM_DST3 ) THEN
393  c       CALL GAD_DST3_ADV_R(            CALL GAD_DST3_ADV_R(
394  c    &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)       &         bi,bj,k,dTtracerLev(k),rTrans,wVel,tracer,af,myThid)
395          STOP 'GAD_CALC_RHS: GAD_DST3_ADV_R not coded yet'          ELSEIF (vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
396         ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN  cph This block is to trick the adjoint:
397  c       CALL GAD_DST3FL_ADV_R(  cph IF inAdExact=.FALSE., we want to use DST3
398  c    &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)  cph with limiters in forward, but without limiters in reverse.
399          STOP 'GAD_CALC_RHS: GAD_DST3FL_ADV_R not coded yet'            IF ( inAdMode ) THEN
400         ELSE             CALL GAD_DST3_ADV_R(
401          STOP 'GAD_CALC_RHS: Bad advectionScheme (R)'       &        bi,bj,k,dTtracerLev(k),rTrans,wVel,tracer,af,myThid)
402         ENDIF            ELSE
403  C-    Surface "correction" term at k>1 :             CALL GAD_DST3FL_ADV_R(
404         DO j=1-Oly,sNy+Oly       &        bi,bj,k,dTtracerLev(k),rTrans,wVel,tracer,af,myThid)
405          DO i=1-Olx,sNx+Olx            ENDIF
406           af(i,j) = af(i,j)          ELSE
407       &           + (maskC(i,j,k,bi,bj)-maskC(i,j,k-1,bi,bj))*            STOP 'GAD_CALC_RHS: Bad vertAdvecScheme (R)'
408       &             rTrans(i,j)*Tracer(i,j,k,bi,bj)          ENDIF
409          ENDDO  C-     add the advective flux to fVerT
410         ENDDO          DO j=1-Oly,sNy+Oly
411        ELSE           DO i=1-Olx,sNx+Olx
412  C-    Surface "correction" term at k=1 :            fVerT(i,j,kUp) = fVerT(i,j,kUp) + af(i,j)
413         DO j=1-Oly,sNy+Oly           ENDDO
         DO i=1-Olx,sNx+Olx  
          af(i,j) = rTrans(i,j)*Tracer(i,j,k,bi,bj)  
414          ENDDO          ENDDO
415         ENDDO  #ifdef ALLOW_DIAGNOSTICS
416        ENDIF          IF ( useDiagnostics ) THEN
417  C-    add the advective flux to fVerT            diagName = 'ADVr'//diagSufx
418        DO j=1-Oly,sNy+Oly            CALL DIAGNOSTICS_FILL(af,diagName, k,1, 2,bi,bj, myThid)
419         DO i=1-Olx,sNx+Olx  C- note: needs to explicitly increment the counter since DIAGNOSTICS_FILL
420          fVerT(i,j,kUp) = fVerT(i,j,kUp) + afFacT*af(i,j)  C        does it only if k=1 (never the case here)
421         ENDDO            IF ( k.EQ.2 ) CALL DIAGNOSTICS_COUNT(diagName,bi,bj,myThid)
422        ENDDO          ENDIF
423    #endif
424        ENDIF        ENDIF
425    
426  C-    Diffusive flux in R  C-    Diffusive flux in R
# Line 313  C           boundary condition. Line 429  C           boundary condition.
429        IF (implicitDiffusion) THEN        IF (implicitDiffusion) THEN
430         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
431          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
432           df(i,j) = 0.           df(i,j) = 0. _d 0
433          ENDDO          ENDDO
434         ENDDO         ENDDO
435        ELSE        ELSE
436         CALL GAD_DIFF_R(bi,bj,k,KappaRT,tracer,df,myThid)         CALL GAD_DIFF_R(bi,bj,k,KappaR,tracer,df,myThid)
437        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  
438    
439  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
440  C-    GM/Redi flux in R  C-    GM/Redi flux in R
# Line 331  C-    GM/Redi flux in R Line 442  C-    GM/Redi flux in R
442  C *note* should update GMREDI_RTRANSPORT to set df  *aja*  C *note* should update GMREDI_RTRANSPORT to set df  *aja*
443         CALL GMREDI_RTRANSPORT(         CALL GMREDI_RTRANSPORT(
444       I     iMin,iMax,jMin,jMax,bi,bj,K,       I     iMin,iMax,jMin,jMax,bi,bj,K,
445       I     Tracer,       I     Tracer,tracerIdentity,
446       U     df,       U     df,
447       I     myThid)       I     myThid)
 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  
448        ENDIF        ENDIF
449  #endif  #endif
450    
451        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
452         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx
453          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)
454         ENDDO         ENDDO
455        ENDDO        ENDDO
456    
457    #ifdef ALLOW_DIAGNOSTICS
458    C-    Diagnostics of Tracer flux in R dir (mainly Diffusive terms),
459    C       Explicit terms only & excluding advective terms:
460          IF ( useDiagnostics .AND.
461         &    (.NOT.implicitDiffusion .OR. useGMRedi) ) THEN
462              diagName = 'DFrE'//diagSufx
463              CALL DIAGNOSTICS_FILL(df,diagName, k,1, 2,bi,bj, myThid)
464          ENDIF
465    #endif
466    
467  #ifdef ALLOW_KPP  #ifdef ALLOW_KPP
468  C-    Add non local KPP transport term (ghat) to diffusive T flux.  C-    Set non local KPP transport term (ghat):
469        IF (useKPP) THEN        IF ( useKPP .AND. k.GE.2 ) THEN
470         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
471          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
472           df(i,j) = 0.           df(i,j) = 0. _d 0
473          ENDDO          ENDDO
474         ENDDO         ENDDO
475         IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN         IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
 C *note* should update KPP_TRANSPORT_T to set df  *aja*  
476          CALL KPP_TRANSPORT_T(          CALL KPP_TRANSPORT_T(
477       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,
478       I     KappaRT,       O     df )
      U     df )  
479         ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN         ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
480          CALL KPP_TRANSPORT_S(          CALL KPP_TRANSPORT_S(
481       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,       I     iMin,iMax,jMin,jMax,bi,bj,k,km1,
482       I     KappaRT,       O     df )
483       U     df )  #ifdef ALLOW_PTRACERS
484           ELSEIF (tracerIdentity .GE. GAD_TR1) THEN
485            CALL KPP_TRANSPORT_PTR(
486         I     iMin,iMax,jMin,jMax,bi,bj,k,km1,
487         I     tracerIdentity-GAD_TR1+1,
488         O     df )
489    #endif
490         ELSE         ELSE
491            PRINT*,'invalid tracer indentity: ', tracerIdentity
492          STOP 'GAD_CALC_RHS: Ooops'          STOP 'GAD_CALC_RHS: Ooops'
493         ENDIF         ENDIF
494         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
495          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
496           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)
497          ENDDO          ENDDO
498         ENDDO         ENDDO
499        ENDIF        ENDIF
500  #endif  #endif
501    
502  C--   Divergence of fluxes  C--   Divergence of fluxes
503        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly-1
504         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx-1
505          gTracer(i,j,k,bi,bj)=gTracer(i,j,k,bi,bj)          gTracer(i,j,k,bi,bj)=gTracer(i,j,k,bi,bj)
506       &   -_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)
507       &    *recip_rA(i,j,bi,bj)       &   *( (fZon(i+1,j)-fZon(i,j))
508       &    *(       &     +(fMer(i,j+1)-fMer(i,j))
509       &    +( fZon(i+1,j)-fZon(i,j) )       &     +(fVerT(i,j,kDown)-fVerT(i,j,kUp))*rkSign
510       &    +( fMer(i,j+1)-fMer(i,j) )       &     -localT(i,j)*( (uTrans(i+1,j)-uTrans(i,j))
511       &    +( fVerT(i,j,kUp)-fVerT(i,j,kDown) )*rkFac       &                   +(vTrans(i,j+1)-vTrans(i,j))
512         &                   +(rTransKp1(i,j)-rTrans(i,j))*rAdvFac
513         &                  )*advFac
514       &    )       &    )
515         ENDDO         ENDDO
516        ENDDO        ENDDO
517    
518    #ifdef ALLOW_DEBUG
519          IF ( debugLevel .GE. debLevB
520         &   .AND. tracerIdentity.EQ.GAD_TEMPERATURE
521         &   .AND. k.EQ.2 .AND. myIter.EQ.1+nIter0
522         &   .AND. nPx.EQ.1 .AND. nPy.EQ.1
523         &   .AND. useCubedSphereExchange ) THEN
524            CALL DEBUG_CS_CORNER_UV( ' fZon,fMer from GAD_CALC_RHS',
525         &             fZon,fMer, k, standardMessageUnit,bi,bj,myThid )
526          ENDIF
527    #endif /* ALLOW_DEBUG */
528    
529        RETURN        RETURN
530        END        END
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.36
  ViewVC Help
Powered by ViewVC 1.1.22