/[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.6 by adcroft, Tue Nov 5 19:58:21 2002 UTC revision 1.35 by heimbach, Wed May 3 23:35:11 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
# Line 33  C !ROUTINE: MOM_FLUXFORM Line 33  C !ROUTINE: MOM_FLUXFORM
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        phi_hyd,KappaRU,KappaRV,       I        KappaRU, KappaRV,
37       U        fVerU, fVerV,       U        fVerU, fVerV,
38       I        myCurrentTime,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  phi_hyd              :: hydrostatic pressure (perturbation)  
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  myCurrentTime        :: current time  C  guDiss               :: dissipation tendency (all explicit terms), u component
72    C  gvDiss               :: dissipation tendency (all explicit terms), v component
73    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 phi_hyd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
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     myCurrentTime        _RL guDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
83          _RL gvDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
84          _RL     myTime
85        INTEGER myIter        INTEGER myIter
86        INTEGER myThid        INTEGER myThid
87    
# Line 82  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     vfFacMom        
114  C     pfFacMom        afFacMom - Advective terms  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 119  C     uDudxFac, AhDudxFac, etc ... indiv Line 126  C     uDudxFac, AhDudxFac, etc ... indiv
126        _RL  vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL  vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
127        _RL  uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL  uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
128        _RL  vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL  vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
129  C     I,J,K - Loop counters        _RL  rTransU(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
130  C     rVelMaskOverride - Factor for imposing special surface boundary conditions        _RL  rTransV(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
131  C                        ( set according to free-surface condition ).        _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
132  C     hFacROpen        - Lopped cell factos used tohold fraction of open        _RL viscAh_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
133  C     hFacRClosed        and closed cell wall.        _RL viscAh_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
134        _RL  rVelMaskOverride        _RL viscA4_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
135  C     xxxFac - On-off tracer parameters used for switching terms off.        _RL viscA4_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
136          _RL vort3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
137          _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            fVrUp(i,j)= 0.
189            fVrDw(i,j)= 0.
190            rTransU(i,j)= 0.
191            rTransV(i,j)= 0.
192            strain(i,j) = 0.
193            tension(i,j)= 0.
194            guDiss(i,j) = 0.
195            gvDiss(i,j) = 0.
196    #ifdef ALLOW_AUTODIFF_TAMC
197            vort3(i,j)   = 0. _d 0
198            strain(i,j)  = 0. _d 0
199            tension(i,j) = 0. _d 0
200    #endif
201         ENDDO         ENDDO
202        ENDDO        ENDDO
203    
# Line 181  C--   Term by term tracer parmeters Line 205  C--   Term by term tracer parmeters
205  C     o U momentum equation  C     o U momentum equation
206        uDudxFac     = afFacMom*1.        uDudxFac     = afFacMom*1.
207        AhDudxFac    = vfFacMom*1.        AhDudxFac    = vfFacMom*1.
       A4DuxxdxFac  = vfFacMom*1.  
208        vDudyFac     = afFacMom*1.        vDudyFac     = afFacMom*1.
209        AhDudyFac    = vfFacMom*1.        AhDudyFac    = vfFacMom*1.
       A4DuyydyFac  = vfFacMom*1.  
210        rVelDudrFac  = afFacMom*1.        rVelDudrFac  = afFacMom*1.
211        ArDudrFac    = vfFacMom*1.        ArDudrFac    = vfFacMom*1.
212        mTFacU       = mtFacMom*1.        mtFacU       = mtFacMom*1.
213          mtNHFacU     = 1.
214        fuFac        = cfFacMom*1.        fuFac        = cfFacMom*1.
       phxFac       = pfFacMom*1.  
215  C     o V momentum equation  C     o V momentum equation
216        uDvdxFac     = afFacMom*1.        uDvdxFac     = afFacMom*1.
217        AhDvdxFac    = vfFacMom*1.        AhDvdxFac    = vfFacMom*1.
       A4DvxxdxFac  = vfFacMom*1.  
218        vDvdyFac     = afFacMom*1.        vDvdyFac     = afFacMom*1.
219        AhDvdyFac    = vfFacMom*1.        AhDvdyFac    = vfFacMom*1.
       A4DvyydyFac  = vfFacMom*1.  
220        rVelDvdrFac  = afFacMom*1.        rVelDvdrFac  = afFacMom*1.
221        ArDvdrFac    = vfFacMom*1.        ArDvdrFac    = vfFacMom*1.
222        mTFacV       = mtFacMom*1.        mtFacV       = mtFacMom*1.
223          mtNHFacV     = 1.
224        fvFac        = cfFacMom*1.        fvFac        = cfFacMom*1.
225        phyFac       = pfFacMom*1.  
226        vForcFac     = foFacMom*1.        IF (implicitViscosity) THEN
227            ArDudrFac  = 0.
228            ArDvdrFac  = 0.
229          ENDIF
230    
231    C note: using standard stencil (no mask) results in under-estimating
232    C       vorticity at a no-slip boundary by a factor of 2 = sideDragFactor
233          IF ( no_slip_sides ) THEN
234            sideMaskFac = sideDragFactor
235          ELSE
236            sideMaskFac = 0. _d 0
237          ENDIF
238    
239        IF (     no_slip_bottom        IF (     no_slip_bottom
240       &    .OR. bottomDragQuadratic.NE.0.       &    .OR. bottomDragQuadratic.NE.0.
# Line 212  C     o V momentum equation Line 244  C     o V momentum equation
244         bottomDragTerms=.FALSE.         bottomDragTerms=.FALSE.
245        ENDIF        ENDIF
246    
 C-- with stagger time stepping, grad Phi_Hyp is directly incoporated in TIMESTEP  
       IF (staggerTimeStep) THEN  
         phxFac = 0.  
         phyFac = 0.  
       ENDIF  
   
247  C--   Calculate open water fraction at vorticity points  C--   Calculate open water fraction at vorticity points
248        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)
249    
# Line 248  C     Calculate velocity field "volume t Line 274  C     Calculate velocity field "volume t
274         ENDDO         ENDDO
275        ENDDO        ENDDO
276    
277        CALL MOM_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid)        CALL MOM_CALC_KE(bi,bj,k,2,uFld,vFld,KE,myThid)
278          IF ( momViscosity) THEN
279            CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid)
280            CALL MOM_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)
281            CALL MOM_CALC_TENSION(bi,bj,k,uFld,vFld,tension,myThid)
282            CALL MOM_CALC_STRAIN(bi,bj,k,uFld,vFld,hFacZ,strain,myThid)
283            DO j=1-Oly,sNy+Oly
284             DO i=1-Olx,sNx+Olx
285               IF ( hFacZ(i,j).EQ.0. ) THEN
286                 vort3(i,j)  = sideMaskFac*vort3(i,j)
287                 strain(i,j) = sideMaskFac*strain(i,j)
288               ENDIF
289             ENDDO
290            ENDDO
291    #ifdef ALLOW_DIAGNOSTICS
292            IF ( useDiagnostics ) THEN
293              CALL DIAGNOSTICS_FILL(hDiv,   'momHDiv ',k,1,2,bi,bj,myThid)
294              CALL DIAGNOSTICS_FILL(vort3,  'momVort3',k,1,2,bi,bj,myThid)
295              CALL DIAGNOSTICS_FILL(tension,'Tension ',k,1,2,bi,bj,myThid)
296              CALL DIAGNOSTICS_FILL(strain, 'Strain  ',k,1,2,bi,bj,myThid)
297            ENDIF
298    #endif
299          ENDIF
300    
301  C---- Zonal momentum equation starts here  C---  First call (k=1): compute vertical adv. flux fVerU(kUp) & fVerV(kUp)
302          IF (momAdvection.AND.k.EQ.1) THEN
303    
304  C     Bi-harmonic term del^2 U -> v4F  C-    Calculate vertical transports above U & V points (West & South face):
       IF (momViscosity)  
      & CALL MOM_U_DEL2U(bi,bj,k,uFld,hFacZ,v4f,myThid)  
305    
306  C---  Calculate mean and eddy fluxes between cells for zonal flow.  #ifdef ALLOW_AUTODIFF_TAMC
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 /* ALLOW_AUTODIFF_TAMC */
314            CALL MOM_CALC_RTRANS( k, bi, bj,
315         O                        rTransU, rTransV,
316         I                        myTime, myIter, myThid)
317    
318  C--   Zonal flux (fZon is at east face of "u" cell)  C-    Free surface correction term (flux at k=1)
319            CALL MOM_U_ADV_WU( bi,bj,k,uVel,wVel,rTransU,
320         O                     fVerU(1-OLx,1-OLy,kUp), myThid )
321    
322  C     Mean flow component of zonal flux -> aF          CALL MOM_V_ADV_WV( bi,bj,k,vVel,wVel,rTransV,
323        IF (momAdvection)       O                     fVerV(1-OLx,1-OLy,kUp), myThid )
      & 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)  
