pkg/generic_advdiff/gad_calc_rhs.F

C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/gad_calc_rhs.F,v 1.14 2002/06/15 03:31:17 jmc Exp $
C $Name:  $

#include "GAD_OPTIONS.h"

CBOP
C !ROUTINE: GAD_CALC_RHS

C !INTERFACE: ==========================================================
      SUBROUTINE GAD_CALC_RHS( 
     I           bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,
     I           xA,yA,uTrans,vTrans,rTrans,maskUp,
     I           diffKh, diffK4, KappaRT, Tracer,
     I           tracerIdentity, advectionScheme, calcAdvection,
     U           fVerT, gTracer,
     I           myThid )

C !DESCRIPTION:
C Calculates the tendancy of a tracer due to advection and diffusion.
C It calculates the fluxes in each direction indepentently and then
C sets the tendancy to the divergence of these fluxes. The advective
C fluxes are only calculated here when using the linear advection schemes
C otherwise only the diffusive and parameterized fluxes are calculated.
C
C Contributions to the flux are calculated and added:
C \begin{equation*}
C {\bf F} = {\bf F}_{adv} + {\bf F}_{diff} +{\bf F}_{GM} + {\bf F}_{KPP}
C \end{equation*}
C
C The tendancy is the divergence of the fluxes:
C \begin{equation*}
C G_\theta = G_\theta + \nabla \cdot {\bf F}
C \end{equation*}
C
C The tendancy is assumed to contain data on entry.

C !USES: ===============================================================
      IMPLICIT NONE
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "DYNVARS.h"
#include "GAD.h"

#ifdef ALLOW_AUTODIFF_TAMC
#include "tamc.h"
#include "tamc_keys.h"
#endif /* ALLOW_AUTODIFF_TAMC */

C !INPUT PARAMETERS: ===================================================
C  bi,bj                :: tile indices
C  iMin,iMax,jMin,jMax  :: loop range for called routines
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,rTrans :: 2-D arrays of volume transports at U,V and W points
C  maskUp               :: 2-D array for mask at W points
C  diffKh               :: horizontal diffusion coefficient
C  diffK4               :: bi-harmonic diffusion coefficient
C  KappaRT              :: 3-D array for vertical diffusion coefficient
C  Tracer               :: tracer field
C  tracerIdentity       :: identifier for the tracer (required only for KPP)
C  advectionScheme      :: advection scheme to use
C  calcAdvection        :: =False if Advec terms computed with multiDim scheme
C  myThid               :: thread number
      INTEGER bi,bj,iMin,iMax,jMin,jMax
      INTEGER k,kUp,kDown,kM1
      _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)
      _RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL diffKh, diffK4
      _RL KappaRT(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
      _RL Tracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      INTEGER tracerIdentity
      INTEGER advectionScheme
      LOGICAL calcAdvection
      INTEGER myThid

C !OUTPUT PARAMETERS: ==================================================
C  gTracer              :: tendancy array
C  fVerT                :: 2 1/2D arrays for vertical advective flux
      _RL gTracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)

C !LOCAL VARIABLES: ====================================================
C  i,j                  :: loop indices
C  df4                  :: used for storing del^2 T for bi-harmonic term
C  fZon                 :: zonal flux
C  fmer                 :: meridional flux
C  af                   :: advective flux
C  df                   :: diffusive flux
C  localT               :: local copy of tracer field
      INTEGER i,j
      _RL df4   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL fZon  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL fMer  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL af    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL df    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL localT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
CEOP

#ifdef ALLOW_AUTODIFF_TAMC
C--   only the kUp part of fverT is set in this subroutine
C--   the kDown is still required
      fVerT(1,1,kDown) = fVerT(1,1,kDown)
#endif

      DO j=1-OLy,sNy+OLy
       DO i=1-OLx,sNx+OLx
        fZon(i,j)      = 0. _d 0
        fMer(i,j)      = 0. _d 0
        fVerT(i,j,kUp) = 0. _d 0
        df(i,j)        = 0. _d 0
        df4(i,j)       = 0. _d 0
        localT(i,j)    = 0. _d 0
       ENDDO
      ENDDO

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

