/[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.34 by jmc, Thu Mar 30 19:49:41 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    #include "MOM_FLUXFORM_OPTIONS.h"
29    
30    CBOP
31    C !ROUTINE: MOM_FLUXFORM
32    
33    C !INTERFACE: ==========================================================
34        SUBROUTINE MOM_FLUXFORM(        SUBROUTINE MOM_FLUXFORM(
35       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,
36       I        phi_hyd,KappaRU,KappaRV,       I        KappaRU, KappaRV,
37       U        fVerU, fVerV,       U        fVerU, fVerV,
38       I        myCurrentTime, 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 34  C     == Global variables == Line 53  C     == Global variables ==
53  #include "GRID.h"  #include "GRID.h"
54  #include "SURFACE.h"  #include "SURFACE.h"
55    
56  C     == Routine arguments ==  C !INPUT PARAMETERS: ===================================================
57  C     fZon    - Work array for flux of momentum in the east-west  C  bi,bj                :: tile indices
58  C               direction at the west face of a cell.  C  iMin,iMax,jMin,jMAx  :: loop ranges
59  C     fMer    - Work array for flux of momentum in the north-south  C  k                    :: vertical level
60  C               direction at the south face of a cell.  C  kUp                  :: =1 or 2 for consecutive k
61  C     fVerU   - Flux of momentum in the vertical  C  kDown                :: =2 or 1 for consecutive k
62  C     fVerV     direction out of the upper face of a cell K  C  KappaRU              :: vertical viscosity
63  C               ( flux into the cell above ).  C  KappaRV              :: vertical viscosity
64  C     phi_hyd - Hydrostatic pressure  C  fVerU                :: vertical flux of U, 2 1/2 dim for pipe-lining
65  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
66  C                                      results will be set.  C  guDiss               :: dissipation tendency (all explicit terms), u component
67  C     kUp, kDown                     - Index for upper and lower layers.  C  gvDiss               :: dissipation tendency (all explicit terms), v component
68  C     myThid - Instance number for this innvocation of CALC_MOM_RHS  C  myTime               :: current time
69        _RL phi_hyd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  C  myIter               :: current time-step number
70    C  myThid               :: thread number
71          INTEGER bi,bj,iMin,iMax,jMin,jMax
72          INTEGER k,kUp,kDown
73        _RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
74        _RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
75        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
76        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
77        INTEGER kUp,kDown        _RL guDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
78          _RL gvDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
79          _RL     myTime
80          INTEGER myIter
81        INTEGER myThid        INTEGER myThid
       _RL     myCurrentTime  
       INTEGER bi,bj,iMin,iMax,jMin,jMax  
82    
83  C     == Local variables ==  C !OUTPUT PARAMETERS: ==================================================
84  C     ab15, ab05    - Weights for Adams-Bashforth time stepping scheme.  C None - updates gU() and gV() in common blocks
85  C     i,j,k         - Loop counters  
86  C     wMaskOverride - Land sea flag override for top layer.  C !LOCAL VARIABLES: ====================================================
87  C     afFacMom      - Tracer parameters for turning terms  C  i,j                  :: loop indices
88  C     vfFacMom        on and off.  C  vF                   :: viscous flux
89    C  v4F                  :: bi-harmonic viscous flux
90    C  cF                   :: Coriolis acceleration
91    C  mT                   :: Metric terms
92    C  fZon                 :: zonal fluxes
93    C  fMer                 :: meridional fluxes
94    C  fVrUp,fVrDw          :: vertical viscous fluxes at interface k-1 & k
95          INTEGER i,j
96          _RL vF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
97          _RL v4F(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
98          _RL cF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
99          _RL mT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
100          _RL fZon(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
101          _RL fMer(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
102          _RL fVrUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
103          _RL fVrDw(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
104    C     afFacMom     :: Tracer parameters for turning terms on and off.
105    C     vfFacMom        
106  C     pfFacMom        afFacMom - Advective terms  C     pfFacMom        afFacMom - Advective terms
107  C     cfFacMom        vfFacMom - Eddy viscosity terms  C     cfFacMom        vfFacMom - Eddy viscosity terms
108  C     mTFacMom        pfFacMom - Pressure terms  C     mtFacMom        pfFacMom - Pressure terms
109  C                     cfFacMom - Coriolis terms  C                     cfFacMom - Coriolis terms
110  C                     foFacMom - Forcing  C                     foFacMom - Forcing
111  C                     mTFacMom - Metric term  C                     mtFacMom - Metric term
112  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)  
113        _RS    hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS    hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
114        _RS  r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS  r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
115        _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 118  C     uDudxFac, AhDudxFac, etc ... indiv
118        _RL  vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL  vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
119        _RL  uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL  uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
120        _RL  vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL  vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
121  C     I,J,K - Loop counters        _RL  rTransU(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
122        INTEGER i,j,k        _RL  rTransV(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
123  C     rVelMaskOverride - Factor for imposing special surface boundary conditions        _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
124  C                        ( set according to free-surface condition ).        _RL viscAh_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
125  C     hFacROpen        - Lopped cell factos used tohold fraction of open        _RL viscAh_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
126  C     hFacRClosed        and closed cell wall.        _RL viscA4_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
127        _RL  rVelMaskOverride        _RL viscA4_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
128  C     xxxFac - On-off tracer parameters used for switching terms off.        _RL vort3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
129          _RL hDiv(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
130          _RL strain(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
131          _RL tension(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
132        _RL  uDudxFac        _RL  uDudxFac
133        _RL  AhDudxFac        _RL  AhDudxFac
       _RL  A4DuxxdxFac  
134        _RL  vDudyFac        _RL  vDudyFac
135        _RL  AhDudyFac        _RL  AhDudyFac
       _RL  A4DuyydyFac  
136        _RL  rVelDudrFac        _RL  rVelDudrFac
137        _RL  ArDudrFac        _RL  ArDudrFac
138        _RL  fuFac        _RL  fuFac
       _RL  phxFac  
139        _RL  mtFacU        _RL  mtFacU
140          _RL  mtNHFacU
141        _RL  uDvdxFac        _RL  uDvdxFac
142        _RL  AhDvdxFac        _RL  AhDvdxFac
       _RL  A4DvxxdxFac  
143        _RL  vDvdyFac        _RL  vDvdyFac
144        _RL  AhDvdyFac        _RL  AhDvdyFac
       _RL  A4DvyydyFac  
145        _RL  rVelDvdrFac        _RL  rVelDvdrFac
146        _RL  ArDvdrFac        _RL  ArDvdrFac
147        _RL  fvFac        _RL  fvFac
       _RL  phyFac  
       _RL  vForcFac  
148        _RL  mtFacV        _RL  mtFacV
149  C     ab05, ab15 - Adams-Bashforth time-stepping weights.        _RL  mtNHFacV
150        _RL  ab05, ab15        _RL  sideMaskFac
151        INTEGER km1,kp1        LOGICAL bottomDragTerms,harmonic,biharmonic,useVariableViscosity
152        _RL wVelBottomOverride  CEOP
       LOGICAL bottomDragTerms  
       _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
   
       km1=MAX(1,k-1)  
       kp1=MIN(Nr,k+1)  
       rVelMaskOverride=1.  
       IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac  
       wVelBottomOverride=1.  
       IF (k.EQ.Nr) wVelBottomOverride=0.  
153    
154  C     Initialise intermediate terms  C     Initialise intermediate terms
155        DO J=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
156         DO I=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
         aF(i,j)   = 0.  
157          vF(i,j)   = 0.          vF(i,j)   = 0.
158          v4F(i,j)  = 0.          v4F(i,j)  = 0.
         vrF(i,j)  = 0.  
159          cF(i,j)   = 0.          cF(i,j)   = 0.
160          mT(i,j)   = 0.          mT(i,j)   = 0.
         pF(i,j)   = 0.  
161          fZon(i,j) = 0.          fZon(i,j) = 0.
162          fMer(i,j) = 0.          fMer(i,j) = 0.
163            fVrUp(i,j)= 0.
164            fVrDw(i,j)= 0.
165            rTransU(i,j)= 0.
166            rTransV(i,j)= 0.
167            strain(i,j) = 0.
168            tension(i,j)= 0.
169            guDiss(i,j) = 0.
170            gvDiss(i,j) = 0.
171    #ifdef ALLOW_AUTODIFF_TAMC
172            vort3(i,j)   = 0. _d 0
173            strain(i,j)  = 0. _d 0
174            tension(i,j) = 0. _d 0
175    #endif
176         ENDDO         ENDDO
177        ENDDO        ENDDO
178    
# Line 156  C--   Term by term tracer parmeters Line 180  C--   Term by term tracer parmeters
180  C     o U momentum equation  C     o U momentum equation
181        uDudxFac     = afFacMom*1.        uDudxFac     = afFacMom*1.
182        AhDudxFac    = vfFacMom*1.        AhDudxFac    = vfFacMom*1.
       A4DuxxdxFac  = vfFacMom*1.  
183        vDudyFac     = afFacMom*1.        vDudyFac     = afFacMom*1.
184        AhDudyFac    = vfFacMom*1.        AhDudyFac    = vfFacMom*1.
       A4DuyydyFac  = vfFacMom*1.  
185        rVelDudrFac  = afFacMom*1.        rVelDudrFac  = afFacMom*1.
186        ArDudrFac    = vfFacMom*1.        ArDudrFac    = vfFacMom*1.
187        mTFacU       = mtFacMom*1.        mtFacU       = mtFacMom*1.
188          mtNHFacU     = 1.
189        fuFac        = cfFacMom*1.        fuFac        = cfFacMom*1.
       phxFac       = pfFacMom*1.  
190  C     o V momentum equation  C     o V momentum equation
191        uDvdxFac     = afFacMom*1.        uDvdxFac     = afFacMom*1.
192        AhDvdxFac    = vfFacMom*1.        AhDvdxFac    = vfFacMom*1.
       A4DvxxdxFac  = vfFacMom*1.  
193        vDvdyFac     = afFacMom*1.        vDvdyFac     = afFacMom*1.
194        AhDvdyFac    = vfFacMom*1.        AhDvdyFac    = vfFacMom*1.
       A4DvyydyFac  = vfFacMom*1.  
195        rVelDvdrFac  = afFacMom*1.        rVelDvdrFac  = afFacMom*1.
196        ArDvdrFac    = vfFacMom*1.        ArDvdrFac    = vfFacMom*1.
197        mTFacV       = mtFacMom*1.        mtFacV       = mtFacMom*1.
198          mtNHFacV     = 1.
199        fvFac        = cfFacMom*1.        fvFac        = cfFacMom*1.
200        phyFac       = pfFacMom*1.  
201        vForcFac     = foFacMom*1.        IF (implicitViscosity) THEN
202            ArDudrFac  = 0.
203            ArDvdrFac  = 0.
204          ENDIF
205    
206    C note: using standard stencil (no mask) results in under-estimating
207    C       vorticity at a no-slip boundary by a factor of 2 = sideDragFactor
208          IF ( no_slip_sides ) THEN
209            sideMaskFac = sideDragFactor
210          ELSE
211            sideMaskFac = 0. _d 0
212          ENDIF
213    
214        IF (     no_slip_bottom        IF (     no_slip_bottom
215       &    .OR. bottomDragQuadratic.NE.0.       &    .OR. bottomDragQuadratic.NE.0.
# Line 187  C     o V momentum equation Line 219  C     o V momentum equation
219         bottomDragTerms=.FALSE.         bottomDragTerms=.FALSE.
220        ENDIF        ENDIF
221    
 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  
     
222  C--   Calculate open water fraction at vorticity points  C--   Calculate open water fraction at vorticity points
223        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)
224    
# Line 227  C     Calculate velocity field "volume t Line 249  C     Calculate velocity field "volume t
249         ENDDO         ENDDO
250        ENDDO        ENDDO
251    
252        CALL MOM_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid)        CALL MOM_CALC_KE(bi,bj,k,2,uFld,vFld,KE,myThid)
253          IF ( momViscosity) THEN
254            CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid)
255            CALL MOM_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)
256            CALL MOM_CALC_TENSION(bi,bj,k,uFld,vFld,tension,myThid)
257            CALL MOM_CALC_STRAIN(bi,bj,k,uFld,vFld,hFacZ,strain,myThid)
258            DO j=1-Oly,sNy+Oly
259             DO i=1-Olx,sNx+Olx
260               IF ( hFacZ(i,j).EQ.0. ) THEN
261                 vort3(i,j)  = sideMaskFac*vort3(i,j)
262                 strain(i,j) = sideMaskFac*strain(i,j)
263               ENDIF
264             ENDDO
265            ENDDO
266    #ifdef ALLOW_DIAGNOSTICS
267            IF ( useDiagnostics ) THEN
268              CALL DIAGNOSTICS_FILL(hDiv,   'momHDiv ',k,1,2,bi,bj,myThid)
269              CALL DIAGNOSTICS_FILL(vort3,  'momVort3',k,1,2,bi,bj,myThid)
270              CALL DIAGNOSTICS_FILL(tension,'Tension ',k,1,2,bi,bj,myThid)
271              CALL DIAGNOSTICS_FILL(strain, 'Strain  ',k,1,2,bi,bj,myThid)
272            ENDIF
273    #endif
274          ENDIF
275    
276  C---- Zonal momentum equation starts here  C---  First call (k=1): compute vertical adv. flux fVerU(kUp) & fVerV(kUp)
277          IF (momAdvection.AND.k.EQ.1) THEN
278    
279  C     Bi-harmonic term del^2 U -> v4F  C-    Calculate vertical transports above U & V points (West & South face):
280        IF (momViscosity)          CALL MOM_CALC_RTRANS( k, bi, bj,
281       & CALL MOM_U_DEL2U(bi,bj,k,uFld,hFacZ,v4f,myThid)       O                        rTransU, rTransV,
282         I                        myTime, myIter, myThid)
283    
284  C---  Calculate mean and eddy fluxes between cells for zonal flow.  C-    Free surface correction term (flux at k=1)
285            CALL MOM_U_ADV_WU( bi,bj,k,uVel,wVel,rTransU,
286         O                     fVerU(1-OLx,1-OLy,kUp), myThid )
287    
288  C--   Zonal flux (fZon is at east face of "u" cell)          CALL MOM_V_ADV_WV( bi,bj,k,vVel,wVel,rTransV,
289         O                     fVerV(1-OLx,1-OLy,kUp), myThid )
290    
291  C     Mean flow component of zonal flux -> aF  C---  endif momAdvection & k=1
292        IF (momAdvection)        ENDIF
      & 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)  
293    
 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  
294    
295  C--   Meridional flux (fMer is at south face of "u" cell)  C---  Calculate vertical transports (at k+1) below U & V points :
296          IF (momAdvection) THEN
297            CALL MOM_CALC_RTRANS( k+1, bi, bj,
298         O                        rTransU, rTransV,
299         I                        myTime, myIter, myThid)
300          ENDIF
301    
302  C     Mean flow component of meridional flux        IF (momViscosity) THEN
303        IF (momAdvection)         CALL MOM_CALC_VISC(
304       & CALL MOM_U_ADV_VU(bi,bj,k,vTrans,uFld,aF,myThid)       I        bi,bj,k,
305         O        viscAh_Z,viscAh_D,viscA4_Z,viscA4_D,
306  C     Laplacian and bi-harmonic term       O        harmonic,biharmonic,useVariableViscosity,
307        IF (momViscosity)       I        hDiv,vort3,tension,strain,KE,hFacZ,
308       & CALL MOM_U_YVISCFLUX(bi,bj,k,uFld,v4F,hFacZ,vF,myThid)       I        myThid)
309          ENDIF
310    
311  C     Combine fluxes -> fMer  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
312        DO j=jMin,jMax  
313         DO i=iMin,iMax  C---- Zonal momentum equation starts here
314          fMer(i,j) = vDudyFac*aF(i,j) + AhDudyFac*vF(i,j)  
315         ENDDO        IF (momAdvection) THEN
316        ENDDO  C---  Calculate mean fluxes (advection)   between cells for zonal flow.
317    
318    C--   Zonal flux (fZon is at east face of "u" cell)
319    C     Mean flow component of zonal flux -> fZon
320            CALL MOM_U_ADV_UU(bi,bj,k,uTrans,uFld,fZon,myThid)
321    
322    C--   Meridional flux (fMer is at south face of "u" cell)
323    C     Mean flow component of meridional flux -> fMer
324            CALL MOM_U_ADV_VU(bi,bj,k,vTrans,uFld,fMer,myThid)
325    
326  C--   Vertical flux (fVer is at upper face of "u" cell)  C--   Vertical flux (fVer is at upper face of "u" cell)
327    C     Mean flow component of vertical flux (at k+1) -> fVer
328            CALL MOM_U_ADV_WU(
329         I                     bi,bj,k+1,uVel,wVel,rTransU,
330         O                     fVerU(1-OLx,1-OLy,kDown), myThid )
331    
332  C--   Free surface correction term (flux at k=1)  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
333        IF (momAdvection.AND.k.EQ.1) THEN          DO j=jMin,jMax
334         CALL MOM_U_ADV_WU(bi,bj,k,uVel,wVel,af,myThid)           DO i=iMin,iMax
335         DO j=jMin,jMax            gU(i,j,k,bi,bj) =
336          DO i=iMin,iMax  #ifdef OLD_UV_GEOM
337           fVerU(i,j,kUp) = af(i,j)       &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/
338         &      ( 0.5 _d 0*(rA(i,j,bi,bj)+rA(i-1,j,bi,bj)) )
339    #else
340         &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
341         &     *recip_rAw(i,j,bi,bj)
342    #endif
343         &    *( ( fZon(i,j  )     - fZon(i-1,j) )*uDudxFac
344         &      +( fMer(i,j+1)     - fMer(i,  j) )*vDudyFac
345         &      +(fVerU(i,j,kDown) - fVerU(i,j,kUp))*rkSign*rVelDudrFac
346         &     )
347             ENDDO
348          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)  
349    
350  C     Eddy component of vertical flux (interior component only) -> vrF  #ifdef ALLOW_DIAGNOSTICS
351        IF (momViscosity.AND..NOT.implicitViscosity)          IF ( useDiagnostics ) THEN
352       & CALL MOM_U_RVISCFLUX(bi,bj,k,uVel,KappaRU,vrF,myThid)            CALL DIAGNOSTICS_FILL(fZon,'ADVx_Um ',k,1,2,bi,bj,myThid)
353              CALL DIAGNOSTICS_FILL(fMer,'ADVy_Um ',k,1,2,bi,bj,myThid)
354              CALL DIAGNOSTICS_FILL(fVerU(1-Olx,1-Oly,kUp),
355         &                               'ADVrE_Um',k,1,2,bi,bj,myThid)
356            ENDIF
357    #endif
358    
359  C     Combine fluxes  #ifdef NONLIN_FRSURF
360        DO j=jMin,jMax  C-- account for 3.D divergence of the flow in rStar coordinate:
361         DO i=iMin,iMax  # ifndef DISABLE_RSTAR_CODE
362          fVerU(i,j,kDown) = rVelDudrFac*aF(i,j) + ArDudrFac*vrF(i,j)          IF ( select_rStar.GT.0 ) THEN
363         ENDDO           DO j=jMin,jMax
364        ENDDO            DO i=iMin,iMax
365               gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)
366         &     - (rStarExpW(i,j,bi,bj) - 1. _d 0)/deltaTfreesurf
367         &       *uVel(i,j,k,bi,bj)
368              ENDDO
369             ENDDO
370            ENDIF
371            IF ( select_rStar.LT.0 ) THEN
372             DO j=jMin,jMax
373              DO i=iMin,iMax
374               gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)
375         &     - rStarDhWDt(i,j,bi,bj)*uVel(i,j,k,bi,bj)
376              ENDDO
377             ENDDO
378            ENDIF
379    # endif /* DISABLE_RSTAR_CODE */
380    #endif /* NONLIN_FRSURF */
381    
382  C---  Hydrostatic term ( -1/rhoConst . dphi/dx )        ELSE
383        IF (momPressureForcing) THEN  C-    if momAdvection / else
384         DO j=jMin,jMax          DO j=1-OLy,sNy+OLy
385          DO i=iMin,iMax           DO i=1-OLx,sNx+OLx
386           pf(i,j) = - _recip_dxC(i,j,bi,bj)             gU(i,j,k,bi,bj) = 0. _d 0
387       &    *(phi_hyd(i,j,k)-phi_hyd(i-1,j,k))           ENDDO
388          ENDDO          ENDDO
389         ENDDO  
390    C-    endif momAdvection.
391        ENDIF        ENDIF
392    
393  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term        IF (momViscosity) THEN
394        DO j=jMin,jMax  C---  Calculate eddy fluxes (dissipation) between cells for zonal flow.
395         DO i=iMin,iMax  
396          gU(i,j,k,bi,bj) =  C     Bi-harmonic term del^2 U -> v4F
397            IF (biharmonic)
398         &  CALL MOM_U_DEL2U(bi,bj,k,uFld,hFacZ,v4f,myThid)
399    
400    C     Laplacian and bi-harmonic terms, Zonal  Fluxes -> fZon
401            CALL MOM_U_XVISCFLUX(bi,bj,k,uFld,v4F,fZon,
402         I    viscAh_D,viscA4_D,myThid)
403    
404    C     Laplacian and bi-harmonic termis, Merid Fluxes -> fMer
405            CALL MOM_U_YVISCFLUX(bi,bj,k,uFld,v4F,hFacZ,fMer,
406         I    viscAh_Z,viscA4_Z,myThid)
407    
408    C     Eddy component of vertical flux (interior component only) -> fVrUp & fVrDw
409           IF (.NOT.implicitViscosity) THEN
410            CALL MOM_U_RVISCFLUX(bi,bj, k, uVel,KappaRU,fVrUp,myThid)
411            CALL MOM_U_RVISCFLUX(bi,bj,k+1,uVel,KappaRU,fVrDw,myThid)
412           ENDIF
413    
414    C--   Tendency is minus divergence of the fluxes
415            DO j=jMin,jMax
416             DO i=iMin,iMax
417              guDiss(i,j) =
418  #ifdef OLD_UV_GEOM  #ifdef OLD_UV_GEOM
419       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/       &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/
420       &    ( 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)) )
421  #else  #else
422       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)       &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
423       &   *recip_rAw(i,j,bi,bj)       &     *recip_rAw(i,j,bi,bj)
424    #endif
425         &    *( ( fZon(i,j  ) - fZon(i-1,j) )*AhDudxFac
426         &      +( fMer(i,j+1) - fMer(i,  j) )*AhDudyFac
427         &      +( fVrDw(i,j)  - fVrUp(i,j) )*rkSign*ArDudrFac
428         &     )
429             ENDDO
430            ENDDO
431    
432    #ifdef ALLOW_DIAGNOSTICS
433            IF ( useDiagnostics ) THEN
434              CALL DIAGNOSTICS_FILL(fZon, 'VISCx_Um',k,1,2,bi,bj,myThid)
435              CALL DIAGNOSTICS_FILL(fMer, 'VISCy_Um',k,1,2,bi,bj,myThid)
436              IF (.NOT.implicitViscosity)
437         &    CALL DIAGNOSTICS_FILL(fVrUp,'VISrE_Um',k,1,2,bi,bj,myThid)
438            ENDIF
439  #endif  #endif
      &  *(fZon(i,j  )          - fZon(i-1,j)  
      &   +fMer(i,j+1)          - fMer(i  ,j)  
      &   +fVerU(i,j,kUp)*rkFac - fVerU(i,j,kDown)*rkFac  
      &   )  
      & _PHM( +phxFac * pf(i,j) )  
        ENDDO  
       ENDDO  
440    
441  C-- No-slip and drag BCs appear as body forces in cell abutting topography  C-- No-slip and drag BCs appear as body forces in cell abutting topography
442        IF (momViscosity.AND.no_slip_sides) THEN          IF (no_slip_sides) THEN
443  C-     No-slip BCs impose a drag at walls...  C-     No-slip BCs impose a drag at walls...
444         CALL MOM_U_SIDEDRAG(bi,bj,k,uFld,v4F,hFacZ,vF,myThid)           CALL MOM_U_SIDEDRAG(
445         DO j=jMin,jMax       I        bi,bj,k,
446          DO i=iMin,iMax       I        uFld, v4f, hFacZ,
447           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)       I        viscAh_Z,viscA4_Z,
448          ENDDO       I        harmonic,biharmonic,useVariableViscosity,
449         ENDDO       O        vF,
450        ENDIF       I        myThid)
451             DO j=jMin,jMax
452              DO i=iMin,iMax
453               gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
454              ENDDO
455             ENDDO
456            ENDIF
457  C-    No-slip BCs impose a drag at bottom  C-    No-slip BCs impose a drag at bottom
458        IF (momViscosity.AND.bottomDragTerms) THEN          IF (bottomDragTerms) THEN
459         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)           CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
460             DO j=jMin,jMax
461              DO i=iMin,iMax
462               gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
463              ENDDO
464             ENDDO
465            ENDIF
466    
467    #ifdef ALLOW_SHELFICE
468            IF (useShelfIce) THEN
469             CALL SHELFICE_U_DRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
470             DO j=jMin,jMax
471              DO i=iMin,iMax
472               gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
473              ENDDO
474             ENDDO
475            ENDIF
476    #endif /* ALLOW_SHELFICE */
477    
478    C-    endif momViscosity
479          ENDIF
480    
481    C--   Forcing term (moved to timestep.F)
482    c     IF (momForcing)
483    c    &  CALL EXTERNAL_FORCING_U(
484    c    I     iMin,iMax,jMin,jMax,bi,bj,k,
485    c    I     myTime,myThid)
486    
487    C--   Metric terms for curvilinear grid systems
488          IF (useNHMTerms) THEN
489    C      o Non-Hydrostatic (spherical) metric terms
490           CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,mT,myThid)
491         DO j=jMin,jMax         DO j=jMin,jMax
492          DO i=iMin,iMax          DO i=iMin,iMax
493           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)
494          ENDDO          ENDDO
495         ENDDO         ENDDO
496        ENDIF        ENDIF
497          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  
498  C      o Spherical polar grid metric terms  C      o Spherical polar grid metric terms
499         CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,mT,myThid)         CALL MOM_U_METRIC_SPHERE(bi,bj,k,uFld,vFld,mT,myThid)
500         DO j=jMin,jMax         DO j=jMin,jMax
501          DO i=iMin,iMax          DO i=iMin,iMax
502           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)
503          ENDDO          ENDDO
504         ENDDO         ENDDO
505         CALL MOM_U_METRIC_SPHERE(bi,bj,k,uFld,vFld,mT,myThid)        ENDIF
506          IF ( usingCylindricalGrid .AND. metricTerms ) THEN
507    C      o Cylindrical grid metric terms
508           CALL MOM_U_METRIC_CYLINDER(bi,bj,k,uFld,vFld,mT,myThid)
509         DO j=jMin,jMax         DO j=jMin,jMax
510          DO i=iMin,iMax          DO i=iMin,iMax
511           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)
512          ENDDO          ENDDO
513         ENDDO         ENDDO
514        ENDIF        ENDIF
515    
516  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  
   
