/[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.19 by edhill, Sat Mar 27 03:51:51 2004 UTC revision 1.53 by heimbach, Fri Oct 19 19:18:01 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-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
8  CBOP  CBOP
# Line 36  C !ROUTINE: GAD_ADVECTION Line 10  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         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
159            act0 = tracerIdentity - 1            act0 = tracerIdentity
160            max0 = maxpass            max0 = maxpass
161            act1 = bi - myBxLo(myThid)            act1 = bi - myBxLo(myThid)
162            max1 = myBxHi(myThid) - myBxLo(myThid) + 1            max1 = myBxHi(myThid) - myBxLo(myThid) + 1
# Line 147  CEOP Line 165  CEOP
165            act3 = myThid - 1            act3 = myThid - 1
166            max3 = nTx*nTy            max3 = nTx*nTy
167            act4 = ikey_dynamics - 1            act4 = ikey_dynamics - 1
168            igadkey = (act0 + 1)            igadkey = act0
169       &                      + act1*max0       &                      + act1*max0
170       &                      + act2*max0*max1       &                      + act2*max0*max1
171       &                      + act3*max0*max1*max2       &                      + act3*max0*max1*max2
# 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    cph-exch2#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  cph-exch2#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
286       &                   + (igadkey-1)*maxcube*Nr       &                   + (k-1)      *maxpass
287         &                   + (igadkey-1)*maxpass*Nr
288           IF (nipass .GT. maxpass) THEN           IF (nipass .GT. maxpass) THEN
289            STOP 'GAD_ADVECTION: nipass > maxcube. check tamc.h'            STOP 'GAD_ADVECTION: nipass > maxcube. check tamc.h'
290           ENDIF           ENDIF
291  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
292    
293        IF (nipass.EQ.3) THEN        interiorOnly = .FALSE.
294         calc_fluxes_X=.FALSE.        overlapOnly  = .FALSE.
295         calc_fluxes_Y=.FALSE.        IF (useCubedSphereExchange) THEN
296         IF (ipass.EQ.1 .AND. (bi.EQ.1 .OR. bi.EQ.2) ) THEN  #ifdef MULTIDIM_OLD_VERSION
297          calc_fluxes_X=.TRUE.  C-    CubedSphere : pass 3 times, with full update of local tracer field
298         ELSEIF (ipass.EQ.1 .AND. (bi.EQ.4 .OR. bi.EQ.5) ) THEN         IF (ipass.EQ.1) THEN
299          calc_fluxes_Y=.TRUE.          calc_fluxes_X = nCFace.EQ.1 .OR. nCFace.EQ.2
300         ELSEIF (ipass.EQ.2 .AND. (bi.EQ.1 .OR. bi.EQ.6) ) THEN          calc_fluxes_Y = nCFace.EQ.4 .OR. nCFace.EQ.5
301          calc_fluxes_Y=.TRUE.         ELSEIF (ipass.EQ.2) THEN
302         ELSEIF (ipass.EQ.2 .AND. (bi.EQ.3 .OR. bi.EQ.4) ) THEN          calc_fluxes_X = nCFace.EQ.3 .OR. nCFace.EQ.4
303          calc_fluxes_X=.TRUE.          calc_fluxes_Y = nCFace.EQ.6 .OR. nCFace.EQ.1
304         ELSEIF (ipass.EQ.3 .AND. (bi.EQ.2 .OR. bi.EQ.3) ) THEN  #else /* MULTIDIM_OLD_VERSION */
305          calc_fluxes_Y=.TRUE.  C-    CubedSphere : pass 3 times, with partial update of local tracer field
306         ELSEIF (ipass.EQ.3 .AND. (bi.EQ.5 .OR. bi.EQ.6) ) THEN         IF (ipass.EQ.1) THEN
307          calc_fluxes_X=.TRUE.          overlapOnly  = MOD(nCFace,3).EQ.0
308            interiorOnly = MOD(nCFace,3).NE.0
309            calc_fluxes_X = nCFace.EQ.6 .OR. nCFace.EQ.1 .OR. nCFace.EQ.2
310            calc_fluxes_Y = nCFace.EQ.3 .OR. nCFace.EQ.4 .OR. nCFace.EQ.5
311           ELSEIF (ipass.EQ.2) THEN
312            overlapOnly  = MOD(nCFace,3).EQ.2
313            calc_fluxes_X = nCFace.EQ.2 .OR. nCFace.EQ.3 .OR. nCFace.EQ.4
314            calc_fluxes_Y = nCFace.EQ.5 .OR. nCFace.EQ.6 .OR. nCFace.EQ.1
315    #endif /* MULTIDIM_OLD_VERSION */
316           ELSE
317            calc_fluxes_X = nCFace.EQ.5 .OR. nCFace.EQ.6
318            calc_fluxes_Y = nCFace.EQ.2 .OR. nCFace.EQ.3
319         ENDIF         ENDIF
320        ELSE        ELSE
321         calc_fluxes_X=.TRUE.  C-    not CubedSphere
322         calc_fluxes_Y=.TRUE.          calc_fluxes_X = MOD(ipass,2).EQ.1
323            calc_fluxes_Y = .NOT.calc_fluxes_X
324        ENDIF        ENDIF
   
 C--   X direction  
       IF (calc_fluxes_X) THEN  
325    
326  C--   Internal exchange for calculations in X  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
327        IF (useCubedSphereExchange) THEN  C--   X direction
328         DO j=1,Oly  C-     Advective flux in X
329          DO i=1,Olx          DO j=1-Oly,sNy+Oly
330           localTij( 1-i , 1-j )=localTij( 1-j ,    i    )           DO i=1-Olx,sNx+Olx
331           localTij( 1-i ,sNy+j)=localTij( 1-j , sNy+1-i )            af(i,j) = 0.
332           localTij(sNx+i, 1-j )=localTij(sNx+j,    i    )           ENDDO
          localTij(sNx+i,sNy+j)=localTij(sNx+j, sNy+1-i )  
333          ENDDO          ENDDO
334         ENDDO  C
335        ENDIF  #ifdef ALLOW_AUTODIFF_TAMC
336    # ifndef DISABLE_MULTIDIM_ADVECTION
337    CADJ STORE localTij(:,:)  =
338    CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
339    CADJ STORE af(:,:)  =
340    CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
341    # endif
342    #endif /* ALLOW_AUTODIFF_TAMC */
343    C
344          IF (calc_fluxes_X) THEN
345    
346  C-    Advective flux in X  C-     Do not compute fluxes if
347        DO j=1-Oly,sNy+Oly  C       a) needed in overlap only
348         DO i=1-Olx,sNx+Olx  C   and b) the overlap of myTile are not cube-face Edges
349          af(i,j) = 0.         IF ( .NOT.overlapOnly .OR. N_edge .OR. S_edge ) THEN
350         ENDDO  
351        ENDDO  cph-exch2#ifndef ALLOW_AUTODIFF_TAMC
352    C-     Internal exchange for calculations in X
353    #ifdef MULTIDIM_OLD_VERSION
354            IF ( useCubedSphereExchange ) THEN
355    #else
356            IF ( useCubedSphereExchange .AND.
357         &       ( overlapOnly .OR. ipass.EQ.1 ) ) THEN
358    #endif
359             CALL FILL_CS_CORNER_TR_RL( .TRUE., .FALSE.,
360         &                              localTij, bi,bj, myThid )
361            ENDIF
362    cph-exch2#endif
363    
364  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
365  #ifndef DISABLE_MULTIDIM_ADVECTION  # ifndef DISABLE_MULTIDIM_ADVECTION
366  CADJ STORE localTij(:,:)  =  CADJ STORE localTij(:,:)  =
367  CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte  CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
368  #endif  # endif
369  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
370    
371        IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN          IF ( advectionScheme.EQ.ENUM_UPWIND_1RST
372         CALL GAD_FLUXLIMIT_ADV_X(       &     .OR. advectionScheme.EQ.ENUM_DST2 ) THEN
373       &      bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)            CALL GAD_DST2U1_ADV_X( bi,bj,k, advectionScheme, .TRUE.,
374        ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN       I                           dTtracerLev(k),uTrans,uFld,localTij,
375         CALL GAD_DST3_ADV_X(       O                           af, myThid )
376       &       bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
377        ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN            CALL GAD_FLUXLIMIT_ADV_X( bi,bj,k, .TRUE., dTtracerLev(k),
378         CALL GAD_DST3FL_ADV_X(       I                              uTrans, uFld, maskLocW, localTij,
379       &       bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)       O                              af, myThid )
380        ELSE          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
381         STOP 'GAD_ADVECTION: adv. scheme incompatibale with multi-dim'            CALL GAD_DST3_ADV_X(      bi,bj,k, .TRUE., dTtracerLev(k),
382        ENDIF       I                              uTrans, uFld, maskLocW, localTij,
383         O                              af, myThid )
384            ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
385              CALL GAD_DST3FL_ADV_X(    bi,bj,k, .TRUE., dTtracerLev(k),
386         I                              uTrans, uFld, maskLocW, localTij,
387         O                              af, myThid )
388    #ifndef ALLOW_AUTODIFF_TAMC
389            ELSEIF (advectionScheme.EQ.ENUM_OS7MP ) THEN
390              CALL GAD_OS7MP_ADV_X(     bi,bj,k, .TRUE., dTtracerLev(k),
391         I                              uTrans, uFld, maskLocW, localTij,
392         O                              af, myThid )
393    #endif
394            ELSE
395             STOP 'GAD_ADVECTION: adv. scheme incompatibale with multi-dim'
396            ENDIF
397    
398        DO j=1-Oly,sNy+Oly  C-     Advective flux in X : done
399         DO i=1-Olx,sNx+Olx-1         ENDIF
400          localTij(i,j)=localTij(i,j)-deltaTtracer*  
401       &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)  cph-exch2#ifndef ALLOW_AUTODIFF_TAMC
402       &    *recip_rA(i,j,bi,bj)  C-     Internal exchange for next calculations in Y
403       &    *( af(i+1,j)-af(i,j)         IF ( overlapOnly .AND. ipass.EQ.1 ) THEN
404       &      -tracer(i,j,k,bi,bj)*(uTrans(i+1,j)-uTrans(i,j))           CALL FILL_CS_CORNER_TR_RL(.FALSE., .FALSE.,
405       &     )       &                              localTij, bi,bj, myThid )
406         ENDDO         ENDIF
407        ENDDO  cph-exch2#endif
408    
409    C-     Update the local tracer field where needed:
410    
411    C      update in overlap-Only
412           IF ( overlapOnly ) THEN
413            iMinUpd = 1-Olx+1
414            iMaxUpd = sNx+Olx-1
415    C- notes: these 2 lines below have no real effect (because recip_hFac=0
416    C         in corner region) but safer to keep them.
417            IF ( W_edge ) iMinUpd = 1
418            IF ( E_edge ) iMaxUpd = sNx
419    
420            IF ( S_edge ) THEN
421             DO j=1-Oly,0
422              DO i=iMinUpd,iMaxUpd
423               localTij(i,j) = localTij(i,j)
424         &      -dTtracerLev(k)*recip_rhoFacC(k)
425         &       *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
426         &       *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
427         &       *( af(i+1,j)-af(i,j)
428         &         -tracer(i,j,k,bi,bj)*(uTrans(i+1,j)-uTrans(i,j))
429         &        )
430              ENDDO
431             ENDDO
432            ENDIF
433            IF ( N_edge ) THEN
434             DO j=sNy+1,sNy+Oly
435              DO i=iMinUpd,iMaxUpd
436               localTij(i,j) = localTij(i,j)
437         &      -dTtracerLev(k)*recip_rhoFacC(k)
438         &       *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
439         &       *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
440         &       *( af(i+1,j)-af(i,j)
441         &         -tracer(i,j,k,bi,bj)*(uTrans(i+1,j)-uTrans(i,j))
442         &        )
443              ENDDO
444             ENDDO
445            ENDIF
446    
447           ELSE
448    C      do not only update the overlap
449            jMinUpd = 1-Oly
450            jMaxUpd = sNy+Oly
451            IF ( interiorOnly .AND. S_edge ) jMinUpd = 1
452            IF ( interiorOnly .AND. N_edge ) jMaxUpd = sNy
453            DO j=jMinUpd,jMaxUpd
454             DO i=1-Olx+1,sNx+Olx-1
455               localTij(i,j) = localTij(i,j)
456         &      -dTtracerLev(k)*recip_rhoFacC(k)
457         &       *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
458         &       *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
459         &       *( af(i+1,j)-af(i,j)
460         &         -tracer(i,j,k,bi,bj)*(uTrans(i+1,j)-uTrans(i,j))
461         &        )
462             ENDDO
463            ENDDO
464    C-      keep advective flux (for diagnostics)
465            DO j=1-Oly,sNy+Oly
466             DO i=1-Olx,sNx+Olx
467              afx(i,j) = af(i,j)
468             ENDDO
469            ENDDO
470    
471  #ifdef ALLOW_OBCS  #ifdef ALLOW_OBCS
472  C--   Apply open boundary conditions  C-     Apply open boundary conditions
473        IF (useOBCS) THEN          IF ( useOBCS ) THEN
474         IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN           IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
475          CALL OBCS_APPLY_TLOC( bi, bj, k, localTij, myThid )            CALL OBCS_APPLY_TLOC( bi, bj, k, localTij, myThid )
476         ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN           ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
477          CALL OBCS_APPLY_SLOC( bi, bj, k, localTij, myThid )            CALL OBCS_APPLY_SLOC( bi, bj, k, localTij, myThid )
478         END IF  #ifdef ALLOW_PTRACERS
479        END IF           ELSEIF (tracerIdentity.GE.GAD_TR1) THEN
480              CALL OBCS_APPLY_PTRACER( bi, bj, k,
481         &         tracerIdentity-GAD_TR1+1, localTij, myThid )
482    #endif /* ALLOW_PTRACERS */
483             ENDIF
484            ENDIF
485  #endif /* ALLOW_OBCS */  #endif /* ALLOW_OBCS */
486    
487    C-     end if/else update overlap-Only
488           ENDIF
489    
490  C--   End of X direction  C--   End of X direction
491        ENDIF        ENDIF
492    
493    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
494  C--   Y direction  C--   Y direction
495    cph-test
496    C-     Advective flux in Y
497            DO j=1-Oly,sNy+Oly
498             DO i=1-Olx,sNx+Olx
499              af(i,j) = 0.
500             ENDDO
501            ENDDO
502    C
503    #ifdef ALLOW_AUTODIFF_TAMC
504    # ifndef DISABLE_MULTIDIM_ADVECTION
505    CADJ STORE localTij(:,:)  =
506    CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
507    CADJ STORE af(:,:)  =
508    CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
509    # endif
510    #endif /* ALLOW_AUTODIFF_TAMC */
511    C
512        IF (calc_fluxes_Y) THEN        IF (calc_fluxes_Y) THEN
513    
514  C--   Internal exchange for calculations in Y  C-     Do not compute fluxes if
515        IF (useCubedSphereExchange) THEN  C       a) needed in overlap only
516         DO j=1,Oly  C   and b) the overlap of myTile are not cube-face edges
517          DO i=1,Olx         IF ( .NOT.overlapOnly .OR. E_edge .OR. W_edge ) THEN
518           localTij( 1-i , 1-j )=localTij(   j   , 1-i )  
519           localTij( 1-i ,sNy+j)=localTij(   j   ,sNy+i)  cph-exch2#ifndef ALLOW_AUTODIFF_TAMC
520           localTij(sNx+i, 1-j )=localTij(sNx+1-j, 1-i )  C-     Internal exchange for calculations in Y
521           localTij(sNx+i,sNy+j)=localTij(sNx+1-j,sNy+i)  #ifdef MULTIDIM_OLD_VERSION
522          ENDDO          IF ( useCubedSphereExchange ) THEN
523         ENDDO  #else
524        ENDIF          IF ( useCubedSphereExchange .AND.
525         &       ( overlapOnly .OR. ipass.EQ.1 ) ) THEN
526    #endif
527             CALL FILL_CS_CORNER_TR_RL(.FALSE., .FALSE.,
528         &                              localTij, bi,bj, myThid )
529            ENDIF
530    cph-exch2#endif
531    
532  C-    Advective flux in Y  C-     Advective flux in Y
533        DO j=1-Oly,sNy+Oly          DO j=1-Oly,sNy+Oly
534         DO i=1-Olx,sNx+Olx           DO i=1-Olx,sNx+Olx
535          af(i,j) = 0.            af(i,j) = 0.
536         ENDDO           ENDDO
537        ENDDO          ENDDO
538    
539  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
540  #ifndef DISABLE_MULTIDIM_ADVECTION  #ifndef DISABLE_MULTIDIM_ADVECTION
# Line 347  CADJ &     comlev1_bibj_k_gad_pass, key= Line 543  CADJ &     comlev1_bibj_k_gad_pass, key=
543  #endif  #endif
544  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
545    
546        IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN          IF ( advectionScheme.EQ.ENUM_UPWIND_1RST
547         CALL GAD_FLUXLIMIT_ADV_Y(       &     .OR. advectionScheme.EQ.ENUM_DST2 ) THEN
548       &       bi,bj,k,deltaTtracer,vTrans,vVel,localTij,af,myThid)            CALL GAD_DST2U1_ADV_Y( bi,bj,k, advectionScheme, .TRUE.,
549        ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN       I                           dTtracerLev(k),vTrans,vFld,localTij,
550         CALL GAD_DST3_ADV_Y(       O                           af, myThid )
551       &       bi,bj,k,deltaTtracer,vTrans,vVel,localTij,af,myThid)          ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
552        ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN            CALL GAD_FLUXLIMIT_ADV_Y( bi,bj,k, .TRUE., dTtracerLev(k),
553         CALL GAD_DST3FL_ADV_Y(       I                              vTrans, vFld, maskLocS, localTij,
554       &       bi,bj,k,deltaTtracer,vTrans,vVel,localTij,af,myThid)       O                              af, myThid )
555        ELSE          ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
556         STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'            CALL GAD_DST3_ADV_Y(      bi,bj,k, .TRUE., dTtracerLev(k),
557        ENDIF       I                              vTrans, vFld, maskLocS, localTij,
558         O                              af, myThid )
559            ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
560              CALL GAD_DST3FL_ADV_Y(    bi,bj,k, .TRUE., dTtracerLev(k),
561         I                              vTrans, vFld, maskLocS, localTij,
562         O                              af, myThid )
563    #ifndef ALLOW_AUTODIFF_TAMC
564            ELSEIF (advectionScheme.EQ.ENUM_OS7MP ) THEN
565              CALL GAD_OS7MP_ADV_Y(     bi,bj,k, .TRUE., dTtracerLev(k),
566         I                              vTrans, vFld, maskLocS, localTij,
567         O                              af, myThid )
568    #endif
569            ELSE
570             STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
571            ENDIF
572    
573        DO j=1-Oly,sNy+Oly-1  C-     Advective flux in Y : done
574         DO i=1-Olx,sNx+Olx         ENDIF
575          localTij(i,j)=localTij(i,j)-deltaTtracer*  
576       &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)  cph-exch2#ifndef ALLOW_AUTODIFF_TAMC
577       &    *recip_rA(i,j,bi,bj)  C-     Internal exchange for next calculations in X
578       &    *( af(i,j+1)-af(i,j)         IF ( overlapOnly .AND. ipass.EQ.1 ) THEN
579       &      -tracer(i,j,k,bi,bj)*(vTrans(i,j+1)-vTrans(i,j))           CALL FILL_CS_CORNER_TR_RL( .TRUE., .FALSE.,
580       &     )       &                              localTij, bi,bj, myThid )
581         ENDDO         ENDIF
582        ENDDO  cph-exch2#endif
583    
584    C-     Update the local tracer field where needed:
585    
586    C      update in overlap-Only
587           IF ( overlapOnly ) THEN
588            jMinUpd = 1-Oly+1
589            jMaxUpd = sNy+Oly-1
590    C- notes: these 2 lines below have no real effect (because recip_hFac=0
591    C         in corner region) but safer to keep them.
592            IF ( S_edge ) jMinUpd = 1
593            IF ( N_edge ) jMaxUpd = sNy
594    
595            IF ( W_edge ) THEN
596             DO j=jMinUpd,jMaxUpd
597              DO i=1-Olx,0
598               localTij(i,j) = localTij(i,j)
599         &      -dTtracerLev(k)*recip_rhoFacC(k)
600         &       *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
601         &       *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
602         &       *( af(i,j+1)-af(i,j)
603         &         -tracer(i,j,k,bi,bj)*(vTrans(i,j+1)-vTrans(i,j))
604         &        )
605              ENDDO
606             ENDDO
607            ENDIF
608            IF ( E_edge ) THEN
609             DO j=jMinUpd,jMaxUpd
610              DO i=sNx+1,sNx+Olx
611               localTij(i,j) = localTij(i,j)
612         &      -dTtracerLev(k)*recip_rhoFacC(k)
613         &       *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
614         &       *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
615         &       *( af(i,j+1)-af(i,j)
616         &         -tracer(i,j,k,bi,bj)*(vTrans(i,j+1)-vTrans(i,j))
617         &        )
618              ENDDO
619             ENDDO
620            ENDIF
621    
622           ELSE
623    C      do not only update the overlap
624            iMinUpd = 1-Olx
625            iMaxUpd = sNx+Olx
626            IF ( interiorOnly .AND. W_edge ) iMinUpd = 1
627            IF ( interiorOnly .AND. E_edge ) iMaxUpd = sNx
628            DO j=1-Oly+1,sNy+Oly-1
629             DO i=iMinUpd,iMaxUpd
630               localTij(i,j) = localTij(i,j)
631         &      -dTtracerLev(k)*recip_rhoFacC(k)
632         &       *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
633         &       *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
634         &       *( af(i,j+1)-af(i,j)
635         &         -tracer(i,j,k,bi,bj)*(vTrans(i,j+1)-vTrans(i,j))
636         &        )
637             ENDDO
638            ENDDO
639    C-      keep advective flux (for diagnostics)
640            DO j=1-Oly,sNy+Oly
641             DO i=1-Olx,sNx+Olx
642              afy(i,j) = af(i,j)
643             ENDDO
644            ENDDO
645    
646  #ifdef ALLOW_OBCS  #ifdef ALLOW_OBCS
647  C--   Apply open boundary conditions  C-     Apply open boundary conditions
648        IF (useOBCS) THEN          IF (useOBCS) THEN
649         IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN           IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
650          CALL OBCS_APPLY_TLOC( bi, bj, k, localTij, myThid )            CALL OBCS_APPLY_TLOC( bi, bj, k, localTij, myThid )
651         ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN           ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
652          CALL OBCS_APPLY_SLOC( bi, bj, k, localTij, myThid )            CALL OBCS_APPLY_SLOC( bi, bj, k, localTij, myThid )
653         END IF  #ifdef ALLOW_PTRACERS
654        END IF           ELSEIF (tracerIdentity.GE.GAD_TR1) THEN
655              CALL OBCS_APPLY_PTRACER( bi, bj, k,
656         &         tracerIdentity-GAD_TR1+1, localTij, myThid )
657    #endif /* ALLOW_PTRACERS */
658             ENDIF
659            ENDIF
660  #endif /* ALLOW_OBCS */  #endif /* ALLOW_OBCS */
661    
662    C      end if/else update overlap-Only
663           ENDIF
664    
665  C--   End of Y direction  C--   End of Y direction
666        ENDIF        ENDIF
667    
# Line 393  C-    explicit advection is done ; store Line 673  C-    explicit advection is done ; store
673          DO j=1-Oly,sNy+Oly          DO j=1-Oly,sNy+Oly
674           DO i=1-Olx,sNx+Olx           DO i=1-Olx,sNx+Olx
675            gTracer(i,j,k,bi,bj)=            gTracer(i,j,k,bi,bj)=
676       &     (localTij(i,j)-tracer(i,j,k,bi,bj))/deltaTtracer       &     (localTij(i,j)-tracer(i,j,k,bi,bj))/dTtracerLev(k)
677           ENDDO           ENDDO
678          ENDDO          ENDDO
679        ELSE        ELSE
680  C-    horizontal advection done; store intermediate result in 3D array:  C-    horizontal advection done; store intermediate result in 3D array:
681         DO j=1-Oly,sNy+Oly          DO j=1-Oly,sNy+Oly
682          DO i=1-Olx,sNx+Olx           DO i=1-Olx,sNx+Olx
683           localTijk(i,j,k)=localTij(i,j)            localTijk(i,j,k)=localTij(i,j)
684             ENDDO
685          ENDDO          ENDDO
        ENDDO  