C--   Unless we have already calculated the advection terms we initialize
C     the tendency to zero.
      IF (calcAdvection) THEN
       DO j=1-Oly,sNy+Oly
        DO i=1-Olx,sNx+Olx
         gTracer(i,j,k,bi,bj)=0. _d 0
        ENDDO
       ENDDO
      ENDIF

C--   Pre-calculate del^2 T if bi-harmonic coefficient is non-zero
      IF (diffK4 .NE. 0.) THEN
       CALL GAD_GRAD_X(bi,bj,k,xA,localT,fZon,myThid)
       CALL GAD_GRAD_Y(bi,bj,k,yA,localT,fMer,myThid)
       CALL GAD_DEL2(bi,bj,k,fZon,fMer,df4,myThid)
      ENDIF

C--   Initialize net flux in X direction
      DO j=1-Oly,sNy+Oly
       DO i=1-Olx,sNx+Olx
        fZon(i,j) = 0. _d 0
       ENDDO
      ENDDO

C-    Advective flux in X
      IF (calcAdvection) THEN
      IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
       CALL GAD_C2_ADV_X(bi,bj,k,uTrans,localT,af,myThid)
      ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
       CALL GAD_FLUXLIMIT_ADV_X(
     &      bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)
      ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
       CALL GAD_U3_ADV_X(bi,bj,k,uTrans,localT,af,myThid)
      ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
       CALL GAD_C4_ADV_X(bi,bj,k,uTrans,localT,af,myThid)
      ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
       CALL GAD_DST3_ADV_X(
     &       bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)
      ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
       CALL GAD_DST3FL_ADV_X(
     &       bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)
      ELSE
       STOP 'GAD_CALC_RHS: Bad advectionScheme (X)'
      ENDIF
      DO j=1-Oly,sNy+Oly
       DO i=1-Olx,sNx+Olx
        fZon(i,j) = fZon(i,j) + af(i,j)
       ENDDO
      ENDDO
      ENDIF

C-    Diffusive flux in X
      IF (diffKh.NE.0.) THEN
       CALL GAD_DIFF_X(bi,bj,k,xA,diffKh,localT,df,myThid)
      ELSE
       DO j=1-Oly,sNy+Oly
        DO i=1-Olx,sNx+Olx
         df(i,j) = 0. _d 0
        ENDDO
       ENDDO
      ENDIF

#ifdef ALLOW_GMREDI
C-    GM/Redi flux in X
      IF (useGMRedi) THEN
C *note* should update GMREDI_XTRANSPORT to use localT and set df  *aja*
        CALL GMREDI_XTRANSPORT(
     I     iMin,iMax,jMin,jMax,bi,bj,K,
     I     xA,Tracer,tracerIdentity,
     U     df,
     I     myThid)
      ENDIF
#endif
      DO j=1-Oly,sNy+Oly
       DO i=1-Olx,sNx+Olx
        fZon(i,j) = fZon(i,j) + df(i,j)
       ENDDO
      ENDDO

C-    Bi-harmonic duffusive flux in X
      IF (diffK4 .NE. 0.) THEN
       CALL GAD_BIHARM_X(bi,bj,k,xA,df4,diffK4,df,myThid)
       DO j=1-Oly,sNy+Oly
        DO i=1-Olx,sNx+Olx
         fZon(i,j) = fZon(i,j) + df(i,j)
        ENDDO
       ENDDO
      ENDIF

C--   Initialize net flux in Y direction
      DO j=1-Oly,sNy+Oly
       DO i=1-Olx,sNx+Olx
        fMer(i,j) = 0. _d 0
       ENDDO
      ENDDO

C-    Advective flux in Y
      IF (calcAdvection) THEN
      IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
       CALL GAD_C2_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)
      ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
       CALL GAD_FLUXLIMIT_ADV_Y(
     &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)
      ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
       CALL GAD_U3_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)
      ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
       CALL GAD_C4_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)
      ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
       CALL GAD_DST3_ADV_Y(
     &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)
      ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
       CALL GAD_DST3FL_ADV_Y(
     &       bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)
      ELSE
       STOP 'GAD_CALC_RHS: Bad advectionScheme (Y)'
      ENDIF
      DO j=1-Oly,sNy+Oly
       DO i=1-Olx,sNx+Olx
        fMer(i,j) = fMer(i,j) + af(i,j)
       ENDDO
      ENDDO
      ENDIF

