pkg/mom_fluxform/mom_fluxform.F

C $Header: /u/gcmpack/MITgcm/pkg/mom_fluxform/mom_fluxform.F,v 1.4 2001/09/28 16:49:54 adcroft Exp $
C $Name:  $

CBOI
C !TITLE: pkg/mom\_advdiff
C !AUTHORS: adcroft@mit.edu
C !INTRODUCTION: Flux-form Momentum Equations Package
C
C Package "mom\_fluxform" provides methods for calculating explicit terms
C in the momentum equation cast in flux-form:
C \begin{eqnarray*}
C G^u & = & -\frac{1}{\rho} \partial_x \phi_h
C           -\nabla \cdot {\bf v} u
C           -fv
C           +\frac{1}{\rho} \nabla \cdot {\bf \tau}^x
C           + \mbox{metrics}
C \\
C G^v & = & -\frac{1}{\rho} \partial_y \phi_h
C           -\nabla \cdot {\bf v} v
C           +fu
C           +\frac{1}{\rho} \nabla \cdot {\bf \tau}^y
C           + \mbox{metrics}
C \end{eqnarray*}
C where ${\bf v}=(u,v,w)$ and $\tau$, the stress tensor, includes surface
C stresses as well as internal viscous stresses.
CEOI

#include "CPP_OPTIONS.h"

CBOP
C !ROUTINE: MOM_FLUXFORM

C !INTERFACE: ==========================================================
      SUBROUTINE MOM_FLUXFORM( 
     I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,
     I        phi_hyd,KappaRU,KappaRV,
     U        fVerU, fVerV,
     I        myCurrentTime,myIter,myThid)

C !DESCRIPTION:
C Calculates all the horizontal accelerations except for the implicit surface
C pressure gradient and implciit vertical viscosity.

C !USES: ===============================================================
C     == Global variables ==
      IMPLICIT NONE
#include "SIZE.h"
#include "DYNVARS.h"
#include "FFIELDS.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "SURFACE.h"

C !INPUT PARAMETERS: ===================================================
C  bi,bj                :: tile indices
C  iMin,iMax,jMin,jMAx  :: loop ranges
C  k                    :: vertical level
C  kUp                  :: =1 or 2 for consecutive k
C  kDown                :: =2 or 1 for consecutive k
C  phi_hyd              :: hydrostatic pressure (perturbation)
C  KappaRU              :: vertical viscosity
C  KappaRV              :: vertical viscosity
C  fVerU                :: vertical flux of U, 2 1/2 dim for pipe-lining
C  fVerV                :: vertical flux of V, 2 1/2 dim for pipe-lining
C  myCurrentTime        :: current time
C  myIter               :: current time-step number
C  myThid               :: thread number
      INTEGER bi,bj,iMin,iMax,jMin,jMax
      INTEGER k,kUp,kDown
      _RL phi_hyd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
      _RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
      _RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
      _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
      _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
      _RL     myCurrentTime
      INTEGER myIter
      INTEGER myThid

C !OUTPUT PARAMETERS: ==================================================
C None - updates gU() and gV() in common blocks

C !LOCAL VARIABLES: ====================================================
C  i,j                  :: loop indices
C  aF                   :: advective flux
C  vF                   :: viscous flux
C  v4F                  :: bi-harmonic viscous flux
C  vrF                  :: vertical viscous flux
C  cF                   :: Coriolis acceleration
C  mT                   :: Metric terms
C  pF                   :: Pressure gradient
C  fZon                 :: zonal fluxes
C  fMer                 :: meridional fluxes
      INTEGER i,j
      _RL aF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL vF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL v4F(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL vrF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL cF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL mT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL pF(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)
C     wMaskOverride - Land sea flag override for top layer.
C     afFacMom      - Tracer parameters for turning terms
C     vfFacMom        on and off.
C     pfFacMom        afFacMom - Advective terms 
C     cfFacMom        vfFacMom - Eddy viscosity terms
C     mTFacMom        pfFacMom - Pressure terms
C                     cfFacMom - Coriolis terms
C                     foFacMom - Forcing
C                     mTFacMom - Metric term
C     uDudxFac, AhDudxFac, etc ... individual term tracer parameters
      _RS    hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RS  r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _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  uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL  vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
C     I,J,K - Loop counters
C     rVelMaskOverride - Factor for imposing special surface boundary conditions
C                        ( set according to free-surface condition ).
C     hFacROpen        - Lopped cell factos used tohold fraction of open
C     hFacRClosed        and closed cell wall.
      _RL  rVelMaskOverride
C     xxxFac - On-off tracer parameters used for switching terms off.
      _RL  uDudxFac
      _RL  AhDudxFac
      _RL  A4DuxxdxFac
      _RL  vDudyFac
      _RL  AhDudyFac
      _RL  A4DuyydyFac
      _RL  rVelDudrFac
      _RL  ArDudrFac
      _RL  fuFac
      _RL  phxFac
      _RL  mtFacU
      _RL  uDvdxFac
      _RL  AhDvdxFac
      _RL  A4DvxxdxFac
      _RL  vDvdyFac
      _RL  AhDvdyFac
      _RL  A4DvyydyFac
      _RL  rVelDvdrFac
      _RL  ArDvdrFac
      _RL  fvFac
      _RL  phyFac
      _RL  vForcFac
      _RL  mtFacV
      INTEGER km1,kp1
      _RL wVelBottomOverride
      LOGICAL bottomDragTerms
      _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
CEOP

      km1=MAX(1,k-1)
      kp1=MIN(Nr,k+1)
      rVelMaskOverride=1.
      IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac
      wVelBottomOverride=1.
      IF (k.EQ.Nr) wVelBottomOverride=0.

C     Initialise intermediate terms
      DO J=1-OLy,sNy+OLy
       DO I=1-OLx,sNx+OLx
        aF(i,j)   = 0.
        vF(i,j)   = 0.
        v4F(i,j)  = 0.
        vrF(i,j)  = 0.
        cF(i,j)   = 0.
        mT(i,j)   = 0.
        pF(i,j)   = 0.
        fZon(i,j) = 0.
        fMer(i,j) = 0.
       ENDDO
      ENDDO

C--   Term by term tracer parmeters
C     o U momentum equation
      uDudxFac     = afFacMom*1.
      AhDudxFac    = vfFacMom*1.
      A4DuxxdxFac  = vfFacMom*1.
      vDudyFac     = afFacMom*1.
      AhDudyFac    = vfFacMom*1.
      A4DuyydyFac  = vfFacMom*1.
      rVelDudrFac  = afFacMom*1.
      ArDudrFac    = vfFacMom*1.
      mTFacU       = mtFacMom*1.
      fuFac        = cfFacMom*1.
      phxFac       = pfFacMom*1.
C     o V momentum equation
      uDvdxFac     = afFacMom*1.
      AhDvdxFac    = vfFacMom*1.
      A4DvxxdxFac  = vfFacMom*1.
      vDvdyFac     = afFacMom*1.
      AhDvdyFac    = vfFacMom*1.
      A4DvyydyFac  = vfFacMom*1.
      rVelDvdrFac  = afFacMom*1.
      ArDvdrFac    = vfFacMom*1.
      mTFacV       = mtFacMom*1.
      fvFac        = cfFacMom*1.
      phyFac       = pfFacMom*1.
      vForcFac     = foFacMom*1.

      IF (     no_slip_bottom
     &    .OR. bottomDragQuadratic.NE.0.
     &    .OR. bottomDragLinear.NE.0.) THEN
       bottomDragTerms=.TRUE.
      ELSE
       bottomDragTerms=.FALSE.
      ENDIF

C-- with stagger time stepping, grad Phi_Hyp is directly incoporated in TIMESTEP
      IF (staggerTimeStep) THEN
        phxFac = 0.
        phyFac = 0.
      ENDIF

C--   Calculate open water fraction at vorticity points
      CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)