517    
518  C---- Meridional momentum equation starts here  C---- Meridional momentum equation starts here
519    
520  C     Bi-harmonic term del^2 V -> v4F        IF (momAdvection) THEN
521        IF (momViscosity)  C---  Calculate mean fluxes (advection)   between cells for meridional flow.
522       & CALL MOM_V_DEL2V(bi,bj,k,vFld,hFacZ,v4f,myThid)  C     Mean flow component of zonal flux -> fZon
523            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  
524    
525  C--   Meridional flux (fMer is at north face of "v" cell)  C--   Meridional flux (fMer is at north face of "v" cell)
526    C     Mean flow component of meridional flux -> fMer
527  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  
528    
529  C--   Vertical flux (fVer is at upper face of "v" cell)  C--   Vertical flux (fVer is at upper face of "v" cell)
530    C     Mean flow component of vertical flux (at k+1) -> fVerV
531            CALL MOM_V_ADV_WV(
532         I                     bi,bj,k+1,vVel,wVel,rTransV,
533         O                     fVerV(1-OLx,1-OLy,kDown), myThid )
534    
535  C--   Free surface correction term (flux at k=1)  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
536        IF (momAdvection.AND.k.EQ.1) THEN          DO j=jMin,jMax
537         CALL MOM_V_ADV_WV(bi,bj,k,vVel,wVel,af,myThid)           DO i=iMin,iMax
538         DO j=jMin,jMax            gV(i,j,k,bi,bj) =
539          DO i=iMin,iMax  #ifdef OLD_UV_GEOM
540           fVerV(i,j,kUp) = af(i,j)       &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/
541         &      ( 0.5 _d 0*(_rA(i,j,bi,bj)+_rA(i,j-1,bi,bj)) )
542    #else
543         &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
544         &      *recip_rAs(i,j,bi,bj)
545    #endif
546         &    *( ( fZon(i+1,j)     - fZon(i,j  ) )*uDvdxFac
547         &      +( fMer(i,  j)     - fMer(i,j-1) )*vDvdyFac
548         &      +(fVerV(i,j,kDown) - fVerV(i,j,kUp))*rkSign*rVelDvdrFac
549         &     )
550             ENDDO
551          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)  
552    
553  C     Eddy component of vertical flux (interior component only) -> vrF  #ifdef ALLOW_DIAGNOSTICS
554        IF (momViscosity.AND..NOT.implicitViscosity)          IF ( useDiagnostics ) THEN
555       & CALL MOM_V_RVISCFLUX(bi,bj,k,vVel,KappaRV,vrf,myThid)            CALL DIAGNOSTICS_FILL(fZon,'ADVx_Vm ',k,1,2,bi,bj,myThid)
556              CALL DIAGNOSTICS_FILL(fMer,'ADVy_Vm ',k,1,2,bi,bj,myThid)
557              CALL DIAGNOSTICS_FILL(fVerV(1-Olx,1-Oly,kUp),
558         &                               'ADVrE_Vm',k,1,2,bi,bj,myThid)
559            ENDIF
560    #endif
561    
562  C     Combine fluxes -> fVerV  #ifdef NONLIN_FRSURF
563        DO j=jMin,jMax  C-- account for 3.D divergence of the flow in rStar coordinate:
564         DO i=iMin,iMax  # ifndef DISABLE_RSTAR_CODE
565          fVerV(i,j,kDown) = rVelDvdrFac*aF(i,j) + ArDvdrFac*vrF(i,j)          IF ( select_rStar.GT.0 ) THEN
566         ENDDO           DO j=jMin,jMax
567        ENDDO            DO i=iMin,iMax
568               gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)
569         &     - (rStarExpS(i,j,bi,bj) - 1. _d 0)/deltaTfreesurf
570         &       *vVel(i,j,k,bi,bj)
571              ENDDO
572             ENDDO
573            ENDIF
574            IF ( select_rStar.LT.0 ) THEN
575             DO j=jMin,jMax
576              DO i=iMin,iMax
577               gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)
578         &     - rStarDhSDt(i,j,bi,bj)*vVel(i,j,k,bi,bj)
579              ENDDO
580             ENDDO
581            ENDIF
582    # endif /* DISABLE_RSTAR_CODE */
583    #endif /* NONLIN_FRSURF */
584    
585  C---  Hydorstatic term (-1/rhoConst . dphi/dy )        ELSE
586        IF (momPressureForcing) THEN  C-    if momAdvection / else
587         DO j=jMin,jMax          DO j=1-OLy,sNy+OLy
588          DO i=iMin,iMax           DO i=1-OLx,sNx+OLx
589           pF(i,j) = -_recip_dyC(i,j,bi,bj)             gV(i,j,k,bi,bj) = 0. _d 0
590       &    *(phi_hyd(i,j,k)-phi_hyd(i,j-1,k))           ENDDO
591          ENDDO          ENDDO
592         ENDDO  
593    C-    endif momAdvection.
594        ENDIF        ENDIF
595    
596          IF (momViscosity) THEN
597    C---  Calculate eddy fluxes (dissipation) between cells for meridional flow.
598    C     Bi-harmonic term del^2 V -> v4F
599            IF (biharmonic)
600         &  CALL MOM_V_DEL2V(bi,bj,k,vFld,hFacZ,v4f,myThid)
601    
602    C     Laplacian and bi-harmonic terms, Zonal  Fluxes -> fZon
603            CALL MOM_V_XVISCFLUX(bi,bj,k,vFld,v4f,hFacZ,fZon,
604         I    viscAh_Z,viscA4_Z,myThid)
605    
606    C     Laplacian and bi-harmonic termis, Merid Fluxes -> fMer
607            CALL MOM_V_YVISCFLUX(bi,bj,k,vFld,v4f,fMer,
608         I    viscAh_D,viscA4_D,myThid)
609    
610    C     Eddy component of vertical flux (interior component only) -> fVrUp & fVrDw
611           IF (.NOT.implicitViscosity) THEN
612            CALL MOM_V_RVISCFLUX(bi,bj, k, vVel,KappaRV,fVrUp,myThid)
613            CALL MOM_V_RVISCFLUX(bi,bj,k+1,vVel,KappaRV,fVrDw,myThid)
614           ENDIF
615    
616  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
617        DO j=jMin,jMax          DO j=jMin,jMax
618         DO i=iMin,iMax           DO i=iMin,iMax
619          gV(i,j,k,bi,bj) =            gvDiss(i,j) =
620  #ifdef OLD_UV_GEOM  #ifdef OLD_UV_GEOM
621       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/       &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/
622       &    ( 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)) )
623  #else  #else
624       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)       &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
625       &    *recip_rAs(i,j,bi,bj)       &      *recip_rAs(i,j,bi,bj)
626    #endif
627         &    *( ( fZon(i+1,j)  - fZon(i,j  ) )*AhDvdxFac
628         &      +( fMer(i,  j)  - fMer(i,j-1) )*AhDvdyFac
629         &      +( fVrDw(i,j)   - fVrUp(i,j) )*rkSign*ArDvdrFac
630         &     )
631             ENDDO
632            ENDDO
633    
634    #ifdef ALLOW_DIAGNOSTICS
635            IF ( useDiagnostics ) THEN
636              CALL DIAGNOSTICS_FILL(fZon, 'VISCx_Vm',k,1,2,bi,bj,myThid)
637              CALL DIAGNOSTICS_FILL(fMer, 'VISCy_Vm',k,1,2,bi,bj,myThid)
638              IF (.NOT.implicitViscosity)
639         &    CALL DIAGNOSTICS_FILL(fVrUp,'VISrE_Vm',k,1,2,bi,bj,myThid)
640            ENDIF
641  #endif  #endif
      &  *(fZon(i+1,j)          - fZon(i,j  )  
      &   +fMer(i,j  )          - fMer(i,j-1)  
      &   +fVerV(i,j,kUp)*rkFac - fVerV(i,j,kDown)*rkFac  
      &   )  
      & _PHM( +phyFac*pf(i,j) )  
        ENDDO  
       ENDDO  