C-    Diffusive flux in Y
      IF (diffKh.NE.0.) THEN
       CALL GAD_DIFF_Y(bi,bj,k,yA,diffKh,localT,df,myThid)
      ELSE
       DO j=1-Oly,sNy+Oly
        DO i=1-Olx,sNx+Olx
         df(i,j) = 0. _d 0
        ENDDO
       ENDDO
      ENDIF

#ifdef ALLOW_GMREDI
C-    GM/Redi flux in Y
      IF (useGMRedi) THEN
C *note* should update GMREDI_YTRANSPORT to use localT and set df  *aja*
       CALL GMREDI_YTRANSPORT(
     I     iMin,iMax,jMin,jMax,bi,bj,K,
     I     yA,Tracer,tracerIdentity,
     U     df,
     I     myThid)
      ENDIF
#endif
      DO j=1-Oly,sNy+Oly
       DO i=1-Olx,sNx+Olx
        fMer(i,j) = fMer(i,j) + df(i,j)
       ENDDO
      ENDDO

C-    Bi-harmonic flux in Y
      IF (diffK4 .NE. 0.) THEN
       CALL GAD_BIHARM_Y(bi,bj,k,yA,df4,diffK4,df,myThid)
       DO j=1-Oly,sNy+Oly
        DO i=1-Olx,sNx+Olx
         fMer(i,j) = fMer(i,j) + df(i,j)
        ENDDO
       ENDDO
      ENDIF

C-    Advective flux in R
      IF (calcAdvection) THEN
C     Note: wVel needs to be masked 
      IF (K.GE.2) THEN
C-    Compute vertical advective flux in the interior:
       IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
        CALL GAD_C2_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)
       ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
        CALL GAD_FLUXLIMIT_ADV_R(
     &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)
       ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
        CALL GAD_U3_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)
       ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
        CALL GAD_C4_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)
       ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
        CALL GAD_DST3_ADV_R(
     &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)
       ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
        CALL GAD_DST3FL_ADV_R(
     &       bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)
       ELSE
        STOP 'GAD_CALC_RHS: Bad advectionScheme (R)'
       ENDIF
C-    Surface "correction" term at k>1 :
       DO j=1-Oly,sNy+Oly
        DO i=1-Olx,sNx+Olx
         af(i,j) = af(i,j)
     &           + (maskC(i,j,k,bi,bj)-maskC(i,j,k-1,bi,bj))*
     &             rTrans(i,j)*Tracer(i,j,k,bi,bj)
        ENDDO
       ENDDO 
      ELSE
C-    Surface "correction" term at k=1 :
       DO j=1-Oly,sNy+Oly
        DO i=1-Olx,sNx+Olx
         af(i,j) = rTrans(i,j)*Tracer(i,j,k,bi,bj)
        ENDDO
       ENDDO 
      ENDIF
C-    add the advective flux to fVerT
      DO j=1-Oly,sNy+Oly
       DO i=1-Olx,sNx+Olx
        fVerT(i,j,kUp) = fVerT(i,j,kUp) + af(i,j)
       ENDDO
      ENDDO
      ENDIF

C-    Diffusive flux in R
C     Note: For K=1 then KM1=1 and this gives a dT/dr = 0 upper
C           boundary condition.
      IF (implicitDiffusion) THEN
       DO j=1-Oly,sNy+Oly
        DO i=1-Olx,sNx+Olx
         df(i,j) = 0. _d 0
        ENDDO
       ENDDO
      ELSE
       CALL GAD_DIFF_R(bi,bj,k,KappaRT,tracer,df,myThid)
      ENDIF

#ifdef ALLOW_GMREDI
C-    GM/Redi flux in R
      IF (useGMRedi) THEN
C *note* should update GMREDI_RTRANSPORT to set df  *aja*
       CALL GMREDI_RTRANSPORT(
     I     iMin,iMax,jMin,jMax,bi,bj,K,
     I     Tracer,tracerIdentity,
     U     df,
     I     myThid)
      ENDIF
