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

Diff of /MITgcm/pkg/mom_vecinv/mom_vecinv.F

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

revision 1.3 by adcroft, Thu Sep 6 14:23:58 2001 UTC revision 1.60 by jmc, Thu Nov 23 00:45:21 2006 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4  #include "CPP_OPTIONS.h"  #include "MOM_VECINV_OPTIONS.h"
5    
6        SUBROUTINE MOM_VECINV(        SUBROUTINE MOM_VECINV(
7       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,
8       I        phi_hyd,KappaRU,KappaRV,       I        KappaRU, KappaRV,
9       U        fVerU, fVerV,       U        fVerU, fVerV,
10       I        myCurrentTime, myIter, myThid)       O        guDiss, gvDiss,
11         I        myTime, myIter, myThid)
12  C     /==========================================================\  C     /==========================================================\
13  C     | S/R MOM_VECINV                                           |  C     | S/R MOM_VECINV                                           |
14  C     | o Form the right hand-side of the momentum equation.     |  C     | o Form the right hand-side of the momentum equation.     |
# Line 30  C     == Global variables == Line 31  C     == Global variables ==
31  #include "DYNVARS.h"  #include "DYNVARS.h"
32  #include "EEPARAMS.h"  #include "EEPARAMS.h"
33  #include "PARAMS.h"  #include "PARAMS.h"
34    #ifdef ALLOW_MNC
35    #include "MNC_PARAMS.h"
36    #endif
37  #include "GRID.h"  #include "GRID.h"
38    #ifdef ALLOW_TIMEAVE
39    #include "TIMEAVE_STATV.h"
40    #endif
41    #ifdef ALLOW_AUTODIFF_TAMC
42    # include "tamc.h"
43    # include "tamc_keys.h"
44    #endif
45    
46  C     == Routine arguments ==  C     == Routine arguments ==
47  C     fVerU   - Flux of momentum in the vertical  C     fVerU  :: Flux of momentum in the vertical direction, out of the upper
48  C     fVerV     direction out of the upper face of a cell K  C     fVerV  :: face of a cell K ( flux into the cell above ).
49  C               ( flux into the cell above ).  C     guDiss :: dissipation tendency (all explicit terms), u component
50  C     phi_hyd - Hydrostatic pressure  C     gvDiss :: dissipation tendency (all explicit terms), v component
51  C     bi, bj, iMin, iMax, jMin, jMax - Range of points for which calculation  C     bi, bj, iMin, iMax, jMin, jMax - Range of points for which calculation
52  C                                      results will be set.  C                                      results will be set.
53  C     kUp, kDown                     - Index for upper and lower layers.  C     kUp, kDown                     - Index for upper and lower layers.
54  C     myThid - Instance number for this innvocation of CALC_MOM_RHS  C     myThid :: my Thread Id number
       _RL phi_hyd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
55        _RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
56        _RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
57        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
58        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
59          _RL guDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
60          _RL gvDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
61        INTEGER kUp,kDown        INTEGER kUp,kDown
62        _RL     myCurrentTime        _RL     myTime
63        INTEGER myIter        INTEGER myIter
64        INTEGER myThid        INTEGER myThid
65        INTEGER bi,bj,iMin,iMax,jMin,jMax        INTEGER bi,bj,iMin,iMax,jMin,jMax
66    
67    #ifdef ALLOW_MOM_VECINV
68    
69  C     == Functions ==  C     == Functions ==
70        LOGICAL  DIFFERENT_MULTIPLE        LOGICAL  DIFFERENT_MULTIPLE
71        EXTERNAL DIFFERENT_MULTIPLE        EXTERNAL DIFFERENT_MULTIPLE
72    
73  C     == Local variables ==  C     == Local variables ==
       _RL      aF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