324    
325  C     Combine fluxes -> fZon  C---  endif momAdvection & k=1
326        DO j=jMin,jMax        ENDIF
        DO i=iMin,iMax  
         fZon(i,j) = uDudxFac*aF(i,j) + AhDudxFac*vF(i,j)  
        ENDDO  
       ENDDO  
327    
 C--   Meridional flux (fMer is at south face of "u" cell)  
328    
329  C     Mean flow component of meridional flux  C---  Calculate vertical transports (at k+1) below U & V points :
330        IF (momAdvection)        IF (momAdvection) THEN
331       & CALL MOM_U_ADV_VU(bi,bj,k,vTrans,uFld,aF,myThid)          CALL MOM_CALC_RTRANS( k+1, bi, bj,
332         O                        rTransU, rTransV,
333  C     Laplacian and bi-harmonic term       I                        myTime, myIter, myThid)
334        IF (momViscosity)        ENDIF
      & CALL MOM_U_YVISCFLUX(bi,bj,k,uFld,v4F,hFacZ,vF,myThid)  
335    
336  C     Combine fluxes -> fMer        IF (momViscosity) THEN
337        DO j=jMin,jMax         CALL MOM_CALC_VISC(
338         DO i=iMin,iMax       I        bi,bj,k,
339          fMer(i,j) = vDudyFac*aF(i,j) + AhDudyFac*vF(i,j)       O        viscAh_Z,viscAh_D,viscA4_Z,viscA4_D,
340         ENDDO       O        harmonic,biharmonic,useVariableViscosity,
341        ENDDO       I        hDiv,vort3,tension,strain,KE,hFacZ,
342         I        myThid)
343          ENDIF
344    
345    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
346    
347    C---- Zonal momentum equation starts here
348    
349          IF (momAdvection) THEN
350    C---  Calculate mean fluxes (advection)   between cells for zonal flow.
351    
352    C--   Zonal flux (fZon is at east face of "u" cell)
353    C     Mean flow component of zonal flux -> fZon
354            CALL MOM_U_ADV_UU(bi,bj,k,uTrans,uFld,fZon,myThid)
355    
356    C--   Meridional flux (fMer is at south face of "u" cell)
357    C     Mean flow component of meridional flux -> fMer
358            CALL MOM_U_ADV_VU(bi,bj,k,vTrans,uFld,fMer,myThid)
359    
360  C--   Vertical flux (fVer is at upper face of "u" cell)  C--   Vertical flux (fVer is at upper face of "u" cell)
361    C     Mean flow component of vertical flux (at k+1) -> fVer
362            CALL MOM_U_ADV_WU(
363         I                     bi,bj,k+1,uVel,wVel,rTransU,
364         O                     fVerU(1-OLx,1-OLy,kDown), myThid )
365    
366  C--   Free surface correction term (flux at k=1)  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
367        IF (momAdvection.AND.k.EQ.1) THEN          DO j=jMin,jMax
368         CALL MOM_U_ADV_WU(bi,bj,k,uVel,wVel,af,myThid)           DO i=iMin,iMax
369         DO j=jMin,jMax            gU(i,j,k,bi,bj) =
370          DO i=iMin,iMax  #ifdef OLD_UV_GEOM
371           fVerU(i,j,kUp) = af(i,j)       &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/
372         &      ( 0.5 _d 0*(rA(i,j,bi,bj)+rA(i-1,j,bi,bj)) )
373    #else
374         &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
375         &     *recip_rAw(i,j,bi,bj)
376    #endif
377         &    *( ( fZon(i,j  )     - fZon(i-1,j) )*uDudxFac
378         &      +( fMer(i,j+1)     - fMer(i,  j) )*vDudyFac
379         &      +(fVerU(i,j,kDown) - fVerU(i,j,kUp))*rkSign*rVelDudrFac
380         &     )
381             ENDDO
382          ENDDO          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)  
383    
384  C     Eddy component of vertical flux (interior component only) -> vrF  #ifdef ALLOW_DIAGNOSTICS
385        IF (momViscosity.AND..NOT.implicitViscosity)          IF ( useDiagnostics ) THEN
386       & CALL MOM_U_RVISCFLUX(bi,bj,k,uVel,KappaRU,vrF,myThid)            CALL DIAGNOSTICS_FILL(fZon,'ADVx_Um ',k,1,2,bi,bj,myThid)
387              CALL DIAGNOSTICS_FILL(fMer,'ADVy_Um ',k,1,2,bi,bj,myThid)
388              CALL DIAGNOSTICS_FILL(fVerU(1-Olx,1-Oly,kUp),
389         &                               'ADVrE_Um',k,1,2,bi,bj,myThid)
390            ENDIF
391    #endif
392    
393  C     Combine fluxes  #ifdef NONLIN_FRSURF
394        DO j=jMin,jMax  C-- account for 3.D divergence of the flow in rStar coordinate:
395         DO i=iMin,iMax  # ifndef DISABLE_RSTAR_CODE
396          fVerU(i,j,kDown) = rVelDudrFac*aF(i,j) + ArDudrFac*vrF(i,j)          IF ( select_rStar.GT.0 ) THEN
397         ENDDO           DO j=jMin,jMax
398        ENDDO            DO i=iMin,iMax
399               gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)
400         &     - (rStarExpW(i,j,bi,bj) - 1. _d 0)/deltaTfreesurf
401         &       *uVel(i,j,k,bi,bj)
402              ENDDO
403             ENDDO
404            ENDIF
405            IF ( select_rStar.LT.0 ) THEN
406             DO j=jMin,jMax
407              DO i=iMin,iMax
408               gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)
409         &     - rStarDhWDt(i,j,bi,bj)*uVel(i,j,k,bi,bj)
410              ENDDO
411             ENDDO
412            ENDIF
413    # endif /* DISABLE_RSTAR_CODE */
414    #endif /* NONLIN_FRSURF */
415    
416  C---  Hydrostatic term ( -1/rhoConst . dphi/dx )        ELSE
417        IF (momPressureForcing) THEN  C-    if momAdvection / else
418         DO j=jMin,jMax          DO j=1-OLy,sNy+OLy
419          DO i=iMin,iMax           DO i=1-OLx,sNx+OLx
420           pf(i,j) = - _recip_dxC(i,j,bi,bj)             gU(i,j,k,bi,bj) = 0. _d 0
421       &    *(phi_hyd(i,j,k)-phi_hyd(i-1,j,k))           ENDDO
422          ENDDO          ENDDO
423         ENDDO  
424    C-    endif momAdvection.
425        ENDIF        ENDIF
426    
427  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term        IF (momViscosity) THEN
428        DO j=jMin,jMax  C---  Calculate eddy fluxes (dissipation) between cells for zonal flow.
429         DO i=iMin,iMax  
430          gU(i,j,k,bi,bj) =  C     Bi-harmonic term del^2 U -> v4F
431            IF (biharmonic)
432         &  CALL MOM_U_DEL2U(bi,bj,k,uFld,hFacZ,v4f,myThid)
433    
434    C     Laplacian and bi-harmonic terms, Zonal  Fluxes -> fZon
435            CALL MOM_U_XVISCFLUX(bi,bj,k,uFld,v4F,fZon,
436         I    viscAh_D,viscA4_D,myThid)
437    
438    C     Laplacian and bi-harmonic termis, Merid Fluxes -> fMer
439            CALL MOM_U_YVISCFLUX(bi,bj,k,uFld,v4F,hFacZ,fMer,
440         I    viscAh_Z,viscA4_Z,myThid)
441    
442    C     Eddy component of vertical flux (interior component only) -> fVrUp & fVrDw
443           IF (.NOT.implicitViscosity) THEN
444            CALL MOM_U_RVISCFLUX(bi,bj, k, uVel,KappaRU,fVrUp,myThid)
445            CALL MOM_U_RVISCFLUX(bi,bj,k+1,uVel,KappaRU,fVrDw,myThid)
446           ENDIF
447    
448    C--   Tendency is minus divergence of the fluxes
449            DO j=jMin,jMax
450             DO i=iMin,iMax
451              guDiss(i,j) =
452  #ifdef OLD_UV_GEOM  #ifdef OLD_UV_GEOM
453       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/       &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/
454       &    ( 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)) )
455  #else  #else
456       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)       &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
457       &   *recip_rAw(i,j,bi,bj)       &     *recip_rAw(i,j,bi,bj)
458    #endif
459         &    *( ( fZon(i,j  ) - fZon(i-1,j) )*AhDudxFac
460         &      +( fMer(i,j+1) - fMer(i,  j) )*AhDudyFac
461         &      +( fVrDw(i,j)  - fVrUp(i,j) )*rkSign*ArDudrFac
462         &     )
463             ENDDO
464            ENDDO
465    
466    #ifdef ALLOW_DIAGNOSTICS
467            IF ( useDiagnostics ) THEN
468              CALL DIAGNOSTICS_FILL(fZon, 'VISCx_Um',k,1,2,bi,bj,myThid)
469              CALL DIAGNOSTICS_FILL(fMer, 'VISCy_Um',k,1,2,bi,bj,myThid)
470              IF (.NOT.implicitViscosity)
471         &    CALL DIAGNOSTICS_FILL(fVrUp,'VISrE_Um',k,1,2,bi,bj,myThid)
472            ENDIF
473  #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  
      &   )  
      & _PHM( +phxFac * pf(i,j) )  
        ENDDO  
       ENDDO  