642    
643  C-- No-slip and drag BCs appear as body forces in cell abutting topography  C-- No-slip and drag BCs appear as body forces in cell abutting topography
644        IF (momViscosity.AND.no_slip_sides) THEN          IF (no_slip_sides) THEN
645  C-     No-slip BCs impose a drag at walls...  C-     No-slip BCs impose a drag at walls...
646         CALL MOM_V_SIDEDRAG(bi,bj,k,vFld,v4F,hFacZ,vF,myThid)           CALL MOM_V_SIDEDRAG(
647         DO j=jMin,jMax       I        bi,bj,k,
648          DO i=iMin,iMax       I        vFld, v4f, hFacZ,
649           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)       I        viscAh_Z,viscA4_Z,
650          ENDDO       I        harmonic,biharmonic,useVariableViscosity,
651         ENDDO       O        vF,
652        ENDIF       I        myThid)
653             DO j=jMin,jMax
654              DO i=iMin,iMax
655               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
656              ENDDO
657             ENDDO
658            ENDIF
659  C-    No-slip BCs impose a drag at bottom  C-    No-slip BCs impose a drag at bottom
660        IF (momViscosity.AND.bottomDragTerms) THEN          IF (bottomDragTerms) THEN
661         CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)           CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)
662             DO j=jMin,jMax
663              DO i=iMin,iMax
664               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
665              ENDDO
666             ENDDO
667            ENDIF
668    
669    #ifdef ALLOW_SHELFICE
670            IF (useShelfIce) THEN
671             CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRU,vF,myThid)
672             DO j=jMin,jMax
673              DO i=iMin,iMax
674               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
675              ENDDO
676             ENDDO
677            ENDIF
678    #endif /* ALLOW_SHELFICE */
679    
680    C-    endif momViscosity
681          ENDIF
682    
683    C--   Forcing term (moved to timestep.F)
684    c     IF (momForcing)
685    c    & CALL EXTERNAL_FORCING_V(
686    c    I     iMin,iMax,jMin,jMax,bi,bj,k,
687    c    I     myTime,myThid)
688    
689    C--   Metric terms for curvilinear grid systems
690          IF (useNHMTerms) THEN
691    C      o Non-Hydrostatic (spherical) metric terms
692           CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,mT,myThid)
693         DO j=jMin,jMax         DO j=jMin,jMax
694          DO i=iMin,iMax          DO i=iMin,iMax
695           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)
696          ENDDO          ENDDO
697         ENDDO         ENDDO
698        ENDIF        ENDIF
699          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  
700  C      o Spherical polar grid metric terms  C      o Spherical polar grid metric terms
701         CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,mT,myThid)         CALL MOM_V_METRIC_SPHERE(bi,bj,k,uFld,mT,myThid)
702         DO j=jMin,jMax         DO j=jMin,jMax
703          DO i=iMin,iMax          DO i=iMin,iMax
704           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)
705          ENDDO          ENDDO
706         ENDDO         ENDDO
707         CALL MOM_V_METRIC_SPHERE(bi,bj,k,uFld,mT,myThid)        ENDIF
708          IF ( usingCylindricalGrid .AND. metricTerms ) THEN
709    C      o Cylindrical grid metric terms
710           CALL MOM_V_METRIC_CYLINDER(bi,bj,k,uFld,vFld,mT,myThid)
711         DO j=jMin,jMax         DO j=jMin,jMax
712          DO i=iMin,iMax          DO i=iMin,iMax
713           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)
714          ENDDO          ENDDO
715         ENDDO         ENDDO
716        ENDIF        ENDIF
717    
718  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  
719    
720  C--   Coriolis term  C--   Coriolis term
721  C     Note. As coded here, coriolis will not work with "thin walls"  C     Note. As coded here, coriolis will not work with "thin walls"
722  #ifdef INCLUDE_CD_CODE  c     IF (useCDscheme) THEN
723        CALL MOM_CDSCHEME(bi,bj,k,phi_hyd,myThid)  c       CALL MOM_CDSCHEME(bi,bj,k,dPhiHydX,dPhiHydY,myThid)
724  #else  c     ELSE
725        CALL MOM_U_CORIOLIS(bi,bj,k,vFld,cf,myThid)        IF (.NOT.useCDscheme) THEN
726        DO j=jMin,jMax          CALL MOM_U_CORIOLIS(bi,bj,k,vFld,cf,myThid)
727         DO i=iMin,iMax          DO j=jMin,jMax
728          gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)           DO i=iMin,iMax
729         ENDDO            gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)
730        ENDDO           ENDDO
731        CALL MOM_V_CORIOLIS(bi,bj,k,uFld,cf,myThid)          ENDDO
732    #ifdef ALLOW_DIAGNOSTICS
733            IF ( useDiagnostics )
734         &    CALL DIAGNOSTICS_FILL(cf,'Um_Cori ',k,1,2,bi,bj,myThid)
735    #endif
736            CALL MOM_V_CORIOLIS(bi,bj,k,uFld,cf,myThid)
737            DO j=jMin,jMax
738             DO i=iMin,iMax
739              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+fvFac*cf(i,j)
740             ENDDO
741            ENDDO
742    #ifdef ALLOW_DIAGNOSTICS
743            IF ( useDiagnostics )
744         &    CALL DIAGNOSTICS_FILL(cf,'Vm_Cori ',k,1,2,bi,bj,myThid)
745    #endif
746          ENDIF
747    
748    C--   3.D Coriolis term (horizontal momentum, Eastward component: -f'*w)
749          IF ( nonHydrostatic.OR.quasiHydrostatic ) THEN
750            CALL MOM_U_CORIOLIS_NH(bi,bj,k,wVel,cf,myThid)
751            DO j=jMin,jMax
752             DO i=iMin,iMax
753              gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)
754             ENDDO
755            ENDDO
756           IF ( usingCurvilinearGrid ) THEN
757    C-     presently, non zero angleSinC array only supported with Curvilinear-Grid
758            CALL MOM_V_CORIOLIS_NH(bi,bj,k,wVel,cf,myThid)
759            DO j=jMin,jMax
760             DO i=iMin,iMax
761              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+fvFac*cf(i,j)
762             ENDDO
763            ENDDO
764           ENDIF
765          ENDIF
766    
767    C--   Set du/dt & dv/dt on boundaries to zero
768        DO j=jMin,jMax        DO j=jMin,jMax
769         DO i=iMin,iMax         DO i=iMin,iMax
770          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)
771            guDiss(i,j)     = guDiss(i,j)    *_maskW(i,j,k,bi,bj)
772            gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)
773            gvDiss(i,j)     = gvDiss(i,j)    *_maskS(i,j,k,bi,bj)
774         ENDDO         ENDDO
775        ENDDO        ENDDO
776  #endif /* INCLUDE_CD_CODE */  
777    #ifdef ALLOW_DIAGNOSTICS
778          IF ( useDiagnostics ) THEN
779            CALL DIAGNOSTICS_FILL(KE,    'momKE   ',k,1,2,bi,bj,myThid)
780            CALL DIAGNOSTICS_FILL(gU(1-Olx,1-Oly,k,bi,bj),
781         &                               'Um_Advec',k,1,2,bi,bj,myThid)
782            CALL DIAGNOSTICS_FILL(gV(1-Olx,1-Oly,k,bi,bj),
783         &                               'Vm_Advec',k,1,2,bi,bj,myThid)
784           IF (momViscosity) THEN
785            CALL DIAGNOSTICS_FILL(guDiss,'Um_Diss ',k,1,2,bi,bj,myThid)
786            CALL DIAGNOSTICS_FILL(gvDiss,'Vm_Diss ',k,1,2,bi,bj,myThid)
787           ENDIF
788          ENDIF
789    #endif /* ALLOW_DIAGNOSTICS */
790    
791        RETURN        RETURN
792        END        END
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.34
  ViewVC Help
Powered by ViewVC 1.1.22