74        _RL      vF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL      vF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
75        _RL      vrF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL      vrF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
76        _RL      uCf (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL      uCf(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
77        _RL      vCf (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL      vCf(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
78        _RL      mT (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS hFacZ   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
79        _RL      pF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS r_hFacZ (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
80        _RL del2u(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uFld    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
81        _RL del2v(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vFld    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
82        _RL tension(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL del2u   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
83        _RL strain(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL del2v   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
84        _RS hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL dStar   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
85        _RS r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL zStar   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
86        _RS xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL tension (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
87        _RS yA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL strain  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
88        _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL KE      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
89        _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL omega3  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
90        _RL uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vort3   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
91        _RL vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL hDiv    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
92        _RL dStar(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL viscAh_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
93        _RL zStar(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL viscAh_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
94        _RL uDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL viscA4_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
95        _RL vDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL viscA4_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
96  C     I,J,K - Loop counters  C     i,j,k  :: Loop counters
97        INTEGER i,j,k        INTEGER i,j,k
 C     rVelMaskOverride - Factor for imposing special surface boundary conditions  
 C                        ( set according to free-surface condition ).  
 C     hFacROpen        - Lopped cell factos used tohold fraction of open  
 C     hFacRClosed        and closed cell wall.  
       _RL  rVelMaskOverride  
98  C     xxxFac - On-off tracer parameters used for switching terms off.  C     xxxFac - On-off tracer parameters used for switching terms off.
       _RL  uDudxFac  
       _RL  AhDudxFac  
       _RL  A4DuxxdxFac  
       _RL  vDudyFac  
       _RL  AhDudyFac  
       _RL  A4DuyydyFac  
       _RL  rVelDudrFac  
99        _RL  ArDudrFac        _RL  ArDudrFac
       _RL  fuFac  
       _RL  phxFac  
       _RL  mtFacU  
       _RL  uDvdxFac  
       _RL  AhDvdxFac  
       _RL  A4DvxxdxFac  
       _RL  vDvdyFac  
       _RL  AhDvdyFac  
       _RL  A4DvyydyFac  
       _RL  rVelDvdrFac  
100        _RL  ArDvdrFac        _RL  ArDvdrFac
101        _RL  fvFac        _RL  sideMaskFac
       _RL  phyFac  
       _RL  vForcFac  
       _RL  mtFacV  
       INTEGER km1,kp1  
       _RL wVelBottomOverride  
102        LOGICAL bottomDragTerms        LOGICAL bottomDragTerms
103        _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        LOGICAL writeDiag
104        _RL omega3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        LOGICAL harmonic,biharmonic,useVariableViscosity
105        _RL vort3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  #ifdef ALLOW_AUTODIFF_TAMC
106        _RL hDiv(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        INTEGER imomkey
107    #endif
108        km1=MAX(1,k-1)  
109        kp1=MIN(Nr,k+1)  #ifdef ALLOW_MNC
110        rVelMaskOverride=1.        INTEGER offsets(9)
111        IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac        CHARACTER*(1) pf
112        wVelBottomOverride=1.  #endif
113        IF (k.EQ.Nr) wVelBottomOverride=0.  
114    #ifdef ALLOW_AUTODIFF_TAMC
115    C--   only the kDown part of fverU/V is set in this subroutine
116    C--   the kUp is still required
117    C--   In the case of mom_fluxform Kup is set as well
118    C--   (at least in part)
119          fVerU(1,1,kUp) = fVerU(1,1,kUp)
120          fVerV(1,1,kUp) = fVerV(1,1,kUp)
121    #endif
122    
123    #ifdef ALLOW_AUTODIFF_TAMC
124              act0 = k - 1
125              max0 = Nr
126              act1 = bi - myBxLo(myThid)
127              max1 = myBxHi(myThid) - myBxLo(myThid) + 1
128              act2 = bj - myByLo(myThid)
129              max2 = myByHi(myThid) - myByLo(myThid) + 1
130              act3 = myThid - 1
131              max3 = nTx*nTy
132              act4 = ikey_dynamics - 1
133              imomkey = (act0 + 1)
134         &                    + act1*max0
135         &                    + act2*max0*max1
136         &                    + act3*max0*max1*max2
137         &                    + act4*max0*max1*max2*max3
138    #endif /* ALLOW_AUTODIFF_TAMC */
139    
140          writeDiag = DIFFERENT_MULTIPLE(diagFreq, myTime, deltaTClock)
141    
142    #ifdef ALLOW_MNC
143          IF (useMNC .AND. snapshot_mnc .AND. writeDiag) THEN
144            IF ( writeBinaryPrec .EQ. precFloat64 ) THEN
145              pf(1:1) = 'D'
146            ELSE
147              pf(1:1) = 'R'
148            ENDIF
149            IF ((bi .EQ. 1).AND.(bj .EQ. 1).AND.(k .EQ. 1)) THEN
150              CALL MNC_CW_SET_UDIM('mom_vi', -1, myThid)
151              CALL MNC_CW_RL_W_S('D','mom_vi',0,0,'T',myTime,myThid)
152              CALL MNC_CW_SET_UDIM('mom_vi', 0, myThid)
153              CALL MNC_CW_I_W_S('I','mom_vi',0,0,'iter',myIter,myThid)
154            ENDIF
155            DO i = 1,9
156              offsets(i) = 0
157            ENDDO
158            offsets(3) = k
159    C       write(*,*) 'offsets = ',(offsets(i),i=1,9)
160          ENDIF
161    #endif /*  ALLOW_MNC  */
162    
163  C     Initialise intermediate terms  C     Initialise intermediate terms
164        DO J=1-OLy,sNy+OLy        DO J=1-OLy,sNy+OLy
165         DO I=1-OLx,sNx+OLx         DO I=1-OLx,sNx+OLx
166          aF(i,j)   = 0.          vF(i,j)    = 0.
167          vF(i,j)   = 0.          vrF(i,j)   = 0.
         vrF(i,j)  = 0.  
168          uCf(i,j)   = 0.          uCf(i,j)   = 0.
169          vCf(i,j)   = 0.          vCf(i,j)   = 0.
         mT(i,j)   = 0.  
         pF(i,j)   = 0.  
170          del2u(i,j) = 0.          del2u(i,j) = 0.
171          del2v(i,j) = 0.          del2v(i,j) = 0.
172          dStar(i,j) = 0.          dStar(i,j) = 0.
173          zStar(i,j) = 0.          zStar(i,j) = 0.
174          uDiss(i,j) = 0.          guDiss(i,j)= 0.
175          vDiss(i,j) = 0.          gvDiss(i,j)= 0.
176          vort3(i,j) = 0.          vort3(i,j) = 0.
177          omega3(i,j) = 0.          omega3(i,j)= 0.
178          ke(i,j) = 0.          KE(i,j)    = 0.
179    c       hDiv(i,j)  = 0.
180            viscAh_Z(i,j) = 0.
181            viscAh_D(i,j) = 0.
182            viscA4_Z(i,j) = 0.
183            viscA4_D(i,j) = 0.
184    
185            strain(i,j)  = 0. _d 0
186            tension(i,j) = 0. _d 0
187    #ifdef ALLOW_AUTODIFF_TAMC
188            hFacZ(i,j)   = 0. _d 0
189    #endif
190         ENDDO         ENDDO
191        ENDDO        ENDDO
192    
193  C--   Term by term tracer parmeters  C--   Term by term tracer parmeters
194  C     o U momentum equation  C     o U momentum equation
       uDudxFac     = afFacMom*1.  
       AhDudxFac    = vfFacMom*1.  
       A4DuxxdxFac  = vfFacMom*1.  
       vDudyFac     = afFacMom*1.  
       AhDudyFac    = vfFacMom*1.  
       A4DuyydyFac  = vfFacMom*1.  
       rVelDudrFac  = afFacMom*1.  
195        ArDudrFac    = vfFacMom*1.        ArDudrFac    = vfFacMom*1.
       mTFacU       = mtFacMom*1.  
       fuFac        = cfFacMom*1.  
       phxFac       = pfFacMom*1.  
196  C     o V momentum equation  C     o V momentum equation
       uDvdxFac     = afFacMom*1.  
       AhDvdxFac    = vfFacMom*1.  
       A4DvxxdxFac  = vfFacMom*1.  
       vDvdyFac     = afFacMom*1.  
       AhDvdyFac    = vfFacMom*1.  
       A4DvyydyFac  = vfFacMom*1.  
       rVelDvdrFac  = afFacMom*1.  
197        ArDvdrFac    = vfFacMom*1.        ArDvdrFac    = vfFacMom*1.
198        mTFacV       = mtFacMom*1.  
199        fvFac        = cfFacMom*1.  C note: using standard stencil (no mask) results in under-estimating
200        phyFac       = pfFacMom*1.  C       vorticity at a no-slip boundary by a factor of 2 = sideDragFactor
201        vForcFac     = foFacMom*1.        IF ( no_slip_sides ) THEN
202            sideMaskFac = sideDragFactor
203          ELSE
204            sideMaskFac = 0. _d 0
205          ENDIF
206    
207        IF (     no_slip_bottom        IF (     no_slip_bottom
208       &    .OR. bottomDragQuadratic.NE.0.       &    .OR. bottomDragQuadratic.NE.0.
# Line 183  C     o V momentum equation Line 212  C     o V momentum equation
212         bottomDragTerms=.FALSE.         bottomDragTerms=.FALSE.
213        ENDIF        ENDIF
214    
 C-- with stagger time stepping, grad Phi_Hyp is directly incoporated in TIMESTEP  
       IF (staggerTimeStep) THEN  
         phxFac = 0.  
         phyFac = 0.  
       ENDIF  
   
215  C--   Calculate open water fraction at vorticity points  C--   Calculate open water fraction at vorticity points
216        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)
217    
 C---- Calculate common quantities used in both U and V equations  
 C     Calculate tracer cell face open areas  
       DO j=1-OLy,sNy+OLy  
        DO i=1-OLx,sNx+OLx  
         xA(i,j) = _dyG(i,j,bi,bj)  
      &   *drF(k)*_hFacW(i,j,k,bi,bj)  
         yA(i,j) = _dxG(i,j,bi,bj)  
      &   *drF(k)*_hFacS(i,j,k,bi,bj)  
        ENDDO  
       ENDDO  
   
218  C     Make local copies of horizontal flow field  C     Make local copies of horizontal flow field
219        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
220         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
# Line 211  C     Make local copies of horizontal fl Line 223  C     Make local copies of horizontal fl
223         ENDDO         ENDDO
224        ENDDO        ENDDO
225    
226  C     Calculate velocity field "volume transports" through tracer cell faces.  C note (jmc) : Dissipation and Vort3 advection do not necesary
227        DO j=1-OLy,sNy+OLy  C              use the same maskZ (and hFacZ)  => needs 2 call(s)
228         DO i=1-OLx,sNx+OLx  c     CALL MOM_VI_HFACZ_DISS(bi,bj,k,hFacZ,r_hFacZ,myThid)
         uTrans(i,j) = uFld(i,j)*xA(i,j)  
         vTrans(i,j) = vFld(i,j)*yA(i,j)  
        ENDDO  
       ENDDO  
229    
230        CALL MOM_VI_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid)        CALL MOM_CALC_KE(bi,bj,k,selectKEscheme,uFld,vFld,KE,myThid)
231    
232        CALL MOM_VI_CALC_HDIV(bi,bj,k,uFld,vFld,hDiv,myThid)        CALL MOM_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)
233    
234          IF (momViscosity) THEN
235    C--    For viscous term, compute horizontal divergence, tension & strain
236    C      and mask relative vorticity (free-slip case):
237    
238        CALL MOM_VI_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)  #ifdef ALLOW_AUTODIFF_TAMC
239    CADJ STORE vort3(:,:) =
240    CADJ &     comlev1_bibj_k, key = imomkey, byte = isbyte
241    #endif
242    
243           CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid)
244    
245           CALL MOM_CALC_TENSION(bi,bj,k,uFld,vFld,tension,myThid)
246    
247           CALL MOM_CALC_STRAIN(bi,bj,k,uFld,vFld,hFacZ,strain,myThid)
248    
249    C-     account for no-slip / free-slip BC:
250           DO j=1-Oly,sNy+Oly
251            DO i=1-Olx,sNx+Olx
252              IF ( hFacZ(i,j).EQ.0. ) THEN
253                vort3(i,j)  = sideMaskFac*vort3(i,j)
254                strain(i,j) = sideMaskFac*strain(i,j)
255              ENDIF
256            ENDDO
257           ENDDO
258    
259        CALL MOM_VI_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)  C--    Calculate Viscosities
260           CALL MOM_CALC_VISC(
261         I        bi,bj,k,
262         O        viscAh_Z,viscAh_D,viscA4_Z,viscA4_D,
263         O        harmonic,biharmonic,useVariableViscosity,
264         I        hDiv,vort3,tension,strain,KE,hfacZ,
265         I        myThid)
266    
       IF (momViscosity) THEN  
267  C      Calculate del^2 u and del^2 v for bi-harmonic term  C      Calculate del^2 u and del^2 v for bi-harmonic term
268         IF (viscA4.NE.0.) THEN         IF (biharmonic) THEN
269           CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ,           CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ,
270       O                      del2u,del2v,       O                      del2u,del2v,
271       &                      myThid)       &                      myThid)
272           CALL MOM_VI_CALC_HDIV(bi,bj,k,del2u,del2v,dStar,myThid)           CALL MOM_CALC_HDIV(bi,bj,k,2,del2u,del2v,dStar,myThid)
273           CALL MOM_VI_CALC_RELVORT3(           CALL MOM_CALC_RELVORT3(bi,bj,k,
274       &                         bi,bj,k,del2u,del2v,hFacZ,zStar,myThid)       &                          del2u,del2v,hFacZ,zStar,myThid)
275         ENDIF         ENDIF
276  C      Calculate dissipation terms for U and V equations  
277  C      in terms of vorticity and divergence  C-    Strain diagnostics:
278         IF (viscAh.NE.0. .OR. viscA4.NE.0.) THEN         IF ( writeDiag ) THEN
279           CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,hFacZ,dStar,zStar,          IF (snapshot_mdsio) THEN
280       O                       uDiss,vDiss,            CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid)
281       &                       myThid)          ENDIF
282    #ifdef ALLOW_MNC
283            IF (useMNC .AND. snapshot_mnc) THEN
284              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Ds',strain,
285         &          offsets, myThid)
286            ENDIF
287    #endif /*  ALLOW_MNC  */
288           ENDIF
289    #ifdef ALLOW_DIAGNOSTICS
290           IF ( useDiagnostics ) THEN
291            CALL DIAGNOSTICS_FILL(strain, 'Strain  ',k,1,2,bi,bj,myThid)
292         ENDIF         ENDIF
293  C      or in terms of tension and strain  #endif /* ALLOW_DIAGNOSTICS */
294         IF (viscAstrain.NE.0. .OR. viscAtension.NE.0.) THEN  
295           CALL MOM_CALC_TENSION(bi,bj,k,uFld,vFld,  C---   Calculate dissipation terms for U and V equations
296       O                         tension,  
297       I                         myThid)  C      in terms of tension and strain
298           CALL MOM_CALC_STRAIN(bi,bj,k,uFld,vFld,hFacZ,         IF (useStrainTensionVisc) THEN
299       O                        strain,  C        mask strain as if free-slip since side-drag is computed separately
300       I                        myThid)           DO j=1-Oly,sNy+Oly
301           CALL MOM_HDISSIP(bi,bj,k,            DO i=1-Olx,sNx+Olx
302       I                    tension,strain,hFacZ,viscAtension,viscAstrain,              IF ( hFacZ(i,j).EQ.0. ) strain(i,j) = 0. _d 0
303       O                    uDiss,vDiss,            ENDDO
304             ENDDO
305             CALL MOM_HDISSIP(bi,bj,k,hDiv,vort3,tension,strain,KE,
306         I                    hFacZ,
307         I                    viscAh_Z,viscAh_D,viscA4_Z,viscA4_D,
308         I                    harmonic,biharmonic,useVariableViscosity,
309         O                    guDiss,gvDiss,
310       I                    myThid)       I                    myThid)
311           ELSE
312    C      in terms of vorticity and divergence
313             CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,tension,strain,KE,
314         I                       hFacZ,dStar,zStar,
315         I                       viscAh_Z,viscAh_D,viscA4_Z,viscA4_D,
316         I                       harmonic,biharmonic,useVariableViscosity,
317         O                       guDiss,gvDiss,
318         &                       myThid)
319         ENDIF         ENDIF
320    C--   if (momViscosity) end of block.
321        ENDIF        ENDIF
322    
323  C---- Zonal momentum equation starts here  C-    Return to standard hfacZ (min-4) and mask vort3 accordingly:
324    c     CALL MOM_VI_MASK_VORT3(bi,bj,k,hFacZ,r_hFacZ,vort3,myThid)
325    
326    C---  Other dissipation terms in Zonal momentum equation
327    
328  C--   Vertical flux (fVer is at upper face of "u" cell)  C--   Vertical flux (fVer is at upper face of "u" cell)
329    
330  C     Eddy component of vertical flux (interior component only) -> vrF  C     Eddy component of vertical flux (interior component only) -> vrF
331        IF (momViscosity.AND..NOT.implicitViscosity)        IF (momViscosity.AND..NOT.implicitViscosity) THEN
332       & CALL MOM_U_RVISCFLUX(bi,bj,k,uVel,KappaRU,vrF,myThid)         CALL MOM_U_RVISCFLUX(bi,bj,k+1,uVel,KappaRU,vrF,myThid)
333    
334  C     Combine fluxes  C     Combine fluxes
335        DO j=jMin,jMax         DO j=jMin,jMax
336         DO i=iMin,iMax          DO i=iMin,iMax
337          fVerU(i,j,kDown) = ArDudrFac*vrF(i,j)           fVerU(i,j,kDown) = ArDudrFac*vrF(i,j)
        ENDDO  
       ENDDO  
   
 C---  Hydrostatic term ( -1/rhoConst . dphi/dx )  
       IF (momPressureForcing) THEN  
        DO j=1-Olx,sNy+Oly  
         DO i=2-Olx,sNx+Olx  
          pf(i,j) = - _recip_dxC(i,j,bi,bj)  
      &    *(phi_hyd(i,j,k)-phi_hyd(i-1,j,k))  
338          ENDDO          ENDDO
339         ENDDO         ENDDO
       ENDIF  
340    
341  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term  C--   Tendency is minus divergence of the fluxes
342        DO j=2-Oly,sNy+Oly-1         DO j=2-Oly,sNy+Oly-1
343         DO i=2-Olx,sNx+Olx-1          DO i=2-Olx,sNx+Olx-1
344          gU(i,j,k,bi,bj) = uDiss(i,j)           guDiss(i,j) = guDiss(i,j)
345       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
346       &   *recip_rAw(i,j,bi,bj)       &   *recip_rAw(i,j,bi,bj)
347       &  *(       &  *(
348       &   +fVerU(i,j,kUp)*rkFac - fVerU(i,j,kDown)*rkFac       &    fVerU(i,j,kDown) - fVerU(i,j,kUp)
349       &   )       &   )*rkSign
350       & _PHM( +phxFac * pf(i,j) )          ENDDO
351         ENDDO         ENDDO
352        ENDDO        ENDIF
353    
354  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
355        IF (momViscosity.AND.no_slip_sides) THEN        IF (momViscosity.AND.no_slip_sides) THEN
356  C-     No-slip BCs impose a drag at walls...  C-     No-slip BCs impose a drag at walls...
357         CALL MOM_U_SIDEDRAG(bi,bj,k,uFld,del2u,hFacZ,vF,myThid)         CALL MOM_U_SIDEDRAG(
358         I        bi,bj,k,
359         I        uFld, del2u, hFacZ,
360         I        viscAh_Z,viscA4_Z,
361         I        harmonic,biharmonic,useVariableViscosity,
362         O        vF,
363         I        myThid)
364         DO j=jMin,jMax         DO j=jMin,jMax
365          DO i=iMin,iMax          DO i=iMin,iMax
366           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)           guDiss(i,j) = guDiss(i,j)+vF(i,j)
367          ENDDO          ENDDO
368         ENDDO         ENDDO
369        ENDIF        ENDIF
# Line 312  C-    No-slip BCs impose a drag at botto Line 372  C-    No-slip BCs impose a drag at botto
372         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
373         DO j=jMin,jMax         DO j=jMin,jMax
374          DO i=iMin,iMax          DO i=iMin,iMax
375           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)           guDiss(i,j) = guDiss(i,j)+vF(i,j)
376          ENDDO          ENDDO
377         ENDDO         ENDDO
378        ENDIF        ENDIF
379    #ifdef ALLOW_SHELFICE
380  C--   Forcing term        IF (useShelfIce.AND.momViscosity.AND.bottomDragTerms) THEN
381        IF (momForcing)         CALL SHELFICE_U_DRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
382       &  CALL EXTERNAL_FORCING_U(         DO j=jMin,jMax
383       I     iMin,iMax,jMin,jMax,bi,bj,k,          DO i=iMin,iMax
384       I     myCurrentTime,myThid)           guDiss(i,j) = guDiss(i,j) + vF(i,j)
385            ENDDO
 C--   Metric terms for curvilinear grid systems  
 c     IF (usingSphericalPolarMTerms) THEN  
 C      o Spherical polar grid metric terms  
 c      CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,mT,myThid)  
 c      DO j=jMin,jMax  
 c       DO i=iMin,iMax  
 c        gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+mTFacU*mT(i,j)  
 c       ENDDO  
 c      ENDDO  
 c     ENDIF  
   
 C--   Set du/dt on boundaries to zero  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)*_maskW(i,j,k,bi,bj)  