#endif

      DO j=1-Oly,sNy+Oly
       DO i=1-Olx,sNx+Olx
        fVerT(i,j,kUp) = fVerT(i,j,kUp) + df(i,j)*maskUp(i,j)
       ENDDO
      ENDDO

#ifdef ALLOW_KPP
C-    Add non local KPP transport term (ghat) to diffusive T flux.
      IF (useKPP) THEN
       DO j=1-Oly,sNy+Oly
        DO i=1-Olx,sNx+Olx
         df(i,j) = 0. _d 0
        ENDDO
       ENDDO
       IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
C *note* should update KPP_TRANSPORT_T to set df  *aja*
        CALL KPP_TRANSPORT_T(
     I     iMin,iMax,jMin,jMax,bi,bj,k,km1,
     I     KappaRT,
     U     df )
       ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
        CALL KPP_TRANSPORT_S(
     I     iMin,iMax,jMin,jMax,bi,bj,k,km1,
     I     KappaRT,
     U     df )
       ELSE
        STOP 'GAD_CALC_RHS: Ooops'
       ENDIF
       DO j=1-Oly,sNy+Oly
        DO i=1-Olx,sNx+Olx
         fVerT(i,j,kUp) = fVerT(i,j,kUp) + df(i,j)*maskUp(i,j)
        ENDDO
       ENDDO
      ENDIF
#endif

C--   Divergence of fluxes
      DO j=1-Oly,sNy+Oly-1
       DO i=1-Olx,sNx+Olx-1
        gTracer(i,j,k,bi,bj)=gTracer(i,j,k,bi,bj)
     &   -_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
     &    *recip_rA(i,j,bi,bj)
     &    *(
     &    +( fZon(i+1,j)-fZon(i,j) )
     &    +( fMer(i,j+1)-fMer(i,j) )
     &    +( fVerT(i,j,kUp)-fVerT(i,j,kDown) )*rkFac
     &    )
       ENDDO
      ENDDO

      RETURN
      END