C---- Calculate common quantities used in both U and V equations
C     Calculate tracer cell face open areas
      DO j=1-OLy,sNy+OLy
       DO i=1-OLx,sNx+OLx
        xA(i,j) = _dyG(i,j,bi,bj)
     &   *drF(k)*_hFacW(i,j,k,bi,bj)
        yA(i,j) = _dxG(i,j,bi,bj)
     &   *drF(k)*_hFacS(i,j,k,bi,bj)
       ENDDO
      ENDDO

C     Make local copies of horizontal flow field
      DO j=1-OLy,sNy+OLy
       DO i=1-OLx,sNx+OLx
        uFld(i,j) = uVel(i,j,k,bi,bj)
        vFld(i,j) = vVel(i,j,k,bi,bj)
       ENDDO
      ENDDO

C     Calculate velocity field "volume transports" through tracer cell faces.
      DO j=1-OLy,sNy+OLy
       DO i=1-OLx,sNx+OLx
        uTrans(i,j) = uFld(i,j)*xA(i,j)
        vTrans(i,j) = vFld(i,j)*yA(i,j)
       ENDDO
      ENDDO

      CALL MOM_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid)

C---- Zonal momentum equation starts here

C     Bi-harmonic term del^2 U -> v4F
      IF (momViscosity)
     & CALL MOM_U_DEL2U(bi,bj,k,uFld,hFacZ,v4f,myThid)

C---  Calculate mean and eddy fluxes between cells for zonal flow.

C--   Zonal flux (fZon is at east face of "u" cell)

C     Mean flow component of zonal flux -> aF
      IF (momAdvection)
     & CALL MOM_U_ADV_UU(bi,bj,k,uTrans,uFld,aF,myThid)

C     Laplacian and bi-harmonic terms -> vF
      IF (momViscosity)
     & CALL MOM_U_XVISCFLUX(bi,bj,k,uFld,v4F,vF,myThid)

C     Combine fluxes -> fZon
      DO j=jMin,jMax
       DO i=iMin,iMax
        fZon(i,j) = uDudxFac*aF(i,j) + AhDudxFac*vF(i,j)
       ENDDO
      ENDDO

C--   Meridional flux (fMer is at south face of "u" cell)

C     Mean flow component of meridional flux
      IF (momAdvection)
     & CALL MOM_U_ADV_VU(bi,bj,k,vTrans,uFld,aF,myThid)

C     Laplacian and bi-harmonic term
      IF (momViscosity)
     & CALL MOM_U_YVISCFLUX(bi,bj,k,uFld,v4F,hFacZ,vF,myThid)

C     Combine fluxes -> fMer
      DO j=jMin,jMax
       DO i=iMin,iMax
        fMer(i,j) = vDudyFac*aF(i,j) + AhDudyFac*vF(i,j)
       ENDDO
      ENDDO

C--   Vertical flux (fVer is at upper face of "u" cell)

C--   Free surface correction term (flux at k=1)
      IF (momAdvection.AND.k.EQ.1) THEN
       CALL MOM_U_ADV_WU(bi,bj,k,uVel,wVel,af,myThid)
       DO j=jMin,jMax
        DO i=iMin,iMax
         fVerU(i,j,kUp) = af(i,j)
        ENDDO
       ENDDO
      ENDIF