474    
475  C-- No-slip and drag BCs appear as body forces in cell abutting topography  C-- No-slip and drag BCs appear as body forces in cell abutting topography
476        IF (momViscosity.AND.no_slip_sides) THEN          IF (no_slip_sides) THEN
477  C-     No-slip BCs impose a drag at walls...  C-     No-slip BCs impose a drag at walls...
478         CALL MOM_U_SIDEDRAG(bi,bj,k,uFld,v4F,hFacZ,vF,myThid)           CALL MOM_U_SIDEDRAG(
479         DO j=jMin,jMax       I        bi,bj,k,
480          DO i=iMin,iMax       I        uFld, v4f, hFacZ,
481           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)       I        viscAh_Z,viscA4_Z,
482          ENDDO       I        harmonic,biharmonic,useVariableViscosity,
483         ENDDO       O        vF,
484        ENDIF       I        myThid)
485             DO j=jMin,jMax
486              DO i=iMin,iMax
487               gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
488              ENDDO
489             ENDDO
490            ENDIF
491  C-    No-slip BCs impose a drag at bottom  C-    No-slip BCs impose a drag at bottom
492        IF (momViscosity.AND.bottomDragTerms) THEN          IF (bottomDragTerms) THEN
493         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)           CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
494         DO j=jMin,jMax           DO j=jMin,jMax
495          DO i=iMin,iMax            DO i=iMin,iMax
496           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)             gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
497          ENDDO            ENDDO
498         ENDDO           ENDDO
499        ENDIF          ENDIF
500    
501  C--   Forcing term  #ifdef ALLOW_SHELFICE
502        IF (momForcing)          IF (useShelfIce) THEN
503       &  CALL EXTERNAL_FORCING_U(           CALL SHELFICE_U_DRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
504       I     iMin,iMax,jMin,jMax,bi,bj,k,           DO j=jMin,jMax
505       I     myCurrentTime,myThid)            DO i=iMin,iMax
506               gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
507              ENDDO
508             ENDDO
509            ENDIF
510    #endif /* ALLOW_SHELFICE */
511    
512    C-    endif momViscosity
513          ENDIF
514    
515    C--   Forcing term (moved to timestep.F)
516    c     IF (momForcing)
517    c    &  CALL EXTERNAL_FORCING_U(
518    c    I     iMin,iMax,jMin,jMax,bi,bj,k,
519    c    I     myTime,myThid)
520    
521  C--   Metric terms for curvilinear grid systems  C--   Metric terms for curvilinear grid systems
522        IF (useNHMTerms) THEN        IF (useNHMTerms) THEN
523  C      o Non-hydrosatic metric terms  C      o Non-Hydrostatic (spherical) metric terms
524         CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,mT,myThid)         CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,mT,myThid)
525         DO j=jMin,jMax         DO j=jMin,jMax
526          DO i=iMin,iMax          DO i=iMin,iMax
527           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)
528          ENDDO          ENDDO
529         ENDDO         ENDDO
530        ENDIF        ENDIF
531        IF (usingSphericalPolarMTerms) THEN        IF ( usingSphericalPolarGrid .AND. metricTerms ) THEN
532    C      o Spherical polar grid metric terms
533         CALL MOM_U_METRIC_SPHERE(bi,bj,k,uFld,vFld,mT,myThid)         CALL MOM_U_METRIC_SPHERE(bi,bj,k,uFld,vFld,mT,myThid)
534         DO j=jMin,jMax         DO j=jMin,jMax
535          DO i=iMin,iMax          DO i=iMin,iMax
536           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)
537          ENDDO          ENDDO
538         ENDDO         ENDDO
539        ENDIF        ENDIF
540          IF ( usingCylindricalGrid .AND. metricTerms ) THEN
541  C--   Set du/dt on boundaries to zero  C      o Cylindrical grid metric terms
542        DO j=jMin,jMax         CALL MOM_U_METRIC_CYLINDER(bi,bj,k,uFld,vFld,mT,myThid)
543         DO i=iMin,iMax         DO j=jMin,jMax
544          gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)*_maskW(i,j,k,bi,bj)          DO i=iMin,iMax
545             gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+mtFacU*mT(i,j)
546            ENDDO
547         ENDDO         ENDDO
548        ENDDO        ENDIF
549    
550    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
551    
552  C---- Meridional momentum equation starts here  C---- Meridional momentum equation starts here
553    
554  C     Bi-harmonic term del^2 V -> v4F        IF (momAdvection) THEN
555        IF (momViscosity)  C---  Calculate mean fluxes (advection)   between cells for meridional flow.
556       & CALL MOM_V_DEL2V(bi,bj,k,vFld,hFacZ,v4f,myThid)  C     Mean flow component of zonal flux -> fZon
557            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  
         fZon(i,j) = uDvdxFac*aF(i,j) + AhDvdxFac*vF(i,j)  
        ENDDO  
       ENDDO  
