/[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.1 by adcroft, Thu Aug 16 17:16:03 2001 UTC revision 1.65 by jmc, Tue Jun 7 22:22:34 2011 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, 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     myTime
63          INTEGER myIter
64        INTEGER myThid        INTEGER myThid
       _RL     myCurrentTime  
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 ==
70          LOGICAL  DIFFERENT_MULTIPLE
71          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        _RS hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL del2u   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
83        _RS r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL del2v   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
84        _RS xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL dStar   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
85        _RS yA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL zStar   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
86        _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL tension (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
87        _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL strain  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
88        _RL uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL KE      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
89        _RL vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL omega3  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
90        _RL dStar(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vort3   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
91        _RL zStar(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL hDiv    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
92        _RL uDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL viscAh_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
93        _RL vDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL viscAh_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
94  C     I,J,K - Loop counters        _RL viscA4_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
95          _RL viscA4_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
96    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     Initialise intermediate terms  C--   only the kDown part of fverU/V is set in this subroutine
116        DO J=1-OLy,sNy+OLy  C--   the kUp is still required
117         DO I=1-OLx,sNx+OLx  C--   In the case of mom_fluxform Kup is set as well
118          aF(i,j)   = 0.  C--   (at least in part)
119          vF(i,j)   = 0.        fVerU(1,1,kUp) = fVerU(1,1,kUp)
120          vrF(i,j)  = 0.        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
164          DO j=1-OLy,sNy+OLy
165           DO i=1-OLx,sNx+OLx
166            vF(i,j)    = 0.
167            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-    need to initialise hDiv for MOM_VI_DEL2UV(call FILL_CS_CORNER_TR_RL)
180            hDiv(i,j)  = 0.
181            viscAh_Z(i,j) = 0.
182            viscAh_D(i,j) = 0.
183            viscA4_Z(i,j) = 0.
184            viscA4_D(i,j) = 0.
185    
186            strain(i,j)  = 0. _d 0
187            tension(i,j) = 0. _d 0
188    #ifdef ALLOW_AUTODIFF_TAMC
189            hFacZ(i,j)   = 0. _d 0
190    #endif
191         ENDDO         ENDDO
192        ENDDO        ENDDO
193    
194  C--   Term by term tracer parmeters  C--   Term by term tracer parmeters
195  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.  
196        ArDudrFac    = vfFacMom*1.        ArDudrFac    = vfFacMom*1.
       mTFacU       = mtFacMom*1.  
       fuFac        = cfFacMom*1.  
       phxFac       = pfFacMom*1.  
197  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.  
198        ArDvdrFac    = vfFacMom*1.        ArDvdrFac    = vfFacMom*1.
199        mTFacV       = mtFacMom*1.  
200        fvFac        = cfFacMom*1.  C note: using standard stencil (no mask) results in under-estimating
201        phyFac       = pfFacMom*1.  C       vorticity at a no-slip boundary by a factor of 2 = sideDragFactor
202        vForcFac     = foFacMom*1.        IF ( no_slip_sides ) THEN
203            sideMaskFac = sideDragFactor
204          ELSE
205            sideMaskFac = 0. _d 0
206          ENDIF
207    
208        IF (     no_slip_bottom        IF (     no_slip_bottom
209       &    .OR. bottomDragQuadratic.NE.0.       &    .OR. bottomDragQuadratic.NE.0.
# Line 176  C     o V momentum equation Line 213  C     o V momentum equation
213         bottomDragTerms=.FALSE.         bottomDragTerms=.FALSE.
214        ENDIF        ENDIF
215    
 C-- with stagger time stepping, grad Phi_Hyp is directly incoporated in TIMESTEP  
       IF (staggerTimeStep) THEN  
         phxFac = 0.  
         phyFac = 0.  
       ENDIF  
   
216  C--   Calculate open water fraction at vorticity points  C--   Calculate open water fraction at vorticity points
217        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)
218    
 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  
   
219  C     Make local copies of horizontal flow field  C     Make local copies of horizontal flow field
220        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
221         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
# Line 204  C     Make local copies of horizontal fl Line 224  C     Make local copies of horizontal fl
224         ENDDO         ENDDO
225        ENDDO        ENDDO
226    
227  C     Calculate velocity field "volume transports" through tracer cell faces.  C note (jmc) : Dissipation and Vort3 advection do not necesary
228        DO j=1-OLy,sNy+OLy  C              use the same maskZ (and hFacZ)  => needs 2 call(s)
229         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  
230    
231        CALL MOM_VI_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid)        CALL MOM_CALC_KE(bi,bj,k,selectKEscheme,uFld,vFld,KE,myThid)
232    
233        CALL MOM_VI_CALC_HDIV(bi,bj,k,uFld,vFld,hDiv,myThid)        CALL MOM_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)
234    
235        CALL MOM_VI_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)        IF (momViscosity) THEN
236    C--    For viscous term, compute horizontal divergence, tension & strain
237    C      and mask relative vorticity (free-slip case):
238    
239        CALL MOM_VI_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)  #ifdef ALLOW_AUTODIFF_TAMC
240    CADJ STORE vort3(:,:) =
241    CADJ &     comlev1_bibj_k, key = imomkey, byte = isbyte
242    #endif
243    
244           CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid)
245    
246           CALL MOM_CALC_TENSION(bi,bj,k,uFld,vFld,tension,myThid)
247    
248           CALL MOM_CALC_STRAIN(bi,bj,k,uFld,vFld,hFacZ,strain,myThid)
249    
250    C-     account for no-slip / free-slip BC:
251           DO j=1-Oly,sNy+Oly
252            DO i=1-Olx,sNx+Olx
253              IF ( hFacZ(i,j).EQ.0. ) THEN
254                vort3(i,j)  = sideMaskFac*vort3(i,j)
255                strain(i,j) = sideMaskFac*strain(i,j)
256              ENDIF
257            ENDDO
258           ENDDO
259    
260    C--    Calculate Viscosities
261           CALL MOM_CALC_VISC(
262         I        bi,bj,k,
263         O        viscAh_Z,viscAh_D,viscA4_Z,viscA4_D,
264         O        harmonic,biharmonic,useVariableViscosity,
265         I        hDiv,vort3,tension,strain,KE,hfacZ,
266         I        myThid)
267    
       IF (momViscosity) THEN  
