/[MITgcm]/MITgcm/pkg/mom_fluxform/mom_fluxform.F
ViewVC logotype

Diff of /MITgcm/pkg/mom_fluxform/mom_fluxform.F

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

revision 1.11 by jmc, Tue Feb 18 15:36:45 2003 UTC revision 1.38 by jmc, Thu Nov 23 00:45:18 2006 UTC
# Line 25  C where ${\bf v}=(u,v,w)$ and $\tau$, th Line 25  C where ${\bf v}=(u,v,w)$ and $\tau$, th
25  C stresses as well as internal viscous stresses.  C stresses as well as internal viscous stresses.
26  CEOI  CEOI
27    
28  #include "CPP_OPTIONS.h"  #include "MOM_FLUXFORM_OPTIONS.h"
29    
30  CBOP  CBOP
31  C !ROUTINE: MOM_FLUXFORM  C !ROUTINE: MOM_FLUXFORM
32    
33  C !INTERFACE: ==========================================================  C !INTERFACE: ==========================================================
34        SUBROUTINE MOM_FLUXFORM(        SUBROUTINE MOM_FLUXFORM(
35       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,
36       I        dPhihydX,dPhiHydY,KappaRU,KappaRV,       I        KappaRU, KappaRV,
37       U        fVerU, fVerV,       U        fVerU, fVerV,
38       I        myTime,myIter,myThid)       O        guDiss, gvDiss,
39         I        myTime, myIter, myThid)
40    
41  C !DESCRIPTION:  C !DESCRIPTION:
42  C Calculates all the horizontal accelerations except for the implicit surface  C Calculates all the horizontal accelerations except for the implicit surface
# Line 51  C     == Global variables == Line 52  C     == Global variables ==
52  #include "PARAMS.h"  #include "PARAMS.h"
53  #include "GRID.h"  #include "GRID.h"
54  #include "SURFACE.h"  #include "SURFACE.h"
55    #ifdef ALLOW_AUTODIFF_TAMC
56    # include "tamc.h"
57    # include "tamc_keys.h"
58    # include "MOM_FLUXFORM.h"
59    #endif
60    
61  C !INPUT PARAMETERS: ===================================================  C !INPUT PARAMETERS: ===================================================
62  C  bi,bj                :: tile indices  C  bi,bj                :: tile indices
# Line 58  C  iMin,iMax,jMin,jMAx  :: loop ranges Line 64  C  iMin,iMax,jMin,jMAx  :: loop ranges
64  C  k                    :: vertical level  C  k                    :: vertical level
65  C  kUp                  :: =1 or 2 for consecutive k  C  kUp                  :: =1 or 2 for consecutive k
66  C  kDown                :: =2 or 1 for consecutive k  C  kDown                :: =2 or 1 for consecutive k
 C  dPhiHydX,Y           :: Gradient (X & Y dir.) of Hydrostatic Potential  
67  C  KappaRU              :: vertical viscosity  C  KappaRU              :: vertical viscosity
68  C  KappaRV              :: vertical viscosity  C  KappaRV              :: vertical viscosity
69  C  fVerU                :: vertical flux of U, 2 1/2 dim for pipe-lining  C  fVerU                :: vertical flux of U, 2 1/2 dim for pipe-lining
70  C  fVerV                :: vertical flux of V, 2 1/2 dim for pipe-lining  C  fVerV                :: vertical flux of V, 2 1/2 dim for pipe-lining
71    C  guDiss               :: dissipation tendency (all explicit terms), u component
72    C  gvDiss               :: dissipation tendency (all explicit terms), v component
73  C  myTime               :: current time  C  myTime               :: current time
74  C  myIter               :: current time-step number  C  myIter               :: current time-step number
75  C  myThid               :: thread number  C  myThid               :: thread number
76        INTEGER bi,bj,iMin,iMax,jMin,jMax        INTEGER bi,bj,iMin,iMax,jMin,jMax
77        INTEGER k,kUp,kDown        INTEGER k,kUp,kDown
       _RL dPhiHydX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL dPhiHydY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
78        _RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
79        _RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
80        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
81        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
82          _RL guDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
83          _RL gvDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
84        _RL     myTime        _RL     myTime
85        INTEGER myIter        INTEGER myIter
86        INTEGER myThid        INTEGER myThid
# Line 83  C None - updates gU() and gV() in common Line 90  C None - updates gU() and gV() in common
90    
91  C !LOCAL VARIABLES: ====================================================  C !LOCAL VARIABLES: ====================================================
92  C  i,j                  :: loop indices  C  i,j                  :: loop indices
 C  aF                   :: advective flux  
93  C  vF                   :: viscous flux  C  vF                   :: viscous flux
94  C  v4F                  :: bi-harmonic viscous flux  C  v4F                  :: bi-harmonic viscous flux
 C  vrF                  :: vertical viscous flux  
95  C  cF                   :: Coriolis acceleration  C  cF                   :: Coriolis acceleration
96  C  mT                   :: Metric terms  C  mT                   :: Metric terms
 C  pF                   :: Pressure gradient  
