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

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

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

revision 1.17 by jmc, Sat Jan 3 00:46:53 2004 UTC revision 1.47 by jmc, Thu Jan 25 16:59:08 2007 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
 CBOI  
 C !TITLE: pkg/generic\_advdiff  
 C !AUTHORS: adcroft@mit.edu  
 C !INTRODUCTION: Generic Advection Diffusion Package  
 C  
 C Package "generic\_advdiff" provides a common set of routines for calculating  
 C advective/diffusive fluxes for tracers (cell centered quantities on a C-grid).  
 C  
 C Many different advection schemes are available: the standard centered  
 C second order, centered fourth order and upwind biased third order schemes  
 C are known as linear methods and require some stable time-stepping method  
 C such as Adams-Bashforth. Alternatives such as flux-limited schemes are  
 C stable in the forward sense and are best combined with the multi-dimensional  
 C method provided in gad\_advection.  
 C  
 C There are two high-level routines:  
 C  \begin{itemize}  
 C  \item{GAD\_CALC\_RHS} calculates all fluxes at time level "n" and is used  
 C  for the standard linear schemes. This must be used in conjuction with  
 C  Adams-Bashforth time-stepping. Diffusive and parameterized fluxes are  
 C  always calculated here.  
 C  \item{GAD\_ADVECTION} calculates just the advective fluxes using the  
 C  non-linear schemes and can not be used in conjuction with Adams-Bashforth  
 C  time-stepping.  
 C  \end{itemize}  
 CEOI  
   