558    
559  C--   Meridional flux (fMer is at north face of "v" cell)  C--   Meridional flux (fMer is at north face of "v" cell)
560    C     Mean flow component of meridional flux -> fMer
561  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  
562    
563  C--   Vertical flux (fVer is at upper face of "v" cell)  C--   Vertical flux (fVer is at upper face of "v" cell)
564    C     Mean flow component of vertical flux (at k+1) -> fVerV
565            CALL MOM_V_ADV_WV(
566         I                     bi,bj,k+1,vVel,wVel,rTransV,
567         O                     fVerV(1-OLx,1-OLy,kDown), myThid )
568    
569  C--   Free surface correction term (flux at k=1)  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
570        IF (momAdvection.AND.k.EQ.1) THEN          DO j=jMin,jMax
571         CALL MOM_V_ADV_WV(bi,bj,k,vVel,wVel,af,myThid)           DO i=iMin,iMax
572         DO j=jMin,jMax            gV(i,j,k,bi,bj) =
573          DO i=iMin,iMax  #ifdef OLD_UV_GEOM
574           fVerV(i,j,kUp) = af(i,j)       &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/
575         &      ( 0.5 _d 0*(_rA(i,j,bi,bj)+_rA(i,j-1,bi,bj)) )
576    #else
577         &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
578         &      *recip_rAs(i,j,bi,bj)
579    #endif
580         &    *( ( fZon(i+1,j)     - fZon(i,j  ) )*uDvdxFac
581         &      +( fMer(i,  j)     - fMer(i,j-1) )*vDvdyFac
582         &      +(fVerV(i,j,kDown) - fVerV(i,j,kUp))*rkSign*rVelDvdrFac
583         &     )
584             ENDDO
585          ENDDO          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)  
586    
587  C     Eddy component of vertical flux (interior component only) -> vrF  #ifdef ALLOW_DIAGNOSTICS
588        IF (momViscosity.AND..NOT.implicitViscosity)          IF ( useDiagnostics ) THEN
589       & CALL MOM_V_RVISCFLUX(bi,bj,k,vVel,KappaRV,vrf,myThid)            CALL DIAGNOSTICS_FILL(fZon,'ADVx_Vm ',k,1,2,bi,bj,myThid)
590              CALL DIAGNOSTICS_FILL(fMer,'ADVy_Vm ',k,1,2,bi,bj,myThid)
591              CALL DIAGNOSTICS_FILL(fVerV(1-Olx,1-Oly,kUp),
592         &                               'ADVrE_Vm',k,1,2,bi,bj,myThid)
593            ENDIF
594    #endif
595    
596  C     Combine fluxes -> fVerV  #ifdef NONLIN_FRSURF
597        DO j=jMin,jMax  C-- account for 3.D divergence of the flow in rStar coordinate:
598         DO i=iMin,iMax  # ifndef DISABLE_RSTAR_CODE
599          fVerV(i,j,kDown) = rVelDvdrFac*aF(i,j) + ArDvdrFac*vrF(i,j)          IF ( select_rStar.GT.0 ) THEN
600         ENDDO           DO j=jMin,jMax
601        ENDDO            DO i=iMin,iMax
602               gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)
603         &     - (rStarExpS(i,j,bi,bj) - 1. _d 0)/deltaTfreesurf
604         &       *vVel(i,j,k,bi,bj)
605              ENDDO
606             ENDDO
607            ENDIF
608            IF ( select_rStar.LT.0 ) THEN
609             DO j=jMin,jMax
610              DO i=iMin,iMax
611               gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)
612         &     - rStarDhSDt(i,j,bi,bj)*vVel(i,j,k,bi,bj)
613              ENDDO
614             ENDDO
615            ENDIF
616    # endif /* DISABLE_RSTAR_CODE */
617    #endif /* NONLIN_FRSURF */
618    
619  C---  Hydorstatic term (-1/rhoConst . dphi/dy )        ELSE
620        IF (momPressureForcing) THEN  C-    if momAdvection / else
621         DO j=jMin,jMax          DO j=1-OLy,sNy+OLy
622          DO i=iMin,iMax           DO i=1-OLx,sNx+OLx
623           pF(i,j) = -_recip_dyC(i,j,bi,bj)             gV(i,j,k,bi,bj) = 0. _d 0
624       &    *(phi_hyd(i,j,k)-phi_hyd(i,j-1,k))           ENDDO
625          ENDDO          ENDDO
626         ENDDO  
627    C-    endif momAdvection.
628        ENDIF        ENDIF
629    
630          IF (momViscosity) THEN
631    C---  Calculate eddy fluxes (dissipation) between cells for meridional flow.
632    C     Bi-harmonic term del^2 V -> v4F
633            IF (biharmonic)
634         &  CALL MOM_V_DEL2V(bi,bj,k,vFld,hFacZ,v4f,myThid)
635    
636    C     Laplacian and bi-harmonic terms, Zonal  Fluxes -> fZon
637            CALL MOM_V_XVISCFLUX(bi,bj,k,vFld,v4f,hFacZ,fZon,
638         I    viscAh_Z,viscA4_Z,myThid)
639    
640    C     Laplacian and bi-harmonic termis, Merid Fluxes -> fMer
641            CALL MOM_V_YVISCFLUX(bi,bj,k,vFld,v4f,fMer,
642         I    viscAh_D,viscA4_D,myThid)
643    
644    C     Eddy component of vertical flux (interior component only) -> fVrUp & fVrDw
645           IF (.NOT.implicitViscosity) THEN
646            CALL MOM_V_RVISCFLUX(bi,bj, k, vVel,KappaRV,fVrUp,myThid)
647            CALL MOM_V_RVISCFLUX(bi,bj,k+1,vVel,KappaRV,fVrDw,myThid)
648           ENDIF
649    
650  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
651        DO j=jMin,jMax          DO j=jMin,jMax
652         DO i=iMin,iMax           DO i=iMin,iMax
653          gV(i,j,k,bi,bj) =            gvDiss(i,j) =
654  #ifdef OLD_UV_GEOM  #ifdef OLD_UV_GEOM
655       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/       &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/
656       &    ( 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)) )
657  #else  #else
658       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)       &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
659       &    *recip_rAs(i,j,bi,bj)       &      *recip_rAs(i,j,bi,bj)
660    #endif
661         &    *( ( fZon(i+1,j)  - fZon(i,j  ) )*AhDvdxFac
662         &      +( fMer(i,  j)  - fMer(i,j-1) )*AhDvdyFac
663         &      +( fVrDw(i,j)   - fVrUp(i,j) )*rkSign*ArDvdrFac
664         &     )
665             ENDDO
666            ENDDO
667    
668    #ifdef ALLOW_DIAGNOSTICS
669            IF ( useDiagnostics ) THEN
670              CALL DIAGNOSTICS_FILL(fZon, 'VISCx_Vm',k,1,2,bi,bj,myThid)
671              CALL DIAGNOSTICS_FILL(fMer, 'VISCy_Vm',k,1,2,bi,bj,myThid)
672              IF (.NOT.implicitViscosity)
673         &    CALL DIAGNOSTICS_FILL(fVrUp,'VISrE_Vm',k,1,2,bi,bj,myThid)
674            ENDIF
675  #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  
      &   )  
      & _PHM( +phyFac*pf(i,j) )  
        ENDDO  
       ENDDO  