1	heimbach	1.15	C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/gad_calc_rhs.F,v 1.14 2002/06/15 03:31:17 jmc Exp $
2	jmc	1.2	C $Name: $
3	adcroft	1.1
4			#include "GAD_OPTIONS.h"
5
6	adcroft	1.11	CBOP
7			C !ROUTINE: GAD_CALC_RHS
8
9			C !INTERFACE: ==========================================================
10	adcroft	1.1	SUBROUTINE GAD_CALC_RHS(
11			I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,
12			I xA,yA,uTrans,vTrans,rTrans,maskUp,
13			I diffKh, diffK4, KappaRT, Tracer,
14	jmc	1.14	I tracerIdentity, advectionScheme, calcAdvection,
15	adcroft	1.1	U fVerT, gTracer,
16			I myThid )
17	adcroft	1.11
18			C !DESCRIPTION:
19			C Calculates the tendancy of a tracer due to advection and diffusion.
20			C It calculates the fluxes in each direction indepentently and then
21			C sets the tendancy to the divergence of these fluxes. The advective
22			C fluxes are only calculated here when using the linear advection schemes
23			C otherwise only the diffusive and parameterized fluxes are calculated.
24			C
25			C Contributions to the flux are calculated and added:
26			C \begin{equation*}
27			C {\bf F} = {\bf F}_{adv} + {\bf F}_{diff} +{\bf F}_{GM} + {\bf F}_{KPP}
28			C \end{equation*}
29			C
30			C The tendancy is the divergence of the fluxes:
31			C \begin{equation*}
32			C G_\theta = G_\theta + \nabla \cdot {\bf F}
33			C \end{equation*}
34			C
35			C The tendancy is assumed to contain data on entry.
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 "DYNVARS.h"
44			#include "GAD.h"
45
46	heimbach	1.13	#ifdef ALLOW_AUTODIFF_TAMC
47			#include "tamc.h"
48			#include "tamc_keys.h"
49			#endif /* ALLOW_AUTODIFF_TAMC */
50
51	adcroft	1.11	C !INPUT PARAMETERS: ===================================================
52			C bi,bj :: tile indices
53			C iMin,iMax,jMin,jMax :: loop range for called routines
54			C kup :: index into 2 1/2D array, toggles between 1 and 2
55			C kdown :: index into 2 1/2D array, toggles between 2 and 1
56			C kp1 :: =k+1 for k<Nr, =Nr for k=Nr
57			C xA,yA :: areas of X and Y face of tracer cells
58			C uTrans,vTrans,rTrans :: 2-D arrays of volume transports at U,V and W points
59			C maskUp :: 2-D array for mask at W points
60			C diffKh :: horizontal diffusion coefficient
61			C diffK4 :: bi-harmonic diffusion coefficient
62			C KappaRT :: 3-D array for vertical diffusion coefficient
63			C Tracer :: tracer field
64			C tracerIdentity :: identifier for the tracer (required only for KPP)
65			C advectionScheme :: advection scheme to use
66	jmc	1.14	C calcAdvection :: =False if Advec terms computed with multiDim scheme
67	adcroft	1.11	C myThid :: thread number
68			INTEGER bi,bj,iMin,iMax,jMin,jMax
69	adcroft	1.1	INTEGER k,kUp,kDown,kM1
70			_RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
71			_RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
72			_RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
73			_RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
74			_RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
75			_RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
76			_RL diffKh, diffK4
77			_RL KappaRT(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
78			_RL Tracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
79			INTEGER tracerIdentity
80	adcroft	1.3	INTEGER advectionScheme
81	jmc	1.14	LOGICAL calcAdvection
82	adcroft	1.11	INTEGER myThid
83
84			C !OUTPUT PARAMETERS: ==================================================
85			C gTracer :: tendancy array
86			C fVerT :: 2 1/2D arrays for vertical advective flux
87			_RL gTracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
88	adcroft	1.1	_RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
89
90	adcroft	1.11	C !LOCAL VARIABLES: ====================================================
91			C i,j :: loop indices
92			C df4 :: used for storing del^2 T for bi-harmonic term
93			C fZon :: zonal flux
94			C fmer :: meridional flux
95			C af :: advective flux
96			C df :: diffusive flux
97			C localT :: local copy of tracer field
98	adcroft	1.1	INTEGER i,j
99			_RL df4 (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
100			_RL fZon (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
101			_RL fMer (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
102			_RL af (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
103			_RL df (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
104			_RL localT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
105	adcroft	1.11	CEOP
106	adcroft	1.1
107			#ifdef ALLOW_AUTODIFF_TAMC
108			C-- only the kUp part of fverT is set in this subroutine
109			C-- the kDown is still required
110			fVerT(1,1,kDown) = fVerT(1,1,kDown)
111			#endif
112	heimbach	1.13
113	adcroft	1.1	DO j=1-OLy,sNy+OLy
114			DO i=1-OLx,sNx+OLx
115	heimbach	1.12	fZon(i,j) = 0. _d 0
116			fMer(i,j) = 0. _d 0
117			fVerT(i,j,kUp) = 0. _d 0
118	heimbach	1.13	df(i,j) = 0. _d 0
119			df4(i,j) = 0. _d 0
120			localT(i,j) = 0. _d 0
121	adcroft	1.1	ENDDO
122			ENDDO
123
124			C-- Make local copy of tracer array
125			DO j=1-OLy,sNy+OLy
126			DO i=1-OLx,sNx+OLx
127			localT(i,j)=tracer(i,j,k,bi,bj)
128			ENDDO
129			ENDDO
130
131	adcroft	1.8	C-- Unless we have already calculated the advection terms we initialize
132			C the tendency to zero.
133	jmc	1.14	IF (calcAdvection) THEN
134	adcroft	1.8	DO j=1-Oly,sNy+Oly
135			DO i=1-Olx,sNx+Olx
136	heimbach	1.12	gTracer(i,j,k,bi,bj)=0. _d 0
137	adcroft	1.8	ENDDO
138			ENDDO
139			ENDIF
140	adcroft	1.1
141			C-- Pre-calculate del^2 T if bi-harmonic coefficient is non-zero
142			IF (diffK4 .NE. 0.) THEN
143			CALL GAD_GRAD_X(bi,bj,k,xA,localT,fZon,myThid)
144			CALL GAD_GRAD_Y(bi,bj,k,yA,localT,fMer,myThid)
145			CALL GAD_DEL2(bi,bj,k,fZon,fMer,df4,myThid)
146			ENDIF
147
148			C-- Initialize net flux in X direction
149			DO j=1-Oly,sNy+Oly
150			DO i=1-Olx,sNx+Olx
151	heimbach	1.12	fZon(i,j) = 0. _d 0
152	adcroft	1.1	ENDDO
153			ENDDO
154
155			C- Advective flux in X
156	jmc	1.14	IF (calcAdvection) THEN
157	adcroft	1.3	IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
158	adcroft	1.1	CALL GAD_C2_ADV_X(bi,bj,k,uTrans,localT,af,myThid)
159	adcroft	1.3	ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
160	adcroft	1.1	CALL GAD_FLUXLIMIT_ADV_X(
161			& bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)
162	adcroft	1.3	ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
163	jmc	1.2	CALL GAD_U3_ADV_X(bi,bj,k,uTrans,localT,af,myThid)
164	adcroft	1.3	ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
165	adcroft	1.1	CALL GAD_C4_ADV_X(bi,bj,k,uTrans,localT,af,myThid)
166	adcroft	1.4	ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
167			CALL GAD_DST3_ADV_X(
168			& bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)
169			ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
170			CALL GAD_DST3FL_ADV_X(
171			& bi,bj,k,deltaTtracer,uTrans,uVel,localT,af,myThid)
172	adcroft	1.1	ELSE
173	adcroft	1.3	STOP 'GAD_CALC_RHS: Bad advectionScheme (X)'
174	adcroft	1.1	ENDIF
175	adcroft	1.5	DO j=1-Oly,sNy+Oly
176			DO i=1-Olx,sNx+Olx
177	adcroft	1.1	fZon(i,j) = fZon(i,j) + af(i,j)
178			ENDDO
179			ENDDO
180	adcroft	1.8	ENDIF
181	adcroft	1.1
182			C- Diffusive flux in X
183			IF (diffKh.NE.0.) THEN
184			CALL GAD_DIFF_X(bi,bj,k,xA,diffKh,localT,df,myThid)
185			ELSE
186	adcroft	1.5	DO j=1-Oly,sNy+Oly
187			DO i=1-Olx,sNx+Olx
188	heimbach	1.12	df(i,j) = 0. _d 0
189	adcroft	1.1	ENDDO
190			ENDDO
191			ENDIF
192
193			#ifdef ALLOW_GMREDI
194			C- GM/Redi flux in X
195			IF (useGMRedi) THEN
196			C note should update GMREDI_XTRANSPORT to use localT and set df aja
197			CALL GMREDI_XTRANSPORT(
198			I iMin,iMax,jMin,jMax,bi,bj,K,
199	heimbach	1.15	I xA,Tracer,tracerIdentity,
200	adcroft	1.1	U df,
201			I myThid)
202			ENDIF
203			#endif
204	adcroft	1.5	DO j=1-Oly,sNy+Oly
205			DO i=1-Olx,sNx+Olx
206	adcroft	1.1	fZon(i,j) = fZon(i,j) + df(i,j)
207			ENDDO
208			ENDDO
209
210			C- Bi-harmonic duffusive flux in X
211			IF (diffK4 .NE. 0.) THEN
212			CALL GAD_BIHARM_X(bi,bj,k,xA,df4,diffK4,df,myThid)
213	adcroft	1.5	DO j=1-Oly,sNy+Oly
214			DO i=1-Olx,sNx+Olx
215	adcroft	1.1	fZon(i,j) = fZon(i,j) + df(i,j)
216			ENDDO
217			ENDDO
218			ENDIF
219
220			C-- Initialize net flux in Y direction
221			DO j=1-Oly,sNy+Oly
222			DO i=1-Olx,sNx+Olx
223	heimbach	1.12	fMer(i,j) = 0. _d 0
224	adcroft	1.1	ENDDO
225			ENDDO
226
227			C- Advective flux in Y
228	jmc	1.14	IF (calcAdvection) THEN
229	adcroft	1.3	IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
230	adcroft	1.1	CALL GAD_C2_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)
231	adcroft	1.3	ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
232	adcroft	1.1	CALL GAD_FLUXLIMIT_ADV_Y(
233			& bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)
234	adcroft	1.3	ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
235	jmc	1.2	CALL GAD_U3_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)
236	adcroft	1.3	ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
237	adcroft	1.1	CALL GAD_C4_ADV_Y(bi,bj,k,vTrans,localT,af,myThid)
238	adcroft	1.4	ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
239			CALL GAD_DST3_ADV_Y(
240			& bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)
241			ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
242			CALL GAD_DST3FL_ADV_Y(
243			& bi,bj,k,deltaTtracer,vTrans,vVel,localT,af,myThid)
244	adcroft	1.1	ELSE
245	adcroft	1.3	STOP 'GAD_CALC_RHS: Bad advectionScheme (Y)'
246	adcroft	1.1	ENDIF
247			DO j=1-Oly,sNy+Oly
248			DO i=1-Olx,sNx+Olx
249			fMer(i,j) = fMer(i,j) + af(i,j)
250			ENDDO
251			ENDDO
252	adcroft	1.8	ENDIF
253	adcroft	1.1
254			C- Diffusive flux in Y
255			IF (diffKh.NE.0.) THEN
256			CALL GAD_DIFF_Y(bi,bj,k,yA,diffKh,localT,df,myThid)
257			ELSE
258			DO j=1-Oly,sNy+Oly
259			DO i=1-Olx,sNx+Olx
260	heimbach	1.12	df(i,j) = 0. _d 0
261	adcroft	1.1	ENDDO
262			ENDDO
263			ENDIF
264
265			#ifdef ALLOW_GMREDI
266			C- GM/Redi flux in Y
267			IF (useGMRedi) THEN
268	heimbach	1.7	C note should update GMREDI_YTRANSPORT to use localT and set df aja
269	adcroft	1.1	CALL GMREDI_YTRANSPORT(
270			I iMin,iMax,jMin,jMax,bi,bj,K,
271	heimbach	1.15	I yA,Tracer,tracerIdentity,
272	adcroft	1.1	U df,
273			I myThid)
274			ENDIF
275			#endif
276			DO j=1-Oly,sNy+Oly
277			DO i=1-Olx,sNx+Olx
278			fMer(i,j) = fMer(i,j) + df(i,j)
279			ENDDO
280			ENDDO
281
282			C- Bi-harmonic flux in Y
283			IF (diffK4 .NE. 0.) THEN
284			CALL GAD_BIHARM_Y(bi,bj,k,yA,df4,diffK4,df,myThid)
285			DO j=1-Oly,sNy+Oly
286			DO i=1-Olx,sNx+Olx
287			fMer(i,j) = fMer(i,j) + df(i,j)
288			ENDDO
289			ENDDO
290			ENDIF
291
292			C- Advective flux in R
293	jmc	1.14	IF (calcAdvection) THEN
294	jmc	1.2	C Note: wVel needs to be masked
295			IF (K.GE.2) THEN
296			C- Compute vertical advective flux in the interior:
297	adcroft	1.3	IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN
298	jmc	1.2	CALL GAD_C2_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)
299	adcroft	1.3	ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
300	jmc	1.2	CALL GAD_FLUXLIMIT_ADV_R(
301	adcroft	1.1	& bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)
302	adcroft	1.3	ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN
303	jmc	1.2	CALL GAD_U3_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)
304	adcroft	1.3	ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN
305	jmc	1.2	CALL GAD_C4_ADV_R(bi,bj,k,rTrans,tracer,af,myThid)
306	adcroft	1.4	ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
307	adcroft	1.9	CALL GAD_DST3_ADV_R(
308			& bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)
309	adcroft	1.4	ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
310	adcroft	1.9	CALL GAD_DST3FL_ADV_R(
311			& bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid)
312	jmc	1.2	ELSE
313	adcroft	1.3	STOP 'GAD_CALC_RHS: Bad advectionScheme (R)'
314	jmc	1.2	ENDIF
315			C- Surface "correction" term at k>1 :
316			DO j=1-Oly,sNy+Oly
317			DO i=1-Olx,sNx+Olx
318			af(i,j) = af(i,j)
319			& + (maskC(i,j,k,bi,bj)-maskC(i,j,k-1,bi,bj))*
320			& rTrans(i,j)*Tracer(i,j,k,bi,bj)
321			ENDDO
322			ENDDO
323	adcroft	1.1	ELSE
324	jmc	1.2	C- Surface "correction" term at k=1 :
325			DO j=1-Oly,sNy+Oly
326			DO i=1-Olx,sNx+Olx
327			af(i,j) = rTrans(i,j)*Tracer(i,j,k,bi,bj)
328			ENDDO
329			ENDDO
330	adcroft	1.1	ENDIF
331	jmc	1.2	C- add the advective flux to fVerT
332	adcroft	1.5	DO j=1-Oly,sNy+Oly
333			DO i=1-Olx,sNx+Olx
334	adcroft	1.11	fVerT(i,j,kUp) = fVerT(i,j,kUp) + af(i,j)
335	adcroft	1.1	ENDDO
336			ENDDO
337	adcroft	1.8	ENDIF
338	adcroft	1.1
339			C- Diffusive flux in R
340			C Note: For K=1 then KM1=1 and this gives a dT/dr = 0 upper
341			C boundary condition.
342			IF (implicitDiffusion) THEN
343	adcroft	1.5	DO j=1-Oly,sNy+Oly
344			DO i=1-Olx,sNx+Olx
345	heimbach	1.12	df(i,j) = 0. _d 0
346	adcroft	1.1	ENDDO
347			ENDDO
348			ELSE
349			CALL GAD_DIFF_R(bi,bj,k,KappaRT,tracer,df,myThid)
350			ENDIF
351
352			#ifdef ALLOW_GMREDI
353			C- GM/Redi flux in R
354			IF (useGMRedi) THEN
355			C note should update GMREDI_RTRANSPORT to set df aja
356			CALL GMREDI_RTRANSPORT(
357			I iMin,iMax,jMin,jMax,bi,bj,K,
358	heimbach	1.15	I Tracer,tracerIdentity,
359	adcroft	1.1	U df,
360			I myThid)
361			ENDIF
362			#endif
363
364	adcroft	1.5	DO j=1-Oly,sNy+Oly
365			DO i=1-Olx,sNx+Olx
366	adcroft	1.11	fVerT(i,j,kUp) = fVerT(i,j,kUp) + df(i,j)*maskUp(i,j)
367	adcroft	1.1	ENDDO
368			ENDDO
369
370			#ifdef ALLOW_KPP
371			C- Add non local KPP transport term (ghat) to diffusive T flux.
372			IF (useKPP) THEN
373	adcroft	1.5	DO j=1-Oly,sNy+Oly
374			DO i=1-Olx,sNx+Olx
375	heimbach	1.12	df(i,j) = 0. _d 0
376	adcroft	1.1	ENDDO
377			ENDDO
378			IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
379			C note should update KPP_TRANSPORT_T to set df aja
380			CALL KPP_TRANSPORT_T(
381			I iMin,iMax,jMin,jMax,bi,bj,k,km1,
382			I KappaRT,
383			U df )
384			ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
385			CALL KPP_TRANSPORT_S(
386			I iMin,iMax,jMin,jMax,bi,bj,k,km1,
387			I KappaRT,
388			U df )
389			ELSE
390			STOP 'GAD_CALC_RHS: Ooops'
391			ENDIF
392	adcroft	1.5	DO j=1-Oly,sNy+Oly
393			DO i=1-Olx,sNx+Olx
394	adcroft	1.11	fVerT(i,j,kUp) = fVerT(i,j,kUp) + df(i,j)*maskUp(i,j)
395	adcroft	1.1	ENDDO
396			ENDDO
397			ENDIF
398			#endif
399
400			C-- Divergence of fluxes
401	adcroft	1.10	DO j=1-Oly,sNy+Oly-1
402			DO i=1-Olx,sNx+Olx-1
403	adcroft	1.8	gTracer(i,j,k,bi,bj)=gTracer(i,j,k,bi,bj)
404	adcroft	1.1	& -_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
405			& *recip_rA(i,j,bi,bj)
406			& *(
407			& +( fZon(i+1,j)-fZon(i,j) )
408			& +( fMer(i,j+1)-fMer(i,j) )
409			& +( fVerT(i,j,kUp)-fVerT(i,j,kDown) )*rkFac
410			& )
411			ENDDO
412			ENDDO
413
414			RETURN
415			END