C     Mean flow component of vertical flux (at k+1) -> aF
      IF (momAdvection)
     & CALL MOM_U_ADV_WU(bi,bj,k+1,uVel,wVel,af,myThid)

C     Eddy component of vertical flux (interior component only) -> vrF
      IF (momViscosity.AND..NOT.implicitViscosity)
     & CALL MOM_U_RVISCFLUX(bi,bj,k,uVel,KappaRU,vrF,myThid)

C     Combine fluxes
      DO j=jMin,jMax
       DO i=iMin,iMax
        fVerU(i,j,kDown) = rVelDudrFac*aF(i,j) + ArDudrFac*vrF(i,j)
       ENDDO
      ENDDO

C---  Hydrostatic term ( -1/rhoConst . dphi/dx )
      IF (momPressureForcing) THEN
       DO j=jMin,jMax
        DO i=iMin,iMax
         pf(i,j) = - _recip_dxC(i,j,bi,bj)
     &    *(phi_hyd(i,j,k)-phi_hyd(i-1,j,k))
        ENDDO
       ENDDO
      ENDIF

C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
      DO j=jMin,jMax
       DO i=iMin,iMax
        gU(i,j,k,bi,bj) =
#ifdef OLD_UV_GEOM
     &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/
     &    ( 0.5 _d 0*(rA(i,j,bi,bj)+rA(i-1,j,bi,bj)) )
#else
     &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
     &   *recip_rAw(i,j,bi,bj)
#endif
     &  *(fZon(i,j  )          - fZon(i-1,j)
     &   +fMer(i,j+1)          - fMer(i  ,j)
     &   +fVerU(i,j,kUp)*rkFac - fVerU(i,j,kDown)*rkFac
     &   )
     & _PHM( +phxFac * pf(i,j) )
       ENDDO
      ENDDO

C-- No-slip and drag BCs appear as body forces in cell abutting topography 
      IF (momViscosity.AND.no_slip_sides) THEN
C-     No-slip BCs impose a drag at walls...
       CALL MOM_U_SIDEDRAG(bi,bj,k,uFld,v4F,hFacZ,vF,myThid)
       DO j=jMin,jMax
        DO i=iMin,iMax
         gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)
        ENDDO
       ENDDO
      ENDIF
C-    No-slip BCs impose a drag at bottom
      IF (momViscosity.AND.bottomDragTerms) THEN
       CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
       DO j=jMin,jMax
        DO i=iMin,iMax
         gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)
        ENDDO
       ENDDO
      ENDIF

C--   Forcing term
      IF (momForcing)
     &  CALL EXTERNAL_FORCING_U(
     I     iMin,iMax,jMin,jMax,bi,bj,k,
     I     myCurrentTime,myThid)

C--   Metric terms for curvilinear grid systems
      IF (useNHMTerms) THEN
C      o Non-hydrosatic metric terms
       CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,mT,myThid)
       DO j=jMin,jMax
        DO i=iMin,iMax
         gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+mTFacU*mT(i,j)
        ENDDO
       ENDDO
      ENDIF
      IF (usingSphericalPolarMTerms) THEN
       CALL MOM_U_METRIC_SPHERE(bi,bj,k,uFld,vFld,mT,myThid)
       DO j=jMin,jMax
        DO i=iMin,iMax
         gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+mTFacU*mT(i,j)
        ENDDO
       ENDDO
      ENDIF

C--   Set du/dt on boundaries to zero
      DO j=jMin,jMax
       DO i=iMin,iMax
        gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)*_maskW(i,j,k,bi,bj)
       ENDDO
      ENDDO


C---- Meridional momentum equation starts here

C     Bi-harmonic term del^2 V -> v4F
      IF (momViscosity)
     & CALL MOM_V_DEL2V(bi,bj,k,vFld,hFacZ,v4f,myThid)

C---  Calculate mean and eddy fluxes between cells for meridional flow.

C--   Zonal flux (fZon is at west face of "v" cell)

C     Mean flow component of zonal flux -> aF
      IF (momAdvection)
     & CALL MOM_V_ADV_UV(bi,bj,k,uTrans,vFld,af,myThid)

C     Laplacian and bi-harmonic terms -> vF
      IF (momViscosity)
     & CALL MOM_V_XVISCFLUX(bi,bj,k,vFld,v4f,hFacZ,vf,myThid)

C     Combine fluxes -> fZon
      DO j=jMin,jMax
       DO i=iMin,iMax
        fZon(i,j) = uDvdxFac*aF(i,j) + AhDvdxFac*vF(i,j)
       ENDDO
      ENDDO

C--   Meridional flux (fMer is at north face of "v" cell)

C     Mean flow component of meridional flux
      IF (momAdvection)
     & CALL MOM_V_ADV_VV(bi,bj,k,vTrans,vFld,af,myThid)

C     Laplacian and bi-harmonic term
      IF (momViscosity)
     & CALL MOM_V_YVISCFLUX(bi,bj,k,vFld,v4f,vf,myThid)

C     Combine fluxes -> fMer
      DO j=jMin,jMax
       DO i=iMin,iMax
        fMer(i,j) = vDvdyFac*aF(i,j) + AhDvdyFac*vF(i,j)
       ENDDO
      ENDDO

C--   Vertical flux (fVer is at upper face of "v" cell)

C--   Free surface correction term (flux at k=1)
      IF (momAdvection.AND.k.EQ.1) THEN
       CALL MOM_V_ADV_WV(bi,bj,k,vVel,wVel,af,myThid)
       DO j=jMin,jMax
        DO i=iMin,iMax
         fVerV(i,j,kUp) = af(i,j)
        ENDDO
       ENDDO
      ENDIF
