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

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

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

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