4  #include "GAD_OPTIONS.h"  #include "GAD_OPTIONS.h"
5    #undef MULTIDIM_OLD_VERSION
6    
7    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
8  CBOP  CBOP
9  C !ROUTINE: GAD_ADVECTION  C !ROUTINE: GAD_ADVECTION
10    
11  C !INTERFACE: ==========================================================  C !INTERFACE: ==========================================================
12        SUBROUTINE GAD_ADVECTION(        SUBROUTINE GAD_ADVECTION(
13       I           implicitAdvection, advectionScheme, tracerIdentity,       I     implicitAdvection, advectionScheme, vertAdvecScheme,
14       I           uVel, vVel, wVel, tracer,       I     tracerIdentity,
15       O           gTracer,       I     uVel, vVel, wVel, tracer,
16       I           bi,bj, myTime,myIter,myThid)       O     gTracer,
17  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|       I     bi,bj, myTime,myIter,myThid)
18    
19  C !DESCRIPTION:  C !DESCRIPTION:
20  C Calculates the tendancy of a tracer due to advection.  C Calculates the tendency of a tracer due to advection.
21  C It uses the multi-dimensional method given in \ref{sect:multiDimAdvection}  C It uses the multi-dimensional method given in \ref{sect:multiDimAdvection}
22  C and can only be used for the non-linear advection schemes such as the  C and can only be used for the non-linear advection schemes such as the
23  C direct-space-time method and flux-limiters.  C direct-space-time method and flux-limiters.
24  C  C
25  C The algorithm is as follows:  C The algorithm is as follows:
26  C \begin{itemize}  C \begin{itemize}
# Line 58  C      - \Delta t \partial_r (w\theta^{( Line 33  C      - \Delta t \partial_r (w\theta^{(
33  C \item{$G_\theta = ( \theta^{(n+3/3)} - \theta^{(n)} )/\Delta t$}  C \item{$G_\theta = ( \theta^{(n+3/3)} - \theta^{(n)} )/\Delta t$}
34  C \end{itemize}  C \end{itemize}
35  C  C
36  C The tendancy (output) is over-written by this routine.  C The tendency (output) is over-written by this routine.
37    
38  C !USES: ===============================================================  C !USES: ===============================================================
39        IMPLICIT NONE        IMPLICIT NONE
# Line 70  C !USES: =============================== Line 45  C !USES: ===============================
45  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
46  # include "tamc.h"  # include "tamc.h"
47  # include "tamc_keys.h"  # include "tamc_keys.h"
48    # ifdef ALLOW_PTRACERS
49    #  include "PTRACERS_SIZE.h"
50    # endif
51  #endif  #endif
52    #ifdef ALLOW_EXCH2
53    #include "W2_EXCH2_TOPOLOGY.h"
54    #include "W2_EXCH2_PARAMS.h"
55    #endif /* ALLOW_EXCH2 */
56    
57  C !INPUT PARAMETERS: ===================================================  C !INPUT PARAMETERS: ===================================================
58  C  implicitAdvection    :: vertical advection treated implicitly (later on)  C  implicitAdvection :: implicit vertical advection (later on)
59  C  advectionScheme      :: advection scheme to use  C  advectionScheme   :: advection scheme to use (Horizontal plane)
60  C  tracerIdentity       :: identifier for the tracer (required only for OBCS)  C  vertAdvecScheme   :: advection scheme to use (vertical direction)
61  C  uVel                 :: velocity, zonal component  C  tracerIdentity    :: tracer identifier (required only for OBCS)
62  C  vVel                 :: velocity, meridional component  C  uVel              :: velocity, zonal component
63  C  wVel                 :: velocity, vertical component  C  vVel              :: velocity, meridional component
64  C  tracer               :: tracer field  C  wVel              :: velocity, vertical component
65  C  bi,bj                :: tile indices  C  tracer            :: tracer field
66  C  myTime               :: current time  C  bi,bj             :: tile indices
67  C  myIter               :: iteration number  C  myTime            :: current time
68  C  myThid               :: thread number  C  myIter            :: iteration number
69    C  myThid            :: thread number
70        LOGICAL implicitAdvection        LOGICAL implicitAdvection
71        INTEGER advectionScheme        INTEGER advectionScheme, vertAdvecScheme
72        INTEGER tracerIdentity        INTEGER tracerIdentity
73        _RL uVel  (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)        _RL uVel  (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
74        _RL vVel  (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)        _RL vVel  (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
# Line 97  C  myThid               :: thread number Line 80  C  myThid               :: thread number
80        INTEGER myThid        INTEGER myThid
81    
82  C !OUTPUT PARAMETERS: ==================================================  C !OUTPUT PARAMETERS: ==================================================
83  C  gTracer              :: tendancy array  C  gTracer           :: tendency array
84        _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)
85    
86  C !LOCAL VARIABLES: ====================================================  C !LOCAL VARIABLES: ====================================================
87  C  maskUp               :: 2-D array for mask at W points  C  maskUp        :: 2-D array for mask at W points
88  C  iMin,iMax,jMin,jMax  :: loop range for called routines  C  maskLocW      :: 2-D array for mask at West points
89  C  i,j,k                :: loop indices  C  maskLocS      :: 2-D array for mask at South points
90  C  kup                  :: index into 2 1/2D array, toggles between 1 and 2  C  iMin,iMax,    :: loop range for called routines
91  C  kdown                :: index into 2 1/2D array, toggles between 2 and 1  C  jMin,jMax     :: loop range for called routines
92  C  kp1                  :: =k+1 for k<Nr, =Nr for k=Nr  C [iMin,iMax]Upd :: loop range to update tracer field
93  C  xA,yA                :: areas of X and Y face of tracer cells  C [jMin,jMax]Upd :: loop range to update tracer field
94  C  uTrans,vTrans,rTrans :: 2-D arrays of volume transports at U,V and W points  C  i,j,k         :: loop indices
95  C  rTransKp1            :: vertical volume transport at interface k+1  C  kUp           :: index into 2 1/2D array, toggles between 1 and 2
96  C  af                   :: 2-D array for horizontal advective flux  C  kDown         :: index into 2 1/2D array, toggles between 2 and 1
97  C  fVerT                :: 2 1/2D arrays for vertical advective flux  C  kp1           :: =k+1 for k<Nr, =Nr for k=Nr
98  C  localTij             :: 2-D array used as temporary local copy of tracer fld  C  xA,yA         :: areas of X and Y face of tracer cells
99  C  localTijk            :: 3-D array used as temporary local copy of tracer fld  C  uFld,vFld     :: 2-D local copy of horizontal velocity, U,V components
100  C  kp1Msk               :: flag (0,1) to act as over-riding mask for W levels  C  wFld          :: 2-D local copy of vertical velocity
101  C  calc_fluxes_X        :: logical to indicate to calculate fluxes in X dir  C  uTrans,vTrans :: 2-D arrays of volume transports at U,V points
102  C  calc_fluxes_Y        :: logical to indicate to calculate fluxes in Y dir  C  rTrans        :: 2-D arrays of volume transports at W points
103  C  nipass               :: number of passes to make in multi-dimensional method  C  rTransKp1     :: vertical volume transport at interface k+1
104  C  ipass                :: number of the current pass being made  C  af            :: 2-D array for horizontal advective flux
105        _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  C  afx           :: 2-D array for horizontal advective flux, x direction
106    C  afy           :: 2-D array for horizontal advective flux, y direction
107    C  fVerT         :: 2 1/2D arrays for vertical advective flux
108    C  localTij      :: 2-D array, temporary local copy of tracer fld
109    C  localTijk     :: 3-D array, temporary local copy of tracer fld
110    C  kp1Msk        :: flag (0,1) for over-riding mask for W levels
111    C  calc_fluxes_X :: logical to indicate to calculate fluxes in X dir
112    C  calc_fluxes_Y :: logical to indicate to calculate fluxes in Y dir
113    C  interiorOnly  :: only update the interior of myTile, but not the edges
114    C  overlapOnly   :: only update the edges of myTile, but not the interior
115    C  nipass        :: number of passes in multi-dimensional method
116    C  ipass         :: number of the current pass being made
117    C  myTile        :: variables used to determine which cube face
118    C  nCFace        :: owns a tile for cube grid runs using
119    C                :: multi-dim advection.
120    C [N,S,E,W]_edge :: true if N,S,E,W edge of myTile is an Edge of the cube
121    c     _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
122          _RS maskLocW(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
123          _RS maskLocS(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
124        INTEGER iMin,iMax,jMin,jMax        INTEGER iMin,iMax,jMin,jMax
125        INTEGER i,j,k,kup,kDown        INTEGER iMinUpd,iMaxUpd,jMinUpd,jMaxUpd
126          INTEGER i,j,k,kUp,kDown
127        _RS xA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS xA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
128        _RS yA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS yA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
129          _RL uFld    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
130          _RL vFld    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
131          _RL wFld    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
132        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
133        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
134        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
135        _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
136        _RL af      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL af      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
137          _RL afx     (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
138          _RL afy     (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
139        _RL fVerT   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerT   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
140        _RL localTij(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL localTij(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
141        _RL localTijk(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL localTijk(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
142        _RL kp1Msk        _RL kp1Msk
143        LOGICAL calc_fluxes_X,calc_fluxes_Y        LOGICAL calc_fluxes_X, calc_fluxes_Y, withSigns
144          LOGICAL interiorOnly, overlapOnly
145        INTEGER nipass,ipass        INTEGER nipass,ipass
146          INTEGER nCFace
147          LOGICAL N_edge, S_edge, E_edge, W_edge
148    #ifdef ALLOW_EXCH2
149          INTEGER myTile
150    #endif
151    #ifdef ALLOW_DIAGNOSTICS
152          CHARACTER*8 diagName
153          CHARACTER*4 GAD_DIAG_SUFX, diagSufx
154          EXTERNAL    GAD_DIAG_SUFX
155    #endif
156  CEOP  CEOP
157    
158  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
# Line 158  CEOP Line 176  CEOP
176            endif            endif
177  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
178    
179    #ifdef ALLOW_DIAGNOSTICS
180    C--   Set diagnostic suffix for the current tracer
181          IF ( useDiagnostics ) THEN
182            diagSufx = GAD_DIAG_SUFX( tracerIdentity, myThid )
183          ENDIF
184    #endif
185    
186  C--   Set up work arrays with valid (i.e. not NaN) values  C--   Set up work arrays with valid (i.e. not NaN) values
187  C     These inital values do not alter the numerical results. They  C     These inital values do not alter the numerical results. They
188  C     just ensure that all memory references are to valid floating  C     just ensure that all memory references are to valid floating
# Line 173  C     uninitialised but inert locations. Line 198  C     uninitialised but inert locations.
198          fVerT(i,j,1) = 0. _d 0          fVerT(i,j,1) = 0. _d 0
199          fVerT(i,j,2) = 0. _d 0          fVerT(i,j,2) = 0. _d 0
200          rTransKp1(i,j)= 0. _d 0          rTransKp1(i,j)= 0. _d 0
201    #ifdef ALLOW_AUTODIFF_TAMC
202            localTij(i,j) = 0. _d 0
203            wfld(i,j)    = 0. _d 0
204    #endif
205         ENDDO         ENDDO
206        ENDDO        ENDDO
207    
208    C--   Set tile-specific parameters for horizontal fluxes
209          IF (useCubedSphereExchange) THEN
210           nipass=3
211    #ifdef ALLOW_AUTODIFF_TAMC
212           IF ( nipass.GT.maxcube ) STOP 'maxcube needs to be = 3'
213    #endif
214    #ifdef ALLOW_EXCH2
215           myTile = W2_myTileList(bi)
216           nCFace = exch2_myFace(myTile)
217           N_edge = exch2_isNedge(myTile).EQ.1
218           S_edge = exch2_isSedge(myTile).EQ.1
219           E_edge = exch2_isEedge(myTile).EQ.1
220           W_edge = exch2_isWedge(myTile).EQ.1
221    #else
222           nCFace = bi
223           N_edge = .TRUE.
224           S_edge = .TRUE.
225           E_edge = .TRUE.
226           W_edge = .TRUE.
227    #endif
228          ELSE
229           nipass=2
230           nCFace = bi
231           N_edge = .FALSE.
232           S_edge = .FALSE.
233           E_edge = .FALSE.
234           W_edge = .FALSE.
235          ENDIF
236    
237        iMin = 1-OLx        iMin = 1-OLx
238        iMax = sNx+OLx        iMax = sNx+OLx
239        jMin = 1-OLy        jMin = 1-OLy
# Line 191  CADJ &     comlev1_bibj_k_gad, key=kkey, Line 249  CADJ &     comlev1_bibj_k_gad, key=kkey,
249    
250  C--   Get temporary terms used by tendency routines  C--   Get temporary terms used by tendency routines
251        CALL CALC_COMMON_FACTORS (        CALL CALC_COMMON_FACTORS (
252       I         bi,bj,iMin,iMax,jMin,jMax,k,       I         uVel, vVel,
253       O         xA,yA,uTrans,vTrans,rTrans,maskUp,       O         uFld, vFld, uTrans, vTrans, xA, yA,
254       I         myThid)       I         k,bi,bj, myThid )
255    
256  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
257  C--   Residual transp = Bolus transp + Eulerian transp  C--   Residual transp = Bolus transp + Eulerian transp
258         IF (useGMRedi)        IF (useGMRedi)
259       &   CALL GMREDI_CALC_UVFLOW(       &   CALL GMREDI_CALC_UVFLOW(
260       &            uTrans, vTrans, bi, bj, k, myThid)       U                  uFld, vFld, uTrans, vTrans,
261         I                  k, bi, bj, myThid )
262  #endif /* ALLOW_GMREDI */  #endif /* ALLOW_GMREDI */
263    
264  C--   Make local copy of tracer array  C--   Make local copy of tracer array and mask West & South
265        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
266         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
267          localTij(i,j)=tracer(i,j,k,bi,bj)           localTij(i,j)=tracer(i,j,k,bi,bj)
268             maskLocW(i,j)=maskW(i,j,k,bi,bj)
269             maskLocS(i,j)=maskS(i,j,k,bi,bj)
270         ENDDO         ENDDO
271        ENDDO        ENDDO
272    
273    #ifndef ALLOW_AUTODIFF_TAMC
274        IF (useCubedSphereExchange) THEN        IF (useCubedSphereExchange) THEN
275         nipass=3          withSigns = .FALSE.
276  #ifdef ALLOW_AUTODIFF_TAMC          CALL FILL_CS_CORNER_UV_RS(
277         if ( nipass.GT.maxcube )       &            withSigns, maskLocW,maskLocS, bi,bj, myThid )
      &      STOP 'maxcube needs to be = 3'  
 #endif  
       ELSE  
        nipass=1  
278        ENDIF        ENDIF
279  cph       nipass=1  #endif
280    
281  C--   Multiple passes for different directions on different tiles  C--   Multiple passes for different directions on different tiles
282    C--   For cube need one pass for each of red, green and blue axes.
283        DO ipass=1,nipass        DO ipass=1,nipass
284  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
285           passkey = ipass + (k-1)      *maxcube           passkey = ipass + (k-1)      *maxcube
# Line 230  C--   Multiple passes for different dire Line 289  C--   Multiple passes for different dire
289           ENDIF           ENDIF
290  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
291    
292        IF (nipass.EQ.3) THEN        interiorOnly = .FALSE.
293         calc_fluxes_X=.FALSE.        overlapOnly  = .FALSE.
294         calc_fluxes_Y=.FALSE.        IF (useCubedSphereExchange) THEN
295         IF (ipass.EQ.1 .AND. (bi.EQ.1 .OR. bi.EQ.2) ) THEN  #ifdef MULTIDIM_OLD_VERSION
296          calc_fluxes_X=.TRUE.  C-    CubedSphere : pass 3 times, with full update of local tracer field
297         ELSEIF (ipass.EQ.1 .AND. (bi.EQ.4 .OR. bi.EQ.5) ) THEN         IF (ipass.EQ.1) THEN
298          calc_fluxes_Y=.TRUE.          calc_fluxes_X = nCFace.EQ.1 .OR. nCFace.EQ.2
299         ELSEIF (ipass.EQ.2 .AND. (bi.EQ.1 .OR. bi.EQ.6) ) THEN          calc_fluxes_Y = nCFace.EQ.4 .OR. nCFace.EQ.5
300          calc_fluxes_Y=.TRUE.         ELSEIF (ipass.EQ.2) THEN
301         ELSEIF (ipass.EQ.2 .AND. (bi.EQ.3 .OR. bi.EQ.4) ) THEN          calc_fluxes_X = nCFace.EQ.3 .OR. nCFace.EQ.4
302          calc_fluxes_X=.TRUE.          calc_fluxes_Y = nCFace.EQ.6 .OR. nCFace.EQ.1
303         ELSEIF (ipass.EQ.3 .AND. (bi.EQ.2 .OR. bi.EQ.3) ) THEN  #else /* MULTIDIM_OLD_VERSION */
304          calc_fluxes_Y=.TRUE.  C-    CubedSphere : pass 3 times, with partial update of local tracer field
305         ELSEIF (ipass.EQ.3 .AND. (bi.EQ.5 .OR. bi.EQ.6) ) THEN         IF (ipass.EQ.1) THEN
306          calc_fluxes_X=.TRUE.          overlapOnly  = MOD(nCFace,3).EQ.0
307            interiorOnly = MOD(nCFace,3).NE.0
308            calc_fluxes_X = nCFace.EQ.6 .OR. nCFace.EQ.1 .OR. nCFace.EQ.2
309            calc_fluxes_Y = nCFace.EQ.3 .OR. nCFace.EQ.4 .OR. nCFace.EQ.5
310           ELSEIF (ipass.EQ.2) THEN
311            overlapOnly  = MOD(nCFace,3).EQ.2
312            calc_fluxes_X = nCFace.EQ.2 .OR. nCFace.EQ.3 .OR. nCFace.EQ.4
313            calc_fluxes_Y = nCFace.EQ.5 .OR. nCFace.EQ.6 .OR. nCFace.EQ.1
314    #endif /* MULTIDIM_OLD_VERSION */
315           ELSE
316            calc_fluxes_X = nCFace.EQ.5 .OR. nCFace.EQ.6
317            calc_fluxes_Y = nCFace.EQ.2 .OR. nCFace.EQ.3
318         ENDIF         ENDIF
319        ELSE        ELSE
320         calc_fluxes_X=.TRUE.  C-    not CubedSphere
321         calc_fluxes_Y=.TRUE.          calc_fluxes_X = MOD(ipass,2).EQ.1
322            calc_fluxes_Y = .NOT.calc_fluxes_X
323        ENDIF        ENDIF
   
 C--   X direction  
       IF (calc_fluxes_X) THEN  
324    
325  C--   Internal exchange for calculations in X  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
326        IF (useCubedSphereExchange) THEN  C--   X direction
327         DO j=1,Oly  C-     Advective flux in X
328          DO i=1,Olx          DO j=1-Oly,sNy+Oly
329           localTij( 1-i , 1-j )=localTij( 1-j ,    i    )           DO i=1-Olx,sNx+Olx
330           localTij( 1-i ,sNy+j)=localTij( 1-j , sNy+1-i )            af(i,j) = 0.
331           localTij(sNx+i, 1-j )=localTij(sNx+j,    i    )           ENDDO
          localTij(sNx+i,sNy+j)=localTij(sNx+j, sNy+1-i )  
332          ENDDO          ENDDO
333         ENDDO  C
334        ENDIF  #ifdef ALLOW_AUTODIFF_TAMC
335    # ifndef DISABLE_MULTIDIM_ADVECTION
336    CADJ STORE localTij(:,:)  =
337    CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
338    CADJ STORE af(:,:)  =
339    CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
340    # endif
341    #endif /* ALLOW_AUTODIFF_TAMC */
342    C
343          IF (calc_fluxes_X) THEN
344    
345  C-    Advective flux in X  C-     Do not compute fluxes if
346        DO j=1-Oly,sNy+Oly  C       a) needed in overlap only
347         DO i=1-Olx,sNx+Olx  C   and b) the overlap of myTile are not cube-face Edges
348          af(i,j) = 0.         IF ( .NOT.overlapOnly .OR. N_edge .OR. S_edge ) THEN
349         ENDDO  
350        ENDDO  #ifndef ALLOW_AUTODIFF_TAMC
351    C-     Internal exchange for calculations in X
352    #ifdef MULTIDIM_OLD_VERSION
353            IF ( useCubedSphereExchange ) THEN
354    #else
355            IF ( useCubedSphereExchange .AND.
356         &       ( overlapOnly .OR. ipass.EQ.1 ) ) THEN
357    #endif
358             CALL FILL_CS_CORNER_TR_RL( .TRUE., localTij, bi,bj, myThid )
359            ENDIF
360    #endif
361    
362  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
363  #ifndef DISABLE_MULTIDIM_ADVECTION  # ifndef DISABLE_MULTIDIM_ADVECTION
364  CADJ STORE localTij(:,:)  =  CADJ STORE localTij(:,:)  =
365  CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte  CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
366  #endif  # endif
367  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
368    
369        IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN          IF ( advectionScheme.EQ.ENUM_UPWIND_1RST
370         CALL GAD_FLUXLIMIT_ADV_X(       &     .OR. advectionScheme.EQ.ENUM_DST2 ) THEN
371       &      bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)            CALL GAD_DST2U1_ADV_X( bi,bj,k, advectionScheme,
372        ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN       I                           dTtracerLev(k),uTrans,uFld,localTij,
373         CALL GAD_DST3_ADV_X(       O                           af, myThid )
374       &       bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
375        ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN            CALL GAD_FLUXLIMIT_ADV_X( bi,bj,k, dTtracerLev(k),
376         CALL GAD_DST3FL_ADV_X(       I                              uTrans, uFld, maskLocW, localTij,
377       &       bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)       O                              af, myThid )
378        ELSE          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
379         STOP 'GAD_ADVECTION: adv. scheme incompatibale with multi-dim'            CALL GAD_DST3_ADV_X(      bi,bj,k, dTtracerLev(k),
380        ENDIF       I                              uTrans, uFld, maskLocW, localTij,
381         O                              af, myThid )
382            ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
383              CALL GAD_DST3FL_ADV_X(    bi,bj,k, dTtracerLev(k),
384         I                              uTrans, uFld, maskLocW, localTij,
385         O                              af, myThid )
386    #ifndef ALLOW_AUTODIFF_TAMC
387            ELSEIF (advectionScheme.EQ.ENUM_OS7MP ) THEN
388              CALL GAD_OS7MP_ADV_X(     bi,bj,k, dTtracerLev(k),
389         I                              uTrans, uFld, maskLocW, localTij,
390         O                              af, myThid )
391    #endif
392            ELSE
393             STOP 'GAD_ADVECTION: adv. scheme incompatibale with multi-dim'
394            ENDIF
395    
396        DO j=1-Oly,sNy+Oly  C-     Advective flux in X : done
397         DO i=1-Olx,sNx+Olx-1         ENDIF
398          localTij(i,j)=localTij(i,j)-deltaTtracer*  
399       &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)  #ifndef ALLOW_AUTODIFF_TAMC
400       &    *recip_rA(i,j,bi,bj)  C-     Internal exchange for next calculations in Y
401       &    *( af(i+1,j)-af(i,j)         IF ( overlapOnly .AND. ipass.EQ.1 ) THEN
402       &      -tracer(i,j,k,bi,bj)*(uTrans(i+1,j)-uTrans(i,j))           CALL FILL_CS_CORNER_TR_RL(.FALSE., localTij, bi,bj, myThid )
403       &     )         ENDIF
404         ENDDO  #endif
405        ENDDO  
406    C-     Update the local tracer field where needed:
407    
408    C      update in overlap-Only
409           IF ( overlapOnly ) THEN
410            iMinUpd = 1-Olx+1
411            iMaxUpd = sNx+Olx-1
412    C- notes: these 2 lines below have no real effect (because recip_hFac=0
413    C         in corner region) but safer to keep them.
414            IF ( W_edge ) iMinUpd = 1
415            IF ( E_edge ) iMaxUpd = sNx
416    
417            IF ( S_edge ) THEN
418             DO j=1-Oly,0
419              DO i=iMinUpd,iMaxUpd
420               localTij(i,j) = localTij(i,j)
421         &      -dTtracerLev(k)*recip_rhoFacC(k)
422         &       *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
423         &       *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
424         &       *( af(i+1,j)-af(i,j)
425         &         -tracer(i,j,k,bi,bj)*(uTrans(i+1,j)-uTrans(i,j))
426         &        )
427              ENDDO
428             ENDDO
429            ENDIF
430            IF ( N_edge ) THEN
431             DO j=sNy+1,sNy+Oly
432              DO i=iMinUpd,iMaxUpd
433               localTij(i,j) = localTij(i,j)
434         &      -dTtracerLev(k)*recip_rhoFacC(k)
435         &       *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
436         &       *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
437         &       *( af(i+1,j)-af(i,j)
438         &         -tracer(i,j,k,bi,bj)*(uTrans(i+1,j)-uTrans(i,j))
439         &        )
440              ENDDO
441             ENDDO
442            ENDIF
443    
444           ELSE
445    C      do not only update the overlap
446            jMinUpd = 1-Oly
447            jMaxUpd = sNy+Oly
448            IF ( interiorOnly .AND. S_edge ) jMinUpd = 1
449            IF ( interiorOnly .AND. N_edge ) jMaxUpd = sNy
450            DO j=jMinUpd,jMaxUpd
451             DO i=1-Olx+1,sNx+Olx-1
452               localTij(i,j) = localTij(i,j)
453         &      -dTtracerLev(k)*recip_rhoFacC(k)
454         &       *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
455         &       *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
456         &       *( af(i+1,j)-af(i,j)
457         &         -tracer(i,j,k,bi,bj)*(uTrans(i+1,j)-uTrans(i,j))
458         &        )
459             ENDDO
460            ENDDO
461    C-      keep advective flux (for diagnostics)
462            DO j=1-Oly,sNy+Oly
463             DO i=1-Olx,sNx+Olx
464              afx(i,j) = af(i,j)
465             ENDDO
466            ENDDO
467    
468  #ifdef ALLOW_OBCS  #ifdef ALLOW_OBCS
469  C--   Apply open boundary conditions  C-     Apply open boundary conditions
470        IF (useOBCS) THEN          IF ( useOBCS ) THEN
471         IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN           IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
472          CALL OBCS_APPLY_TLOC( bi, bj, k, localTij, myThid )            CALL OBCS_APPLY_TLOC( bi, bj, k, localTij, myThid )
473         ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN           ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
474          CALL OBCS_APPLY_SLOC( bi, bj, k, localTij, myThid )            CALL OBCS_APPLY_SLOC( bi, bj, k, localTij, myThid )
475         END IF  #ifdef ALLOW_PTRACERS
476        END IF           ELSEIF (tracerIdentity.GE.GAD_TR1) THEN
477              CALL OBCS_APPLY_PTRACER( bi, bj, k,
478         &         tracerIdentity-GAD_TR1+1, localTij, myThid )
479    #endif /* ALLOW_PTRACERS */
480             ENDIF
481            ENDIF
482  #endif /* ALLOW_OBCS */  #endif /* ALLOW_OBCS */
483    
484    C-     end if/else update overlap-Only
485           ENDIF
486    
487  C--   End of X direction  C--   End of X direction
488        ENDIF        ENDIF
489    
490    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
491  C--   Y direction  C--   Y direction
492    cph-test
493    C-     Advective flux in Y
494            DO j=1-Oly,sNy+Oly
495             DO i=1-Olx,sNx+Olx
496              af(i,j) = 0.
497             ENDDO
498            ENDDO
499    C
500    #ifdef ALLOW_AUTODIFF_TAMC
501    # ifndef DISABLE_MULTIDIM_ADVECTION
502    CADJ STORE localTij(:,:)  =
503    CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
504    CADJ STORE af(:,:)  =
505    CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
506    # endif
507    #endif /* ALLOW_AUTODIFF_TAMC */
508    C
509        IF (calc_fluxes_Y) THEN        IF (calc_fluxes_Y) THEN
510    
511  C--   Internal exchange for calculations in Y  C-     Do not compute fluxes if
512        IF (useCubedSphereExchange) THEN  C       a) needed in overlap only
513         DO j=1,Oly  C   and b) the overlap of myTile are not cube-face edges
514          DO i=1,Olx         IF ( .NOT.overlapOnly .OR. E_edge .OR. W_edge ) THEN
515           localTij( 1-i , 1-j )=localTij(   j   , 1-i )  
516           localTij( 1-i ,sNy+j)=localTij(   j   ,sNy+i)  #ifndef ALLOW_AUTODIFF_TAMC
517           localTij(sNx+i, 1-j )=localTij(sNx+1-j, 1-i )  C-     Internal exchange for calculations in Y
518           localTij(sNx+i,sNy+j)=localTij(sNx+1-j,sNy+i)  #ifdef MULTIDIM_OLD_VERSION
519          ENDDO          IF ( useCubedSphereExchange ) THEN
520         ENDDO  #else
521        ENDIF          IF ( useCubedSphereExchange .AND.
522         &       ( overlapOnly .OR. ipass.EQ.1 ) ) THEN
523    #endif
524             CALL FILL_CS_CORNER_TR_RL(.FALSE., localTij, bi,bj, myThid )
525            ENDIF
526    #endif
527    
528  C-    Advective flux in Y  C-     Advective flux in Y
529        DO j=1-Oly,sNy+Oly          DO j=1-Oly,sNy+Oly
530         DO i=1-Olx,sNx+Olx           DO i=1-Olx,sNx+Olx
531          af(i,j) = 0.            af(i,j) = 0.
532         ENDDO           ENDDO
533        ENDDO          ENDDO
534    
535  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
536  #ifndef DISABLE_MULTIDIM_ADVECTION  #ifndef DISABLE_MULTIDIM_ADVECTION
# Line 347  CADJ &     comlev1_bibj_k_gad_pass, key= Line 539  CADJ &     comlev1_bibj_k_gad_pass, key=
539  #endif  #endif
540  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
541    
542        IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN          IF ( advectionScheme.EQ.ENUM_UPWIND_1RST
543         CALL GAD_FLUXLIMIT_ADV_Y(       &     .OR. advectionScheme.EQ.ENUM_DST2 ) THEN
544       &       bi,bj,k,deltaTtracer,vTrans,vVel,localTij,af,myThid)            CALL GAD_DST2U1_ADV_Y( bi,bj,k, advectionScheme,
545        ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN       I                           dTtracerLev(k),vTrans,vFld,localTij,
546         CALL GAD_DST3_ADV_Y(       O                           af, myThid )
547       &       bi,bj,k,deltaTtracer,vTrans,vVel,localTij,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
548        ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN            CALL GAD_FLUXLIMIT_ADV_Y( bi,bj,k, dTtracerLev(k),
549         CALL GAD_DST3FL_ADV_Y(       I                              vTrans, vFld, maskLocS, localTij,
550       &       bi,bj,k,deltaTtracer,vTrans,vVel,localTij,af,myThid)       O                              af, myThid )
551        ELSE          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
552         STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'            CALL GAD_DST3_ADV_Y(      bi,bj,k, dTtracerLev(k),
553        ENDIF       I                              vTrans, vFld, maskLocS, localTij,
554         O                              af, myThid )
555            ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
556              CALL GAD_DST3FL_ADV_Y(    bi,bj,k, dTtracerLev(k),
557         I                              vTrans, vFld, maskLocS, localTij,
558         O                              af, myThid )
559    #ifndef ALLOW_AUTODIFF_TAMC
560            ELSEIF (advectionScheme.EQ.ENUM_OS7MP ) THEN
561              CALL GAD_OS7MP_ADV_Y(     bi,bj,k, dTtracerLev(k),
562         I                              vTrans, vFld, maskLocS, localTij,
563         O                              af, myThid )
564    #endif
565            ELSE
566             STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
567            ENDIF
568    
569        DO j=1-Oly,sNy+Oly-1  C-     Advective flux in Y : done
570         DO i=1-Olx,sNx+Olx         ENDIF
571          localTij(i,j)=localTij(i,j)-deltaTtracer*  
572       &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)  #ifndef ALLOW_AUTODIFF_TAMC
573       &    *recip_rA(i,j,bi,bj)  C-     Internal exchange for next calculations in X
574       &    *( af(i,j+1)-af(i,j)         IF ( overlapOnly .AND. ipass.EQ.1 ) THEN
575       &      -tracer(i,j,k,bi,bj)*(vTrans(i,j+1)-vTrans(i,j))           CALL FILL_CS_CORNER_TR_RL( .TRUE., localTij, bi,bj, myThid )
576       &     )         ENDIF
577         ENDDO  #endif
578        ENDDO  
579    C-     Update the local tracer field where needed:
580    
581    C      update in overlap-Only
582           IF ( overlapOnly ) THEN
583            jMinUpd = 1-Oly+1
584            jMaxUpd = sNy+Oly-1
585    C- notes: these 2 lines below have no real effect (because recip_hFac=0
586    C         in corner region) but safer to keep them.
587            IF ( S_edge ) jMinUpd = 1
588            IF ( N_edge ) jMaxUpd = sNy
589    
590            IF ( W_edge ) THEN
591             DO j=jMinUpd,jMaxUpd
592              DO i=1-Olx,0
593               localTij(i,j) = localTij(i,j)
594         &      -dTtracerLev(k)*recip_rhoFacC(k)
595         &       *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
596         &       *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
597         &       *( af(i,j+1)-af(i,j)
598         &         -tracer(i,j,k,bi,bj)*(vTrans(i,j+1)-vTrans(i,j))
599         &        )
600              ENDDO
601             ENDDO
602            ENDIF
603            IF ( E_edge ) THEN
604             DO j=jMinUpd,jMaxUpd
605              DO i=sNx+1,sNx+Olx
606               localTij(i,j) = localTij(i,j)
607         &      -dTtracerLev(k)*recip_rhoFacC(k)
608         &       *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
609         &       *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
610         &       *( af(i,j+1)-af(i,j)
611         &         -tracer(i,j,k,bi,bj)*(vTrans(i,j+1)-vTrans(i,j))
612         &        )
613              ENDDO
614             ENDDO
615            ENDIF
616    
617           ELSE
618    C      do not only update the overlap
619            iMinUpd = 1-Olx
620            iMaxUpd = sNx+Olx
621            IF ( interiorOnly .AND. W_edge ) iMinUpd = 1
622            IF ( interiorOnly .AND. E_edge ) iMaxUpd = sNx
623            DO j=1-Oly+1,sNy+Oly-1
624             DO i=iMinUpd,iMaxUpd
625               localTij(i,j) = localTij(i,j)
626         &      -dTtracerLev(k)*recip_rhoFacC(k)
627         &       *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
628         &       *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
629         &       *( af(i,j+1)-af(i,j)
630         &         -tracer(i,j,k,bi,bj)*(vTrans(i,j+1)-vTrans(i,j))
631         &        )
632             ENDDO
633            ENDDO
634    C-      keep advective flux (for diagnostics)
635            DO j=1-Oly,sNy+Oly
636             DO i=1-Olx,sNx+Olx
637              afy(i,j) = af(i,j)
638             ENDDO
639            ENDDO
640    
641  #ifdef ALLOW_OBCS  #ifdef ALLOW_OBCS
642  C--   Apply open boundary conditions  C-     Apply open boundary conditions
643        IF (useOBCS) THEN          IF (useOBCS) THEN
644         IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN           IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
645          CALL OBCS_APPLY_TLOC( bi, bj, k, localTij, myThid )            CALL OBCS_APPLY_TLOC( bi, bj, k, localTij, myThid )
646         ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN           ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
647          CALL OBCS_APPLY_SLOC( bi, bj, k, localTij, myThid )            CALL OBCS_APPLY_SLOC( bi, bj, k, localTij, myThid )
648         END IF  #ifdef ALLOW_PTRACERS
649        END IF           ELSEIF (tracerIdentity.GE.GAD_TR1) THEN
650              CALL OBCS_APPLY_PTRACER( bi, bj, k,
651         &         tracerIdentity-GAD_TR1+1, localTij, myThid )
652    #endif /* ALLOW_PTRACERS */
653             ENDIF
654            ENDIF
655  #endif /* ALLOW_OBCS */  #endif /* ALLOW_OBCS */
656    
657    C      end if/else update overlap-Only
658           ENDIF
659    
660  C--   End of Y direction  C--   End of Y direction
661        ENDIF        ENDIF
662    
       DO j=1-Oly,sNy+Oly  
        DO i=1-Olx,sNx+Olx  
         localTijk(i,j,k)=localTij(i,j)  
        ENDDO  
       ENDDO  
   
663  C--   End of ipass loop  C--   End of ipass loop
664        ENDDO        ENDDO
665    
666          IF ( implicitAdvection ) THEN
667    C-    explicit advection is done ; store tendency in gTracer:
668            DO j=1-Oly,sNy+Oly
669             DO i=1-Olx,sNx+Olx
670              gTracer(i,j,k,bi,bj)=
671         &     (localTij(i,j)-tracer(i,j,k,bi,bj))/dTtracerLev(k)
672             ENDDO
673            ENDDO
674          ELSE
675    C-    horizontal advection done; store intermediate result in 3D array:
676            DO j=1-Oly,sNy+Oly
677             DO i=1-Olx,sNx+Olx
678              localTijk(i,j,k)=localTij(i,j)
679             ENDDO
680            ENDDO
681          ENDIF
682    
683    #ifdef ALLOW_DIAGNOSTICS
684            IF ( useDiagnostics ) THEN
685              diagName = 'ADVx'//diagSufx
686              CALL DIAGNOSTICS_FILL(afx,diagName, k,1, 2,bi,bj, myThid)
687              diagName = 'ADVy'//diagSufx
688              CALL DIAGNOSTICS_FILL(afy,diagName, k,1, 2,bi,bj, myThid)
689            ENDIF
690    #endif
691    
692    #ifdef ALLOW_DEBUG
693          IF ( debugLevel .GE. debLevB
694         &   .AND. tracerIdentity.EQ.GAD_TEMPERATURE
695         &   .AND. k.LE.3 .AND. myIter.EQ.1+nIter0
696         &   .AND. nPx.EQ.1 .AND. nPy.EQ.1
697         &   .AND. useCubedSphereExchange ) THEN
698            CALL DEBUG_CS_CORNER_UV( ' afx,afy from GAD_ADVECTION',
699         &             afx,afy, k, standardMessageUnit,bi,bj,myThid )
700          ENDIF
701    #endif /* ALLOW_DEBUG */
702    
703  C--   End of K loop for horizontal fluxes  C--   End of K loop for horizontal fluxes
704        ENDDO        ENDDO
705    
706    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
707    
708          IF ( .NOT.implicitAdvection ) THEN
709  C--   Start of k loop for vertical flux  C--   Start of k loop for vertical flux
710        DO k=Nr,1,-1         DO k=Nr,1,-1
711  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
712           kkey = (igadkey-1)*Nr + k           kkey = (igadkey-1)*Nr + k
713  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
714    C--   kUp    Cycles through 1,2 to point to w-layer above
 C--   kup    Cycles through 1,2 to point to w-layer above  
715  C--   kDown  Cycles through 2,1 to point to w-layer below  C--   kDown  Cycles through 2,1 to point to w-layer below
716        kup  = 1+MOD(k+1,2)          kUp  = 1+MOD(k+1,2)
717        kDown= 1+MOD(k,2)          kDown= 1+MOD(k,2)
718  c     kp1=min(Nr,k+1)  c       kp1=min(Nr,k+1)
719        kp1Msk=1.          kp1Msk=1.
720        if (k.EQ.Nr) kp1Msk=0.          if (k.EQ.Nr) kp1Msk=0.
721    
722  C-- Compute Vertical transport  C-- Compute Vertical transport
723  C     Note: wVel needs to be masked  #ifdef ALLOW_AIM
724    C- a hack to prevent Water-Vapor vert.transport into the stratospheric level Nr
725            IF ( k.EQ.1 .OR.
726         &     (useAIM .AND. tracerIdentity.EQ.GAD_SALINITY .AND. k.EQ.Nr)
727         &              ) THEN
728    #else
729            IF ( k.EQ.1 ) THEN
730    #endif
731    
732    #ifdef ALLOW_AUTODIFF_TAMC
733    CADJ STORE rtrans(:,:)  =
734    CADJ &     comlev1_bibj_k_gad, key=kkey, byte=isbyte
735    CADJ STORE wfld(:,:)  =
736    CADJ &     comlev1_bibj_k_gad, key=kkey, byte=isbyte
737    #endif /* ALLOW_AUTODIFF_TAMC */
738    
       IF (k.EQ.1) THEN  
739  C- Surface interface :  C- Surface interface :
740             DO j=1-Oly,sNy+Oly
741              DO i=1-Olx,sNx+Olx
742               rTransKp1(i,j) = kp1Msk*rTrans(i,j)
743               wFld(i,j)   = 0.
744               rTrans(i,j) = 0.
745               fVerT(i,j,kUp) = 0.
746              ENDDO
747             ENDDO
748    
749         DO j=1-Oly,sNy+Oly          ELSE
750          DO i=1-Olx,sNx+Olx  
751           rTransKp1(i,j) = rTrans(i,j)  #ifdef ALLOW_AUTODIFF_TAMC
752           rTrans(i,j) = 0.  CADJ STORE rtrans(:,:)  =
753           fVerT(i,j,kUp) = 0.  CADJ &     comlev1_bibj_k_gad, key=kkey, byte=isbyte
754           af(i,j) = 0.  CADJ STORE wfld(:,:)  =
755          ENDDO  CADJ &     comlev1_bibj_k_gad, key=kkey, byte=isbyte
756         ENDDO  #endif /* ALLOW_AUTODIFF_TAMC */
757    
       ELSE  
758  C- Interior interface :  C- Interior interface :
759         DO j=1-Oly,sNy+Oly           DO j=1-Oly,sNy+Oly
760          DO i=1-Olx,sNx+Olx            DO i=1-Olx,sNx+Olx
761           rTransKp1(i,j) = kp1Msk*rTrans(i,j)             rTransKp1(i,j) = kp1Msk*rTrans(i,j)
762           rTrans(i,j) = wVel(i,j,k,bi,bj)*rA(i,j,bi,bj)             wFld(i,j)   = wVel(i,j,k,bi,bj)
763       &               *maskC(i,j,k-1,bi,bj)             rTrans(i,j) = wVel(i,j,k,bi,bj)*rA(i,j,bi,bj)
764           af(i,j) = 0.       &                 *deepFac2F(k)*rhoFacF(k)
765          ENDDO       &                 *maskC(i,j,k-1,bi,bj)
766         ENDDO             fVerT(i,j,kUp) = 0.
767              ENDDO
768             ENDDO
769    
770  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
771  C--   Residual transp = Bolus transp + Eulerian transp  C--   Residual transp = Bolus transp + Eulerian transp
772         IF (useGMRedi)           IF (useGMRedi)
773       &   CALL GMREDI_CALC_WFLOW(       &     CALL GMREDI_CALC_WFLOW(
774       &                    rTrans, bi, bj, k, myThid)       U                 wFld, rTrans,
775         I                 k, bi, bj, myThid )
776  #endif /* ALLOW_GMREDI */  #endif /* ALLOW_GMREDI */
777    
778  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
# Line 451  CADJ STORE rTrans(:,:) Line 782  CADJ STORE rTrans(:,:)
782  CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
783  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
784    
        IF ( .NOT.implicitAdvection ) THEN  
785  C-    Compute vertical advective flux in the interior:  C-    Compute vertical advective flux in the interior:
786          IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN           IF ( vertAdvecScheme.EQ.ENUM_UPWIND_1RST
787           CALL GAD_FLUXLIMIT_ADV_R(       &      .OR. vertAdvecScheme.EQ.ENUM_DST2 ) THEN
788       &        bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)             CALL GAD_DST2U1_ADV_R( bi,bj,k, advectionScheme,
789          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN       I                            dTtracerLev(k),rTrans,wFld,localTijk,
790           CALL GAD_DST3_ADV_R(       O                            fVerT(1-Olx,1-Oly,kUp), myThid )
791       &        bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)           ELSEIF( vertAdvecScheme.EQ.ENUM_FLUX_LIMIT) THEN
792          ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN             CALL GAD_FLUXLIMIT_ADV_R( bi,bj,k, dTtracerLev(k),
793           CALL GAD_DST3FL_ADV_R(       I                               rTrans, wFld, localTijk,
794       &        bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)       O                               fVerT(1-Olx,1-Oly,kUp), myThid )
795          ELSE           ELSEIF( vertAdvecScheme.EQ.ENUM_DST3 ) THEN
796           STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'             CALL GAD_DST3_ADV_R(      bi,bj,k, dTtracerLev(k),
797          ENDIF       I                               rTrans, wFld, localTijk,
798         ENDIF       O                               fVerT(1-Olx,1-Oly,kUp), myThid )
799  C-    add the advective flux to fVerT           ELSEIF( vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
800         DO j=1-Oly,sNy+Oly             CALL GAD_DST3FL_ADV_R(    bi,bj,k, dTtracerLev(k),
801          DO i=1-Olx,sNx+Olx       I                               rTrans, wFld, localTijk,
802           fVerT(i,j,kUp) = af(i,j)       O                               fVerT(1-Olx,1-Oly,kUp), myThid )
803          ENDDO  #ifndef ALLOW_AUTODIFF_TAMC
804         ENDDO           ELSEIF (vertAdvecScheme.EQ.ENUM_OS7MP ) THEN
805               CALL GAD_OS7MP_ADV_R(     bi,bj,k, dTtracerLev(k),
806         I                               rTrans, wFld, localTijk,
807         O                               fVerT(1-Olx,1-Oly,kUp), myThid )
808    #endif
809             ELSE
810              STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
811             ENDIF
812    
813  C- end Surface/Interior if bloc  C- end Surface/Interior if bloc
814        ENDIF          ENDIF
815    
816  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
817  CADJ STORE rTrans(:,:)    CADJ STORE rTrans(:,:)  
# Line 483  CADJ STORE rTranskp1(:,:) Line 820  CADJ STORE rTranskp1(:,:)
820  CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
821  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
822    
823  C--   Divergence of fluxes  C--   Divergence of vertical fluxes
824        DO j=1-Oly,sNy+Oly          DO j=1-Oly,sNy+Oly
825         DO i=1-Olx,sNx+Olx           DO i=1-Olx,sNx+Olx
826          localTij(i,j)=localTijk(i,j,k)-deltaTtracer*            localTij(i,j) = localTijk(i,j,k)
827       &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)       &      -dTtracerLev(k)*recip_rhoFacC(k)
828       &    *recip_rA(i,j,bi,bj)       &       *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
829       &    *( fVerT(i,j,kUp)-fVerT(i,j,kDown)       &       *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
830       &      -tracer(i,j,k,bi,bj)*(rTrans(i,j)-rTransKp1(i,j))       &       *( fVerT(i,j,kDown)-fVerT(i,j,kUp)
831       &     )*rkFac       &         -tracer(i,j,k,bi,bj)*(rTransKp1(i,j)-rTrans(i,j))
832          gTracer(i,j,k,bi,bj)=       &        )*rkSign
833       &   (localTij(i,j)-tracer(i,j,k,bi,bj))/deltaTtracer            gTracer(i,j,k,bi,bj)=
834         ENDDO       &     (localTij(i,j)-tracer(i,j,k,bi,bj))/dTtracerLev(k)
835        ENDDO           ENDDO
836            ENDDO
837    
838    #ifdef ALLOW_DIAGNOSTICS
839            IF ( useDiagnostics ) THEN
840              diagName = 'ADVr'//diagSufx
841              CALL DIAGNOSTICS_FILL( fVerT(1-Olx,1-Oly,kUp),
842         &                           diagName, k,1, 2,bi,bj, myThid)
843            ENDIF
844    #endif
845    
846  C--   End of K loop for vertical flux  C--   End of K loop for vertical flux
847        ENDDO         ENDDO
848    C--   end of if not.implicitAdvection block
849          ENDIF
850    
851        RETURN        RETURN
852        END        END
Legend:
Removed from v.1.17  
changed lines
  Added in v.1.47
  ViewVC Help
Powered by ViewVC 1.1.22