686        ENDIF        ENDIF
687    
688    #ifdef ALLOW_DIAGNOSTICS
689            IF ( useDiagnostics ) THEN
690              diagName = 'ADVx'//diagSufx
691              CALL DIAGNOSTICS_FILL(afx,diagName, k,1, 2,bi,bj, myThid)
692              diagName = 'ADVy'//diagSufx
693              CALL DIAGNOSTICS_FILL(afy,diagName, k,1, 2,bi,bj, myThid)
694            ENDIF
695    #endif
696    
697    #ifdef ALLOW_DEBUG
698          IF ( debugLevel .GE. debLevB
699         &   .AND. tracerIdentity.EQ.GAD_TEMPERATURE
700         &   .AND. k.LE.3 .AND. myIter.EQ.1+nIter0
701         &   .AND. nPx.EQ.1 .AND. nPy.EQ.1
702         &   .AND. useCubedSphereExchange ) THEN
703            CALL DEBUG_CS_CORNER_UV( ' afx,afy from GAD_ADVECTION',
704         &             afx,afy, k, standardMessageUnit,bi,bj,myThid )
705          ENDIF
706    #endif /* ALLOW_DEBUG */
707    
708  C--   End of K loop for horizontal fluxes  C--   End of K loop for horizontal fluxes
709        ENDDO        ENDDO
710    
711    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
712    
713        IF ( .NOT.implicitAdvection ) THEN        IF ( .NOT.implicitAdvection ) THEN
714  C--   Start of k loop for vertical flux  C--   Start of k loop for vertical flux
715         DO k=Nr,1,-1         DO k=Nr,1,-1
716  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
717           kkey = (igadkey-1)*Nr + k           kkey = (igadkey-1)*Nr + (Nr-k+1)
718  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
719  C--   kup    Cycles through 1,2 to point to w-layer above  C--   kUp    Cycles through 1,2 to point to w-layer above
720  C--   kDown  Cycles through 2,1 to point to w-layer below  C--   kDown  Cycles through 2,1 to point to w-layer below
721          kup  = 1+MOD(k+1,2)          kUp  = 1+MOD(k+1,2)
722          kDown= 1+MOD(k,2)          kDown= 1+MOD(k,2)
723  c       kp1=min(Nr,k+1)  c       kp1=min(Nr,k+1)
724          kp1Msk=1.          kp1Msk=1.
725          if (k.EQ.Nr) kp1Msk=0.          if (k.EQ.Nr) kp1Msk=0.
726    
727    #ifdef ALLOW_AUTODIFF_TAMC
728    CADJ STORE rtrans(:,:)  =
729    CADJ &     comlev1_bibj_k_gad, key=kkey, byte=isbyte
730    cphCADJ STORE wfld(:,:)  =
731    cphCADJ &     comlev1_bibj_k_gad, key=kkey, byte=isbyte
732    #endif
733    
734  C-- Compute Vertical transport  C-- Compute Vertical transport
735          IF (k.EQ.1) THEN  #ifdef ALLOW_AIM
736    C- a hack to prevent Water-Vapor vert.transport into the stratospheric level Nr
737            IF ( k.EQ.1 .OR.
738         &     (useAIM .AND. tracerIdentity.EQ.GAD_SALINITY .AND. k.EQ.Nr)
739         &              ) THEN
740    #else
741            IF ( k.EQ.1 ) THEN
742    #endif
743    
744    #ifdef ALLOW_AUTODIFF_TAMC
745    cphmultiCADJ STORE wfld(:,:)  =
746    cphmultiCADJ &     comlev1_bibj_k_gad, key=kkey, byte=isbyte
747    #endif /* ALLOW_AUTODIFF_TAMC */
748    
749  C- Surface interface :  C- Surface interface :
750           DO j=1-Oly,sNy+Oly           DO j=1-Oly,sNy+Oly
751            DO i=1-Olx,sNx+Olx            DO i=1-Olx,sNx+Olx
752             rTransKp1(i,j) = rTrans(i,j)             rTransKp1(i,j) = kp1Msk*rTrans(i,j)
753               wFld(i,j)   = 0.
754             rTrans(i,j) = 0.             rTrans(i,j) = 0.
755             fVerT(i,j,kUp) = 0.             fVerT(i,j,kUp) = 0.
            af(i,j) = 0.  