268  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
269         CALL MOM_VI_DEL2UV(         IF (biharmonic) THEN
270       I                    bi,bj,k,hDiv,vort3,hFacZ,           CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ,
271       O                    del2u,del2v,       O                      del2u,del2v,
272       &                    myThid)       &                      myThid)
273         CALL MOM_VI_CALC_HDIV(bi,bj,k,del2u,del2v,dStar,myThid)           CALL MOM_CALC_HDIV(bi,bj,k,2,del2u,del2v,dStar,myThid)
274         CALL MOM_VI_CALC_RELVORT3(bi,bj,k,del2u,del2v,hFacZ,zStar,myThid)           CALL MOM_CALC_RELVORT3(bi,bj,k,
275  C      Calculate dissipation terms for U and V equations       &                          del2u,del2v,hFacZ,zStar,myThid)
276         CALL MOM_VI_HDISSIP(           IF ( writeDiag ) THEN
277       I                     bi,bj,k,hDiv,vort3,hFacZ,dStar,zStar,             CALL WRITE_LOCAL_RL( 'del2u', 'I10', 1, del2u,
278       O                     uDiss,vDiss,       &                           bi,bj,k, myIter, myThid )
279       &                     myThid)             CALL WRITE_LOCAL_RL( 'del2v', 'I10', 1, del2v,
280         &                           bi,bj,k, myIter, myThid )
281               CALL WRITE_LOCAL_RL( 'dStar', 'I10', 1, dStar,
282         &                           bi,bj,k, myIter, myThid )
283               CALL WRITE_LOCAL_RL( 'zStar', 'I10', 1, zStar,
284         &                           bi,bj,k, myIter, myThid )
285             ENDIF
286           ENDIF
287    
288    C-    Strain diagnostics:
289           IF ( writeDiag ) THEN
290            IF (snapshot_mdsio) THEN
291              CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid)
292            ENDIF
293    #ifdef ALLOW_MNC
294            IF (useMNC .AND. snapshot_mnc) THEN
295              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Ds',strain,
296         &          offsets, myThid)
297            ENDIF
298    #endif /*  ALLOW_MNC  */
299           ENDIF
300    #ifdef ALLOW_DIAGNOSTICS
301           IF ( useDiagnostics ) THEN
302            CALL DIAGNOSTICS_FILL(strain, 'Strain  ',k,1,2,bi,bj,myThid)
303           ENDIF
304    #endif /* ALLOW_DIAGNOSTICS */
305    
306    C---   Calculate dissipation terms for U and V equations
307    
308    C      in terms of tension and strain
309           IF (useStrainTensionVisc) THEN
310    C        mask strain as if free-slip since side-drag is computed separately
311             DO j=1-Oly,sNy+Oly
312              DO i=1-Olx,sNx+Olx
313                IF ( hFacZ(i,j).EQ.0. ) strain(i,j) = 0. _d 0
314              ENDDO
315             ENDDO
316             CALL MOM_HDISSIP(bi,bj,k,hDiv,vort3,tension,strain,KE,
317         I                    hFacZ,
318         I                    viscAh_Z,viscAh_D,viscA4_Z,viscA4_D,
319         I                    harmonic,biharmonic,useVariableViscosity,
320         O                    guDiss,gvDiss,
321         I                    myThid)
322           ELSE
323    C      in terms of vorticity and divergence
324             CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,tension,strain,KE,
325         I                       hFacZ,dStar,zStar,
326         I                       viscAh_Z,viscAh_D,viscA4_Z,viscA4_D,
327         I                       harmonic,biharmonic,useVariableViscosity,
328         O                       guDiss,gvDiss,
329         &                       myThid)
330           ENDIF
331    C--   if (momViscosity) end of block.
332        ENDIF        ENDIF
333    
334  C---- Zonal momentum equation starts here  C-    Return to standard hfacZ (min-4) and mask vort3 accordingly:
335    c     CALL MOM_VI_MASK_VORT3(bi,bj,k,hFacZ,r_hFacZ,vort3,myThid)
336    
337    C---  Other dissipation terms in Zonal momentum equation
338    
339  C--   Vertical flux (fVer is at upper face of "u" cell)  C--   Vertical flux (fVer is at upper face of "u" cell)
340    
341  C     Eddy component of vertical flux (interior component only) -> vrF  C     Eddy component of vertical flux (interior component only) -> vrF
342        IF (momViscosity.AND..NOT.implicitViscosity)        IF (momViscosity.AND..NOT.implicitViscosity) THEN
343       & CALL MOM_U_RVISCFLUX(bi,bj,k,uVel,KappaRU,vrF,myThid)         CALL MOM_U_RVISCFLUX(bi,bj,k+1,uVel,KappaRU,vrF,myThid)
344    
345  C     Combine fluxes  C     Combine fluxes
346        DO j=jMin,jMax         DO j=jMin,jMax
347         DO i=iMin,iMax          DO i=iMin,iMax
348          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))  
349          ENDDO          ENDDO
350         ENDDO         ENDDO
       ENDIF  