C     o Mean flow component of vertical flux
      IF (momAdvection)
     & CALL MOM_V_ADV_WV(bi,bj,k+1,vVel,wVel,af,myThid)

C     Eddy component of vertical flux (interior component only) -> vrF
      IF (momViscosity.AND..NOT.implicitViscosity)
     & CALL MOM_V_RVISCFLUX(bi,bj,k,vVel,KappaRV,vrf,myThid)

C     Combine fluxes -> fVerV
      DO j=jMin,jMax
       DO i=iMin,iMax
        fVerV(i,j,kDown) = rVelDvdrFac*aF(i,j) + ArDvdrFac*vrF(i,j)
       ENDDO
      ENDDO

C---  Hydorstatic term (-1/rhoConst . dphi/dy )
      IF (momPressureForcing) THEN
       DO j=jMin,jMax
        DO i=iMin,iMax
         pF(i,j) = -_recip_dyC(i,j,bi,bj)
     &    *(phi_hyd(i,j,k)-phi_hyd(i,j-1,k))
        ENDDO
       ENDDO
      ENDIF

C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
      DO j=jMin,jMax
       DO i=iMin,iMax
        gV(i,j,k,bi,bj) =
#ifdef OLD_UV_GEOM
     &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/
     &    ( 0.5 _d 0*(_rA(i,j,bi,bj)+_rA(i,j-1,bi,bj)) )
#else
     &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
     &    *recip_rAs(i,j,bi,bj)
#endif
     &  *(fZon(i+1,j)          - fZon(i,j  )
     &   +fMer(i,j  )          - fMer(i,j-1)
     &   +fVerV(i,j,kUp)*rkFac - fVerV(i,j,kDown)*rkFac
     &   )
     & _PHM( +phyFac*pf(i,j) )
       ENDDO
      ENDDO

C-- No-slip and drag BCs appear as body forces in cell abutting topography 
      IF (momViscosity.AND.no_slip_sides) THEN
C-     No-slip BCs impose a drag at walls...
       CALL MOM_V_SIDEDRAG(bi,bj,k,vFld,v4F,hFacZ,vF,myThid)
       DO j=jMin,jMax
        DO i=iMin,iMax
         gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)
        ENDDO
       ENDDO
      ENDIF
C-    No-slip BCs impose a drag at bottom
      IF (momViscosity.AND.bottomDragTerms) THEN
       CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)
       DO j=jMin,jMax
        DO i=iMin,iMax
         gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)
        ENDDO
       ENDDO
      ENDIF

C--   Forcing term
      IF (momForcing)
     & CALL EXTERNAL_FORCING_V(
     I     iMin,iMax,jMin,jMax,bi,bj,k,
     I     myCurrentTime,myThid)

C--   Metric terms for curvilinear grid systems
      IF (useNHMTerms) THEN
C      o Spherical polar grid metric terms
       CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,mT,myThid)
       DO j=jMin,jMax
        DO i=iMin,iMax
         gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+mTFacV*mT(i,j)
        ENDDO
       ENDDO
      ENDIF
      IF (usingSphericalPolarMTerms) THEN
       CALL MOM_V_METRIC_SPHERE(bi,bj,k,uFld,mT,myThid)
       DO j=jMin,jMax
        DO i=iMin,iMax
         gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+mTFacV*mT(i,j)
        ENDDO
       ENDDO
      ENDIF

C--   Set dv/dt on boundaries to zero
      DO j=jMin,jMax
       DO i=iMin,iMax
        gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)
       ENDDO
      ENDDO

C--   Coriolis term
C     Note. As coded here, coriolis will not work with "thin walls"
#ifdef INCLUDE_CD_CODE
      CALL MOM_CDSCHEME(bi,bj,k,phi_hyd,myThid)
#else
      CALL MOM_U_CORIOLIS(bi,bj,k,vFld,cf,myThid)
      DO j=jMin,jMax
       DO i=iMin,iMax
        gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)
       ENDDO
      ENDDO
      CALL MOM_V_CORIOLIS(bi,bj,k,uFld,cf,myThid)
      DO j=jMin,jMax
       DO i=iMin,iMax
        gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+fvFac*cf(i,j)
       ENDDO
      ENDDO
#endif /* INCLUDE_CD_CODE */

      RETURN
      END