756            ENDDO            ENDDO
757           ENDDO           ENDDO
758    
759          ELSE          ELSE
 C- Interior interface :  
760    
761    #ifdef ALLOW_AUTODIFF_TAMC
762    cphmultiCADJ STORE wfld(:,:)  =
763    cphmultiCADJ &     comlev1_bibj_k_gad, key=kkey, byte=isbyte
764    #endif /* ALLOW_AUTODIFF_TAMC */
765    
766    C- Interior interface :
767           DO j=1-Oly,sNy+Oly           DO j=1-Oly,sNy+Oly
768            DO i=1-Olx,sNx+Olx            DO i=1-Olx,sNx+Olx
769             rTransKp1(i,j) = kp1Msk*rTrans(i,j)             rTransKp1(i,j) = kp1Msk*rTrans(i,j)
770               wFld(i,j)   = wVel(i,j,k,bi,bj)
771             rTrans(i,j) = wVel(i,j,k,bi,bj)*rA(i,j,bi,bj)             rTrans(i,j) = wVel(i,j,k,bi,bj)*rA(i,j,bi,bj)
772         &                 *deepFac2F(k)*rhoFacF(k)
773       &                 *maskC(i,j,k-1,bi,bj)       &                 *maskC(i,j,k-1,bi,bj)
774             af(i,j) = 0.             fVerT(i,j,kUp) = 0.
775            ENDDO            ENDDO
776           ENDDO           ENDDO
777    
778  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
779  C--   Residual transp = Bolus transp + Eulerian transp  C--   Residual transp = Bolus transp + Eulerian transp
780           IF (useGMRedi)           IF (useGMRedi)
781       &   CALL GMREDI_CALC_WFLOW(       &     CALL GMREDI_CALC_WFLOW(
782       &                    rTrans, bi, bj, k, myThid)       U                 wFld, rTrans,
783         I                 k, bi, bj, myThid )
784  #endif /* ALLOW_GMREDI */  #endif /* ALLOW_GMREDI */
785    
786  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
787  CADJ STORE localTijk(:,:,k)    cphmultiCADJ STORE localTijk(:,:,k)  
788  CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte  cphmultiCADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
789  CADJ STORE rTrans(:,:)    cphmultiCADJ STORE rTrans(:,:)  
790  CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte  cphmultiCADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
791  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
792    
793  C-    Compute vertical advective flux in the interior:  C-    Compute vertical advective flux in the interior:
794           IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN           IF ( vertAdvecScheme.EQ.ENUM_UPWIND_1RST
795            CALL GAD_FLUXLIMIT_ADV_R(       &      .OR. vertAdvecScheme.EQ.ENUM_DST2 ) THEN
796       &        bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)             CALL GAD_DST2U1_ADV_R( bi,bj,k, advectionScheme,
797           ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN       I                            dTtracerLev(k),rTrans,wFld,localTijk,
798            CALL GAD_DST3_ADV_R(       O                            fVerT(1-Olx,1-Oly,kUp), myThid )
799       &        bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)           ELSEIF( vertAdvecScheme.EQ.ENUM_FLUX_LIMIT) THEN
800           ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN             CALL GAD_FLUXLIMIT_ADV_R( bi,bj,k, dTtracerLev(k),
801            CALL GAD_DST3FL_ADV_R(       I                               rTrans, wFld, localTijk,
802       &        bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)       O                               fVerT(1-Olx,1-Oly,kUp), myThid )
803             ELSEIF( vertAdvecScheme.EQ.ENUM_DST3 ) THEN
804               CALL GAD_DST3_ADV_R(      bi,bj,k, dTtracerLev(k),
805         I                               rTrans, wFld, localTijk,
806         O                               fVerT(1-Olx,1-Oly,kUp), myThid )
807             ELSEIF( vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
808               CALL GAD_DST3FL_ADV_R(    bi,bj,k, dTtracerLev(k),
809         I                               rTrans, wFld, localTijk,
810         O                               fVerT(1-Olx,1-Oly,kUp), myThid )
811    #ifndef ALLOW_AUTODIFF_TAMC
812             ELSEIF (vertAdvecScheme.EQ.ENUM_OS7MP ) THEN
813               CALL GAD_OS7MP_ADV_R(     bi,bj,k, dTtracerLev(k),
814         I                               rTrans, wFld, localTijk,
815         O                               fVerT(1-Olx,1-Oly,kUp), myThid )
816    #endif
817           ELSE           ELSE
818            STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'            STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
819           ENDIF           ENDIF
 C-    add the advective flux to fVerT  
          DO j=1-Oly,sNy+Oly  
           DO i=1-Olx,sNx+Olx  
            fVerT(i,j,kUp) = af(i,j)  
           ENDDO  
          ENDDO  
820    
821  C- end Surface/Interior if bloc  C- end Surface/Interior if bloc
822          ENDIF          ENDIF
823    
824  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
825  CADJ STORE rTrans(:,:)    cphmultiCADJ STORE rTrans(:,:)  
826  CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte  cphmultiCADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
827  CADJ STORE rTranskp1(:,:)    cphmultiCADJ STORE rTranskp1(:,:)  
828    cphmultiCADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
829    cph --- following storing of fVerT is critical for correct
830    cph --- gradient with multiDimAdvection
831    cph --- Without it, kDown component is not properly recomputed
832    cph --- This is a TAF bug (and no warning available)
833    CADJ STORE fVerT(:,:,:)  
834  CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
835  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
836    
837  C--   Divergence of vertical fluxes  C--   Divergence of vertical fluxes
838          DO j=1-Oly,sNy+Oly          DO j=1-Oly,sNy+Oly
839           DO i=1-Olx,sNx+Olx           DO i=1-Olx,sNx+Olx
840            localTij(i,j)=localTijk(i,j,k)-deltaTtracer*            localTij(i,j) = localTijk(i,j,k)
841       &     _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)       &      -dTtracerLev(k)*recip_rhoFacC(k)
842       &     *recip_rA(i,j,bi,bj)       &       *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
843       &     *( fVerT(i,j,kUp)-fVerT(i,j,kDown)       &       *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
844       &       -tracer(i,j,k,bi,bj)*(rTrans(i,j)-rTransKp1(i,j))       &       *( fVerT(i,j,kDown)-fVerT(i,j,kUp)
845       &      )*rkFac       &         -tracer(i,j,k,bi,bj)*(rTransKp1(i,j)-rTrans(i,j))
846         &        )*rkSign
847            gTracer(i,j,k,bi,bj)=            gTracer(i,j,k,bi,bj)=
848       &     (localTij(i,j)-tracer(i,j,k,bi,bj))/deltaTtracer       &     (localTij(i,j)-tracer(i,j,k,bi,bj))/dTtracerLev(k)
849           ENDDO           ENDDO
850          ENDDO          ENDDO
851    
852    #ifdef ALLOW_DIAGNOSTICS
853            IF ( useDiagnostics ) THEN
854              diagName = 'ADVr'//diagSufx
855              CALL DIAGNOSTICS_FILL( fVerT(1-Olx,1-Oly,kUp),
856         &                           diagName, k,1, 2,bi,bj, myThid)
857            ENDIF
858    #endif
859    
860  C--   End of K loop for vertical flux  C--   End of K loop for vertical flux
861         ENDDO         ENDDO
862  C--   end of if not.implicitAdvection block  C--   end of if not.implicitAdvection block
863        ENDIF        ENDIF
864    
865        RETURN        RETURN
866        END        END
Legend:
Removed from v.1.19  
changed lines
  Added in v.1.53
  ViewVC Help
Powered by ViewVC 1.1.22