351    
352  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term  C--   Tendency is minus divergence of the fluxes
353        DO j=2-Oly,sNy+Oly-1         DO j=2-Oly,sNy+Oly-1
354         DO i=2-Olx,sNx+Olx-1          DO i=2-Olx,sNx+Olx-1
355          gU(i,j,k,bi,bj) = uDiss(i,j)           guDiss(i,j) = guDiss(i,j)
356       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
357       &   *recip_rAw(i,j,bi,bj)       &   *recip_rAw(i,j,bi,bj)
358       &  *(       &  *(
359       &   +fVerU(i,j,kUp)*rkFac - fVerU(i,j,kDown)*rkFac       &    fVerU(i,j,kDown) - fVerU(i,j,kUp)
360       &   )       &   )*rkSign
361       & _PHM( +phxFac * pf(i,j) )          ENDDO
362         ENDDO         ENDDO
363        ENDDO        ENDIF
364    
365  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
366        IF (momViscosity.AND.no_slip_sides) THEN        IF (momViscosity.AND.no_slip_sides) THEN
367  C-     No-slip BCs impose a drag at walls...  C-     No-slip BCs impose a drag at walls...
368         CALL MOM_U_SIDEDRAG(bi,bj,k,uFld,del2u,hFacZ,vF,myThid)         CALL MOM_U_SIDEDRAG(
369         I        bi,bj,k,
370         I        uFld, del2u, hFacZ,
371         I        viscAh_Z,viscA4_Z,
372         I        harmonic,biharmonic,useVariableViscosity,
373         O        vF,
374         I        myThid)
375         DO j=jMin,jMax         DO j=jMin,jMax
376          DO i=iMin,iMax          DO i=iMin,iMax
377           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)           guDiss(i,j) = guDiss(i,j)+vF(i,j)
378          ENDDO          ENDDO
379         ENDDO         ENDDO
380        ENDIF        ENDIF
# Line 288  C-    No-slip BCs impose a drag at botto Line 383  C-    No-slip BCs impose a drag at botto
383         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
384         DO j=jMin,jMax         DO j=jMin,jMax
385          DO i=iMin,iMax          DO i=iMin,iMax
386           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)           guDiss(i,j) = guDiss(i,j)+vF(i,j)
387          ENDDO          ENDDO
388         ENDDO         ENDDO
389        ENDIF        ENDIF
390    #ifdef ALLOW_SHELFICE
391  C--   Forcing term        IF (useShelfIce.AND.momViscosity.AND.bottomDragTerms) THEN
392        IF (momForcing)         CALL SHELFICE_U_DRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
393       &  CALL EXTERNAL_FORCING_U(         DO j=jMin,jMax
394       I     iMin,iMax,jMin,jMax,bi,bj,k,          DO i=iMin,iMax
395       I     myCurrentTime,myThid)           guDiss(i,j) = guDiss(i,j) + vF(i,j)
396            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)  
397         ENDDO         ENDDO
398        ENDDO        ENDIF
399    #endif /* ALLOW_SHELFICE */
400    
401    
402  C---- Meridional momentum equation starts here  C---  Other dissipation terms in Meridional momentum equation
403    
404  C--   Vertical flux (fVer is at upper face of "v" cell)  C--   Vertical flux (fVer is at upper face of "v" cell)
405    
406  C     Eddy component of vertical flux (interior component only) -> vrF  C     Eddy component of vertical flux (interior component only) -> vrF
407        IF (momViscosity.AND..NOT.implicitViscosity)        IF (momViscosity.AND..NOT.implicitViscosity) THEN
408       & CALL MOM_V_RVISCFLUX(bi,bj,k,vVel,KappaRV,vrf,myThid)         CALL MOM_V_RVISCFLUX(bi,bj,k+1,vVel,KappaRV,vrF,myThid)
409    
410  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  
411         DO j=jMin,jMax         DO j=jMin,jMax
412          DO i=iMin,iMax          DO i=iMin,iMax
413           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))  
414          ENDDO          ENDDO
415         ENDDO         ENDDO
       ENDIF  