386         ENDDO         ENDDO
387        ENDDO        ENDIF
388    #endif /* ALLOW_SHELFICE */
389    
390    
391  C---- Meridional momentum equation starts here  C---  Other dissipation terms in Meridional momentum equation
392    
393  C--   Vertical flux (fVer is at upper face of "v" cell)  C--   Vertical flux (fVer is at upper face of "v" cell)
394    
395  C     Eddy component of vertical flux (interior component only) -> vrF  C     Eddy component of vertical flux (interior component only) -> vrF
396        IF (momViscosity.AND..NOT.implicitViscosity)        IF (momViscosity.AND..NOT.implicitViscosity) THEN
397       & CALL MOM_V_RVISCFLUX(bi,bj,k,vVel,KappaRV,vrf,myThid)         CALL MOM_V_RVISCFLUX(bi,bj,k+1,vVel,KappaRV,vrF,myThid)
398    
399  C     Combine fluxes -> fVerV  C     Combine fluxes -> fVerV
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         fVerV(i,j,kDown) = ArDvdrFac*vrF(i,j)  
        ENDDO  
       ENDDO  
   
 C---  Hydorstatic term (-1/rhoConst . dphi/dy )  
       IF (momPressureForcing) THEN  
400         DO j=jMin,jMax         DO j=jMin,jMax
401          DO i=iMin,iMax          DO i=iMin,iMax
402           pF(i,j) = -_recip_dyC(i,j,bi,bj)           fVerV(i,j,kDown) = ArDvdrFac*vrF(i,j)
      &    *(phi_hyd(i,j,k)-phi_hyd(i,j-1,k))  