676    
677  C-- No-slip and drag BCs appear as body forces in cell abutting topography  C-- No-slip and drag BCs appear as body forces in cell abutting topography
678        IF (momViscosity.AND.no_slip_sides) THEN          IF (no_slip_sides) THEN
679  C-     No-slip BCs impose a drag at walls...  C-     No-slip BCs impose a drag at walls...
680         CALL MOM_V_SIDEDRAG(bi,bj,k,vFld,v4F,hFacZ,vF,myThid)           CALL MOM_V_SIDEDRAG(
681         DO j=jMin,jMax       I        bi,bj,k,
682          DO i=iMin,iMax       I        vFld, v4f, hFacZ,
683           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)       I        viscAh_Z,viscA4_Z,
684          ENDDO       I        harmonic,biharmonic,useVariableViscosity,
685         ENDDO       O        vF,
686        ENDIF       I        myThid)
687             DO j=jMin,jMax
688              DO i=iMin,iMax
689               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
690              ENDDO
691             ENDDO
692            ENDIF
693  C-    No-slip BCs impose a drag at bottom  C-    No-slip BCs impose a drag at bottom
694        IF (momViscosity.AND.bottomDragTerms) THEN          IF (bottomDragTerms) THEN
695         CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)           CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)
696             DO j=jMin,jMax
697              DO i=iMin,iMax
698               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
699              ENDDO
700             ENDDO
701            ENDIF
702    
703    #ifdef ALLOW_SHELFICE
704            IF (useShelfIce) THEN
705             CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRU,vF,myThid)
706             DO j=jMin,jMax
707              DO i=iMin,iMax
708               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
709              ENDDO
710             ENDDO
711            ENDIF
712    #endif /* ALLOW_SHELFICE */
713    
714    C-    endif momViscosity
715          ENDIF
716    
717    C--   Forcing term (moved to timestep.F)
718    c     IF (momForcing)
719    c    & CALL EXTERNAL_FORCING_V(
720    c    I     iMin,iMax,jMin,jMax,bi,bj,k,
721    c    I     myTime,myThid)
722    
723    C--   Metric terms for curvilinear grid systems
724          IF (useNHMTerms) THEN
725    C      o Non-Hydrostatic (spherical) metric terms
726           CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,mT,myThid)
727         DO j=jMin,jMax         DO j=jMin,jMax
728          DO i=iMin,iMax          DO i=iMin,iMax
729           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+mtNHFacV*mT(i,j)
730          ENDDO          ENDDO
731         ENDDO         ENDDO
732        ENDIF        ENDIF
733          IF ( usingSphericalPolarGrid .AND. metricTerms ) THEN
 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  
