pkg/generic_advdiff/gad_advection.F

C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/gad_advection.F,v 1.22 2004/06/25 18:19:20 jmc Exp $
C $Name:  $

#include "GAD_OPTIONS.h"

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: GAD_ADVECTION

C !INTERFACE: ==========================================================
      SUBROUTINE GAD_ADVECTION(
     I     implicitAdvection, advectionScheme, vertAdvecScheme,
     I     tracerIdentity,
     I     uVel, vVel, wVel, tracer,
     O     gTracer,
     I     bi,bj, myTime,myIter,myThid)

C !DESCRIPTION:
C Calculates the tendancy of a tracer due to advection.
C It uses the multi-dimensional method given in \ref{sect:multiDimAdvection}
C and can only be used for the non-linear advection schemes such as the
C direct-space-time method and flux-limiters. 
C
C The algorithm is as follows:
C \begin{itemize}
C \item{$\theta^{(n+1/3)} = \theta^{(n)}
C      - \Delta t \partial_x (u\theta^{(n)}) + \theta^{(n)} \partial_x u$}
C \item{$\theta^{(n+2/3)} = \theta^{(n+1/3)}
C      - \Delta t \partial_y (v\theta^{(n+1/3)}) + \theta^{(n)} \partial_y v$}
C \item{$\theta^{(n+3/3)} = \theta^{(n+2/3)}
C      - \Delta t \partial_r (w\theta^{(n+2/3)}) + \theta^{(n)} \partial_r w$}
C \item{$G_\theta = ( \theta^{(n+3/3)} - \theta^{(n)} )/\Delta t$}
C \end{itemize}
C
C The tendancy (output) is over-written by this routine.

C !USES: ===============================================================
      IMPLICIT NONE
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "GAD.h"
#ifdef ALLOW_AUTODIFF_TAMC
# include "tamc.h"
# include "tamc_keys.h"
#endif