1	adcroft	1.5	C $Header: /u/gcmpack/MITgcm/pkg/mom_fluxform/mom_fluxform.F,v 1.4 2001/09/28 16:49:54 adcroft Exp $
2	adcroft	1.2	C $Name: $
3	adcroft	1.1
4	adcroft	1.3	CBOI
5			C !TITLE: pkg/mom\_advdiff
6			C !AUTHORS: adcroft@mit.edu
7	adcroft	1.4	C !INTRODUCTION: Flux-form Momentum Equations Package
8	adcroft	1.3	C
9			C Package "mom\_fluxform" provides methods for calculating explicit terms
10			C in the momentum equation cast in flux-form:
11			C \begin{eqnarray*}
12			C G^u & = & -\frac{1}{\rho} \partial_x \phi_h
13			C -\nabla \cdot {\bf v} u
14			C -fv
15			C +\frac{1}{\rho} \nabla \cdot {\bf \tau}^x
16			C + \mbox{metrics}
17			C \\
18			C G^v & = & -\frac{1}{\rho} \partial_y \phi_h
19			C -\nabla \cdot {\bf v} v
20			C +fu
21			C +\frac{1}{\rho} \nabla \cdot {\bf \tau}^y
22			C + \mbox{metrics}
23			C \end{eqnarray*}
24			C where ${\bf v}=(u,v,w)$ and $\tau$, the stress tensor, includes surface
25			C stresses as well as internal viscous stresses.
26			CEOI
27
28	adcroft	1.1	#include "CPP_OPTIONS.h"
29
30	adcroft	1.3	CBOP
31			C !ROUTINE: MOM_FLUXFORM
32
33			C !INTERFACE: ==========================================================
34	adcroft	1.1	SUBROUTINE MOM_FLUXFORM(
35			I bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,
36			I phi_hyd,KappaRU,KappaRV,
37			U fVerU, fVerV,
38	adcroft	1.3	I myCurrentTime,myIter,myThid)
39
40			C !DESCRIPTION:
41			C Calculates all the horizontal accelerations except for the implicit surface
42			C pressure gradient and implciit vertical viscosity.
43	adcroft	1.1
44	adcroft	1.3	C !USES: ===============================================================
45	adcroft	1.1	C == Global variables ==
46	adcroft	1.3	IMPLICIT NONE
47	adcroft	1.1	#include "SIZE.h"
48			#include "DYNVARS.h"
49			#include "FFIELDS.h"
50			#include "EEPARAMS.h"
51			#include "PARAMS.h"
52			#include "GRID.h"
53			#include "SURFACE.h"
54
55	adcroft	1.3	C !INPUT PARAMETERS: ===================================================
56			C bi,bj :: tile indices
57			C iMin,iMax,jMin,jMAx :: loop ranges
58			C k :: vertical level
59			C kUp :: =1 or 2 for consecutive k
60			C kDown :: =2 or 1 for consecutive k
61			C phi_hyd :: hydrostatic pressure (perturbation)
62			C KappaRU :: vertical viscosity
63			C KappaRV :: vertical viscosity
64			C fVerU :: vertical flux of U, 2 1/2 dim for pipe-lining
65			C fVerV :: vertical flux of V, 2 1/2 dim for pipe-lining
66			C myCurrentTime :: current time
67			C myIter :: current time-step number
68			C myThid :: thread number
69			INTEGER bi,bj,iMin,iMax,jMin,jMax
70			INTEGER k,kUp,kDown
71	adcroft	1.1	_RL phi_hyd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
72			_RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
73			_RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
74			_RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
75			_RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
76	adcroft	1.2	_RL myCurrentTime
77			INTEGER myIter
78	adcroft	1.1	INTEGER myThid
79
80	adcroft	1.3	C !OUTPUT PARAMETERS: ==================================================
81			C None - updates gU() and gV() in common blocks
82
83			C !LOCAL VARIABLES: ====================================================
84			C i,j :: loop indices
85			C aF :: advective flux
86			C vF :: viscous flux
87			C v4F :: bi-harmonic viscous flux
88			C vrF :: vertical viscous flux
89			C cF :: Coriolis acceleration
90			C mT :: Metric terms
91			C pF :: Pressure gradient
92			C fZon :: zonal fluxes
93			C fMer :: meridional fluxes
94			INTEGER i,j
95			_RL aF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
96			_RL vF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
97			_RL v4F(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
98			_RL vrF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
99			_RL cF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
100			_RL mT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
101			_RL pF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
102			_RL fZon(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
103			_RL fMer(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
104	adcroft	1.1	C wMaskOverride - Land sea flag override for top layer.
105			C afFacMom - Tracer parameters for turning terms
106			C vfFacMom on and off.
107			C pfFacMom afFacMom - Advective terms
108			C cfFacMom vfFacMom - Eddy viscosity terms
109			C mTFacMom pfFacMom - Pressure terms
110			C cfFacMom - Coriolis terms
111			C foFacMom - Forcing
112			C mTFacMom - Metric term
113			C uDudxFac, AhDudxFac, etc ... individual term tracer parameters
114			_RS hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
115			_RS r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
116			_RS xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
117			_RS yA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
118			_RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
119			_RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
120			_RL uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
121			_RL vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
122			C I,J,K - Loop counters
123			C rVelMaskOverride - Factor for imposing special surface boundary conditions
124			C ( set according to free-surface condition ).
125			C hFacROpen - Lopped cell factos used tohold fraction of open
126			C hFacRClosed and closed cell wall.
127			_RL rVelMaskOverride
128			C xxxFac - On-off tracer parameters used for switching terms off.
129			_RL uDudxFac
130			_RL AhDudxFac
131			_RL A4DuxxdxFac
132			_RL vDudyFac
133			_RL AhDudyFac
134			_RL A4DuyydyFac
135			_RL rVelDudrFac
136			_RL ArDudrFac
137			_RL fuFac
138			_RL phxFac
139			_RL mtFacU
140			_RL uDvdxFac
141			_RL AhDvdxFac
142			_RL A4DvxxdxFac
143			_RL vDvdyFac
144			_RL AhDvdyFac
145			_RL A4DvyydyFac
146			_RL rVelDvdrFac
147			_RL ArDvdrFac
148			_RL fvFac
149			_RL phyFac
150			_RL vForcFac
151			_RL mtFacV
152			INTEGER km1,kp1
153			_RL wVelBottomOverride
154			LOGICAL bottomDragTerms
155			_RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
156	adcroft	1.3	CEOP
157	adcroft	1.1
158			km1=MAX(1,k-1)
159			kp1=MIN(Nr,k+1)
160			rVelMaskOverride=1.
161			IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac
162			wVelBottomOverride=1.
163			IF (k.EQ.Nr) wVelBottomOverride=0.
164
165			C Initialise intermediate terms
166			DO J=1-OLy,sNy+OLy
167			DO I=1-OLx,sNx+OLx
168			aF(i,j) = 0.
169			vF(i,j) = 0.
170			v4F(i,j) = 0.
171			vrF(i,j) = 0.
172			cF(i,j) = 0.
173			mT(i,j) = 0.
174			pF(i,j) = 0.
175			fZon(i,j) = 0.
176			fMer(i,j) = 0.
177			ENDDO
178			ENDDO
179
180			C-- Term by term tracer parmeters
181			C o U momentum equation
182			uDudxFac = afFacMom*1.
183			AhDudxFac = vfFacMom*1.
184			A4DuxxdxFac = vfFacMom*1.
185			vDudyFac = afFacMom*1.
186			AhDudyFac = vfFacMom*1.
187			A4DuyydyFac = vfFacMom*1.
188			rVelDudrFac = afFacMom*1.
189			ArDudrFac = vfFacMom*1.
190			mTFacU = mtFacMom*1.
191			fuFac = cfFacMom*1.
192			phxFac = pfFacMom*1.
193			C o V momentum equation
194			uDvdxFac = afFacMom*1.
195			AhDvdxFac = vfFacMom*1.
196			A4DvxxdxFac = vfFacMom*1.
197			vDvdyFac = afFacMom*1.
198			AhDvdyFac = vfFacMom*1.
199			A4DvyydyFac = vfFacMom*1.
200			rVelDvdrFac = afFacMom*1.
201			ArDvdrFac = vfFacMom*1.
202			mTFacV = mtFacMom*1.
203			fvFac = cfFacMom*1.
204			phyFac = pfFacMom*1.
205			vForcFac = foFacMom*1.
206
207			IF ( no_slip_bottom
208			& .OR. bottomDragQuadratic.NE.0.
209			& .OR. bottomDragLinear.NE.0.) THEN
210			bottomDragTerms=.TRUE.
211			ELSE
212			bottomDragTerms=.FALSE.
213			ENDIF
214
215			C-- with stagger time stepping, grad Phi_Hyp is directly incoporated in TIMESTEP
216			IF (staggerTimeStep) THEN
217			phxFac = 0.
218			phyFac = 0.
219			ENDIF
220
221			C-- Calculate open water fraction at vorticity points
222			CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)
223
224			C---- Calculate common quantities used in both U and V equations
225			C Calculate tracer cell face open areas
226			DO j=1-OLy,sNy+OLy
227			DO i=1-OLx,sNx+OLx
228			xA(i,j) = _dyG(i,j,bi,bj)
229			& drF(k)_hFacW(i,j,k,bi,bj)
230			yA(i,j) = _dxG(i,j,bi,bj)
231			& drF(k)_hFacS(i,j,k,bi,bj)
232			ENDDO
233			ENDDO
234
235			C Make local copies of horizontal flow field
236			DO j=1-OLy,sNy+OLy
237			DO i=1-OLx,sNx+OLx
238			uFld(i,j) = uVel(i,j,k,bi,bj)
239			vFld(i,j) = vVel(i,j,k,bi,bj)
240			ENDDO
241			ENDDO
242
243			C Calculate velocity field "volume transports" through tracer cell faces.
244			DO j=1-OLy,sNy+OLy
245			DO i=1-OLx,sNx+OLx
246			uTrans(i,j) = uFld(i,j)*xA(i,j)
247			vTrans(i,j) = vFld(i,j)*yA(i,j)
248			ENDDO
249			ENDDO
250
251			CALL MOM_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid)
252
253			C---- Zonal momentum equation starts here
254
255			C Bi-harmonic term del^2 U -> v4F
256			IF (momViscosity)
257			& CALL MOM_U_DEL2U(bi,bj,k,uFld,hFacZ,v4f,myThid)
258
259			C--- Calculate mean and eddy fluxes between cells for zonal flow.
260
261			C-- Zonal flux (fZon is at east face of "u" cell)
262
263			C Mean flow component of zonal flux -> aF
264			IF (momAdvection)
265			& CALL MOM_U_ADV_UU(bi,bj,k,uTrans,uFld,aF,myThid)
266
267			C Laplacian and bi-harmonic terms -> vF
268			IF (momViscosity)
269			& CALL MOM_U_XVISCFLUX(bi,bj,k,uFld,v4F,vF,myThid)
270
271			C Combine fluxes -> fZon
272			DO j=jMin,jMax
273			DO i=iMin,iMax
274			fZon(i,j) = uDudxFacaF(i,j) + AhDudxFacvF(i,j)
275			ENDDO
276			ENDDO
277
278			C-- Meridional flux (fMer is at south face of "u" cell)
279
280			C Mean flow component of meridional flux
281			IF (momAdvection)
282			& CALL MOM_U_ADV_VU(bi,bj,k,vTrans,uFld,aF,myThid)
283
284			C Laplacian and bi-harmonic term
285			IF (momViscosity)
286			& CALL MOM_U_YVISCFLUX(bi,bj,k,uFld,v4F,hFacZ,vF,myThid)
287
288			C Combine fluxes -> fMer
289			DO j=jMin,jMax
290			DO i=iMin,iMax
291			fMer(i,j) = vDudyFacaF(i,j) + AhDudyFacvF(i,j)
292			ENDDO
293			ENDDO
294
295			C-- Vertical flux (fVer is at upper face of "u" cell)
296
297			C-- Free surface correction term (flux at k=1)
298			IF (momAdvection.AND.k.EQ.1) THEN
299			CALL MOM_U_ADV_WU(bi,bj,k,uVel,wVel,af,myThid)
300			DO j=jMin,jMax
301			DO i=iMin,iMax
302			fVerU(i,j,kUp) = af(i,j)
303			ENDDO
304			ENDDO
305			ENDIF
306			C Mean flow component of vertical flux (at k+1) -> aF
307			IF (momAdvection)
308			& CALL MOM_U_ADV_WU(bi,bj,k+1,uVel,wVel,af,myThid)
309
310			C Eddy component of vertical flux (interior component only) -> vrF
311			IF (momViscosity.AND..NOT.implicitViscosity)
312			& CALL MOM_U_RVISCFLUX(bi,bj,k,uVel,KappaRU,vrF,myThid)
313
314			C Combine fluxes
315			DO j=jMin,jMax
316			DO i=iMin,iMax
317			fVerU(i,j,kDown) = rVelDudrFacaF(i,j) + ArDudrFacvrF(i,j)
318			ENDDO
319			ENDDO
320
321			C--- Hydrostatic term ( -1/rhoConst . dphi/dx )
322			IF (momPressureForcing) THEN
323			DO j=jMin,jMax
324			DO i=iMin,iMax
325			pf(i,j) = - _recip_dxC(i,j,bi,bj)
326			& *(phi_hyd(i,j,k)-phi_hyd(i-1,j,k))
327			ENDDO
328			ENDDO
329			ENDIF
330
331			C-- Tendency is minus divergence of the fluxes + coriolis + pressure term
332			DO j=jMin,jMax
333			DO i=iMin,iMax
334			gU(i,j,k,bi,bj) =
335			#ifdef OLD_UV_GEOM
336			& -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/
337			& ( 0.5 _d 0*(rA(i,j,bi,bj)+rA(i-1,j,bi,bj)) )
338			#else
339			& -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
340			& *recip_rAw(i,j,bi,bj)
341			#endif
342			& *(fZon(i,j ) - fZon(i-1,j)
343			& +fMer(i,j+1) - fMer(i ,j)
344			& +fVerU(i,j,kUp)rkFac - fVerU(i,j,kDown)rkFac
345			& )
346			& _PHM( +phxFac * pf(i,j) )
347			ENDDO
348			ENDDO
349
350			C-- No-slip and drag BCs appear as body forces in cell abutting topography
351			IF (momViscosity.AND.no_slip_sides) THEN
352			C- No-slip BCs impose a drag at walls...
353			CALL MOM_U_SIDEDRAG(bi,bj,k,uFld,v4F,hFacZ,vF,myThid)
354			DO j=jMin,jMax
355			DO i=iMin,iMax
356			gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)
357			ENDDO
358			ENDDO
359			ENDIF
360			C- No-slip BCs impose a drag at bottom
361			IF (momViscosity.AND.bottomDragTerms) THEN
362			CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
363			DO j=jMin,jMax
364			DO i=iMin,iMax
365			gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)
366			ENDDO
367			ENDDO
368			ENDIF
369
370			C-- Forcing term
371			IF (momForcing)
372			& CALL EXTERNAL_FORCING_U(
373			I iMin,iMax,jMin,jMax,bi,bj,k,
374			I myCurrentTime,myThid)
375
376			C-- Metric terms for curvilinear grid systems
377	adcroft	1.5	IF (useNHMTerms) THEN
378			C o Non-hydrosatic metric terms
379	adcroft	1.1	CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,mT,myThid)
380			DO j=jMin,jMax
381			DO i=iMin,iMax
382			gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+mTFacU*mT(i,j)
383			ENDDO
384			ENDDO
385	adcroft	1.5	ENDIF
386			IF (usingSphericalPolarMTerms) THEN
387	adcroft	1.1	CALL MOM_U_METRIC_SPHERE(bi,bj,k,uFld,vFld,mT,myThid)
388			DO j=jMin,jMax
389			DO i=iMin,iMax
390			gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+mTFacU*mT(i,j)
391			ENDDO
392			ENDDO
393			ENDIF
394
395			C-- Set du/dt on boundaries to zero
396			DO j=jMin,jMax
397			DO i=iMin,iMax
398			gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)*_maskW(i,j,k,bi,bj)
399			ENDDO
400			ENDDO
401
402
403			C---- Meridional momentum equation starts here
404
405			C Bi-harmonic term del^2 V -> v4F
406			IF (momViscosity)
407			& CALL MOM_V_DEL2V(bi,bj,k,vFld,hFacZ,v4f,myThid)
408
409			C--- Calculate mean and eddy fluxes between cells for meridional flow.
410
411			C-- Zonal flux (fZon is at west face of "v" cell)
412
413			C Mean flow component of zonal flux -> aF
414			IF (momAdvection)
415			& CALL MOM_V_ADV_UV(bi,bj,k,uTrans,vFld,af,myThid)
416
417			C Laplacian and bi-harmonic terms -> vF
418			IF (momViscosity)
419			& CALL MOM_V_XVISCFLUX(bi,bj,k,vFld,v4f,hFacZ,vf,myThid)
420
421			C Combine fluxes -> fZon
422			DO j=jMin,jMax
423			DO i=iMin,iMax
424			fZon(i,j) = uDvdxFacaF(i,j) + AhDvdxFacvF(i,j)
425			ENDDO
426			ENDDO
427
428			C-- Meridional flux (fMer is at north face of "v" cell)
429
430			C Mean flow component of meridional flux
431			IF (momAdvection)
432			& CALL MOM_V_ADV_VV(bi,bj,k,vTrans,vFld,af,myThid)
433
434			C Laplacian and bi-harmonic term
435			IF (momViscosity)
436			& CALL MOM_V_YVISCFLUX(bi,bj,k,vFld,v4f,vf,myThid)
437
438			C Combine fluxes -> fMer
439			DO j=jMin,jMax
440			DO i=iMin,iMax
441			fMer(i,j) = vDvdyFacaF(i,j) + AhDvdyFacvF(i,j)
442			ENDDO
443			ENDDO
444
445			C-- Vertical flux (fVer is at upper face of "v" cell)
446
447			C-- Free surface correction term (flux at k=1)
448			IF (momAdvection.AND.k.EQ.1) THEN
449			CALL MOM_V_ADV_WV(bi,bj,k,vVel,wVel,af,myThid)
450			DO j=jMin,jMax
451			DO i=iMin,iMax
452			fVerV(i,j,kUp) = af(i,j)
453			ENDDO
454			ENDDO
455			ENDIF
456			C o Mean flow component of vertical flux
457			IF (momAdvection)
458			& CALL MOM_V_ADV_WV(bi,bj,k+1,vVel,wVel,af,myThid)
459
460			C Eddy component of vertical flux (interior component only) -> vrF
461			IF (momViscosity.AND..NOT.implicitViscosity)
462			& CALL MOM_V_RVISCFLUX(bi,bj,k,vVel,KappaRV,vrf,myThid)
463
464			C Combine fluxes -> fVerV
465			DO j=jMin,jMax
466			DO i=iMin,iMax
467			fVerV(i,j,kDown) = rVelDvdrFacaF(i,j) + ArDvdrFacvrF(i,j)
468			ENDDO
469			ENDDO
470
471			C--- Hydorstatic term (-1/rhoConst . dphi/dy )
472			IF (momPressureForcing) THEN
473			DO j=jMin,jMax
474			DO i=iMin,iMax
475			pF(i,j) = -_recip_dyC(i,j,bi,bj)
476			& *(phi_hyd(i,j,k)-phi_hyd(i,j-1,k))
477			ENDDO
478			ENDDO
479			ENDIF
480
481			C-- Tendency is minus divergence of the fluxes + coriolis + pressure term
482			DO j=jMin,jMax
483			DO i=iMin,iMax
484			gV(i,j,k,bi,bj) =
485			#ifdef OLD_UV_GEOM
486			& -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/
487			& ( 0.5 _d 0*(_rA(i,j,bi,bj)+_rA(i,j-1,bi,bj)) )
488			#else
489			& -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
490			& *recip_rAs(i,j,bi,bj)
491			#endif
492			& *(fZon(i+1,j) - fZon(i,j )
493			& +fMer(i,j ) - fMer(i,j-1)
494			& +fVerV(i,j,kUp)rkFac - fVerV(i,j,kDown)rkFac
495			& )
496			& _PHM( +phyFac*pf(i,j) )
497			ENDDO
498			ENDDO
499
500			C-- No-slip and drag BCs appear as body forces in cell abutting topography
501			IF (momViscosity.AND.no_slip_sides) THEN
502			C- No-slip BCs impose a drag at walls...
503			CALL MOM_V_SIDEDRAG(bi,bj,k,vFld,v4F,hFacZ,vF,myThid)
504			DO j=jMin,jMax
505			DO i=iMin,iMax
506			gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)
507			ENDDO
508			ENDDO
509			ENDIF
510			C- No-slip BCs impose a drag at bottom
511			IF (momViscosity.AND.bottomDragTerms) THEN
512			CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)
513			DO j=jMin,jMax
514			DO i=iMin,iMax
515			gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)
516			ENDDO
517			ENDDO
518			ENDIF
519
520			C-- Forcing term
521			IF (momForcing)
522			& CALL EXTERNAL_FORCING_V(
523			I iMin,iMax,jMin,jMax,bi,bj,k,
524			I myCurrentTime,myThid)
525
526			C-- Metric terms for curvilinear grid systems
527	adcroft	1.5	IF (useNHMTerms) THEN
528	adcroft	1.1	C o Spherical polar grid metric terms
529			CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,mT,myThid)
530			DO j=jMin,jMax
531			DO i=iMin,iMax
532			gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+mTFacV*mT(i,j)
533			ENDDO
534			ENDDO
535	adcroft	1.5	ENDIF
536			IF (usingSphericalPolarMTerms) THEN
537	adcroft	1.1	CALL MOM_V_METRIC_SPHERE(bi,bj,k,uFld,mT,myThid)
538			DO j=jMin,jMax
539			DO i=iMin,iMax
540			gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+mTFacV*mT(i,j)
541			ENDDO
542			ENDDO
543			ENDIF
544
545			C-- Set dv/dt on boundaries to zero
546			DO j=jMin,jMax
547			DO i=iMin,iMax
548			gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)
549			ENDDO
550			ENDDO
551
552			C-- Coriolis term
553			C Note. As coded here, coriolis will not work with "thin walls"
554			#ifdef INCLUDE_CD_CODE
555			CALL MOM_CDSCHEME(bi,bj,k,phi_hyd,myThid)
556			#else
557			CALL MOM_U_CORIOLIS(bi,bj,k,vFld,cf,myThid)
558			DO j=jMin,jMax
559			DO i=iMin,iMax
560			gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)
561			ENDDO
562			ENDDO
563			CALL MOM_V_CORIOLIS(bi,bj,k,uFld,cf,myThid)
564			DO j=jMin,jMax
565			DO i=iMin,iMax
566			gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+fvFac*cf(i,j)
567			ENDDO
568			ENDDO
569			#endif /* INCLUDE_CD_CODE */
570
571			RETURN
572			END