734  C      o Spherical polar grid metric terms  C      o Spherical polar grid metric terms
735         CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,mT,myThid)         CALL MOM_V_METRIC_SPHERE(bi,bj,k,uFld,mT,myThid)
736         DO j=jMin,jMax         DO j=jMin,jMax
737          DO i=iMin,iMax          DO i=iMin,iMax
738           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)
739          ENDDO          ENDDO
740         ENDDO         ENDDO
741        ENDIF        ENDIF
742        IF (usingSphericalPolarMTerms) THEN        IF ( usingCylindricalGrid .AND. metricTerms ) THEN
743         CALL MOM_V_METRIC_SPHERE(bi,bj,k,uFld,mT,myThid)  C      o Cylindrical grid metric terms
744           CALL MOM_V_METRIC_CYLINDER(bi,bj,k,uFld,vFld,mT,myThid)
745         DO j=jMin,jMax         DO j=jMin,jMax
746          DO i=iMin,iMax          DO i=iMin,iMax
747           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)
748          ENDDO          ENDDO
749         ENDDO         ENDDO
750        ENDIF        ENDIF
751    
752  C--   Set dv/dt on boundaries to zero  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
       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  
753    
754  C--   Coriolis term  C--   Coriolis term
755  C     Note. As coded here, coriolis will not work with "thin walls"  C     Note. As coded here, coriolis will not work with "thin walls"
756  #ifdef INCLUDE_CD_CODE  c     IF (useCDscheme) THEN
757        CALL MOM_CDSCHEME(bi,bj,k,phi_hyd,myThid)  c       CALL MOM_CDSCHEME(bi,bj,k,dPhiHydX,dPhiHydY,myThid)
758  #else  c     ELSE
759        CALL MOM_U_CORIOLIS(bi,bj,k,vFld,cf,myThid)        IF (.NOT.useCDscheme) THEN
760        DO j=jMin,jMax          CALL MOM_U_CORIOLIS(bi,bj,k,vFld,cf,myThid)
761         DO i=iMin,iMax          DO j=jMin,jMax
762          gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)           DO i=iMin,iMax
763         ENDDO            gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)
764        ENDDO           ENDDO
765        CALL MOM_V_CORIOLIS(bi,bj,k,uFld,cf,myThid)          ENDDO
766    #ifdef ALLOW_DIAGNOSTICS
767            IF ( useDiagnostics )
768         &    CALL DIAGNOSTICS_FILL(cf,'Um_Cori ',k,1,2,bi,bj,myThid)
769    #endif
770            CALL MOM_V_CORIOLIS(bi,bj,k,uFld,cf,myThid)
771            DO j=jMin,jMax
772             DO i=iMin,iMax
773              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+fvFac*cf(i,j)
774             ENDDO
775            ENDDO
776    #ifdef ALLOW_DIAGNOSTICS
777            IF ( useDiagnostics )
778         &    CALL DIAGNOSTICS_FILL(cf,'Vm_Cori ',k,1,2,bi,bj,myThid)
779    #endif
780          ENDIF
781    
782    C--   3.D Coriolis term (horizontal momentum, Eastward component: -f'*w)
783          IF ( nonHydrostatic.OR.quasiHydrostatic ) THEN
784            CALL MOM_U_CORIOLIS_NH(bi,bj,k,wVel,cf,myThid)
785            DO j=jMin,jMax
786             DO i=iMin,iMax
787              gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)
788             ENDDO
789            ENDDO
790           IF ( usingCurvilinearGrid ) THEN
791    C-     presently, non zero angleSinC array only supported with Curvilinear-Grid
792            CALL MOM_V_CORIOLIS_NH(bi,bj,k,wVel,cf,myThid)
793            DO j=jMin,jMax
794             DO i=iMin,iMax
795              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+fvFac*cf(i,j)
796             ENDDO
797            ENDDO
798           ENDIF
799          ENDIF
800    
801    C--   Set du/dt & dv/dt on boundaries to zero
802        DO j=jMin,jMax        DO j=jMin,jMax
803         DO i=iMin,iMax         DO i=iMin,iMax
804          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)
805            guDiss(i,j)     = guDiss(i,j)    *_maskW(i,j,k,bi,bj)
806            gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)
807            gvDiss(i,j)     = gvDiss(i,j)    *_maskS(i,j,k,bi,bj)
808         ENDDO         ENDDO
809        ENDDO        ENDDO
810  #endif /* INCLUDE_CD_CODE */  
811        IF (nonHydrostatic) THEN  #ifdef ALLOW_DIAGNOSTICS
812         CALL MOM_U_CORIOLIS_NH(bi,bj,k,wVel,cf,myThid)        IF ( useDiagnostics ) THEN
813         DO j=jMin,jMax          CALL DIAGNOSTICS_FILL(KE,    'momKE   ',k,1,2,bi,bj,myThid)
814          DO i=iMin,iMax          CALL DIAGNOSTICS_FILL(gU(1-Olx,1-Oly,k,bi,bj),
815           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)       &                               'Um_Advec',k,1,2,bi,bj,myThid)
816          ENDDO          CALL DIAGNOSTICS_FILL(gV(1-Olx,1-Oly,k,bi,bj),
817         ENDDO       &                               'Vm_Advec',k,1,2,bi,bj,myThid)
818           IF (momViscosity) THEN
819            CALL DIAGNOSTICS_FILL(guDiss,'Um_Diss ',k,1,2,bi,bj,myThid)
820            CALL DIAGNOSTICS_FILL(gvDiss,'Vm_Diss ',k,1,2,bi,bj,myThid)
821           ENDIF
822        ENDIF        ENDIF
823    #endif /* ALLOW_DIAGNOSTICS */
824    
825        RETURN        RETURN
826        END        END
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.35
  ViewVC Help
Powered by ViewVC 1.1.22