97  C  fZon                 :: zonal fluxes  C  fZon                 :: zonal fluxes
98  C  fMer                 :: meridional fluxes  C  fMer                 :: meridional fluxes
99    C  fVrUp,fVrDw          :: vertical viscous fluxes at interface k-1 & k
100        INTEGER i,j        INTEGER i,j
101        _RL aF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  #ifdef ALLOW_AUTODIFF_TAMC
102          INTEGER imomkey
103    #endif
104        _RL vF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
105        _RL v4F(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)  
106        _RL cF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL cF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
107        _RL mT(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)  
108        _RL fZon(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL fZon(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
109        _RL fMer(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL fMer(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
110  C     wMaskOverride - Land sea flag override for top layer.        _RL fVrUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
111  C     afFacMom      - Tracer parameters for turning terms        _RL fVrDw(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
112  C     vfFacMom        on and off.  C     afFacMom     :: Tracer parameters for turning terms on and off.
113  C     pfFacMom        afFacMom - Advective terms  C     vfFacMom
114    C     pfFacMom        afFacMom - Advective terms
115  C     cfFacMom        vfFacMom - Eddy viscosity terms  C     cfFacMom        vfFacMom - Eddy viscosity terms
116  C     mTFacMom        pfFacMom - Pressure terms  C     mtFacMom        pfFacMom - Pressure terms
117  C                     cfFacMom - Coriolis terms  C                     cfFacMom - Coriolis terms
118  C                     foFacMom - Forcing  C                     foFacMom - Forcing
119  C                     mTFacMom - Metric term  C                     mtFacMom - Metric term
120  C     uDudxFac, AhDudxFac, etc ... individual term tracer parameters  C     uDudxFac, AhDudxFac, etc ... individual term parameters for switching terms off
121        _RS    hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS    hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
122        _RS  r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS  r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
123        _RS      xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS      xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
# Line 122  C     uDudxFac, AhDudxFac, etc ... indiv Line 128  C     uDudxFac, AhDudxFac, etc ... indiv
128        _RL  vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL  vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
129        _RL  rTransU(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL  rTransU(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
130        _RL  rTransV(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL  rTransV(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
131  C     I,J,K - Loop counters        _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
132  C     rVelMaskOverride - Factor for imposing special surface boundary conditions        _RL viscAh_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
133  C                        ( set according to free-surface condition ).        _RL viscAh_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
134  C     hFacROpen        - Lopped cell factos used tohold fraction of open        _RL viscA4_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
135  C     hFacRClosed        and closed cell wall.        _RL viscA4_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
136        _RL  rVelMaskOverride        _RL vort3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
137  C     xxxFac - On-off tracer parameters used for switching terms off.        _RL hDiv(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
138          _RL strain(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
139          _RL tension(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
140        _RL  uDudxFac        _RL  uDudxFac
141        _RL  AhDudxFac        _RL  AhDudxFac
       _RL  A4DuxxdxFac  
142        _RL  vDudyFac        _RL  vDudyFac
143        _RL  AhDudyFac        _RL  AhDudyFac
       _RL  A4DuyydyFac  
144        _RL  rVelDudrFac        _RL  rVelDudrFac
145        _RL  ArDudrFac        _RL  ArDudrFac
146        _RL  fuFac        _RL  fuFac
       _RL  phxFac  
147        _RL  mtFacU        _RL  mtFacU
148          _RL  mtNHFacU
149        _RL  uDvdxFac        _RL  uDvdxFac
150        _RL  AhDvdxFac        _RL  AhDvdxFac
       _RL  A4DvxxdxFac  
151        _RL  vDvdyFac        _RL  vDvdyFac
152        _RL  AhDvdyFac        _RL  AhDvdyFac
       _RL  A4DvyydyFac  
153        _RL  rVelDvdrFac        _RL  rVelDvdrFac
154        _RL  ArDvdrFac        _RL  ArDvdrFac
155        _RL  fvFac        _RL  fvFac
       _RL  phyFac  
       _RL  vForcFac  
156        _RL  mtFacV        _RL  mtFacV
157        INTEGER km1,kp1        _RL  mtNHFacV
158        _RL wVelBottomOverride        _RL  sideMaskFac
159        LOGICAL bottomDragTerms        LOGICAL bottomDragTerms,harmonic,biharmonic,useVariableViscosity
       _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
160  CEOP  CEOP
161    
162        km1=MAX(1,k-1)  #ifdef ALLOW_AUTODIFF_TAMC
163        kp1=MIN(Nr,k+1)            act0 = k - 1
164        rVelMaskOverride=1.            max0 = Nr
165        IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac            act1 = bi - myBxLo(myThid)
166        wVelBottomOverride=1.            max1 = myBxHi(myThid) - myBxLo(myThid) + 1
167        IF (k.EQ.Nr) wVelBottomOverride=0.            act2 = bj - myByLo(myThid)
168              max2 = myByHi(myThid) - myByLo(myThid) + 1
169              act3 = myThid - 1
170              max3 = nTx*nTy
171              act4 = ikey_dynamics - 1
172              imomkey = (act0 + 1)
173         &                    + act1*max0
174         &                    + act2*max0*max1
175         &                    + act3*max0*max1*max2
176         &                    + act4*max0*max1*max2*max3
177    #endif /* ALLOW_AUTODIFF_TAMC */
178    
179  C     Initialise intermediate terms  C     Initialise intermediate terms
180        DO J=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
181         DO I=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
         aF(i,j)   = 0.  
182          vF(i,j)   = 0.          vF(i,j)   = 0.
183          v4F(i,j)  = 0.          v4F(i,j)  = 0.
         vrF(i,j)  = 0.  
184          cF(i,j)   = 0.          cF(i,j)   = 0.
185          mT(i,j)   = 0.          mT(i,j)   = 0.
         pF(i,j)   = 0.  
186          fZon(i,j) = 0.          fZon(i,j) = 0.
187          fMer(i,j) = 0.          fMer(i,j) = 0.
188          rTransU(i,j) = 0.          fVrUp(i,j)= 0.
189          rTransV(i,j) = 0.          fVrDw(i,j)= 0.
190            rTransU(i,j)= 0.
191            rTransV(i,j)= 0.
192    c       KE(i,j)     = 0.
193    c       hDiv(i,j)   = 0.
194            vort3(i,j)  = 0.
195            strain(i,j) = 0.
196            tension(i,j)= 0.
197            guDiss(i,j) = 0.
198            gvDiss(i,j) = 0.
199         ENDDO         ENDDO
200        ENDDO        ENDDO
201    
# Line 186  C--   Term by term tracer parmeters Line 203  C--   Term by term tracer parmeters
203  C     o U momentum equation  C     o U momentum equation
204        uDudxFac     = afFacMom*1.        uDudxFac     = afFacMom*1.
205        AhDudxFac    = vfFacMom*1.        AhDudxFac    = vfFacMom*1.
       A4DuxxdxFac  = vfFacMom*1.  
206        vDudyFac     = afFacMom*1.        vDudyFac     = afFacMom*1.
207        AhDudyFac    = vfFacMom*1.        AhDudyFac    = vfFacMom*1.
       A4DuyydyFac  = vfFacMom*1.  
208        rVelDudrFac  = afFacMom*1.        rVelDudrFac  = afFacMom*1.
209        ArDudrFac    = vfFacMom*1.        ArDudrFac    = vfFacMom*1.
210        mTFacU       = mtFacMom*1.        mtFacU       = mtFacMom*1.
211          mtNHFacU     = 1.
212        fuFac        = cfFacMom*1.        fuFac        = cfFacMom*1.
       phxFac       = pfFacMom*1.  
213  C     o V momentum equation  C     o V momentum equation
214        uDvdxFac     = afFacMom*1.        uDvdxFac     = afFacMom*1.
215        AhDvdxFac    = vfFacMom*1.        AhDvdxFac    = vfFacMom*1.
       A4DvxxdxFac  = vfFacMom*1.  
216        vDvdyFac     = afFacMom*1.        vDvdyFac     = afFacMom*1.
217        AhDvdyFac    = vfFacMom*1.        AhDvdyFac    = vfFacMom*1.
       A4DvyydyFac  = vfFacMom*1.  
218        rVelDvdrFac  = afFacMom*1.        rVelDvdrFac  = afFacMom*1.
219        ArDvdrFac    = vfFacMom*1.        ArDvdrFac    = vfFacMom*1.
220        mTFacV       = mtFacMom*1.        mtFacV       = mtFacMom*1.
221          mtNHFacV     = 1.
222        fvFac        = cfFacMom*1.        fvFac        = cfFacMom*1.
223        phyFac       = pfFacMom*1.  
224        vForcFac     = foFacMom*1.        IF (implicitViscosity) THEN
225            ArDudrFac  = 0.
226            ArDvdrFac  = 0.
227          ENDIF
228    
229    C note: using standard stencil (no mask) results in under-estimating
230    C       vorticity at a no-slip boundary by a factor of 2 = sideDragFactor
231          IF ( no_slip_sides ) THEN
232            sideMaskFac = sideDragFactor
233          ELSE
234            sideMaskFac = 0. _d 0
235          ENDIF
236    
237        IF (     no_slip_bottom        IF (     no_slip_bottom
238       &    .OR. bottomDragQuadratic.NE.0.       &    .OR. bottomDragQuadratic.NE.0.
# Line 217  C     o V momentum equation Line 242  C     o V momentum equation
242         bottomDragTerms=.FALSE.         bottomDragTerms=.FALSE.
243        ENDIF        ENDIF
244    
 C-- with stagger time stepping, grad Phi_Hyp is directly incoporated in TIMESTEP  
       IF (staggerTimeStep) THEN  
         phxFac = 0.  
         phyFac = 0.  
       ENDIF  
   
245  C--   Calculate open water fraction at vorticity points  C--   Calculate open water fraction at vorticity points
246        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)
247    
# Line 253  C     Calculate velocity field "volume t Line 272  C     Calculate velocity field "volume t
272         ENDDO         ENDDO
273        ENDDO        ENDDO
274    
275        CALL MOM_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid)        CALL MOM_CALC_KE(bi,bj,k,2,uFld,vFld,KE,myThid)
276          IF ( momViscosity) THEN
277            CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid)
278            CALL MOM_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)
279            CALL MOM_CALC_TENSION(bi,bj,k,uFld,vFld,tension,myThid)
280            CALL MOM_CALC_STRAIN(bi,bj,k,uFld,vFld,hFacZ,strain,myThid)
281            DO j=1-Oly,sNy+Oly
282             DO i=1-Olx,sNx+Olx
283               IF ( hFacZ(i,j).EQ.0. ) THEN
284                 vort3(i,j)  = sideMaskFac*vort3(i,j)
285                 strain(i,j) = sideMaskFac*strain(i,j)
286               ENDIF
287             ENDDO
288            ENDDO
289    #ifdef ALLOW_DIAGNOSTICS
290            IF ( useDiagnostics ) THEN
291              CALL DIAGNOSTICS_FILL(hDiv,   'momHDiv ',k,1,2,bi,bj,myThid)
292              CALL DIAGNOSTICS_FILL(vort3,  'momVort3',k,1,2,bi,bj,myThid)
293              CALL DIAGNOSTICS_FILL(tension,'Tension ',k,1,2,bi,bj,myThid)
294              CALL DIAGNOSTICS_FILL(strain, 'Strain  ',k,1,2,bi,bj,myThid)
295            ENDIF
296    #endif
297          ENDIF
298    
299  C---  First call (k=1): compute vertical adv. flux fVerU(kUp) & fVerV(kUp)  C---  First call (k=1): compute vertical adv. flux fVerU(kUp) & fVerV(kUp)
300        IF (momAdvection.AND.k.EQ.1) THEN        IF (momAdvection.AND.k.EQ.1) THEN
301    
302  C-    Calculate vertical transports above U & V points (West & South face):  C-    Calculate vertical transports above U & V points (West & South face):
303         CALL MOM_CALC_RTRANS( k, bi, bj,  
304       O                       rTransU, rTransV,  #ifdef ALLOW_AUTODIFF_TAMC
305       I                       myTime, myIter, myThid)  # ifdef NONLIN_FRSURF
306    #  ifndef DISABLE_RSTAR_CODE
307    CADJ STORE dwtransc(:,:,bi,bj) =
308    CADJ &     comlev1_bibj_k, key = imomkey, byte = isbyte
309    CADJ STORE dwtransu(:,:,bi,bj) =
310    CADJ &     comlev1_bibj_k, key = imomkey, byte = isbyte
311    CADJ STORE dwtransv(:,:,bi,bj) =
312    CADJ &     comlev1_bibj_k, key = imomkey, byte = isbyte
313    #  endif
314    # endif /* NONLIN_FRSURF */
315    #endif /* ALLOW_AUTODIFF_TAMC */
316            CALL MOM_CALC_RTRANS( k, bi, bj,
317         O                        rTransU, rTransV,
318         I                        myTime, myIter, myThid)
319    
320  C-    Free surface correction term (flux at k=1)  C-    Free surface correction term (flux at k=1)
321         CALL MOM_U_ADV_WU(bi,bj,k,uVel,wVel,rTransU,af,myThid)          CALL MOM_U_ADV_WU( bi,bj,k,uVel,wVel,rTransU,
322         DO j=jMin,jMax       O                     fVerU(1-OLx,1-OLy,kUp), myThid )
         DO i=iMin,iMax  
          fVerU(i,j,kUp) = af(i,j)  
         ENDDO  
        ENDDO  
323    
324         CALL MOM_V_ADV_WV(bi,bj,k,vVel,wVel,rTransV,af,myThid)          CALL MOM_V_ADV_WV( bi,bj,k,vVel,wVel,rTransV,
325         DO j=jMin,jMax       O                     fVerV(1-OLx,1-OLy,kUp), myThid )
         DO i=iMin,iMax  
          fVerV(i,j,kUp) = af(i,j)  
         ENDDO  
        ENDDO  
326    
327  C---  endif momAdvection & k=1  C---  endif momAdvection & k=1
328        ENDIF        ENDIF
# Line 284  C---  endif momAdvection & k=1 Line 330  C---  endif momAdvection & k=1
330    
331  C---  Calculate vertical transports (at k+1) below U & V points :  C---  Calculate vertical transports (at k+1) below U & V points :
332        IF (momAdvection) THEN        IF (momAdvection) THEN
333         CALL MOM_CALC_RTRANS( k+1, bi, bj,          CALL MOM_CALC_RTRANS( k+1, bi, bj,
334       O                       rTransU, rTransV,       O                        rTransU, rTransV,
335       I                       myTime, myIter, myThid)       I                        myTime, myIter, myThid)
336        ENDIF        ENDIF
337    
338          IF (momViscosity) THEN
339           CALL MOM_CALC_VISC(
340         I        bi,bj,k,
341         O        viscAh_Z,viscAh_D,viscA4_Z,viscA4_D,
342         O        harmonic,biharmonic,useVariableViscosity,
343         I        hDiv,vort3,tension,strain,KE,hFacZ,
344         I        myThid)
345          ENDIF
346    
347  C---- Zonal momentum equation starts here  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
348    
349  C     Bi-harmonic term del^2 U -> v4F  C---- Zonal momentum equation starts here
       IF (momViscosity .AND. viscA4.NE.0. )  
      & CALL MOM_U_DEL2U(bi,bj,k,uFld,hFacZ,v4f,myThid)  
350    
351  C---  Calculate mean and eddy fluxes between cells for zonal flow.        IF (momAdvection) THEN
352    C---  Calculate mean fluxes (advection)   between cells for zonal flow.
353    
354  C--   Zonal flux (fZon is at east face of "u" cell)  C--   Zonal flux (fZon is at east face of "u" cell)
355    C     Mean flow component of zonal flux -> fZon
356  C     Mean flow component of zonal flux -> aF          CALL MOM_U_ADV_UU(bi,bj,k,uTrans,uFld,fZon,myThid)
       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  
357    
358  C--   Meridional flux (fMer is at south face of "u" cell)  C--   Meridional flux (fMer is at south face of "u" cell)
359    C     Mean flow component of meridional flux -> fMer
360  C     Mean flow component of meridional flux          CALL MOM_U_ADV_VU(bi,bj,k,vTrans,uFld,fMer,myThid)
       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+1  
        DO i=iMin,iMax  
         fMer(i,j) = vDudyFac*aF(i,j) + AhDudyFac*vF(i,j)  
        ENDDO  
       ENDDO  
361    
362  C--   Vertical flux (fVer is at upper face of "u" cell)  C--   Vertical flux (fVer is at upper face of "u" cell)
363    C     Mean flow component of vertical flux (at k+1) -> fVer
364  C     Mean flow component of vertical flux (at k+1) -> aF          CALL MOM_U_ADV_WU(
365        IF (momAdvection)       I                     bi,bj,k+1,uVel,wVel,rTransU,
366       & CALL MOM_U_ADV_WU(bi,bj,k+1,uVel,wVel,rTransU,af,myThid)       O                     fVerU(1-OLx,1-OLy,kDown), 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  
367    
368  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
369        DO j=jMin,jMax          DO j=jMin,jMax
370         DO i=iMin,iMax           DO i=iMin,iMax
371          gU(i,j,k,bi,bj) =            gU(i,j,k,bi,bj) =
372  #ifdef OLD_UV_GEOM  #ifdef OLD_UV_GEOM
373       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/       &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/
374       &    ( 0.5 _d 0*(rA(i,j,bi,bj)+rA(i-1,j,bi,bj)) )       &      ( 0.5 _d 0*(rA(i,j,bi,bj)+rA(i-1,j,bi,bj)) )
375  #else  #else
376       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)       &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
377       &   *recip_rAw(i,j,bi,bj)       &     *recip_rAw(i,j,bi,bj)
378    #endif
379         &    *( ( fZon(i,j  )     - fZon(i-1,j) )*uDudxFac
380         &      +( fMer(i,j+1)     - fMer(i,  j) )*vDudyFac
381         &      +(fVerU(i,j,kDown) - fVerU(i,j,kUp))*rkSign*rVelDudrFac
382         &     )
383             ENDDO
384            ENDDO
385    
386    #ifdef ALLOW_DIAGNOSTICS
387            IF ( useDiagnostics ) THEN
388              CALL DIAGNOSTICS_FILL(fZon,'ADVx_Um ',k,1,2,bi,bj,myThid)
389              CALL DIAGNOSTICS_FILL(fMer,'ADVy_Um ',k,1,2,bi,bj,myThid)
390              CALL DIAGNOSTICS_FILL(fVerU(1-Olx,1-Oly,kUp),
391         &                               'ADVrE_Um',k,1,2,bi,bj,myThid)
392            ENDIF
393  #endif  #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  
      &   )  
      &  - phxFac*dPhiHydX(i,j)  
        ENDDO  
       ENDDO  
394    
395  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
396  C-- account for 3.D divergence of the flow in rStar coordinate:  C-- account for 3.D divergence of the flow in rStar coordinate:
397        IF ( momAdvection .AND. select_rStar.GT.0 ) THEN  # ifndef DISABLE_RSTAR_CODE
398         DO j=jMin,jMax          IF ( select_rStar.GT.0 ) THEN
399          DO i=iMin,iMax           DO j=jMin,jMax
400           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)            DO i=iMin,iMax
401               gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)
402       &     - (rStarExpW(i,j,bi,bj) - 1. _d 0)/deltaTfreesurf       &     - (rStarExpW(i,j,bi,bj) - 1. _d 0)/deltaTfreesurf
403       &       *uVel(i,j,k,bi,bj)       &       *uVel(i,j,k,bi,bj)
404          ENDDO            ENDDO
405         ENDDO           ENDDO
406        ENDIF          ENDIF
407        IF ( momAdvection .AND. select_rStar.LT.0 ) THEN          IF ( select_rStar.LT.0 ) THEN
408         DO j=jMin,jMax           DO j=jMin,jMax
409          DO i=iMin,iMax            DO i=iMin,iMax
410           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)             gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)
411       &     - rStarDhWDt(i,j,bi,bj)*uVel(i,j,k,bi,bj)       &     - rStarDhWDt(i,j,bi,bj)*uVel(i,j,k,bi,bj)
412          ENDDO            ENDDO
413         ENDDO           ENDDO
414        ENDIF          ENDIF
415    # endif /* DISABLE_RSTAR_CODE */
416  #endif /* NONLIN_FRSURF */  #endif /* NONLIN_FRSURF */
417    
418  C-- No-slip and drag BCs appear as body forces in cell abutting topography        ELSE
419        IF (momViscosity.AND.no_slip_sides) THEN  C-    if momAdvection / else
420  C-     No-slip BCs impose a drag at walls...          DO j=1-OLy,sNy+OLy
421         CALL MOM_U_SIDEDRAG(bi,bj,k,uFld,v4F,hFacZ,vF,myThid)           DO i=1-OLx,sNx+OLx
422         DO j=jMin,jMax             gU(i,j,k,bi,bj) = 0. _d 0
423          DO i=iMin,iMax           ENDDO
          gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)  
424          ENDDO          ENDDO
425         ENDDO  
426    C-    endif momAdvection.
427        ENDIF        ENDIF
428  C-    No-slip BCs impose a drag at bottom  
429        IF (momViscosity.AND.bottomDragTerms) THEN        IF (momViscosity) THEN
430         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)  C---  Calculate eddy fluxes (dissipation) between cells for zonal flow.
431         DO j=jMin,jMax  
432          DO i=iMin,iMax  C     Bi-harmonic term del^2 U -> v4F
433           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)          IF (biharmonic)
434         &  CALL MOM_U_DEL2U(bi,bj,k,uFld,hFacZ,v4f,myThid)
435    
436    C     Laplacian and bi-harmonic terms, Zonal  Fluxes -> fZon
437            CALL MOM_U_XVISCFLUX(bi,bj,k,uFld,v4F,fZon,
438         I    viscAh_D,viscA4_D,myThid)
439    
440    C     Laplacian and bi-harmonic termis, Merid Fluxes -> fMer
441            CALL MOM_U_YVISCFLUX(bi,bj,k,uFld,v4F,hFacZ,fMer,
442         I    viscAh_Z,viscA4_Z,myThid)
443    
444    C     Eddy component of vertical flux (interior component only) -> fVrUp & fVrDw
445           IF (.NOT.implicitViscosity) THEN
446            CALL MOM_U_RVISCFLUX(bi,bj, k, uVel,KappaRU,fVrUp,myThid)
447            CALL MOM_U_RVISCFLUX(bi,bj,k+1,uVel,KappaRU,fVrDw,myThid)
448           ENDIF
449    
450    C--   Tendency is minus divergence of the fluxes
451            DO j=jMin,jMax
452             DO i=iMin,iMax
453              guDiss(i,j) =
454    #ifdef OLD_UV_GEOM
455         &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/
456         &      ( 0.5 _d 0*(rA(i,j,bi,bj)+rA(i-1,j,bi,bj)) )
457    #else
458         &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
459         &     *recip_rAw(i,j,bi,bj)
460    #endif
461         &    *( ( fZon(i,j  ) - fZon(i-1,j) )*AhDudxFac
462         &      +( fMer(i,j+1) - fMer(i,  j) )*AhDudyFac
463         &      +( fVrDw(i,j)  - fVrUp(i,j) )*rkSign*ArDudrFac
464         &     )
465             ENDDO
466          ENDDO          ENDDO
        ENDDO  
       ENDIF  
467    
468  C--   Forcing term  #ifdef ALLOW_DIAGNOSTICS
469        IF (momForcing)          IF ( useDiagnostics ) THEN
470       &  CALL EXTERNAL_FORCING_U(            CALL DIAGNOSTICS_FILL(fZon, 'VISCx_Um',k,1,2,bi,bj,myThid)
471       I     iMin,iMax,jMin,jMax,bi,bj,k,            CALL DIAGNOSTICS_FILL(fMer, 'VISCy_Um',k,1,2,bi,bj,myThid)
472       I     myTime,myThid)            IF (.NOT.implicitViscosity)
473         &    CALL DIAGNOSTICS_FILL(fVrUp,'VISrE_Um',k,1,2,bi,bj,myThid)
474            ENDIF
475    #endif
476    
477    C-- No-slip and drag BCs appear as body forces in cell abutting topography
478            IF (no_slip_sides) THEN
479    C-     No-slip BCs impose a drag at walls...
480             CALL MOM_U_SIDEDRAG(
481         I        bi,bj,k,
482         I        uFld, v4f, hFacZ,
483         I        viscAh_Z,viscA4_Z,
484         I        harmonic,biharmonic,useVariableViscosity,
485         O        vF,
486         I        myThid)
487             DO j=jMin,jMax
488              DO i=iMin,iMax
489               gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
490              ENDDO
491             ENDDO
492            ENDIF
493    C-    No-slip BCs impose a drag at bottom
494            IF (bottomDragTerms) THEN
495             CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
496             DO j=jMin,jMax
497              DO i=iMin,iMax
498               gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
499              ENDDO
500             ENDDO
501            ENDIF
502    
503    #ifdef ALLOW_SHELFICE
504            IF (useShelfIce) THEN
505             CALL SHELFICE_U_DRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
506             DO j=jMin,jMax
507              DO i=iMin,iMax
508               gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
509              ENDDO
510             ENDDO
511            ENDIF
512    #endif /* ALLOW_SHELFICE */
513    
514    C-    endif momViscosity
515          ENDIF
516    
517    C--   Forcing term (moved to timestep.F)
518    c     IF (momForcing)
519    c    &  CALL EXTERNAL_FORCING_U(
520    c    I     iMin,iMax,jMin,jMax,bi,bj,k,
521    c    I     myTime,myThid)
522    
523  C--   Metric terms for curvilinear grid systems  C--   Metric terms for curvilinear grid systems
524        IF (useNHMTerms) THEN        IF (useNHMTerms) THEN
525  C      o Non-hydrosatic metric terms  C      o Non-Hydrostatic (spherical) metric terms
526         CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,mT,myThid)         CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,mT,myThid)
527         DO j=jMin,jMax         DO j=jMin,jMax
528          DO i=iMin,iMax          DO i=iMin,iMax
529           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+mTFacU*mT(i,j)           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+mtNHFacU*mT(i,j)
530          ENDDO          ENDDO
531         ENDDO         ENDDO
532        ENDIF        ENDIF
533        IF (usingSphericalPolarMTerms) THEN        IF ( usingSphericalPolarGrid .AND. metricTerms ) THEN
534    C      o Spherical polar grid metric terms
535         CALL MOM_U_METRIC_SPHERE(bi,bj,k,uFld,vFld,mT,myThid)         CALL MOM_U_METRIC_SPHERE(bi,bj,k,uFld,vFld,mT,myThid)
536         DO j=jMin,jMax         DO j=jMin,jMax
537          DO i=iMin,iMax          DO i=iMin,iMax
538           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+mTFacU*mT(i,j)           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+mtFacU*mT(i,j)
539          ENDDO          ENDDO
540         ENDDO         ENDDO
541        ENDIF        ENDIF
542          IF ( usingCylindricalGrid .AND. metricTerms ) THEN
543  C--   Set du/dt on boundaries to zero  C      o Cylindrical grid metric terms
544        DO j=jMin,jMax         CALL MOM_U_METRIC_CYLINDER(bi,bj,k,uFld,vFld,mT,myThid)
545         DO i=iMin,iMax         DO j=jMin,jMax
546          gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)*_maskW(i,j,k,bi,bj)          DO i=iMin,iMax
547             gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+mtFacU*mT(i,j)
548            ENDDO
549         ENDDO         ENDDO
550        ENDDO        ENDIF
551    
552    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
553    
554  C---- Meridional momentum equation starts here  C---- Meridional momentum equation starts here
555    
556  C     Bi-harmonic term del^2 V -> v4F        IF (momAdvection) THEN
557        IF (momViscosity .AND. viscA4.NE.0. )  C---  Calculate mean fluxes (advection)   between cells for meridional flow.
558       & CALL MOM_V_DEL2V(bi,bj,k,vFld,hFacZ,v4f,myThid)  C     Mean flow component of zonal flux -> fZon
559            CALL MOM_V_ADV_UV(bi,bj,k,uTrans,vFld,fZon,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+1  
         fZon(i,j) = uDvdxFac*aF(i,j) + AhDvdxFac*vF(i,j)  
        ENDDO  
       ENDDO  
560    
561  C--   Meridional flux (fMer is at north face of "v" cell)  C--   Meridional flux (fMer is at north face of "v" cell)
562    C     Mean flow component of meridional flux -> fMer
563  C     Mean flow component of meridional flux          CALL MOM_V_ADV_VV(bi,bj,k,vTrans,vFld,fMer,myThid)
       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  
564    
565  C--   Vertical flux (fVer is at upper face of "v" cell)  C--   Vertical flux (fVer is at upper face of "v" cell)
566    C     Mean flow component of vertical flux (at k+1) -> fVerV
567  C     o Mean flow component of vertical flux          CALL MOM_V_ADV_WV(
568        IF (momAdvection)       I                     bi,bj,k+1,vVel,wVel,rTransV,
569       & CALL MOM_V_ADV_WV(bi,bj,k+1,vVel,wVel,rTransV,af,myThid)       O                     fVerV(1-OLx,1-OLy,kDown), 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  
570    
571  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
572        DO j=jMin,jMax          DO j=jMin,jMax
573         DO i=iMin,iMax           DO i=iMin,iMax
574          gV(i,j,k,bi,bj) =            gV(i,j,k,bi,bj) =
575  #ifdef OLD_UV_GEOM  #ifdef OLD_UV_GEOM
576       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/       &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/
577       &    ( 0.5 _d 0*(_rA(i,j,bi,bj)+_rA(i,j-1,bi,bj)) )       &      ( 0.5 _d 0*(_rA(i,j,bi,bj)+_rA(i,j-1,bi,bj)) )
578  #else  #else
579       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)       &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
580       &    *recip_rAs(i,j,bi,bj)       &      *recip_rAs(i,j,bi,bj)
581    #endif
582         &    *( ( fZon(i+1,j)     - fZon(i,j  ) )*uDvdxFac
583         &      +( fMer(i,  j)     - fMer(i,j-1) )*vDvdyFac
584         &      +(fVerV(i,j,kDown) - fVerV(i,j,kUp))*rkSign*rVelDvdrFac
585         &     )
586             ENDDO
587            ENDDO
588    
589    #ifdef ALLOW_DIAGNOSTICS
590            IF ( useDiagnostics ) THEN
591              CALL DIAGNOSTICS_FILL(fZon,'ADVx_Vm ',k,1,2,bi,bj,myThid)
592              CALL DIAGNOSTICS_FILL(fMer,'ADVy_Vm ',k,1,2,bi,bj,myThid)
593              CALL DIAGNOSTICS_FILL(fVerV(1-Olx,1-Oly,kUp),
594         &                               'ADVrE_Vm',k,1,2,bi,bj,myThid)
595            ENDIF
596  #endif  #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  
      &   )  
      &  - phyFac*dPhiHydY(i,j)  
        ENDDO  
       ENDDO  
