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