416    
417  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term  C--   Tendency is minus divergence of the fluxes
418        DO j=jMin,jMax         DO j=jMin,jMax
419         DO i=iMin,iMax          DO i=iMin,iMax
420          gV(i,j,k,bi,bj) = vDiss(i,j)           gvDiss(i,j) = gvDiss(i,j)
421       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
422       &    *recip_rAs(i,j,bi,bj)       &    *recip_rAs(i,j,bi,bj)
423       &  *(       &  *(
424       &   +fVerV(i,j,kUp)*rkFac - fVerV(i,j,kDown)*rkFac       &    fVerV(i,j,kDown) - fVerV(i,j,kUp)
425       &   )       &   )*rkSign
426       & _PHM( +phyFac*pf(i,j) )          ENDDO
427         ENDDO         ENDDO
428        ENDDO        ENDIF
429    
430  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
431        IF (momViscosity.AND.no_slip_sides) THEN        IF (momViscosity.AND.no_slip_sides) THEN
432  C-     No-slip BCs impose a drag at walls...  C-     No-slip BCs impose a drag at walls...
433         CALL MOM_V_SIDEDRAG(bi,bj,k,vFld,del2v,hFacZ,vF,myThid)         CALL MOM_V_SIDEDRAG(
434         I        bi,bj,k,
435         I        vFld, del2v, hFacZ,
436         I        viscAh_Z,viscA4_Z,
437         I        harmonic,biharmonic,useVariableViscosity,
438         O        vF,
439         I        myThid)
440         DO j=jMin,jMax         DO j=jMin,jMax
441          DO i=iMin,iMax          DO i=iMin,iMax
442           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)           gvDiss(i,j) = gvDiss(i,j)+vF(i,j)
443          ENDDO          ENDDO
444         ENDDO         ENDDO
445        ENDIF        ENDIF
# Line 371  C-    No-slip BCs impose a drag at botto Line 448  C-    No-slip BCs impose a drag at botto
448         CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)         CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)
449         DO j=jMin,jMax         DO j=jMin,jMax
450          DO i=iMin,iMax          DO i=iMin,iMax
451           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)           gvDiss(i,j) = gvDiss(i,j)+vF(i,j)
452          ENDDO          ENDDO
453         ENDDO         ENDDO
454        ENDIF        ENDIF
455    #ifdef ALLOW_SHELFICE
456          IF (useShelfIce.AND.momViscosity.AND.bottomDragTerms) THEN
457             CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRU,vF,myThid)
458             DO j=jMin,jMax
459              DO i=iMin,iMax
460               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
461              ENDDO
462             ENDDO
463            ENDIF
464    #endif /* ALLOW_SHELFICE */
465    
466    
467    C-    Vorticity diagnostics:
468          IF ( writeDiag ) THEN
469            IF (snapshot_mdsio) THEN
470              CALL WRITE_LOCAL_RL('Z3','I10',1,vort3, bi,bj,k,myIter,myThid)
471            ENDIF
472    #ifdef ALLOW_MNC
473            IF (useMNC .AND. snapshot_mnc) THEN
474              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Z3',vort3,
475         &          offsets, myThid)
476            ENDIF
477    #endif /*  ALLOW_MNC  */
478          ENDIF
479    #ifdef ALLOW_DIAGNOSTICS
480          IF ( useDiagnostics ) THEN
481            CALL DIAGNOSTICS_FILL(vort3,  'momVort3',k,1,2,bi,bj,myThid)
482          ENDIF
483    #endif /* ALLOW_DIAGNOSTICS */
484    
485  C--   Forcing term  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
       IF (momForcing)  
      & CALL EXTERNAL_FORCING_V(  
      I     iMin,iMax,jMin,jMax,bi,bj,k,  
      I     myCurrentTime,myThid)  
   
 C--   Metric terms for curvilinear grid systems  
 c     IF (usingSphericalPolarMTerms) THEN  
 C      o Spherical polar grid metric terms  
 c      CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,mT,myThid)  
 c      DO j=jMin,jMax  
 c       DO i=iMin,iMax  
 c        gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+mTFacV*mT(i,j)  
 c       ENDDO  
 c      ENDDO  
 c     ENDIF  