597    
598  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
599  C-- account for 3.D divergence of the flow in rStar coordinate:  C-- account for 3.D divergence of the flow in rStar coordinate:
600        IF ( momAdvection .AND. select_rStar.GT.0 ) THEN  # ifndef DISABLE_RSTAR_CODE
601         DO j=jMin,jMax          IF ( select_rStar.GT.0 ) THEN
602          DO i=iMin,iMax           DO j=jMin,jMax
603           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)            DO i=iMin,iMax
604               gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)
605       &     - (rStarExpS(i,j,bi,bj) - 1. _d 0)/deltaTfreesurf       &     - (rStarExpS(i,j,bi,bj) - 1. _d 0)/deltaTfreesurf
606       &       *vVel(i,j,k,bi,bj)       &       *vVel(i,j,k,bi,bj)
607          ENDDO            ENDDO
608         ENDDO           ENDDO
609        ENDIF          ENDIF
610        IF ( momAdvection .AND. select_rStar.LT.0 ) THEN          IF ( select_rStar.LT.0 ) THEN
611         DO j=jMin,jMax           DO j=jMin,jMax
612          DO i=iMin,iMax            DO i=iMin,iMax
613           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)             gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)
614       &     - rStarDhSDt(i,j,bi,bj)*vVel(i,j,k,bi,bj)       &     - rStarDhSDt(i,j,bi,bj)*vVel(i,j,k,bi,bj)
615          ENDDO            ENDDO
616         ENDDO           ENDDO
617        ENDIF          ENDIF
618    # endif /* DISABLE_RSTAR_CODE */
619  #endif /* NONLIN_FRSURF */  #endif /* NONLIN_FRSURF */
620    
621  C-- No-slip and drag BCs appear as body forces in cell abutting topography        ELSE
622        IF (momViscosity.AND.no_slip_sides) THEN  C-    if momAdvection / else
623  C-     No-slip BCs impose a drag at walls...          DO j=1-OLy,sNy+OLy
624         CALL MOM_V_SIDEDRAG(bi,bj,k,vFld,v4F,hFacZ,vF,myThid)           DO i=1-OLx,sNx+OLx
625         DO j=jMin,jMax             gV(i,j,k,bi,bj) = 0. _d 0
626          DO i=iMin,iMax           ENDDO
          gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)  