403          ENDDO          ENDDO
404         ENDDO         ENDDO
       ENDIF  
405    
406  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term  C--   Tendency is minus divergence of the fluxes
407        DO j=jMin,jMax         DO j=jMin,jMax
408         DO i=iMin,iMax          DO i=iMin,iMax
409          gV(i,j,k,bi,bj) = vDiss(i,j)           gvDiss(i,j) = gvDiss(i,j)
410       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
411       &    *recip_rAs(i,j,bi,bj)       &    *recip_rAs(i,j,bi,bj)
412       &  *(       &  *(
413       &   +fVerV(i,j,kUp)*rkFac - fVerV(i,j,kDown)*rkFac       &    fVerV(i,j,kDown) - fVerV(i,j,kUp)
414       &   )       &   )*rkSign
415       & _PHM( +phyFac*pf(i,j) )          ENDDO
416         ENDDO         ENDDO
417        ENDDO        ENDIF
418    
419  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
420        IF (momViscosity.AND.no_slip_sides) THEN        IF (momViscosity.AND.no_slip_sides) THEN
421  C-     No-slip BCs impose a drag at walls...  C-     No-slip BCs impose a drag at walls...
422         CALL MOM_V_SIDEDRAG(bi,bj,k,vFld,del2v,hFacZ,vF,myThid)         CALL MOM_V_SIDEDRAG(
423         I        bi,bj,k,
424         I        vFld, del2v, hFacZ,
425         I        viscAh_Z,viscA4_Z,
426         I        harmonic,biharmonic,useVariableViscosity,
427         O        vF,
428         I        myThid)
429         DO j=jMin,jMax         DO j=jMin,jMax
430          DO i=iMin,iMax          DO i=iMin,iMax
431           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)           gvDiss(i,j) = gvDiss(i,j)+vF(i,j)
432          ENDDO          ENDDO
433         ENDDO         ENDDO
434        ENDIF        ENDIF
# Line 395  C-    No-slip BCs impose a drag at botto Line 437  C-    No-slip BCs impose a drag at botto
437         CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)         CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)
438         DO j=jMin,jMax         DO j=jMin,jMax
439          DO i=iMin,iMax          DO i=iMin,iMax
440           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)           gvDiss(i,j) = gvDiss(i,j)+vF(i,j)
441          ENDDO          ENDDO
442         ENDDO         ENDDO
443        ENDIF        ENDIF
444    #ifdef ALLOW_SHELFICE
445  C--   Forcing term        IF (useShelfIce.AND.momViscosity.AND.bottomDragTerms) THEN
446        IF (momForcing)           CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRU,vF,myThid)
447       & CALL EXTERNAL_FORCING_V(           DO j=jMin,jMax
448       I     iMin,iMax,jMin,jMax,bi,bj,k,            DO i=iMin,iMax
449       I     myCurrentTime,myThid)             gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
450              ENDDO
451  C--   Metric terms for curvilinear grid systems           ENDDO
452  c     IF (usingSphericalPolarMTerms) THEN          ENDIF
453  C      o Spherical polar grid metric terms  #endif /* ALLOW_SHELFICE */
454  c      CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,mT,myThid)  
455  c      DO j=jMin,jMax  
456  c       DO i=iMin,iMax  C-    Vorticity diagnostics:
457  c        gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+mTFacV*mT(i,j)        IF ( writeDiag ) THEN
458  c       ENDDO          IF (snapshot_mdsio) THEN
459  c      ENDDO            CALL WRITE_LOCAL_RL('Z3','I10',1,vort3, bi,bj,k,myIter,myThid)
460  c     ENDIF          ENDIF
461    #ifdef ALLOW_MNC
462  C--   Set dv/dt on boundaries to zero          IF (useMNC .AND. snapshot_mnc) THEN
463        DO j=jMin,jMax            CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Z3',vort3,
464         DO i=iMin,iMax       &          offsets, myThid)
465          gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)          ENDIF
466    #endif /*  ALLOW_MNC  */
467          ENDIF
468    #ifdef ALLOW_DIAGNOSTICS
469          IF ( useDiagnostics ) THEN
470            CALL DIAGNOSTICS_FILL(vort3,  'momVort3',k,1,2,bi,bj,myThid)
471          ENDIF
472    #endif /* ALLOW_DIAGNOSTICS */
473    
474    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
475    
476    C---  Prepare for Advection & Coriolis terms:
477    C-    Mask relative vorticity and calculate absolute vorticity
478          DO j=1-Oly,sNy+Oly
479           DO i=1-Olx,sNx+Olx
480             IF ( hFacZ(i,j).EQ.0. ) vort3(i,j) = 0.
481         ENDDO         ENDDO
482        ENDDO        ENDDO
483          IF (useAbsVorticity)
484         &  CALL MOM_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)
485    
486  C--   Horizontal Coriolis terms  C--   Horizontal Coriolis terms
487        CALL MOM_VI_CORIOLIS(bi,bj,K,uFld,vFld,omega3,r_hFacZ,  c     IF (useCoriolis .AND. .NOT.useCDscheme
488       &                     uCf,vCf,myThid)  c    &    .AND. .NOT. useAbsVorticity) THEN
489        DO j=jMin,jMax  C- jmc: change it to keep the Coriolis terms when useAbsVorticity=T & momAdvection=F
490         DO i=iMin,iMax        IF ( useCoriolis .AND.
491          gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j))       &     .NOT.( useCDscheme .OR. useAbsVorticity.AND.momAdvection )
492       &                    *_maskW(i,j,k,bi,bj)       &   ) THEN
493          gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))         IF (useAbsVorticity) THEN
494       &                    *_maskS(i,j,k,bi,bj)          CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,hFacZ,r_hFacZ,
495         ENDDO       &                         uCf,myThid)
496        ENDDO          CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,hFacZ,r_hFacZ,
497  c     CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid)       &                         vCf,myThid)
498        CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid)         ELSE
499  c     CALL MOM_VI_U_CORIOLIS_C4(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid)          CALL MOM_VI_CORIOLIS(bi,bj,k,uFld,vFld,hFacZ,r_hFacZ,
500        DO j=jMin,jMax       &                       uCf,vCf,myThid)
501         DO i=iMin,iMax         ENDIF
502          gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j))         DO j=jMin,jMax
503       &                    *_maskW(i,j,k,bi,bj)          DO i=iMin,iMax
504             gU(i,j,k,bi,bj) = uCf(i,j)
505             gV(i,j,k,bi,bj) = vCf(i,j)
506            ENDDO
507         ENDDO         ENDDO
508        ENDDO         IF ( writeDiag ) THEN
509  c     CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,r_hFacZ,vCf,myThid)           IF (snapshot_mdsio) THEN
510        CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,vort3,r_hFacZ,vCf,myThid)             CALL WRITE_LOCAL_RL('fV','I10',1,uCf,bi,bj,k,myIter,myThid)
511  c     CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,vort3,r_hFacZ,vCf,myThid)             CALL WRITE_LOCAL_RL('fU','I10',1,vCf,bi,bj,k,myIter,myThid)
512        DO j=jMin,jMax           ENDIF
513         DO i=iMin,iMax  #ifdef ALLOW_MNC
514          gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))           IF (useMNC .AND. snapshot_mnc) THEN
515       &                    *_maskS(i,j,k,bi,bj)             CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'fV', uCf,
516         &          offsets, myThid)
517               CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'fU', vCf,
518         &          offsets, myThid)
519             ENDIF
520    #endif /*  ALLOW_MNC  */
521           ENDIF
522    #ifdef ALLOW_DIAGNOSTICS
523           IF ( useDiagnostics ) THEN
524             CALL DIAGNOSTICS_FILL(uCf,'Um_Cori ',k,1,2,bi,bj,myThid)
525             CALL DIAGNOSTICS_FILL(vCf,'Vm_Cori ',k,1,2,bi,bj,myThid)
526           ENDIF
527    #endif /* ALLOW_DIAGNOSTICS */
528          ELSE
529           DO j=jMin,jMax
530            DO i=iMin,iMax
531             gU(i,j,k,bi,bj) = 0. _d 0
532             gV(i,j,k,bi,bj) = 0. _d 0
533            ENDDO
534         ENDDO         ENDDO
535        ENDDO        ENDIF
536    
537        IF (momAdvection) THEN        IF (momAdvection) THEN
538  C--   Vertical shear terms (Coriolis)  C--   Horizontal advection of relative (or absolute) vorticity
539        CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid)         IF (highOrderVorticity.AND.useAbsVorticity) THEN
540        DO j=jMin,jMax          CALL MOM_VI_U_CORIOLIS_C4(bi,bj,k,vFld,omega3,r_hFacZ,
541         DO i=iMin,iMax       &                         uCf,myThid)
542          gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j))         ELSEIF (highOrderVorticity) THEN
543       &                    *_maskW(i,j,k,bi,bj)          CALL MOM_VI_U_CORIOLIS_C4(bi,bj,k,vFld,vort3, r_hFacZ,
544         &                         uCf,myThid)
545           ELSEIF (useAbsVorticity) THEN
546            CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,hFacZ,r_hFacZ,
547         &                         uCf,myThid)
548           ELSE
549            CALL MOM_VI_U_CORIOLIS(bi,bj,k,vFld,vort3, hFacZ,r_hFacZ,
550         &                         uCf,myThid)
551           ENDIF
552           DO j=jMin,jMax
553            DO i=iMin,iMax
554             gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
555            ENDDO
556         ENDDO         ENDDO
557        ENDDO         IF (highOrderVorticity.AND.useAbsVorticity) THEN
558        CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid)          CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,omega3,r_hFacZ,
559        DO j=jMin,jMax       &                         vCf,myThid)
560         DO i=iMin,iMax         ELSEIF (highOrderVorticity) THEN
561          gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))          CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,vort3, r_hFacZ,
562       &                    *_maskS(i,j,k,bi,bj)       &                         vCf,myThid)
563           ELSEIF (useAbsVorticity) THEN
564            CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,hFacZ,r_hFacZ,
565         &                         vCf,myThid)
566           ELSE
567            CALL MOM_VI_V_CORIOLIS(bi,bj,k,uFld,vort3, hFacZ,r_hFacZ,
568         &                         vCf,myThid)
569           ENDIF
570           DO j=jMin,jMax
571            DO i=iMin,iMax
572             gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
573            ENDDO
574         ENDDO         ENDDO
575        ENDDO  
576           IF ( writeDiag ) THEN
577             IF (snapshot_mdsio) THEN
578               CALL WRITE_LOCAL_RL('zV','I10',1,uCf,bi,bj,k,myIter,myThid)
579               CALL WRITE_LOCAL_RL('zU','I10',1,vCf,bi,bj,k,myIter,myThid)
580             ENDIF
581    #ifdef ALLOW_MNC
582             IF (useMNC .AND. snapshot_mnc) THEN
583               CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'zV', uCf,
584         &          offsets, myThid)
585               CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'zU', vCf,
586         &          offsets, myThid)
587             ENDIF
588    #endif /*  ALLOW_MNC  */
589           ENDIF
590    
591    #ifdef ALLOW_TIMEAVE
592           IF (taveFreq.GT.0.) THEN
593             CALL TIMEAVE_CUMUL_1K1T(uZetatave,vCf,deltaTClock,
594         &                           Nr, k, bi, bj, myThid)
595             CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock,
596         &                           Nr, k, bi, bj, myThid)
597           ENDIF
598    #endif /* ALLOW_TIMEAVE */
599    #ifdef ALLOW_DIAGNOSTICS
600           IF ( useDiagnostics ) THEN
601             CALL DIAGNOSTICS_FILL(uCf,'Um_AdvZ3',k,1,2,bi,bj,myThid)
602             CALL DIAGNOSTICS_FILL(vCf,'Vm_AdvZ3',k,1,2,bi,bj,myThid)
603           ENDIF
604    #endif /* ALLOW_DIAGNOSTICS */
605    
606    C--   Vertical shear terms (-w*du/dr & -w*dv/dr)
607           IF ( .NOT. momImplVertAdv ) THEN
608            CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid)
609            DO j=jMin,jMax
610             DO i=iMin,iMax
611              gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
612             ENDDO
613            ENDDO
614            CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid)
615            DO j=jMin,jMax
616             DO i=iMin,iMax
617              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
618             ENDDO
619            ENDDO
620    #ifdef ALLOW_DIAGNOSTICS
621            IF ( useDiagnostics ) THEN
622             CALL DIAGNOSTICS_FILL(uCf,'Um_AdvRe',k,1,2,bi,bj,myThid)
623             CALL DIAGNOSTICS_FILL(vCf,'Vm_AdvRe',k,1,2,bi,bj,myThid)
624            ENDIF
625    #endif /* ALLOW_DIAGNOSTICS */
626           ENDIF
627    
628  C--   Bernoulli term  C--   Bernoulli term
629        CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid)         CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid)
630        DO j=jMin,jMax         DO j=jMin,jMax
631         DO i=iMin,iMax          DO i=iMin,iMax
632          gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j))           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
633       &                    *_maskW(i,j,k,bi,bj)          ENDDO
634         ENDDO         ENDDO
635        ENDDO         CALL MOM_VI_V_GRAD_KE(bi,bj,K,KE,vCf,myThid)
636        CALL MOM_VI_V_GRAD_KE(bi,bj,K,KE,vCf,myThid)         DO j=jMin,jMax
637            DO i=iMin,iMax
638             gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
639            ENDDO
640           ENDDO
641           IF ( writeDiag ) THEN
642             IF (snapshot_mdsio) THEN
643               CALL WRITE_LOCAL_RL('KEx','I10',1,uCf,bi,bj,k,myIter,myThid)
644               CALL WRITE_LOCAL_RL('KEy','I10',1,vCf,bi,bj,k,myIter,myThid)
645             ENDIF
646    #ifdef ALLOW_MNC
647             IF (useMNC .AND. snapshot_mnc) THEN
648               CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'KEx', uCf,
649         &          offsets, myThid)
650               CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'KEy', vCf,
651         &          offsets, myThid)
652             ENDIF
653    #endif /*  ALLOW_MNC  */
654           ENDIF
655    
656    C--   end if momAdvection
657          ENDIF
658    
659    C--   3.D Coriolis term (horizontal momentum, Eastward component: -f'*w)
660          IF ( use3dCoriolis ) THEN
661            CALL MOM_U_CORIOLIS_NH(bi,bj,k,wVel,uCf,myThid)
662            DO j=jMin,jMax
663             DO i=iMin,iMax
664              gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
665             ENDDO
666            ENDDO
667           IF ( usingCurvilinearGrid ) THEN
668    C-     presently, non zero angleSinC array only supported with Curvilinear-Grid
669            CALL MOM_V_CORIOLIS_NH(bi,bj,k,wVel,vCf,myThid)
670            DO j=jMin,jMax
671             DO i=iMin,iMax
672              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
673             ENDDO
674            ENDDO
675           ENDIF
676          ENDIF
677    
678    C--   Non-Hydrostatic (spherical) metric terms
679          IF ( useNHMTerms ) THEN
680           CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,uCf,myThid)
681           DO j=jMin,jMax
682            DO i=iMin,iMax
683             gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
684            ENDDO
685           ENDDO
686           CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,vCf,myThid)
687           DO j=jMin,jMax
688            DO i=iMin,iMax
689             gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
690            ENDDO
691           ENDDO
692          ENDIF
693    
694    C--   Set du/dt & dv/dt on boundaries to zero
695        DO j=jMin,jMax        DO j=jMin,jMax
696         DO i=iMin,iMax         DO i=iMin,iMax
697          gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))          gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)*_maskW(i,j,k,bi,bj)
698       &                    *_maskS(i,j,k,bi,bj)          gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)
699         ENDDO         ENDDO
700        ENDDO        ENDDO
       ENDIF  