486    
487  C--   Set dv/dt on boundaries to zero  C---  Prepare for Advection & Coriolis terms:
488        DO j=jMin,jMax  C-    Mask relative vorticity and calculate absolute vorticity
489         DO i=iMin,iMax        DO j=1-Oly,sNy+Oly
490          gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)         DO i=1-Olx,sNx+Olx
491             IF ( hFacZ(i,j).EQ.0. ) vort3(i,j) = 0.
492         ENDDO         ENDDO
493        ENDDO        ENDDO
494          IF (useAbsVorticity)
495         &  CALL MOM_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)
496    
497  C--   Horizontal Coriolis terms  C--   Horizontal Coriolis terms
498        CALL MOM_VI_CORIOLIS(bi,bj,K,uFld,vFld,omega3,r_hFacZ,  c     IF (useCoriolis .AND. .NOT.useCDscheme
499       &                     uCf,vCf,myThid)  c    &    .AND. .NOT. useAbsVorticity) THEN
500        DO j=jMin,jMax  C- jmc: change it to keep the Coriolis terms when useAbsVorticity=T & momAdvection=F
501         DO i=iMin,iMax        IF ( useCoriolis .AND.
502          gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j))       &     .NOT.( useCDscheme .OR. useAbsVorticity.AND.momAdvection )
503       &                    *_maskW(i,j,k,bi,bj)       &   ) THEN
504          gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))         IF (useAbsVorticity) THEN
505       &                    *_maskS(i,j,k,bi,bj)          CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,hFacZ,r_hFacZ,
506         ENDDO       &                         uCf,myThid)
507        ENDDO          CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,hFacZ,r_hFacZ,
508  c     CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid)       &                         vCf,myThid)
509        CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid)         ELSE
510  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,
511        DO j=jMin,jMax       &                       uCf,vCf,myThid)
512         DO i=iMin,iMax         ENDIF
513          gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j))         DO j=jMin,jMax
514       &                    *_maskW(i,j,k,bi,bj)          DO i=iMin,iMax
515             gU(i,j,k,bi,bj) = uCf(i,j)
516             gV(i,j,k,bi,bj) = vCf(i,j)
517            ENDDO
518         ENDDO         ENDDO
519        ENDDO         IF ( writeDiag ) THEN
520  c     CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,r_hFacZ,vCf,myThid)           IF (snapshot_mdsio) THEN
521        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)
522  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)
523        DO j=jMin,jMax           ENDIF
524         DO i=iMin,iMax  #ifdef ALLOW_MNC
525          gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))           IF (useMNC .AND. snapshot_mnc) THEN
526       &                    *_maskS(i,j,k,bi,bj)             CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'fV', uCf,
527         &          offsets, myThid)
528               CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'fU', vCf,
529         &          offsets, myThid)
530             ENDIF
531    #endif /*  ALLOW_MNC  */
532           ENDIF
533    #ifdef ALLOW_DIAGNOSTICS
534           IF ( useDiagnostics ) THEN
535             CALL DIAGNOSTICS_FILL(uCf,'Um_Cori ',k,1,2,bi,bj,myThid)
536             CALL DIAGNOSTICS_FILL(vCf,'Vm_Cori ',k,1,2,bi,bj,myThid)
537           ENDIF
538    #endif /* ALLOW_DIAGNOSTICS */
539          ELSE
540           DO j=jMin,jMax
541            DO i=iMin,iMax
542             gU(i,j,k,bi,bj) = 0. _d 0
543             gV(i,j,k,bi,bj) = 0. _d 0
544            ENDDO
545         ENDDO         ENDDO
546        ENDDO        ENDIF
547    
548        IF (momAdvection) THEN        IF (momAdvection) THEN
549  C--   Vertical shear terms (Coriolis)  C--   Horizontal advection of relative (or absolute) vorticity
550        CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid)         IF ( (highOrderVorticity.OR.upwindVorticity)
551        DO j=jMin,jMax       &     .AND.useAbsVorticity ) THEN
552         DO i=iMin,iMax          CALL MOM_VI_U_CORIOLIS_C4(bi,bj,k,vFld,omega3,r_hFacZ,
553          gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j))       &                         uCf,myThid)
554       &                    *_maskW(i,j,k,bi,bj)         ELSEIF ( (highOrderVorticity.OR.upwindVorticity) ) THEN
555            CALL MOM_VI_U_CORIOLIS_C4(bi,bj,k,vFld,vort3, r_hFacZ,
556         &                         uCf,myThid)
557           ELSEIF ( useAbsVorticity ) THEN
558            CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,hFacZ,r_hFacZ,
559         &                         uCf,myThid)
560           ELSE
561            CALL MOM_VI_U_CORIOLIS(bi,bj,k,vFld,vort3, hFacZ,r_hFacZ,
562         &                         uCf,myThid)
563           ENDIF
564           DO j=jMin,jMax
565            DO i=iMin,iMax
566             gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
567            ENDDO
568         ENDDO         ENDDO
569        ENDDO         IF ( (highOrderVorticity.OR.upwindVorticity)
570        CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid)       &     .AND.useAbsVorticity ) THEN
571        DO j=jMin,jMax          CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,omega3,r_hFacZ,
572         DO i=iMin,iMax       &                         vCf,myThid)
573          gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))         ELSEIF ( (highOrderVorticity.OR.upwindVorticity) ) THEN
574       &                    *_maskS(i,j,k,bi,bj)          CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,vort3, r_hFacZ,
575         &                         vCf,myThid)
576           ELSEIF ( useAbsVorticity ) THEN
577            CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,hFacZ,r_hFacZ,
578         &                         vCf,myThid)
579           ELSE
580            CALL MOM_VI_V_CORIOLIS(bi,bj,k,uFld,vort3, hFacZ,r_hFacZ,
581         &                         vCf,myThid)
582           ENDIF
583           DO j=jMin,jMax
584            DO i=iMin,iMax
585             gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
586            ENDDO
587         ENDDO         ENDDO
588        ENDDO  
589           IF ( writeDiag ) THEN
590             IF (snapshot_mdsio) THEN
591               CALL WRITE_LOCAL_RL('zV','I10',1,uCf,bi,bj,k,myIter,myThid)
592               CALL WRITE_LOCAL_RL('zU','I10',1,vCf,bi,bj,k,myIter,myThid)
593             ENDIF
594    #ifdef ALLOW_MNC
595             IF (useMNC .AND. snapshot_mnc) THEN
596               CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'zV', uCf,
597         &          offsets, myThid)
598               CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'zU', vCf,
599         &          offsets, myThid)
600             ENDIF
601    #endif /*  ALLOW_MNC  */
602           ENDIF
603    
604    #ifdef ALLOW_TIMEAVE
605           IF (taveFreq.GT.0.) THEN
606             CALL TIMEAVE_CUMUL_1K1T(uZetatave,vCf,deltaTClock,
607         &                           Nr, k, bi, bj, myThid)
608             CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock,
609         &                           Nr, k, bi, bj, myThid)
610           ENDIF
611    #endif /* ALLOW_TIMEAVE */
612    #ifdef ALLOW_DIAGNOSTICS
613           IF ( useDiagnostics ) THEN
614             CALL DIAGNOSTICS_FILL(uCf,'Um_AdvZ3',k,1,2,bi,bj,myThid)
615             CALL DIAGNOSTICS_FILL(vCf,'Vm_AdvZ3',k,1,2,bi,bj,myThid)
616           ENDIF
617    #endif /* ALLOW_DIAGNOSTICS */
618    
619    C--   Vertical shear terms (-w*du/dr & -w*dv/dr)
620           IF ( .NOT. momImplVertAdv ) THEN
621            CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid)
622            DO j=jMin,jMax
623             DO i=iMin,iMax
624              gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
625             ENDDO
626            ENDDO
627            CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid)
628            DO j=jMin,jMax
629             DO i=iMin,iMax
630              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
631             ENDDO
632            ENDDO
633    #ifdef ALLOW_DIAGNOSTICS
634            IF ( useDiagnostics ) THEN
635             CALL DIAGNOSTICS_FILL(uCf,'Um_AdvRe',k,1,2,bi,bj,myThid)
636             CALL DIAGNOSTICS_FILL(vCf,'Vm_AdvRe',k,1,2,bi,bj,myThid)
637            ENDIF
638    #endif /* ALLOW_DIAGNOSTICS */
639           ENDIF
640    
641  C--   Bernoulli term  C--   Bernoulli term
642        CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid)         CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid)
643        DO j=jMin,jMax         DO j=jMin,jMax
644         DO i=iMin,iMax          DO i=iMin,iMax
645          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)
646       &                    *_maskW(i,j,k,bi,bj)          ENDDO
647         ENDDO         ENDDO
648        ENDDO         CALL MOM_VI_V_GRAD_KE(bi,bj,K,KE,vCf,myThid)
649        CALL MOM_VI_V_GRAD_KE(bi,bj,K,KE,vCf,myThid)         DO j=jMin,jMax
650            DO i=iMin,iMax
651             gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
652            ENDDO
653           ENDDO
654           IF ( writeDiag ) THEN
655             IF (snapshot_mdsio) THEN
656               CALL WRITE_LOCAL_RL('KEx','I10',1,uCf,bi,bj,k,myIter,myThid)
657               CALL WRITE_LOCAL_RL('KEy','I10',1,vCf,bi,bj,k,myIter,myThid)
658             ENDIF
659    #ifdef ALLOW_MNC
660             IF (useMNC .AND. snapshot_mnc) THEN
661               CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'KEx', uCf,
662         &          offsets, myThid)
663               CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'KEy', vCf,
664         &          offsets, myThid)
665             ENDIF
666    #endif /*  ALLOW_MNC  */
667           ENDIF
668    
669    C--   end if momAdvection
670          ENDIF
671    
672    C--   3.D Coriolis term (horizontal momentum, Eastward component: -fprime*w)
673          IF ( use3dCoriolis ) THEN
674            CALL MOM_U_CORIOLIS_NH(bi,bj,k,wVel,uCf,myThid)
675            DO j=jMin,jMax
676             DO i=iMin,iMax
677              gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
678             ENDDO
679            ENDDO
680           IF ( usingCurvilinearGrid ) THEN
681    C-     presently, non zero angleSinC array only supported with Curvilinear-Grid
682            CALL MOM_V_CORIOLIS_NH(bi,bj,k,wVel,vCf,myThid)
683            DO j=jMin,jMax
684             DO i=iMin,iMax
685              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
686             ENDDO
687            ENDDO
688           ENDIF
689          ENDIF
690    
691    C--   Non-Hydrostatic (spherical) metric terms
692          IF ( useNHMTerms ) THEN
693           CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,uCf,myThid)
694           DO j=jMin,jMax
695            DO i=iMin,iMax
696             gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
697            ENDDO
698           ENDDO
699           CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,vCf,myThid)
700           DO j=jMin,jMax
701            DO i=iMin,iMax
702             gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
703            ENDDO
704           ENDDO
705          ENDIF
706    
707    C--   Set du/dt & dv/dt on boundaries to zero
708        DO j=jMin,jMax        DO j=jMin,jMax
709         DO i=iMin,iMax         DO i=iMin,iMax
710          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)
711       &                    *_maskS(i,j,k,bi,bj)          gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)
712         ENDDO         ENDDO
713        ENDDO        ENDDO
714    
715    #ifdef ALLOW_DEBUG
716          IF ( debugLevel .GE. debLevC
717         &   .AND. k.EQ.4 .AND. myIter.EQ.nIter0
718         &   .AND. nPx.EQ.1 .AND. nPy.EQ.1
719         &   .AND. useCubedSphereExchange ) THEN
720            CALL DEBUG_CS_CORNER_UV( ' uDiss,vDiss from MOM_VECINV',
721         &             guDiss,gvDiss, k, standardMessageUnit,bi,bj,myThid )
722          ENDIF
723    #endif /* ALLOW_DEBUG */
724    
725          IF ( writeDiag ) THEN
726            IF (snapshot_mdsio) THEN
727             CALL WRITE_LOCAL_RL('W3','I10',1,omega3, bi,bj,k,myIter,myThid)
728             CALL WRITE_LOCAL_RL('KE','I10',1,KE,     bi,bj,k,myIter,myThid)
729             CALL WRITE_LOCAL_RL('D', 'I10',1,hDiv,   bi,bj,k,myIter,myThid)
730             CALL WRITE_LOCAL_RL('Dt','I10',1,tension,bi,bj,k,myIter,myThid)
731             CALL WRITE_LOCAL_RL('Du','I10',1,guDiss, bi,bj,k,myIter,myThid)
732             CALL WRITE_LOCAL_RL('Dv','I10',1,gvDiss, bi,bj,k,myIter,myThid)
733            ENDIF
734    #ifdef ALLOW_MNC
735            IF (useMNC .AND. snapshot_mnc) THEN
736              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'W3',omega3,
737         &          offsets, myThid)
738              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'KE',KE,
739         &          offsets, myThid)
740              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'D', hDiv,
741         &          offsets, myThid)
742              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Dt',tension,
743         &          offsets, myThid)
744              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Du',guDiss,
745         &          offsets, myThid)
746              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Dv',gvDiss,
747         &          offsets, myThid)
748            ENDIF
749    #endif /*  ALLOW_MNC  */
750          ENDIF
751    
752    #ifdef ALLOW_DIAGNOSTICS
753          IF ( useDiagnostics ) THEN
754            CALL DIAGNOSTICS_FILL(KE,     'momKE   ',k,1,2,bi,bj,myThid)
755           IF (momViscosity) THEN
756            CALL DIAGNOSTICS_FILL(hDiv,   'momHDiv ',k,1,2,bi,bj,myThid)
757            CALL DIAGNOSTICS_FILL(tension,'Tension ',k,1,2,bi,bj,myThid)
758            CALL DIAGNOSTICS_FILL(guDiss, 'Um_Diss ',k,1,2,bi,bj,myThid)
759            CALL DIAGNOSTICS_FILL(gvDiss, 'Vm_Diss ',k,1,2,bi,bj,myThid)
760           ENDIF
761            CALL DIAGNOSTICS_FILL(gU(1-Olx,1-Oly,k,bi,bj),
762         &                                'Um_Advec',k,1,2,bi,bj,myThid)
763            CALL DIAGNOSTICS_FILL(gV(1-Olx,1-Oly,k,bi,bj),
764         &                                'Vm_Advec',k,1,2,bi,bj,myThid)
765        ENDIF        ENDIF
766    #endif /* ALLOW_DIAGNOSTICS */
767    
768    #endif /* ALLOW_MOM_VECINV */
769    
770        RETURN        RETURN
771        END        END
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.65
  ViewVC Help
Powered by ViewVC 1.1.22