627          ENDDO          ENDDO
628         ENDDO  
629    C-    endif momAdvection.
630        ENDIF        ENDIF
631  C-    No-slip BCs impose a drag at bottom  
632        IF (momViscosity.AND.bottomDragTerms) THEN        IF (momViscosity) THEN
633         CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)  C---  Calculate eddy fluxes (dissipation) between cells for meridional flow.
634         DO j=jMin,jMax  C     Bi-harmonic term del^2 V -> v4F
635          DO i=iMin,iMax          IF (biharmonic)
636           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)       &  CALL MOM_V_DEL2V(bi,bj,k,vFld,hFacZ,v4f,myThid)
637    
638    C     Laplacian and bi-harmonic terms, Zonal  Fluxes -> fZon
639            CALL MOM_V_XVISCFLUX(bi,bj,k,vFld,v4f,hFacZ,fZon,
640         I    viscAh_Z,viscA4_Z,myThid)
641    
642    C     Laplacian and bi-harmonic termis, Merid Fluxes -> fMer
643            CALL MOM_V_YVISCFLUX(bi,bj,k,vFld,v4f,fMer,
644         I    viscAh_D,viscA4_D,myThid)
645    
646    C     Eddy component of vertical flux (interior component only) -> fVrUp & fVrDw
647           IF (.NOT.implicitViscosity) THEN
648            CALL MOM_V_RVISCFLUX(bi,bj, k, vVel,KappaRV,fVrUp,myThid)
649            CALL MOM_V_RVISCFLUX(bi,bj,k+1,vVel,KappaRV,fVrDw,myThid)
650           ENDIF
651    
652    C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
653            DO j=jMin,jMax
654             DO i=iMin,iMax
655              gvDiss(i,j) =
656    #ifdef OLD_UV_GEOM
657         &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/
658         &      ( 0.5 _d 0*(_rA(i,j,bi,bj)+_rA(i,j-1,bi,bj)) )
659    #else
660         &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
661         &      *recip_rAs(i,j,bi,bj)
662    #endif
663         &    *( ( fZon(i+1,j)  - fZon(i,j  ) )*AhDvdxFac
664         &      +( fMer(i,  j)  - fMer(i,j-1) )*AhDvdyFac
665         &      +( fVrDw(i,j)   - fVrUp(i,j) )*rkSign*ArDvdrFac
666         &     )
667             ENDDO
668          ENDDO          ENDDO
        ENDDO  
       ENDIF  