701    
702        IF (  #ifdef ALLOW_DEBUG
703       &  DIFFERENT_MULTIPLE(diagFreq,myCurrentTime,        IF ( debugLevel .GE. debLevB
704       &                     myCurrentTime-deltaTClock)       &   .AND. k.EQ.4 .AND. myIter.EQ.nIter0
705       & ) THEN       &   .AND. nPx.EQ.1 .AND. nPy.EQ.1
706         CALL WRITE_LOCAL_RL('Ph','I10',Nr,phi_hyd,bi,bj,1,myIter,myThid)       &   .AND. useCubedSphereExchange ) THEN
707         CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid)          CALL DEBUG_CS_CORNER_UV( ' uDiss,vDiss from MOM_VECINV',
708         CALL WRITE_LOCAL_RL('Dt','I10',1,tension,bi,bj,k,myIter,myThid)       &             guDiss,gvDiss, k, standardMessageUnit,bi,bj,myThid )
709         CALL WRITE_LOCAL_RL('fV','I10',1,uCf,bi,bj,k,myIter,myThid)        ENDIF
710         CALL WRITE_LOCAL_RL('fU','I10',1,vCf,bi,bj,k,myIter,myThid)  #endif /* ALLOW_DEBUG */
711         CALL WRITE_LOCAL_RL('Du','I10',1,uDiss,bi,bj,k,myIter,myThid)  
712         CALL WRITE_LOCAL_RL('Dv','I10',1,vDiss,bi,bj,k,myIter,myThid)        IF ( writeDiag ) THEN
713         CALL WRITE_LOCAL_RL('Z3','I10',1,vort3,bi,bj,k,myIter,myThid)          IF (snapshot_mdsio) THEN
714         CALL WRITE_LOCAL_RL('W3','I10',1,omega3,bi,bj,k,myIter,myThid)           CALL WRITE_LOCAL_RL('W3','I10',1,omega3, bi,bj,k,myIter,myThid)
715         CALL WRITE_LOCAL_RL('KE','I10',1,KE,bi,bj,k,myIter,myThid)           CALL WRITE_LOCAL_RL('KE','I10',1,KE,     bi,bj,k,myIter,myThid)
716         CALL WRITE_LOCAL_RL('D','I10',1,hdiv,bi,bj,k,myIter,myThid)           CALL WRITE_LOCAL_RL('D', 'I10',1,hDiv,   bi,bj,k,myIter,myThid)
717             CALL WRITE_LOCAL_RL('Dt','I10',1,tension,bi,bj,k,myIter,myThid)
718             CALL WRITE_LOCAL_RL('Du','I10',1,guDiss, bi,bj,k,myIter,myThid)
719             CALL WRITE_LOCAL_RL('Dv','I10',1,gvDiss, bi,bj,k,myIter,myThid)
720            ENDIF
721    #ifdef ALLOW_MNC
722            IF (useMNC .AND. snapshot_mnc) THEN
723              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'W3',omega3,
724         &          offsets, myThid)
725              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'KE',KE,
726         &          offsets, myThid)
727              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'D', hDiv,
728         &          offsets, myThid)
729              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Dt',tension,
730         &          offsets, myThid)
731              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Du',guDiss,
732         &          offsets, myThid)
733              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Dv',gvDiss,
734         &          offsets, myThid)
735            ENDIF
736    #endif /*  ALLOW_MNC  */
737          ENDIF
738    
739    #ifdef ALLOW_DIAGNOSTICS
740          IF ( useDiagnostics ) THEN
741            CALL DIAGNOSTICS_FILL(KE,     'momKE   ',k,1,2,bi,bj,myThid)
742           IF (momViscosity) THEN
743            CALL DIAGNOSTICS_FILL(hDiv,   'momHDiv ',k,1,2,bi,bj,myThid)
744            CALL DIAGNOSTICS_FILL(tension,'Tension ',k,1,2,bi,bj,myThid)
745            CALL DIAGNOSTICS_FILL(guDiss, 'Um_Diss ',k,1,2,bi,bj,myThid)
746            CALL DIAGNOSTICS_FILL(gvDiss, 'Vm_Diss ',k,1,2,bi,bj,myThid)
747           ENDIF
748            CALL DIAGNOSTICS_FILL(gU(1-Olx,1-Oly,k,bi,bj),
749         &                                'Um_Advec',k,1,2,bi,bj,myThid)
750            CALL DIAGNOSTICS_FILL(gV(1-Olx,1-Oly,k,bi,bj),
751         &                                'Vm_Advec',k,1,2,bi,bj,myThid)
752        ENDIF        ENDIF
753    #endif /* ALLOW_DIAGNOSTICS */
754    
755    #endif /* ALLOW_MOM_VECINV */
756    
757        RETURN        RETURN
758        END        END
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.60
  ViewVC Help
Powered by ViewVC 1.1.22