C !INPUT PARAMETERS: ===================================================
C  implicitAdvection :: implicit vertical advection (later on)
C  advectionScheme   :: advection scheme to use (Horizontal plane)
C  vertAdvecScheme   :: advection scheme to use (vertical direction)
C  tracerIdentity    :: tracer identifier (required only for OBCS)
C  uVel              :: velocity, zonal component
C  vVel              :: velocity, meridional component
C  wVel              :: velocity, vertical component
C  tracer            :: tracer field
C  bi,bj             :: tile indices
C  myTime            :: current time
C  myIter            :: iteration number
C  myThid            :: thread number
      LOGICAL implicitAdvection
      INTEGER advectionScheme, vertAdvecScheme
      INTEGER tracerIdentity
      _RL uVel  (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
      _RL vVel  (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
      _RL wVel  (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
      _RL tracer(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
      INTEGER bi,bj
      _RL myTime
      INTEGER myIter
      INTEGER myThid

C !OUTPUT PARAMETERS: ==================================================
C  gTracer           :: tendancy array
      _RL gTracer(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)

C !LOCAL VARIABLES: ====================================================
C  maskUp        :: 2-D array for mask at W points
C  iMin,iMax,    :: loop range for called routines
C  jMin,jMax     :: loop range for called routines
C  i,j,k         :: loop indices
C  kup           :: index into 2 1/2D array, toggles between 1 and 2
C  kdown         :: index into 2 1/2D array, toggles between 2 and 1
C  kp1           :: =k+1 for k<Nr, =Nr for k=Nr
C  xA,yA         :: areas of X and Y face of tracer cells
C  uTrans,vTrans :: 2-D arrays of volume transports at U,V points
C  rTrans        :: 2-D arrays of volume transports at W points
C  rTransKp1     :: vertical volume transport at interface k+1
C  af            :: 2-D array for horizontal advective flux
C  fVerT         :: 2 1/2D arrays for vertical advective flux
C  localTij      :: 2-D array, temporary local copy of tracer fld
C  localTijk     :: 3-D array, temporary local copy of tracer fld
C  kp1Msk        :: flag (0,1) for over-riding mask for W levels
C  calc_fluxes_X :: logical to indicate to calculate fluxes in X dir
C  calc_fluxes_Y :: logical to indicate to calculate fluxes in Y dir
C  nipass        :: number of passes in multi-dimensional method
C  ipass         :: number of the current pass being made
      _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      INTEGER iMin,iMax,jMin,jMax
      INTEGER i,j,k,kup,kDown
      _RS xA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RS yA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL af      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL fVerT   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
      _RL localTij(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL localTijk(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
      _RL kp1Msk
      LOGICAL calc_fluxes_X,calc_fluxes_Y
      INTEGER nipass,ipass
CEOP

#ifdef ALLOW_AUTODIFF_TAMC
          act0 = tracerIdentity - 1
          max0 = maxpass
          act1 = bi - myBxLo(myThid)
          max1 = myBxHi(myThid) - myBxLo(myThid) + 1
          act2 = bj - myByLo(myThid)
          max2 = myByHi(myThid) - myByLo(myThid) + 1
          act3 = myThid - 1
          max3 = nTx*nTy
          act4 = ikey_dynamics - 1
          igadkey = (act0 + 1) 
     &                      + act1*max0
     &                      + act2*max0*max1
     &                      + act3*max0*max1*max2
     &                      + act4*max0*max1*max2*max3
          if (tracerIdentity.GT.maxpass) then
             print *, 'ph-pass gad_advection ', maxpass, tracerIdentity
             STOP 'maxpass seems smaller than tracerIdentity'
          endif
#endif /* ALLOW_AUTODIFF_TAMC */

C--   Set up work arrays with valid (i.e. not NaN) values
C     These inital values do not alter the numerical results. They
C     just ensure that all memory references are to valid floating
C     point numbers. This prevents spurious hardware signals due to
C     uninitialised but inert locations.
      DO j=1-OLy,sNy+OLy
       DO i=1-OLx,sNx+OLx
        xA(i,j)      = 0. _d 0
        yA(i,j)      = 0. _d 0
        uTrans(i,j)  = 0. _d 0
        vTrans(i,j)  = 0. _d 0
        rTrans(i,j)  = 0. _d 0
        fVerT(i,j,1) = 0. _d 0
        fVerT(i,j,2) = 0. _d 0
        rTransKp1(i,j)= 0. _d 0
       ENDDO
      ENDDO

      iMin = 1-OLx
      iMax = sNx+OLx
      jMin = 1-OLy
      jMax = sNy+OLy

C--   Start of k loop for horizontal fluxes
      DO k=1,Nr
#ifdef ALLOW_AUTODIFF_TAMC 
         kkey = (igadkey-1)*Nr + k
CADJ STORE tracer(:,:,k,bi,bj) = 
CADJ &     comlev1_bibj_k_gad, key=kkey, byte=isbyte
#endif /* ALLOW_AUTODIFF_TAMC */

C--   Get temporary terms used by tendency routines
      CALL CALC_COMMON_FACTORS (
     I         bi,bj,iMin,iMax,jMin,jMax,k,
     O         xA,yA,uTrans,vTrans,rTrans,maskUp,
     I         myThid)

#ifdef ALLOW_GMREDI
C--   Residual transp = Bolus transp + Eulerian transp
       IF (useGMRedi)
     &   CALL GMREDI_CALC_UVFLOW(
     &            uTrans, vTrans, bi, bj, k, myThid)
#endif /* ALLOW_GMREDI */

C--   Make local copy of tracer array
      DO j=1-OLy,sNy+OLy
       DO i=1-OLx,sNx+OLx
        localTij(i,j)=tracer(i,j,k,bi,bj)
       ENDDO
      ENDDO

      IF (useCubedSphereExchange) THEN
       nipass=3
#ifdef ALLOW_AUTODIFF_TAMC
       if ( nipass.GT.maxcube )
     &      STOP 'maxcube needs to be = 3'
#endif
      ELSE
       nipass=1
      ENDIF
cph       nipass=1

C--   Multiple passes for different directions on different tiles
      DO ipass=1,nipass
#ifdef ALLOW_AUTODIFF_TAMC
         passkey = ipass + (k-1)      *maxcube
     &                   + (igadkey-1)*maxcube*Nr
         IF (nipass .GT. maxpass) THEN
          STOP 'GAD_ADVECTION: nipass > maxcube. check tamc.h'
         ENDIF
#endif /* ALLOW_AUTODIFF_TAMC */

      IF (nipass.EQ.3) THEN
       calc_fluxes_X=.FALSE.
       calc_fluxes_Y=.FALSE.
       IF (ipass.EQ.1 .AND. (bi.EQ.1 .OR. bi.EQ.2) ) THEN
        calc_fluxes_X=.TRUE.
       ELSEIF (ipass.EQ.1 .AND. (bi.EQ.4 .OR. bi.EQ.5) ) THEN
        calc_fluxes_Y=.TRUE.
       ELSEIF (ipass.EQ.2 .AND. (bi.EQ.1 .OR. bi.EQ.6) ) THEN
        calc_fluxes_Y=.TRUE.
       ELSEIF (ipass.EQ.2 .AND. (bi.EQ.3 .OR. bi.EQ.4) ) THEN
        calc_fluxes_X=.TRUE.
       ELSEIF (ipass.EQ.3 .AND. (bi.EQ.2 .OR. bi.EQ.3) ) THEN
        calc_fluxes_Y=.TRUE.
       ELSEIF (ipass.EQ.3 .AND. (bi.EQ.5 .OR. bi.EQ.6) ) THEN
        calc_fluxes_X=.TRUE.
       ENDIF
      ELSE
       calc_fluxes_X=.TRUE.
       calc_fluxes_Y=.TRUE.
      ENDIF
 
C--   X direction
      IF (calc_fluxes_X) THEN

C--   Internal exchange for calculations in X
      IF (useCubedSphereExchange) THEN
       DO j=1,Oly
        DO i=1,Olx
         localTij( 1-i , 1-j )=localTij( 1-j ,    i    )
         localTij( 1-i ,sNy+j)=localTij( 1-j , sNy+1-i )
         localTij(sNx+i, 1-j )=localTij(sNx+j,    i    )
         localTij(sNx+i,sNy+j)=localTij(sNx+j, sNy+1-i )
        ENDDO
       ENDDO
      ENDIF

C-    Advective flux in X
      DO j=1-Oly,sNy+Oly
       DO i=1-Olx,sNx+Olx
        af(i,j) = 0.
       ENDDO
      ENDDO

#ifdef ALLOW_AUTODIFF_TAMC
#ifndef DISABLE_MULTIDIM_ADVECTION
CADJ STORE localTij(:,:)  = 
CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
#endif
#endif /* ALLOW_AUTODIFF_TAMC */

      IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
       CALL GAD_FLUXLIMIT_ADV_X(
     &      bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)
      ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
       CALL GAD_DST3_ADV_X(
     &       bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)
      ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
       CALL GAD_DST3FL_ADV_X(
     &       bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)
      ELSE
       STOP 'GAD_ADVECTION: adv. scheme incompatibale with multi-dim'
      ENDIF

      DO j=1-Oly,sNy+Oly
       DO i=1-Olx,sNx+Olx-1
        localTij(i,j)=localTij(i,j)-deltaTtracer*
     &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
     &    *recip_rA(i,j,bi,bj)
     &    *( af(i+1,j)-af(i,j)
     &      -tracer(i,j,k,bi,bj)*(uTrans(i+1,j)-uTrans(i,j))
     &     )
       ENDDO
      ENDDO

#ifdef ALLOW_OBCS
C--   Apply open boundary conditions
      IF (useOBCS) THEN
       IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
        CALL OBCS_APPLY_TLOC( bi, bj, k, localTij, myThid )
       ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
        CALL OBCS_APPLY_SLOC( bi, bj, k, localTij, myThid )
       END IF
      END IF
#endif /* ALLOW_OBCS */

C--   End of X direction
      ENDIF

C--   Y direction
      IF (calc_fluxes_Y) THEN

C--   Internal exchange for calculations in Y
      IF (useCubedSphereExchange) THEN
       DO j=1,Oly
        DO i=1,Olx
         localTij( 1-i , 1-j )=localTij(   j   , 1-i )
         localTij( 1-i ,sNy+j)=localTij(   j   ,sNy+i)
         localTij(sNx+i, 1-j )=localTij(sNx+1-j, 1-i )
         localTij(sNx+i,sNy+j)=localTij(sNx+1-j,sNy+i)
        ENDDO
       ENDDO
      ENDIF

C-    Advective flux in Y
      DO j=1-Oly,sNy+Oly
       DO i=1-Olx,sNx+Olx
        af(i,j) = 0.
       ENDDO
      ENDDO

#ifdef ALLOW_AUTODIFF_TAMC 
#ifndef DISABLE_MULTIDIM_ADVECTION
CADJ STORE localTij(:,:)  = 
CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
#endif
#endif /* ALLOW_AUTODIFF_TAMC */

      IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
       CALL GAD_FLUXLIMIT_ADV_Y(
     &       bi,bj,k,deltaTtracer,vTrans,vVel,localTij,af,myThid)
      ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
       CALL GAD_DST3_ADV_Y(
     &       bi,bj,k,deltaTtracer,vTrans,vVel,localTij,af,myThid)
      ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
       CALL GAD_DST3FL_ADV_Y(
     &       bi,bj,k,deltaTtracer,vTrans,vVel,localTij,af,myThid)
      ELSE
       STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
      ENDIF

      DO j=1-Oly,sNy+Oly-1
       DO i=1-Olx,sNx+Olx
        localTij(i,j)=localTij(i,j)-deltaTtracer*
     &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
     &    *recip_rA(i,j,bi,bj)
     &    *( af(i,j+1)-af(i,j)
     &      -tracer(i,j,k,bi,bj)*(vTrans(i,j+1)-vTrans(i,j))
     &     )
       ENDDO
      ENDDO

#ifdef ALLOW_OBCS
C--   Apply open boundary conditions
      IF (useOBCS) THEN
       IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
        CALL OBCS_APPLY_TLOC( bi, bj, k, localTij, myThid )
       ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
        CALL OBCS_APPLY_SLOC( bi, bj, k, localTij, myThid )
       END IF
      END IF
#endif /* ALLOW_OBCS */

C--   End of Y direction
      ENDIF

C--   End of ipass loop
      ENDDO

      IF ( implicitAdvection ) THEN
C-    explicit advection is done ; store tendency in gTracer:
        DO j=1-Oly,sNy+Oly
         DO i=1-Olx,sNx+Olx
          gTracer(i,j,k,bi,bj)=
     &     (localTij(i,j)-tracer(i,j,k,bi,bj))/deltaTtracer
         ENDDO
        ENDDO
      ELSE
C-    horizontal advection done; store intermediate result in 3D array:
       DO j=1-Oly,sNy+Oly
        DO i=1-Olx,sNx+Olx
         localTijk(i,j,k)=localTij(i,j)
        ENDDO
       ENDDO
      ENDIF

C--   End of K loop for horizontal fluxes
      ENDDO

      IF ( .NOT.implicitAdvection ) THEN
C--   Start of k loop for vertical flux
       DO k=Nr,1,-1
#ifdef ALLOW_AUTODIFF_TAMC 
         kkey = (igadkey-1)*Nr + k
#endif /* ALLOW_AUTODIFF_TAMC */
C--   kup    Cycles through 1,2 to point to w-layer above
C--   kDown  Cycles through 2,1 to point to w-layer below
        kup  = 1+MOD(k+1,2)
        kDown= 1+MOD(k,2)
c       kp1=min(Nr,k+1)
        kp1Msk=1.
        if (k.EQ.Nr) kp1Msk=0.

C-- Compute Vertical transport
#ifdef ALLOW_AIM
C- a hack to prevent Water-Vapor vert.transport into the stratospheric level Nr
        IF ( k.EQ.1 .OR.
     &     (useAIM .AND. tracerIdentity.EQ.GAD_SALINITY .AND. k.EQ.Nr)
     &              ) THEN
#else
        IF ( k.EQ.1 ) THEN
#endif

C- Surface interface :
         DO j=1-Oly,sNy+Oly
          DO i=1-Olx,sNx+Olx
           rTransKp1(i,j) = kp1Msk*rTrans(i,j)
           rTrans(i,j) = 0.
           fVerT(i,j,kUp) = 0.
           af(i,j) = 0.
          ENDDO
         ENDDO

        ELSE
C- Interior interface :

         DO j=1-Oly,sNy+Oly
          DO i=1-Olx,sNx+Olx
           rTransKp1(i,j) = kp1Msk*rTrans(i,j)
           rTrans(i,j) = wVel(i,j,k,bi,bj)*rA(i,j,bi,bj)
     &                 *maskC(i,j,k-1,bi,bj)
           af(i,j) = 0.
          ENDDO
         ENDDO

#ifdef ALLOW_GMREDI
C--   Residual transp = Bolus transp + Eulerian transp
         IF (useGMRedi) 
     &   CALL GMREDI_CALC_WFLOW(
     &                    rTrans, bi, bj, k, myThid)
#endif /* ALLOW_GMREDI */

#ifdef ALLOW_AUTODIFF_TAMC 
CADJ STORE localTijk(:,:,k)  
CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
CADJ STORE rTrans(:,:)  
CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
#endif /* ALLOW_AUTODIFF_TAMC */

C-    Compute vertical advective flux in the interior:
         IF (vertAdvecScheme.EQ.ENUM_FLUX_LIMIT) THEN
          CALL GAD_FLUXLIMIT_ADV_R(
     &        bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)
         ELSEIF (vertAdvecScheme.EQ.ENUM_DST3 ) THEN
          CALL GAD_DST3_ADV_R(
     &        bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)
         ELSEIF (vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
          CALL GAD_DST3FL_ADV_R(
     &        bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)
         ELSE
          STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
         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

C- end Surface/Interior if bloc
        ENDIF

#ifdef ALLOW_AUTODIFF_TAMC 
CADJ STORE rTrans(:,:)  
CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
CADJ STORE rTranskp1(:,:)  
CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
#endif /* ALLOW_AUTODIFF_TAMC */

C--   Divergence of vertical fluxes
        DO j=1-Oly,sNy+Oly
         DO i=1-Olx,sNx+Olx
          localTij(i,j)=localTijk(i,j,k)-deltaTtracer*
     &     _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
     &     *recip_rA(i,j,bi,bj)
     &     *( fVerT(i,j,kUp)-fVerT(i,j,kDown)
     &       -tracer(i,j,k,bi,bj)*(rTrans(i,j)-rTransKp1(i,j))
     &      )*rkFac
          gTracer(i,j,k,bi,bj)=
     &     (localTij(i,j)-tracer(i,j,k,bi,bj))/deltaTtracer
         ENDDO
        ENDDO
 
C--   End of K loop for vertical flux
       ENDDO
C--   end of if not.implicitAdvection block
      ENDIF 

      RETURN
      END
1	jmc	1.23	C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/gad_advection.F,v 1.22 2004/06/25 18:19:20 jmc Exp $
2	adcroft	1.2	C $Name: $
3	adcroft	1.4
4	adcroft	1.1	#include "GAD_OPTIONS.h"
5
6	edhill	1.19	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
7	adcroft	1.4	CBOP
8			C !ROUTINE: GAD_ADVECTION
9
10			C !INTERFACE: ==========================================================
11	jmc	1.17	SUBROUTINE GAD_ADVECTION(
12	jmc	1.23	I implicitAdvection, advectionScheme, vertAdvecScheme,
13			I tracerIdentity,
14	edhill	1.21	I uVel, vVel, wVel, tracer,
15			O gTracer,
16			I bi,bj, myTime,myIter,myThid)
17	adcroft	1.4
18			C !DESCRIPTION:
19			C Calculates the tendancy of a tracer due to advection.
20			C It uses the multi-dimensional method given in \ref{sect:multiDimAdvection}
21			C and can only be used for the non-linear advection schemes such as the
22			C direct-space-time method and flux-limiters.
23			C
24			C The algorithm is as follows:
25			C \begin{itemize}
26			C \item{$\theta^{(n+1/3)} = \theta^{(n)}
27	adcroft	1.5	C - \Delta t \partial_x (u\theta^{(n)}) + \theta^{(n)} \partial_x u$}
28	adcroft	1.4	C \item{$\theta^{(n+2/3)} = \theta^{(n+1/3)}
29	adcroft	1.5	C - \Delta t \partial_y (v\theta^{(n+1/3)}) + \theta^{(n)} \partial_y v$}
30	adcroft	1.4	C \item{$\theta^{(n+3/3)} = \theta^{(n+2/3)}
31	adcroft	1.5	C - \Delta t \partial_r (w\theta^{(n+2/3)}) + \theta^{(n)} \partial_r w$}
32	adcroft	1.4	C \item{$G_\theta = ( \theta^{(n+3/3)} - \theta^{(n)} )/\Delta t$}
33			C \end{itemize}
34			C
35			C The tendancy (output) is over-written by this routine.
36
37			C !USES: ===============================================================
38	adcroft	1.1	IMPLICIT NONE
39			#include "SIZE.h"
40			#include "EEPARAMS.h"
41			#include "PARAMS.h"
42			#include "GRID.h"
43			#include "GAD.h"
44	heimbach	1.6	#ifdef ALLOW_AUTODIFF_TAMC
45			# include "tamc.h"
46			# include "tamc_keys.h"
47			#endif
48	adcroft	1.1
49	adcroft	1.4	C !INPUT PARAMETERS: ===================================================
50	edhill	1.21	C implicitAdvection :: implicit vertical advection (later on)
51	jmc	1.23	C advectionScheme :: advection scheme to use (Horizontal plane)
52			C vertAdvecScheme :: advection scheme to use (vertical direction)
53	edhill	1.21	C tracerIdentity :: tracer identifier (required only for OBCS)
54			C uVel :: velocity, zonal component
55			C vVel :: velocity, meridional component
56			C wVel :: velocity, vertical component
57			C tracer :: tracer field
58			C bi,bj :: tile indices
59			C myTime :: current time
60			C myIter :: iteration number
61			C myThid :: thread number
62	jmc	1.17	LOGICAL implicitAdvection
63	jmc	1.23	INTEGER advectionScheme, vertAdvecScheme
64	adcroft	1.1	INTEGER tracerIdentity
65	jmc	1.17	_RL uVel (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
66			_RL vVel (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
67			_RL wVel (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
68			_RL tracer(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
69			INTEGER bi,bj
70	adcroft	1.1	_RL myTime
71			INTEGER myIter
72			INTEGER myThid
73
74	adcroft	1.4	C !OUTPUT PARAMETERS: ==================================================
75	edhill	1.21	C gTracer :: tendancy array
76	adcroft	1.9	_RL gTracer(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
77	adcroft	1.4
78			C !LOCAL VARIABLES: ====================================================
79	edhill	1.21	C maskUp :: 2-D array for mask at W points
80			C iMin,iMax, :: loop range for called routines
81			C jMin,jMax :: loop range for called routines
82			C i,j,k :: loop indices
83			C kup :: index into 2 1/2D array, toggles between 1 and 2
84			C kdown :: index into 2 1/2D array, toggles between 2 and 1
85			C kp1 :: =k+1 for k<Nr, =Nr for k=Nr
86			C xA,yA :: areas of X and Y face of tracer cells
87			C uTrans,vTrans :: 2-D arrays of volume transports at U,V points
88			C rTrans :: 2-D arrays of volume transports at W points
89			C rTransKp1 :: vertical volume transport at interface k+1
90			C af :: 2-D array for horizontal advective flux
91			C fVerT :: 2 1/2D arrays for vertical advective flux
92			C localTij :: 2-D array, temporary local copy of tracer fld
93			C localTijk :: 3-D array, temporary local copy of tracer fld
94			C kp1Msk :: flag (0,1) for over-riding mask for W levels
95			C calc_fluxes_X :: logical to indicate to calculate fluxes in X dir
96			C calc_fluxes_Y :: logical to indicate to calculate fluxes in Y dir
97			C nipass :: number of passes in multi-dimensional method
98			C ipass :: number of the current pass being made
99	adcroft	1.1	_RS maskUp (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
100			INTEGER iMin,iMax,jMin,jMax
101	jmc	1.11	INTEGER i,j,k,kup,kDown
102	adcroft	1.1	_RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
103			_RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
104			_RL uTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
105			_RL vTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
106			_RL rTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
107	jmc	1.11	_RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
108	adcroft	1.1	_RL af (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
109			_RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
110			_RL localTij(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
111			_RL localTijk(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
112			_RL kp1Msk
113	adcroft	1.3	LOGICAL calc_fluxes_X,calc_fluxes_Y
114			INTEGER nipass,ipass
115	adcroft	1.4	CEOP
116	adcroft	1.1
117	heimbach	1.6	#ifdef ALLOW_AUTODIFF_TAMC
118	heimbach	1.14	act0 = tracerIdentity - 1
119			max0 = maxpass
120	heimbach	1.6	act1 = bi - myBxLo(myThid)
121			max1 = myBxHi(myThid) - myBxLo(myThid) + 1
122			act2 = bj - myByLo(myThid)
123			max2 = myByHi(myThid) - myByLo(myThid) + 1
124			act3 = myThid - 1
125			max3 = nTx*nTy
126			act4 = ikey_dynamics - 1
127	heimbach	1.14	igadkey = (act0 + 1)
128			& + act1*max0
129			& + act2max0max1
130			& + act3max0max1*max2
131			& + act4max0max1max2max3
132	heimbach	1.15	if (tracerIdentity.GT.maxpass) then
133			print *, 'ph-pass gad_advection ', maxpass, tracerIdentity
134			STOP 'maxpass seems smaller than tracerIdentity'
135			endif
136	heimbach	1.6	#endif /* ALLOW_AUTODIFF_TAMC */
137
138	adcroft	1.1	C-- Set up work arrays with valid (i.e. not NaN) values
139			C These inital values do not alter the numerical results. They
140			C just ensure that all memory references are to valid floating
141			C point numbers. This prevents spurious hardware signals due to
142			C uninitialised but inert locations.
143			DO j=1-OLy,sNy+OLy
144			DO i=1-OLx,sNx+OLx
145			xA(i,j) = 0. _d 0
146			yA(i,j) = 0. _d 0
147			uTrans(i,j) = 0. _d 0
148			vTrans(i,j) = 0. _d 0
149			rTrans(i,j) = 0. _d 0
150			fVerT(i,j,1) = 0. _d 0
151			fVerT(i,j,2) = 0. _d 0
152	jmc	1.11	rTransKp1(i,j)= 0. _d 0
153	adcroft	1.1	ENDDO
154			ENDDO
155
156			iMin = 1-OLx
157			iMax = sNx+OLx
158			jMin = 1-OLy
159			jMax = sNy+OLy
160
161			C-- Start of k loop for horizontal fluxes
162			DO k=1,Nr
163	heimbach	1.6	#ifdef ALLOW_AUTODIFF_TAMC
164	heimbach	1.14	kkey = (igadkey-1)*Nr + k
165			CADJ STORE tracer(:,:,k,bi,bj) =
166			CADJ & comlev1_bibj_k_gad, key=kkey, byte=isbyte
167	heimbach	1.6	#endif /* ALLOW_AUTODIFF_TAMC */
168	adcroft	1.1
169			C-- Get temporary terms used by tendency routines
170			CALL CALC_COMMON_FACTORS (
171			I bi,bj,iMin,iMax,jMin,jMax,k,
172			O xA,yA,uTrans,vTrans,rTrans,maskUp,
173			I myThid)
174
175	jmc	1.11	#ifdef ALLOW_GMREDI
176			C-- Residual transp = Bolus transp + Eulerian transp
177			IF (useGMRedi)
178			& CALL GMREDI_CALC_UVFLOW(
179			& uTrans, vTrans, bi, bj, k, myThid)
180			#endif /* ALLOW_GMREDI */
181
182	adcroft	1.1	C-- Make local copy of tracer array
183			DO j=1-OLy,sNy+OLy
184			DO i=1-OLx,sNx+OLx
185			localTij(i,j)=tracer(i,j,k,bi,bj)
186			ENDDO
187			ENDDO
188
189	adcroft	1.3	IF (useCubedSphereExchange) THEN
190			nipass=3
191	heimbach	1.14	#ifdef ALLOW_AUTODIFF_TAMC
192			if ( nipass.GT.maxcube )
193			& STOP 'maxcube needs to be = 3'
194			#endif
195	adcroft	1.3	ELSE
196			nipass=1
197			ENDIF
198	heimbach	1.6	cph nipass=1
199	adcroft	1.3
200			C-- Multiple passes for different directions on different tiles
201			DO ipass=1,nipass
202	heimbach	1.6	#ifdef ALLOW_AUTODIFF_TAMC
203	heimbach	1.14	passkey = ipass + (k-1) *maxcube
204			& + (igadkey-1)maxcubeNr
205	heimbach	1.6	IF (nipass .GT. maxpass) THEN
206	heimbach	1.14	STOP 'GAD_ADVECTION: nipass > maxcube. check tamc.h'
207	heimbach	1.6	ENDIF
208			#endif /* ALLOW_AUTODIFF_TAMC */
209	adcroft	1.3
210			IF (nipass.EQ.3) THEN
211			calc_fluxes_X=.FALSE.
212			calc_fluxes_Y=.FALSE.
213			IF (ipass.EQ.1 .AND. (bi.EQ.1 .OR. bi.EQ.2) ) THEN
214			calc_fluxes_X=.TRUE.
215			ELSEIF (ipass.EQ.1 .AND. (bi.EQ.4 .OR. bi.EQ.5) ) THEN
216			calc_fluxes_Y=.TRUE.
217			ELSEIF (ipass.EQ.2 .AND. (bi.EQ.1 .OR. bi.EQ.6) ) THEN
218			calc_fluxes_Y=.TRUE.
219			ELSEIF (ipass.EQ.2 .AND. (bi.EQ.3 .OR. bi.EQ.4) ) THEN
220			calc_fluxes_X=.TRUE.
221			ELSEIF (ipass.EQ.3 .AND. (bi.EQ.2 .OR. bi.EQ.3) ) THEN
222			calc_fluxes_Y=.TRUE.
223			ELSEIF (ipass.EQ.3 .AND. (bi.EQ.5 .OR. bi.EQ.6) ) THEN
224			calc_fluxes_X=.TRUE.
225			ENDIF
226			ELSE
227			calc_fluxes_X=.TRUE.
228			calc_fluxes_Y=.TRUE.
229			ENDIF
230
231			C-- X direction
232			IF (calc_fluxes_X) THEN
233
234			C-- Internal exchange for calculations in X
235			IF (useCubedSphereExchange) THEN
236			DO j=1,Oly
237			DO i=1,Olx
238			localTij( 1-i , 1-j )=localTij( 1-j , i )
239			localTij( 1-i ,sNy+j)=localTij( 1-j , sNy+1-i )
240			localTij(sNx+i, 1-j )=localTij(sNx+j, i )
241			localTij(sNx+i,sNy+j)=localTij(sNx+j, sNy+1-i )
242			ENDDO
243			ENDDO
244			ENDIF
245
246	adcroft	1.1	C- Advective flux in X
247			DO j=1-Oly,sNy+Oly
248			DO i=1-Olx,sNx+Olx
249			af(i,j) = 0.
250			ENDDO
251			ENDDO
252	heimbach	1.6
253			#ifdef ALLOW_AUTODIFF_TAMC
254	adcroft	1.7	#ifndef DISABLE_MULTIDIM_ADVECTION
255	heimbach	1.14	CADJ STORE localTij(:,:) =
256			CADJ & comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
257	heimbach	1.6	#endif
258			#endif /* ALLOW_AUTODIFF_TAMC */
259
260	adcroft	1.1	IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
261			CALL GAD_FLUXLIMIT_ADV_X(
262			& bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)
263			ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
264			CALL GAD_DST3_ADV_X(
265			& bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)
266			ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
267			CALL GAD_DST3FL_ADV_X(
268			& bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)
269			ELSE
270	adcroft	1.9	STOP 'GAD_ADVECTION: adv. scheme incompatibale with multi-dim'
271	adcroft	1.1	ENDIF
272	heimbach	1.6
273	adcroft	1.1	DO j=1-Oly,sNy+Oly
274			DO i=1-Olx,sNx+Olx-1
275			localTij(i,j)=localTij(i,j)-deltaTtracer*
276			& _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
277			& *recip_rA(i,j,bi,bj)
278			& *( af(i+1,j)-af(i,j)
279			& -tracer(i,j,k,bi,bj)*(uTrans(i+1,j)-uTrans(i,j))
280			& )
281			ENDDO
282			ENDDO
283
284			#ifdef ALLOW_OBCS
285			C-- Apply open boundary conditions
286			IF (useOBCS) THEN
287			IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
288			CALL OBCS_APPLY_TLOC( bi, bj, k, localTij, myThid )
289			ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
290			CALL OBCS_APPLY_SLOC( bi, bj, k, localTij, myThid )
291			END IF
292			END IF
293			#endif /* ALLOW_OBCS */
294
295	adcroft	1.3	C-- End of X direction
296			ENDIF
297
298			C-- Y direction
299			IF (calc_fluxes_Y) THEN
300
301			C-- Internal exchange for calculations in Y
302			IF (useCubedSphereExchange) THEN
303			DO j=1,Oly
304			DO i=1,Olx
305			localTij( 1-i , 1-j )=localTij( j , 1-i )
306			localTij( 1-i ,sNy+j)=localTij( j ,sNy+i)
307			localTij(sNx+i, 1-j )=localTij(sNx+1-j, 1-i )
308			localTij(sNx+i,sNy+j)=localTij(sNx+1-j,sNy+i)
309			ENDDO
310			ENDDO
311			ENDIF
312
313	adcroft	1.1	C- Advective flux in Y
314			DO j=1-Oly,sNy+Oly
315			DO i=1-Olx,sNx+Olx
316			af(i,j) = 0.
317			ENDDO
318			ENDDO
319	heimbach	1.6
320			#ifdef ALLOW_AUTODIFF_TAMC
321	adcroft	1.7	#ifndef DISABLE_MULTIDIM_ADVECTION
322	heimbach	1.14	CADJ STORE localTij(:,:) =
323			CADJ & comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
324	heimbach	1.6	#endif
325			#endif /* ALLOW_AUTODIFF_TAMC */
326
327	adcroft	1.1	IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
328			CALL GAD_FLUXLIMIT_ADV_Y(
329			& bi,bj,k,deltaTtracer,vTrans,vVel,localTij,af,myThid)
330			ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
331			CALL GAD_DST3_ADV_Y(
332			& bi,bj,k,deltaTtracer,vTrans,vVel,localTij,af,myThid)
333			ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
334			CALL GAD_DST3FL_ADV_Y(
335			& bi,bj,k,deltaTtracer,vTrans,vVel,localTij,af,myThid)
336			ELSE
337			STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
338			ENDIF
339	heimbach	1.6
340	adcroft	1.1	DO j=1-Oly,sNy+Oly-1
341			DO i=1-Olx,sNx+Olx
342			localTij(i,j)=localTij(i,j)-deltaTtracer*
343			& _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
344			& *recip_rA(i,j,bi,bj)
345			& *( af(i,j+1)-af(i,j)
346			& -tracer(i,j,k,bi,bj)*(vTrans(i,j+1)-vTrans(i,j))
347			& )
348			ENDDO
349			ENDDO
350	adcroft	1.3
351	adcroft	1.1	#ifdef ALLOW_OBCS
352			C-- Apply open boundary conditions
353			IF (useOBCS) THEN
354			IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
355			CALL OBCS_APPLY_TLOC( bi, bj, k, localTij, myThid )
356			ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
357			CALL OBCS_APPLY_SLOC( bi, bj, k, localTij, myThid )
358			END IF
359			END IF
360			#endif /* ALLOW_OBCS */
361	adcroft	1.3
362			C-- End of Y direction
363			ENDIF
364
365	jmc	1.18	C-- End of ipass loop
366	adcroft	1.1	ENDDO
367
368	jmc	1.18	IF ( implicitAdvection ) THEN
369			C- explicit advection is done ; store tendency in gTracer:
370			DO j=1-Oly,sNy+Oly
371			DO i=1-Olx,sNx+Olx
372			gTracer(i,j,k,bi,bj)=
373			& (localTij(i,j)-tracer(i,j,k,bi,bj))/deltaTtracer
374			ENDDO
375			ENDDO
376			ELSE
377			C- horizontal advection done; store intermediate result in 3D array:
378			DO j=1-Oly,sNy+Oly
379			DO i=1-Olx,sNx+Olx
380			localTijk(i,j,k)=localTij(i,j)
381			ENDDO
382			ENDDO
383			ENDIF
384	adcroft	1.1
385			C-- End of K loop for horizontal fluxes
386			ENDDO
387
388	jmc	1.18	IF ( .NOT.implicitAdvection ) THEN
389	adcroft	1.1	C-- Start of k loop for vertical flux
390	jmc	1.18	DO k=Nr,1,-1
391	heimbach	1.6	#ifdef ALLOW_AUTODIFF_TAMC
392	heimbach	1.16	kkey = (igadkey-1)*Nr + k
393	heimbach	1.6	#endif /* ALLOW_AUTODIFF_TAMC */
394	adcroft	1.1	C-- kup Cycles through 1,2 to point to w-layer above
395			C-- kDown Cycles through 2,1 to point to w-layer below
396	jmc	1.18	kup = 1+MOD(k+1,2)
397			kDown= 1+MOD(k,2)
398			c kp1=min(Nr,k+1)
399			kp1Msk=1.
400			if (k.EQ.Nr) kp1Msk=0.
401	heimbach	1.6
402	jmc	1.11	C-- Compute Vertical transport
403	jmc	1.22	#ifdef ALLOW_AIM
404			C- a hack to prevent Water-Vapor vert.transport into the stratospheric level Nr
405			IF ( k.EQ.1 .OR.
406			& (useAIM .AND. tracerIdentity.EQ.GAD_SALINITY .AND. k.EQ.Nr)
407			& ) THEN
408			#else
409			IF ( k.EQ.1 ) THEN
410			#endif
411	jmc	1.11
412			C- Surface interface :
413	jmc	1.18	DO j=1-Oly,sNy+Oly
414			DO i=1-Olx,sNx+Olx
415	jmc	1.22	rTransKp1(i,j) = kp1Msk*rTrans(i,j)
416	jmc	1.18	rTrans(i,j) = 0.
417			fVerT(i,j,kUp) = 0.
418			af(i,j) = 0.
419			ENDDO
420			ENDDO
421	jmc	1.11
422	jmc	1.18	ELSE
423			C- Interior interface :
424	jmc	1.11
425	jmc	1.18	DO j=1-Oly,sNy+Oly
426			DO i=1-Olx,sNx+Olx
427			rTransKp1(i,j) = kp1Msk*rTrans(i,j)
428			rTrans(i,j) = wVel(i,j,k,bi,bj)*rA(i,j,bi,bj)
429			& *maskC(i,j,k-1,bi,bj)
430			af(i,j) = 0.
431			ENDDO
432			ENDDO
433	jmc	1.11
434			#ifdef ALLOW_GMREDI
435			C-- Residual transp = Bolus transp + Eulerian transp
436	jmc	1.18	IF (useGMRedi)
437	jmc	1.11	& CALL GMREDI_CALC_WFLOW(
438			& rTrans, bi, bj, k, myThid)
439			#endif /* ALLOW_GMREDI */
440
441	heimbach	1.16	#ifdef ALLOW_AUTODIFF_TAMC
442			CADJ STORE localTijk(:,:,k)
443			CADJ & = comlev1_bibj_k_gad, key=kkey, byte=isbyte
444			CADJ STORE rTrans(:,:)
445			CADJ & = comlev1_bibj_k_gad, key=kkey, byte=isbyte
446			#endif /* ALLOW_AUTODIFF_TAMC */
447
448	adcroft	1.1	C- Compute vertical advective flux in the interior:
449	jmc	1.23	IF (vertAdvecScheme.EQ.ENUM_FLUX_LIMIT) THEN
450	jmc	1.18	CALL GAD_FLUXLIMIT_ADV_R(
451	jmc	1.17	& bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)
452	jmc	1.23	ELSEIF (vertAdvecScheme.EQ.ENUM_DST3 ) THEN
453	jmc	1.18	CALL GAD_DST3_ADV_R(
454	jmc	1.17	& bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)
455	jmc	1.23	ELSEIF (vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
456	jmc	1.18	CALL GAD_DST3FL_ADV_R(
457	jmc	1.17	& bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)
458	jmc	1.18	ELSE
459			STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
460			ENDIF
461	jmc	1.11	C- add the advective flux to fVerT
462	jmc	1.18	DO j=1-Oly,sNy+Oly
463			DO i=1-Olx,sNx+Olx
464			fVerT(i,j,kUp) = af(i,j)
465			ENDDO
466			ENDDO
467	jmc	1.11
468			C- end Surface/Interior if bloc
469	jmc	1.18	ENDIF
470	heimbach	1.16
471			#ifdef ALLOW_AUTODIFF_TAMC
472			CADJ STORE rTrans(:,:)
473			CADJ & = comlev1_bibj_k_gad, key=kkey, byte=isbyte
474			CADJ STORE rTranskp1(:,:)
475			CADJ & = comlev1_bibj_k_gad, key=kkey, byte=isbyte
476			#endif /* ALLOW_AUTODIFF_TAMC */
477	adcroft	1.1
478	jmc	1.18	C-- Divergence of vertical fluxes
479			DO j=1-Oly,sNy+Oly
480			DO i=1-Olx,sNx+Olx
481			localTij(i,j)=localTijk(i,j,k)-deltaTtracer*
482			& _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
483			& *recip_rA(i,j,bi,bj)
484			& *( fVerT(i,j,kUp)-fVerT(i,j,kDown)
485			& -tracer(i,j,k,bi,bj)*(rTrans(i,j)-rTransKp1(i,j))
486			& )*rkFac
487			gTracer(i,j,k,bi,bj)=
488			& (localTij(i,j)-tracer(i,j,k,bi,bj))/deltaTtracer
489			ENDDO
490			ENDDO
491	adcroft	1.1
492			C-- End of K loop for vertical flux
493	jmc	1.18	ENDDO
494			C-- end of if not.implicitAdvection block
495			ENDIF
496	adcroft	1.1
497			RETURN
498			END