669    
670  C--   Forcing term  #ifdef ALLOW_DIAGNOSTICS
671        IF (momForcing)          IF ( useDiagnostics ) THEN
672       & CALL EXTERNAL_FORCING_V(            CALL DIAGNOSTICS_FILL(fZon, 'VISCx_Vm',k,1,2,bi,bj,myThid)
673       I     iMin,iMax,jMin,jMax,bi,bj,k,            CALL DIAGNOSTICS_FILL(fMer, 'VISCy_Vm',k,1,2,bi,bj,myThid)
674       I     myTime,myThid)            IF (.NOT.implicitViscosity)
675         &    CALL DIAGNOSTICS_FILL(fVrUp,'VISrE_Vm',k,1,2,bi,bj,myThid)
676            ENDIF
677    #endif
678    
679    C-- No-slip and drag BCs appear as body forces in cell abutting topography
680            IF (no_slip_sides) THEN
681    C-     No-slip BCs impose a drag at walls...
682             CALL MOM_V_SIDEDRAG(
683         I        bi,bj,k,
684         I        vFld, v4f, hFacZ,
685         I        viscAh_Z,viscA4_Z,
686         I        harmonic,biharmonic,useVariableViscosity,
687         O        vF,
688         I        myThid)
689             DO j=jMin,jMax
690              DO i=iMin,iMax
691               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
692              ENDDO
693             ENDDO
694            ENDIF
695    C-    No-slip BCs impose a drag at bottom
696            IF (bottomDragTerms) THEN
697             CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)
698             DO j=jMin,jMax
699              DO i=iMin,iMax
700               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
701              ENDDO
702             ENDDO
703            ENDIF
704    
705    #ifdef ALLOW_SHELFICE
706            IF (useShelfIce) THEN
707             CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRU,vF,myThid)
708             DO j=jMin,jMax
709              DO i=iMin,iMax
710               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
711              ENDDO
712             ENDDO
713            ENDIF
714    #endif /* ALLOW_SHELFICE */
715    
716    C-    endif momViscosity
717          ENDIF
718    
719    C--   Forcing term (moved to timestep.F)
720    c     IF (momForcing)
721    c    & CALL EXTERNAL_FORCING_V(
722    c    I     iMin,iMax,jMin,jMax,bi,bj,k,
723    c    I     myTime,myThid)
724    
725  C--   Metric terms for curvilinear grid systems  C--   Metric terms for curvilinear grid systems
726        IF (useNHMTerms) THEN        IF (useNHMTerms) THEN
727  C      o Spherical polar grid metric terms  C      o Non-Hydrostatic (spherical) metric terms
728         CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,mT,myThid)         CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,mT,myThid)
729         DO j=jMin,jMax         DO j=jMin,jMax
730          DO i=iMin,iMax          DO i=iMin,iMax
731           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+mTFacV*mT(i,j)           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+mtNHFacV*mT(i,j)
732          ENDDO          ENDDO
733         ENDDO         ENDDO
734        ENDIF        ENDIF
735        IF (usingSphericalPolarMTerms) THEN        IF ( usingSphericalPolarGrid .AND. metricTerms ) THEN
736    C      o Spherical polar grid metric terms
737         CALL MOM_V_METRIC_SPHERE(bi,bj,k,uFld,mT,myThid)         CALL MOM_V_METRIC_SPHERE(bi,bj,k,uFld,mT,myThid)
738         DO j=jMin,jMax         DO j=jMin,jMax
739          DO i=iMin,iMax          DO i=iMin,iMax
740           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+mTFacV*mT(i,j)           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+mtFacV*mT(i,j)
741          ENDDO          ENDDO
742         ENDDO         ENDDO
743        ENDIF        ENDIF
744          IF ( usingCylindricalGrid .AND. metricTerms ) THEN
745  C--   Set dv/dt on boundaries to zero  C      o Cylindrical grid metric terms
746        DO j=jMin,jMax         CALL MOM_V_METRIC_CYLINDER(bi,bj,k,uFld,vFld,mT,myThid)
747         DO i=iMin,iMax         DO j=jMin,jMax
748          gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)          DO i=iMin,iMax
749             gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+mtFacV*mT(i,j)
750            ENDDO
751         ENDDO         ENDDO
752        ENDDO        ENDIF
753    
754    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
755    
756  C--   Coriolis term  C--   Coriolis term
757  C     Note. As coded here, coriolis will not work with "thin walls"  C     Note. As coded here, coriolis will not work with "thin walls"
758  #ifdef INCLUDE_CD_CODE  c     IF (useCDscheme) THEN
759        CALL MOM_CDSCHEME(bi,bj,k,dPhiHydX,dPhiHydY,myThid)  c       CALL MOM_CDSCHEME(bi,bj,k,dPhiHydX,dPhiHydY,myThid)
760  #else  c     ELSE
761        CALL MOM_U_CORIOLIS(bi,bj,k,vFld,cf,myThid)        IF (.NOT.useCDscheme) THEN
762        DO j=jMin,jMax          CALL MOM_U_CORIOLIS(bi,bj,k,vFld,cf,myThid)
763         DO i=iMin,iMax          DO j=jMin,jMax
764          gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)           DO i=iMin,iMax
765         ENDDO            gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)
766        ENDDO           ENDDO
767        CALL MOM_V_CORIOLIS(bi,bj,k,uFld,cf,myThid)          ENDDO
768    #ifdef ALLOW_DIAGNOSTICS
769            IF ( useDiagnostics )
770         &    CALL DIAGNOSTICS_FILL(cf,'Um_Cori ',k,1,2,bi,bj,myThid)
771    #endif
772            CALL MOM_V_CORIOLIS(bi,bj,k,uFld,cf,myThid)
773            DO j=jMin,jMax
774             DO i=iMin,iMax
775              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+fvFac*cf(i,j)
776             ENDDO
777            ENDDO
778    #ifdef ALLOW_DIAGNOSTICS
779            IF ( useDiagnostics )
780         &    CALL DIAGNOSTICS_FILL(cf,'Vm_Cori ',k,1,2,bi,bj,myThid)
781    #endif
782          ENDIF
783    
784    C--   3.D Coriolis term (horizontal momentum, Eastward component: -f'*w)
785          IF ( use3dCoriolis ) THEN
786            CALL MOM_U_CORIOLIS_NH(bi,bj,k,wVel,cf,myThid)
787            DO j=jMin,jMax
788             DO i=iMin,iMax
789              gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)
790             ENDDO
791            ENDDO
792           IF ( usingCurvilinearGrid ) THEN
793    C-     presently, non zero angleSinC array only supported with Curvilinear-Grid
794            CALL MOM_V_CORIOLIS_NH(bi,bj,k,wVel,cf,myThid)
795            DO j=jMin,jMax
796             DO i=iMin,iMax
797              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+fvFac*cf(i,j)
798             ENDDO
799            ENDDO
800           ENDIF
801          ENDIF
802    
803    C--   Set du/dt & dv/dt on boundaries to zero
804        DO j=jMin,jMax        DO j=jMin,jMax
805         DO i=iMin,iMax         DO i=iMin,iMax
806          gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+fvFac*cf(i,j)          gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)*_maskW(i,j,k,bi,bj)
807            guDiss(i,j)     = guDiss(i,j)    *_maskW(i,j,k,bi,bj)
808            gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)
809            gvDiss(i,j)     = gvDiss(i,j)    *_maskS(i,j,k,bi,bj)
810         ENDDO         ENDDO
811        ENDDO        ENDDO
812  #endif /* INCLUDE_CD_CODE */  
813        IF (nonHydrostatic.OR.quasiHydrostatic) THEN  #ifdef ALLOW_DIAGNOSTICS
814         CALL MOM_U_CORIOLIS_NH(bi,bj,k,wVel,cf,myThid)        IF ( useDiagnostics ) THEN
815         DO j=jMin,jMax          CALL DIAGNOSTICS_FILL(KE,    'momKE   ',k,1,2,bi,bj,myThid)
816          DO i=iMin,iMax          CALL DIAGNOSTICS_FILL(gU(1-Olx,1-Oly,k,bi,bj),
817           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)       &                               'Um_Advec',k,1,2,bi,bj,myThid)
818          ENDDO          CALL DIAGNOSTICS_FILL(gV(1-Olx,1-Oly,k,bi,bj),
819         ENDDO       &                               'Vm_Advec',k,1,2,bi,bj,myThid)
820           IF (momViscosity) THEN
821            CALL DIAGNOSTICS_FILL(guDiss,'Um_Diss ',k,1,2,bi,bj,myThid)
822            CALL DIAGNOSTICS_FILL(gvDiss,'Vm_Diss ',k,1,2,bi,bj,myThid)
823           ENDIF
824        ENDIF        ENDIF
825    #endif /* ALLOW_DIAGNOSTICS */
826    
827        RETURN        RETURN
828        END        END
Legend:
Removed from v.1.11  
changed lines
  Added in v.1.38
  ViewVC Help
Powered by ViewVC 1.1.22