/[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.4 by adcroft, Fri Sep 28 16:49:54 2001 UTC revision 1.43 by jmc, Fri Mar 16 21:35:09 2012 UTC
# Line 25  C where ${\bf v}=(u,v,w)$ and $\tau$, th Line 25  C where ${\bf v}=(u,v,w)$ and $\tau$, th
25  C stresses as well as internal viscous stresses.  C stresses as well as internal viscous stresses.
26  CEOI  CEOI
27    
28  #include "CPP_OPTIONS.h"  #include "MOM_FLUXFORM_OPTIONS.h"
29    
30  CBOP  CBOP
31  C !ROUTINE: MOM_FLUXFORM  C !ROUTINE: MOM_FLUXFORM
32    
33  C !INTERFACE: ==========================================================  C !INTERFACE: ==========================================================
34        SUBROUTINE MOM_FLUXFORM(        SUBROUTINE MOM_FLUXFORM(
35       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,
36       I        phi_hyd,KappaRU,KappaRV,       I        KappaRU, KappaRV,
37       U        fVerU, fVerV,       U        fVerU, fVerV,
38       I        myCurrentTime,myIter,myThid)       O        guDiss, gvDiss,
39         I        myTime, myIter, myThid)
40    
41  C !DESCRIPTION:  C !DESCRIPTION:
42  C Calculates all the horizontal accelerations except for the implicit surface  C Calculates all the horizontal accelerations except for the implicit surface
43  C pressure gradient and implciit vertical viscosity.  C pressure gradient and implicit vertical viscosity.
44    
45  C !USES: ===============================================================  C !USES: ===============================================================
46  C     == Global variables ==  C     == Global variables ==
# Line 51  C     == Global variables == Line 52  C     == Global variables ==
52  #include "PARAMS.h"  #include "PARAMS.h"
53  #include "GRID.h"  #include "GRID.h"
54  #include "SURFACE.h"  #include "SURFACE.h"
55    #ifdef ALLOW_AUTODIFF_TAMC
56    # include "tamc.h"
57    # include "tamc_keys.h"
58    # include "MOM_FLUXFORM.h"
59    #endif
60    
61  C !INPUT PARAMETERS: ===================================================  C !INPUT PARAMETERS: ===================================================
62  C  bi,bj                :: tile indices  C  bi,bj                :: tile indices
# Line 58  C  iMin,iMax,jMin,jMAx  :: loop ranges Line 64  C  iMin,iMax,jMin,jMAx  :: loop ranges
64  C  k                    :: vertical level  C  k                    :: vertical level
65  C  kUp                  :: =1 or 2 for consecutive k  C  kUp                  :: =1 or 2 for consecutive k
66  C  kDown                :: =2 or 1 for consecutive k  C  kDown                :: =2 or 1 for consecutive k
 C  phi_hyd              :: hydrostatic pressure (perturbation)  
67  C  KappaRU              :: vertical viscosity  C  KappaRU              :: vertical viscosity
68  C  KappaRV              :: vertical viscosity  C  KappaRV              :: vertical viscosity
69  C  fVerU                :: vertical flux of U, 2 1/2 dim for pipe-lining  C  fVerU                :: vertical flux of U, 2 1/2 dim for pipe-lining
70  C  fVerV                :: vertical flux of V, 2 1/2 dim for pipe-lining  C  fVerV                :: vertical flux of V, 2 1/2 dim for pipe-lining
71  C  myCurrentTime        :: current time  C  guDiss               :: dissipation tendency (all explicit terms), u component
72    C  gvDiss               :: dissipation tendency (all explicit terms), v component
73    C  myTime               :: current time
74  C  myIter               :: current time-step number  C  myIter               :: current time-step number
75  C  myThid               :: thread number  C  myThid               :: thread number
76        INTEGER bi,bj,iMin,iMax,jMin,jMax        INTEGER bi,bj,iMin,iMax,jMin,jMax
77        INTEGER k,kUp,kDown        INTEGER k,kUp,kDown
       _RL phi_hyd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
78        _RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
79        _RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
80        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
81        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
82        _RL     myCurrentTime        _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        INTEGER myIter
86        INTEGER myThid        INTEGER myThid
87    
# Line 82  C None - updates gU() and gV() in common Line 90  C None - updates gU() and gV() in common
90    
91  C !LOCAL VARIABLES: ====================================================  C !LOCAL VARIABLES: ====================================================
92  C  i,j                  :: loop indices  C  i,j                  :: loop indices
 C  aF                   :: advective flux  
93  C  vF                   :: viscous flux  C  vF                   :: viscous flux
94  C  v4F                  :: bi-harmonic viscous flux  C  v4F                  :: bi-harmonic viscous flux
 C  vrF                  :: vertical viscous flux  
95  C  cF                   :: Coriolis acceleration  C  cF                   :: Coriolis acceleration
96  C  mT                   :: Metric terms  C  mT                   :: Metric terms
 C  pF                   :: Pressure gradient  
97  C  fZon                 :: zonal fluxes  C  fZon                 :: zonal fluxes
98  C  fMer                 :: meridional fluxes  C  fMer                 :: meridional fluxes
99    C  fVrUp,fVrDw          :: vertical viscous fluxes at interface k-1 & k
100        INTEGER i,j        INTEGER i,j
101        _RL aF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  #ifdef ALLOW_AUTODIFF_TAMC
102          INTEGER imomkey
103    #endif
104        _RL vF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
105        _RL v4F(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL v4F(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
       _RL vrF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
106        _RL cF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL cF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
107        _RL mT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL mT(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
       _RL pF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
108        _RL fZon(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL fZon(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
109        _RL fMer(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL fMer(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
110  C     wMaskOverride - Land sea flag override for top layer.        _RL fVrUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
111  C     afFacMom      - Tracer parameters for turning terms        _RL fVrDw(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
112  C     vfFacMom        on and off.  C     afFacMom     :: Tracer parameters for turning terms on and off.
113  C     pfFacMom        afFacMom - Advective terms  C     vfFacMom
114    C     pfFacMom        afFacMom - Advective terms
115  C     cfFacMom        vfFacMom - Eddy viscosity terms  C     cfFacMom        vfFacMom - Eddy viscosity terms
116  C     mTFacMom        pfFacMom - Pressure terms  C     mtFacMom        pfFacMom - Pressure terms
117  C                     cfFacMom - Coriolis terms  C                     cfFacMom - Coriolis terms
118  C                     foFacMom - Forcing  C                     foFacMom - Forcing
119  C                     mTFacMom - Metric term  C                     mtFacMom - Metric term
120  C     uDudxFac, AhDudxFac, etc ... individual term tracer parameters  C     uDudxFac, AhDudxFac, etc ... individual term parameters for switching terms off
121        _RS    hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS    hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
122        _RS  r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS  r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
123        _RS      xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS      xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
# Line 119  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  C     rVelMaskOverride - Factor for imposing special surface boundary conditions        _RL  rTransV(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
131  C                        ( set according to free-surface condition ).        _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
132  C     hFacROpen        - Lopped cell factos used tohold fraction of open        _RL viscAh_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
133  C     hFacRClosed        and closed cell wall.        _RL viscAh_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
134        _RL  rVelMaskOverride        _RL viscA4_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
135  C     xxxFac - On-off tracer parameters used for switching terms off.        _RL viscA4_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
136          _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        INTEGER km1,kp1        _RL  mtNHFacV
158        _RL wVelBottomOverride        _RL  sideMaskFac
159        LOGICAL bottomDragTerms        LOGICAL bottomDragTerms,harmonic,biharmonic,useVariableViscosity
       _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
160  CEOP  CEOP
161    #ifdef MOM_BOUNDARY_CONSERVE
162        km1=MAX(1,k-1)        COMMON / MOM_FLUXFORM_LOCAL / uBnd, vBnd
163        kp1=MIN(Nr,k+1)        _RL  uBnd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
164        rVelMaskOverride=1.        _RL  vBnd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
165        IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac  #endif /* MOM_BOUNDARY_CONSERVE */
166        wVelBottomOverride=1.  
167        IF (k.EQ.Nr) wVelBottomOverride=0.  #ifdef ALLOW_AUTODIFF_TAMC
168              act0 = k - 1
169              max0 = Nr
170              act1 = bi - myBxLo(myThid)
171              max1 = myBxHi(myThid) - myBxLo(myThid) + 1
172              act2 = bj - myByLo(myThid)
173              max2 = myByHi(myThid) - myByLo(myThid) + 1
174              act3 = myThid - 1
175              max3 = nTx*nTy
176              act4 = ikey_dynamics - 1
177              imomkey = (act0 + 1)
178         &                    + act1*max0
179         &                    + act2*max0*max1
180         &                    + act3*max0*max1*max2
181         &                    + act4*max0*max1*max2*max3
182    #endif /* ALLOW_AUTODIFF_TAMC */
183    
184  C     Initialise intermediate terms  C     Initialise intermediate terms
185        DO J=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
186         DO I=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
         aF(i,j)   = 0.  
187          vF(i,j)   = 0.          vF(i,j)   = 0.
188          v4F(i,j)  = 0.          v4F(i,j)  = 0.
         vrF(i,j)  = 0.  
189          cF(i,j)   = 0.          cF(i,j)   = 0.
190          mT(i,j)   = 0.          mT(i,j)   = 0.
         pF(i,j)   = 0.  
191          fZon(i,j) = 0.          fZon(i,j) = 0.
192          fMer(i,j) = 0.          fMer(i,j) = 0.
193            fVrUp(i,j)= 0.
194            fVrDw(i,j)= 0.
195            rTransU(i,j)= 0.
196            rTransV(i,j)= 0.
197    c       KE(i,j)     = 0.
198            hDiv(i,j)   = 0.
199            vort3(i,j)  = 0.
200            strain(i,j) = 0.
201            tension(i,j)= 0.
202            guDiss(i,j) = 0.
203            gvDiss(i,j) = 0.
204         ENDDO         ENDDO
205        ENDDO        ENDDO
206    
# Line 181  C--   Term by term tracer parmeters Line 208  C--   Term by term tracer parmeters
208  C     o U momentum equation  C     o U momentum equation
209        uDudxFac     = afFacMom*1.        uDudxFac     = afFacMom*1.
210        AhDudxFac    = vfFacMom*1.        AhDudxFac    = vfFacMom*1.
       A4DuxxdxFac  = vfFacMom*1.  
211        vDudyFac     = afFacMom*1.        vDudyFac     = afFacMom*1.
212        AhDudyFac    = vfFacMom*1.        AhDudyFac    = vfFacMom*1.
       A4DuyydyFac  = vfFacMom*1.  
213        rVelDudrFac  = afFacMom*1.        rVelDudrFac  = afFacMom*1.
214        ArDudrFac    = vfFacMom*1.        ArDudrFac    = vfFacMom*1.
215        mTFacU       = mtFacMom*1.        mtFacU       = mtFacMom*1.
216          mtNHFacU     = 1.
217        fuFac        = cfFacMom*1.        fuFac        = cfFacMom*1.
       phxFac       = pfFacMom*1.  
218  C     o V momentum equation  C     o V momentum equation
219        uDvdxFac     = afFacMom*1.        uDvdxFac     = afFacMom*1.
220        AhDvdxFac    = vfFacMom*1.        AhDvdxFac    = vfFacMom*1.
       A4DvxxdxFac  = vfFacMom*1.  
221        vDvdyFac     = afFacMom*1.        vDvdyFac     = afFacMom*1.
222        AhDvdyFac    = vfFacMom*1.        AhDvdyFac    = vfFacMom*1.
       A4DvyydyFac  = vfFacMom*1.  
223        rVelDvdrFac  = afFacMom*1.        rVelDvdrFac  = afFacMom*1.
224        ArDvdrFac    = vfFacMom*1.        ArDvdrFac    = vfFacMom*1.
225        mTFacV       = mtFacMom*1.        mtFacV       = mtFacMom*1.
226          mtNHFacV     = 1.
227        fvFac        = cfFacMom*1.        fvFac        = cfFacMom*1.
228        phyFac       = pfFacMom*1.  
229        vForcFac     = foFacMom*1.        IF (implicitViscosity) THEN
230            ArDudrFac  = 0.
231            ArDvdrFac  = 0.
232          ENDIF
233    
234    C note: using standard stencil (no mask) results in under-estimating
235    C       vorticity at a no-slip boundary by a factor of 2 = sideDragFactor
236          IF ( no_slip_sides ) THEN
237            sideMaskFac = sideDragFactor
238          ELSE
239            sideMaskFac = 0. _d 0
240          ENDIF
241    
242        IF (     no_slip_bottom        IF (     no_slip_bottom
243       &    .OR. bottomDragQuadratic.NE.0.       &    .OR. bottomDragQuadratic.NE.0.
# Line 212  C     o V momentum equation Line 247  C     o V momentum equation
247         bottomDragTerms=.FALSE.         bottomDragTerms=.FALSE.
248        ENDIF        ENDIF
249    
 C-- with stagger time stepping, grad Phi_Hyp is directly incoporated in TIMESTEP  
       IF (staggerTimeStep) THEN  
         phxFac = 0.  
         phyFac = 0.  
       ENDIF  
   
250  C--   Calculate open water fraction at vorticity points  C--   Calculate open water fraction at vorticity points
251        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)
252    
# Line 225  C---- Calculate common quantities used i Line 254  C---- Calculate common quantities used i
254  C     Calculate tracer cell face open areas  C     Calculate tracer cell face open areas
255        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
256         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
257          xA(i,j) = _dyG(i,j,bi,bj)          xA(i,j) = _dyG(i,j,bi,bj)*deepFacC(k)
258       &   *drF(k)*_hFacW(i,j,k,bi,bj)       &          *drF(k)*_hFacW(i,j,k,bi,bj)
259          yA(i,j) = _dxG(i,j,bi,bj)          yA(i,j) = _dxG(i,j,bi,bj)*deepFacC(k)
260       &   *drF(k)*_hFacS(i,j,k,bi,bj)       &          *drF(k)*_hFacS(i,j,k,bi,bj)
261         ENDDO         ENDDO
262        ENDDO        ENDDO
263    
# Line 241  C     Make local copies of horizontal fl Line 270  C     Make local copies of horizontal fl
270        ENDDO        ENDDO
271    
272  C     Calculate velocity field "volume transports" through tracer cell faces.  C     Calculate velocity field "volume transports" through tracer cell faces.
273    C     anelastic: transports are scaled by rhoFacC (~ mass transport)
274        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
275         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
276          uTrans(i,j) = uFld(i,j)*xA(i,j)          uTrans(i,j) = uFld(i,j)*xA(i,j)*rhoFacC(k)
277          vTrans(i,j) = vFld(i,j)*yA(i,j)          vTrans(i,j) = vFld(i,j)*yA(i,j)*rhoFacC(k)
278         ENDDO         ENDDO
279        ENDDO        ENDDO
280    
281        CALL MOM_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid)        CALL MOM_CALC_KE(bi,bj,k,2,uFld,vFld,KE,myThid)
282          IF ( momViscosity) THEN
283            CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid)
284            CALL MOM_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)
285            CALL MOM_CALC_TENSION(bi,bj,k,uFld,vFld,tension,myThid)
286            CALL MOM_CALC_STRAIN(bi,bj,k,uFld,vFld,hFacZ,strain,myThid)
287            DO j=1-OLy,sNy+OLy
288             DO i=1-OLx,sNx+OLx
289               IF ( hFacZ(i,j).EQ.0. ) THEN
290                 vort3(i,j)  = sideMaskFac*vort3(i,j)
291                 strain(i,j) = sideMaskFac*strain(i,j)
292               ENDIF
293             ENDDO
294            ENDDO
295    #ifdef ALLOW_DIAGNOSTICS
296            IF ( useDiagnostics ) THEN
297              CALL DIAGNOSTICS_FILL(hDiv,   'momHDiv ',k,1,2,bi,bj,myThid)
298              CALL DIAGNOSTICS_FILL(vort3,  'momVort3',k,1,2,bi,bj,myThid)
299              CALL DIAGNOSTICS_FILL(tension,'Tension ',k,1,2,bi,bj,myThid)
300              CALL DIAGNOSTICS_FILL(strain, 'Strain  ',k,1,2,bi,bj,myThid)
301            ENDIF
302    #endif
303          ENDIF
304    
305  C---- Zonal momentum equation starts here  C---  First call (k=1): compute vertical adv. flux fVerU(kUp) & fVerV(kUp)
306          IF (momAdvection.AND.k.EQ.1) THEN
307    
308  C     Bi-harmonic term del^2 U -> v4F  #ifdef MOM_BOUNDARY_CONSERVE
309        IF (momViscosity)          CALL MOM_UV_BOUNDARY( bi, bj, k,
310       & CALL MOM_U_DEL2U(bi,bj,k,uFld,hFacZ,v4f,myThid)       I                        uVel, vVel,
311         O                        uBnd(1-OLx,1-OLy,k,bi,bj),
312         O                        vBnd(1-OLx,1-OLy,k,bi,bj),
313         I                        myTime, myIter, myThid )
314    #endif /* MOM_BOUNDARY_CONSERVE */
315    
316    C-    Calculate vertical transports above U & V points (West & South face):
317    
318    #ifdef ALLOW_AUTODIFF_TAMC
319    # ifdef NONLIN_FRSURF
320    #  ifndef DISABLE_RSTAR_CODE
321    CADJ STORE dwtransc(:,:,bi,bj) =
322    CADJ &     comlev1_bibj_k, key = imomkey, byte = isbyte
323    CADJ STORE dwtransu(:,:,bi,bj) =
324    CADJ &     comlev1_bibj_k, key = imomkey, byte = isbyte
325    CADJ STORE dwtransv(:,:,bi,bj) =
326    CADJ &     comlev1_bibj_k, key = imomkey, byte = isbyte
327    #  endif
328    # endif /* NONLIN_FRSURF */
329    #endif /* ALLOW_AUTODIFF_TAMC */
330            CALL MOM_CALC_RTRANS( k, bi, bj,
331         O                        rTransU, rTransV,
332         I                        myTime, myIter, myThid)
333    
334    C-    Free surface correction term (flux at k=1)
335            CALL MOM_U_ADV_WU( bi,bj,k,uVel,wVel,rTransU,
336         O                     fVerU(1-OLx,1-OLy,kUp), myThid )
337    
338            CALL MOM_V_ADV_WV( bi,bj,k,vVel,wVel,rTransV,
339         O                     fVerV(1-OLx,1-OLy,kUp), myThid )
340    
341    C---  endif momAdvection & k=1
342          ENDIF
343    
344    
345    C---  Calculate vertical transports (at k+1) below U & V points :
346          IF (momAdvection) THEN
347            CALL MOM_CALC_RTRANS( k+1, bi, bj,
348         O                        rTransU, rTransV,
349         I                        myTime, myIter, myThid)
350          ENDIF
351    
352    #ifdef MOM_BOUNDARY_CONSERVE
353          IF ( momAdvection .AND. k.LT.Nr ) THEN
354            CALL MOM_UV_BOUNDARY( bi, bj, k+1,
355         I                        uVel, vVel,
356         O                        uBnd(1-OLx,1-OLy,k+1,bi,bj),
357         O                        vBnd(1-OLx,1-OLy,k+1,bi,bj),
358         I                        myTime, myIter, myThid )
359          ENDIF
360    #endif /* MOM_BOUNDARY_CONSERVE */
361    
362          IF (momViscosity) THEN
363           CALL MOM_CALC_VISC(
364         I        bi,bj,k,
365         O        viscAh_Z,viscAh_D,viscA4_Z,viscA4_D,
366         O        harmonic,biharmonic,useVariableViscosity,
367         I        hDiv,vort3,tension,strain,KE,hFacZ,
368         I        myThid)
369          ENDIF
370    
371  C---  Calculate mean and eddy fluxes between cells for zonal flow.  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
372    
373  C--   Zonal flux (fZon is at east face of "u" cell)  C---- Zonal momentum equation starts here
374    
375  C     Mean flow component of zonal flux -> aF        IF (momAdvection) THEN
376        IF (momAdvection)  C---  Calculate mean fluxes (advection)   between cells for zonal flow.
      & 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)  
377    
378  C     Combine fluxes -> fZon  #ifdef MOM_BOUNDARY_CONSERVE
379        DO j=jMin,jMax          CALL MOM_U_ADV_UU( bi,bj,k,uTrans,uBnd(1-OLx,1-OLy,k,bi,bj),
380         DO i=iMin,iMax       O                     fZon,myThid )
381          fZon(i,j) = uDudxFac*aF(i,j) + AhDudxFac*vF(i,j)          CALL MOM_U_ADV_VU( bi,bj,k,vTrans,uBnd(1-OLx,1-OLy,k,bi,bj),
382         ENDDO       O                     fMer,myThid )
383        ENDDO          CALL MOM_U_ADV_WU(
384         I                     bi,bj,k+1,uBnd,wVel,rTransU,
385         O                     fVerU(1-OLx,1-OLy,kDown), myThid )
386    #else /* MOM_BOUNDARY_CONSERVE */
387    C--   Zonal flux (fZon is at east face of "u" cell)
388    C     Mean flow component of zonal flux -> fZon
389            CALL MOM_U_ADV_UU(bi,bj,k,uTrans,uFld,fZon,myThid)
390    
391  C--   Meridional flux (fMer is at south face of "u" cell)  C--   Meridional flux (fMer is at south face of "u" cell)
392    C     Mean flow component of meridional flux -> fMer
393  C     Mean flow component of meridional flux          CALL MOM_U_ADV_VU(bi,bj,k,vTrans,uFld,fMer,myThid)
       IF (momAdvection)  
      & CALL MOM_U_ADV_VU(bi,bj,k,vTrans,uFld,aF,myThid)  
   
 C     Laplacian and bi-harmonic term  
       IF (momViscosity)  
      & CALL MOM_U_YVISCFLUX(bi,bj,k,uFld,v4F,hFacZ,vF,myThid)  
   
 C     Combine fluxes -> fMer  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         fMer(i,j) = vDudyFac*aF(i,j) + AhDudyFac*vF(i,j)  
        ENDDO  
       ENDDO  
394    
395  C--   Vertical flux (fVer is at upper face of "u" cell)  C--   Vertical flux (fVer is at upper face of "u" cell)
396    C     Mean flow component of vertical flux (at k+1) -> fVer
397            CALL MOM_U_ADV_WU(
398         I                     bi,bj,k+1,uVel,wVel,rTransU,
399         O                     fVerU(1-OLx,1-OLy,kDown), myThid )
400    #endif /* MOM_BOUNDARY_CONSERVE */
401    
402  C--   Free surface correction term (flux at k=1)  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
403        IF (momAdvection.AND.k.EQ.1) THEN          DO j=jMin,jMax
404         CALL MOM_U_ADV_WU(bi,bj,k,uVel,wVel,af,myThid)           DO i=iMin,iMax
405         DO j=jMin,jMax            gU(i,j,k,bi,bj) =
406          DO i=iMin,iMax  #ifdef OLD_UV_GEOM
407           fVerU(i,j,kUp) = af(i,j)       &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/
408         &      ( 0.5 _d 0*(rA(i,j,bi,bj)+rA(i-1,j,bi,bj)) )
409    #else
410         &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
411         &     *recip_rAw(i,j,bi,bj)*recip_deepFac2C(k)*recip_rhoFacC(k)
412    #endif
413         &     *( ( fZon(i,j  )     - fZon(i-1,j) )*uDudxFac
414         &       +( fMer(i,j+1)     - fMer(i,  j) )*vDudyFac
415         &       +(fVerU(i,j,kDown) - fVerU(i,j,kUp))*rkSign*rVelDudrFac
416         &     )
417             ENDDO
418          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)  
419    
420  C     Eddy component of vertical flux (interior component only) -> vrF  #ifdef ALLOW_DIAGNOSTICS
421        IF (momViscosity.AND..NOT.implicitViscosity)          IF ( useDiagnostics ) THEN
422       & CALL MOM_U_RVISCFLUX(bi,bj,k,uVel,KappaRU,vrF,myThid)            CALL DIAGNOSTICS_FILL(fZon,'ADVx_Um ',k,1,2,bi,bj,myThid)
423              CALL DIAGNOSTICS_FILL(fMer,'ADVy_Um ',k,1,2,bi,bj,myThid)
424              CALL DIAGNOSTICS_FILL(fVerU(1-OLx,1-OLy,kUp),
425         &                               'ADVrE_Um',k,1,2,bi,bj,myThid)
426            ENDIF
427    #endif
428    
429  C     Combine fluxes  #ifdef NONLIN_FRSURF
430        DO j=jMin,jMax  C-- account for 3.D divergence of the flow in rStar coordinate:
431         DO i=iMin,iMax  # ifndef DISABLE_RSTAR_CODE
432          fVerU(i,j,kDown) = rVelDudrFac*aF(i,j) + ArDudrFac*vrF(i,j)          IF ( select_rStar.GT.0 ) THEN
433         ENDDO           DO j=jMin,jMax
434        ENDDO            DO i=iMin,iMax
435               gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)
436         &     - (rStarExpW(i,j,bi,bj) - 1. _d 0)/deltaTfreesurf
437         &       *uVel(i,j,k,bi,bj)
438              ENDDO
439             ENDDO
440            ENDIF
441            IF ( select_rStar.LT.0 ) THEN
442             DO j=jMin,jMax
443              DO i=iMin,iMax
444               gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)
445         &     - rStarDhWDt(i,j,bi,bj)*uVel(i,j,k,bi,bj)
446              ENDDO
447             ENDDO
448            ENDIF
449    # endif /* DISABLE_RSTAR_CODE */
450    #endif /* NONLIN_FRSURF */
451    
452    #ifdef ALLOW_ADDFLUID
453            IF ( selectAddFluid.GE.1 ) THEN
454             DO j=jMin,jMax
455              DO i=iMin,iMax
456               gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)
457         &     + uVel(i,j,k,bi,bj)*mass2rUnit*0.5 _d 0
458         &      *( addMass(i-1,j,k,bi,bj) + addMass(i,j,k,bi,bj) )
459         &      *_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)*recip_rhoFacC(k)
460         &      * recip_rAw(i,j,bi,bj)*recip_deepFac2C(k)
461              ENDDO
462             ENDDO
463            ENDIF
464    #endif /* ALLOW_ADDFLUID */
465    
466  C---  Hydrostatic term ( -1/rhoConst . dphi/dx )        ELSE
467        IF (momPressureForcing) THEN  C-    if momAdvection / else
468         DO j=jMin,jMax          DO j=1-OLy,sNy+OLy
469          DO i=iMin,iMax           DO i=1-OLx,sNx+OLx
470           pf(i,j) = - _recip_dxC(i,j,bi,bj)             gU(i,j,k,bi,bj) = 0. _d 0
471       &    *(phi_hyd(i,j,k)-phi_hyd(i-1,j,k))           ENDDO
472          ENDDO          ENDDO
473         ENDDO  
474    C-    endif momAdvection.
475        ENDIF        ENDIF
476    
477  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term        IF (momViscosity) THEN
478        DO j=jMin,jMax  C---  Calculate eddy fluxes (dissipation) between cells for zonal flow.
479         DO i=iMin,iMax  
480          gU(i,j,k,bi,bj) =  C     Bi-harmonic term del^2 U -> v4F
481            IF (biharmonic)
482         &  CALL MOM_U_DEL2U(bi,bj,k,uFld,hFacZ,v4f,myThid)
483    
484    C     Laplacian and bi-harmonic terms, Zonal  Fluxes -> fZon
485            CALL MOM_U_XVISCFLUX(bi,bj,k,uFld,v4F,fZon,
486         I    viscAh_D,viscA4_D,myThid)
487    
488    C     Laplacian and bi-harmonic termis, Merid Fluxes -> fMer
489            CALL MOM_U_YVISCFLUX(bi,bj,k,uFld,v4F,hFacZ,fMer,
490         I    viscAh_Z,viscA4_Z,myThid)
491    
492    C     Eddy component of vertical flux (interior component only) -> fVrUp & fVrDw
493           IF (.NOT.implicitViscosity) THEN
494            CALL MOM_U_RVISCFLUX(bi,bj, k, uVel,KappaRU,fVrUp,myThid)
495            CALL MOM_U_RVISCFLUX(bi,bj,k+1,uVel,KappaRU,fVrDw,myThid)
496           ENDIF
497    
498    C--   Tendency is minus divergence of the fluxes
499    C     anelastic: hor.visc.fluxes are not scaled by rhoFac (by vert.visc.flx is)
500            DO j=jMin,jMax
501             DO i=iMin,iMax
502              guDiss(i,j) =
503  #ifdef OLD_UV_GEOM  #ifdef OLD_UV_GEOM
504       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/       &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/
505       &    ( 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)) )
506  #else  #else
507       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)       &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
508       &   *recip_rAw(i,j,bi,bj)       &     *recip_rAw(i,j,bi,bj)*recip_deepFac2C(k)
509  #endif  #endif
510       &  *(fZon(i,j  )          - fZon(i-1,j)       &     *( ( fZon(i,j  ) - fZon(i-1,j) )*AhDudxFac
511       &   +fMer(i,j+1)          - fMer(i  ,j)       &       +( fMer(i,j+1) - fMer(i,  j) )*AhDudyFac
512       &   +fVerU(i,j,kUp)*rkFac - fVerU(i,j,kDown)*rkFac       &       +( fVrDw(i,j)  - fVrUp(i,j)  )*rkSign*ArDudrFac
513       &   )       &                                     *recip_rhoFacC(k)
514       & _PHM( +phxFac * pf(i,j) )       &     )
515         ENDDO           ENDDO
516        ENDDO          ENDDO
517    
518  C-- No-slip and drag BCs appear as body forces in cell abutting topography  #ifdef ALLOW_DIAGNOSTICS
519        IF (momViscosity.AND.no_slip_sides) THEN          IF ( useDiagnostics ) THEN
520              CALL DIAGNOSTICS_FILL(fZon, 'VISCx_Um',k,1,2,bi,bj,myThid)
521              CALL DIAGNOSTICS_FILL(fMer, 'VISCy_Um',k,1,2,bi,bj,myThid)
522              IF (.NOT.implicitViscosity)
523         &    CALL DIAGNOSTICS_FILL(fVrUp,'VISrE_Um',k,1,2,bi,bj,myThid)
524            ENDIF
525    #endif
526    
527    C-- No-slip and drag BCs appear as body forces in cell abutting topography
528            IF (no_slip_sides) THEN
529  C-     No-slip BCs impose a drag at walls...  C-     No-slip BCs impose a drag at walls...
530         CALL MOM_U_SIDEDRAG(bi,bj,k,uFld,v4F,hFacZ,vF,myThid)           CALL MOM_U_SIDEDRAG(
531         DO j=jMin,jMax       I        bi,bj,k,
532          DO i=iMin,iMax       I        uFld, v4f, hFacZ,
533           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)       I        viscAh_Z,viscA4_Z,
534          ENDDO       I        harmonic,biharmonic,useVariableViscosity,
535         ENDDO       O        vF,
536        ENDIF       I        myThid)
537             DO j=jMin,jMax
538              DO i=iMin,iMax
539               gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
540              ENDDO
541             ENDDO
542            ENDIF
543  C-    No-slip BCs impose a drag at bottom  C-    No-slip BCs impose a drag at bottom
544        IF (momViscosity.AND.bottomDragTerms) THEN          IF (bottomDragTerms) THEN
545         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)           CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
546             DO j=jMin,jMax
547              DO i=iMin,iMax
548               gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
549              ENDDO
550             ENDDO
551            ENDIF
552    
553    #ifdef ALLOW_SHELFICE
554            IF (useShelfIce) THEN
555             CALL SHELFICE_U_DRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
556             DO j=jMin,jMax
557              DO i=iMin,iMax
558               gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
559              ENDDO
560             ENDDO
561            ENDIF
562    #endif /* ALLOW_SHELFICE */
563    
564    C-    endif momViscosity
565          ENDIF
566    
567    C--   Forcing term (moved to timestep.F)
568    c     IF (momForcing)
569    c    &  CALL EXTERNAL_FORCING_U(
570    c    I     iMin,iMax,jMin,jMax,bi,bj,k,
571    c    I     myTime,myThid)
572    
573    C--   Metric terms for curvilinear grid systems
574          IF (useNHMTerms) THEN
575    C      o Non-Hydrostatic (spherical) metric terms
576           CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,mT,myThid)
577         DO j=jMin,jMax         DO j=jMin,jMax
578          DO i=iMin,iMax          DO i=iMin,iMax
579           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)
580          ENDDO          ENDDO
581         ENDDO         ENDDO
582        ENDIF        ENDIF
583          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  
584  C      o Spherical polar grid metric terms  C      o Spherical polar grid metric terms
585         CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,mT,myThid)         CALL MOM_U_METRIC_SPHERE(bi,bj,k,uFld,vFld,mT,myThid)
586         DO j=jMin,jMax         DO j=jMin,jMax
587          DO i=iMin,iMax          DO i=iMin,iMax
588           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)
589          ENDDO          ENDDO
590         ENDDO         ENDDO
591         CALL MOM_U_METRIC_SPHERE(bi,bj,k,uFld,vFld,mT,myThid)        ENDIF
592          IF ( usingCylindricalGrid .AND. metricTerms ) THEN
593    C      o Cylindrical grid metric terms
594           CALL MOM_U_METRIC_CYLINDER(bi,bj,k,uFld,vFld,mT,myThid)
595         DO j=jMin,jMax         DO j=jMin,jMax
596          DO i=iMin,iMax          DO i=iMin,iMax
597           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)
598          ENDDO          ENDDO
599         ENDDO         ENDDO
600        ENDIF        ENDIF
601    
602  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  
   
603    
604  C---- Meridional momentum equation starts here  C---- Meridional momentum equation starts here
605    
606  C     Bi-harmonic term del^2 V -> v4F        IF (momAdvection) THEN
       IF (momViscosity)  
      & CALL MOM_V_DEL2V(bi,bj,k,vFld,hFacZ,v4f,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)  
607    
608  C     Laplacian and bi-harmonic terms -> vF  #ifdef MOM_BOUNDARY_CONSERVE
609        IF (momViscosity)          CALL MOM_V_ADV_UV( bi,bj,k,uTrans,vBnd(1-OLx,1-OLy,k,bi,bj),
610       & CALL MOM_V_XVISCFLUX(bi,bj,k,vFld,v4f,hFacZ,vf,myThid)       O                     fZon,myThid )
611            CALL MOM_V_ADV_VV( bi,bj,k,vTrans,vBnd(1-OLx,1-OLy,k,bi,bj),
612  C     Combine fluxes -> fZon       O                     fMer,myThid )
613        DO j=jMin,jMax          CALL MOM_V_ADV_WV(
614         DO i=iMin,iMax       I                     bi,bj,k+1,vBnd,wVel,rTransV,
615          fZon(i,j) = uDvdxFac*aF(i,j) + AhDvdxFac*vF(i,j)       O                     fVerV(1-OLx,1-OLy,kDown), myThid )
616         ENDDO  #else /* MOM_BOUNDARY_CONSERVE */
617        ENDDO  C---  Calculate mean fluxes (advection)   between cells for meridional flow.
618    C     Mean flow component of zonal flux -> fZon
619            CALL MOM_V_ADV_UV(bi,bj,k,uTrans,vFld,fZon,myThid)
620    
621  C--   Meridional flux (fMer is at north face of "v" cell)  C--   Meridional flux (fMer is at north face of "v" cell)
622    C     Mean flow component of meridional flux -> fMer
623  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  
624    
625  C--   Vertical flux (fVer is at upper face of "v" cell)  C--   Vertical flux (fVer is at upper face of "v" cell)
626    C     Mean flow component of vertical flux (at k+1) -> fVerV
627            CALL MOM_V_ADV_WV(
628         I                     bi,bj,k+1,vVel,wVel,rTransV,
629         O                     fVerV(1-OLx,1-OLy,kDown), myThid )
630    #endif /* MOM_BOUNDARY_CONSERVE */
631    
632  C--   Free surface correction term (flux at k=1)  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
633        IF (momAdvection.AND.k.EQ.1) THEN          DO j=jMin,jMax
634         CALL MOM_V_ADV_WV(bi,bj,k,vVel,wVel,af,myThid)           DO i=iMin,iMax
635         DO j=jMin,jMax            gV(i,j,k,bi,bj) =
636          DO i=iMin,iMax  #ifdef OLD_UV_GEOM
637           fVerV(i,j,kUp) = af(i,j)       &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/
638         &      ( 0.5 _d 0*(_rA(i,j,bi,bj)+_rA(i,j-1,bi,bj)) )
639    #else
640         &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
641         &     *recip_rAs(i,j,bi,bj)*recip_deepFac2C(k)*recip_rhoFacC(k)
642    #endif
643         &     *( ( fZon(i+1,j)     - fZon(i,j  ) )*uDvdxFac
644         &       +( fMer(i,  j)     - fMer(i,j-1) )*vDvdyFac
645         &       +(fVerV(i,j,kDown) - fVerV(i,j,kUp))*rkSign*rVelDvdrFac
646         &     )
647             ENDDO
648          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)  
649    
650  C     Eddy component of vertical flux (interior component only) -> vrF  #ifdef ALLOW_DIAGNOSTICS
651        IF (momViscosity.AND..NOT.implicitViscosity)          IF ( useDiagnostics ) THEN
652       & CALL MOM_V_RVISCFLUX(bi,bj,k,vVel,KappaRV,vrf,myThid)            CALL DIAGNOSTICS_FILL(fZon,'ADVx_Vm ',k,1,2,bi,bj,myThid)
653              CALL DIAGNOSTICS_FILL(fMer,'ADVy_Vm ',k,1,2,bi,bj,myThid)
654              CALL DIAGNOSTICS_FILL(fVerV(1-OLx,1-OLy,kUp),
655         &                               'ADVrE_Vm',k,1,2,bi,bj,myThid)
656            ENDIF
657    #endif
658    
659  C     Combine fluxes -> fVerV  #ifdef NONLIN_FRSURF
660        DO j=jMin,jMax  C-- account for 3.D divergence of the flow in rStar coordinate:
661         DO i=iMin,iMax  # ifndef DISABLE_RSTAR_CODE
662          fVerV(i,j,kDown) = rVelDvdrFac*aF(i,j) + ArDvdrFac*vrF(i,j)          IF ( select_rStar.GT.0 ) THEN
663         ENDDO           DO j=jMin,jMax
664        ENDDO            DO i=iMin,iMax
665               gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)
666         &     - (rStarExpS(i,j,bi,bj) - 1. _d 0)/deltaTfreesurf
667         &       *vVel(i,j,k,bi,bj)
668              ENDDO
669             ENDDO
670            ENDIF
671            IF ( select_rStar.LT.0 ) THEN
672             DO j=jMin,jMax
673              DO i=iMin,iMax
674               gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)
675         &     - rStarDhSDt(i,j,bi,bj)*vVel(i,j,k,bi,bj)
676              ENDDO
677             ENDDO
678            ENDIF
679    # endif /* DISABLE_RSTAR_CODE */
680    #endif /* NONLIN_FRSURF */
681    
682    #ifdef ALLOW_ADDFLUID
683            IF ( selectAddFluid.GE.1 ) THEN
684             DO j=jMin,jMax
685              DO i=iMin,iMax
686               gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)
687         &     + vVel(i,j,k,bi,bj)*mass2rUnit*0.5 _d 0
688         &      *( addMass(i,j-1,k,bi,bj) + addMass(i,j,k,bi,bj) )
689         &      *_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)*recip_rhoFacC(k)
690         &      * recip_rAs(i,j,bi,bj)*recip_deepFac2C(k)
691              ENDDO
692             ENDDO
693            ENDIF
694    #endif /* ALLOW_ADDFLUID */
695    
696  C---  Hydorstatic term (-1/rhoConst . dphi/dy )        ELSE
697        IF (momPressureForcing) THEN  C-    if momAdvection / else
698         DO j=jMin,jMax          DO j=1-OLy,sNy+OLy
699          DO i=iMin,iMax           DO i=1-OLx,sNx+OLx
700           pF(i,j) = -_recip_dyC(i,j,bi,bj)             gV(i,j,k,bi,bj) = 0. _d 0
701       &    *(phi_hyd(i,j,k)-phi_hyd(i,j-1,k))           ENDDO
702          ENDDO          ENDDO
703         ENDDO  
704    C-    endif momAdvection.
705        ENDIF        ENDIF
706    
707          IF (momViscosity) THEN
708    C---  Calculate eddy fluxes (dissipation) between cells for meridional flow.
709    C     Bi-harmonic term del^2 V -> v4F
710            IF (biharmonic)
711         &  CALL MOM_V_DEL2V(bi,bj,k,vFld,hFacZ,v4f,myThid)
712    
713    C     Laplacian and bi-harmonic terms, Zonal  Fluxes -> fZon
714            CALL MOM_V_XVISCFLUX(bi,bj,k,vFld,v4f,hFacZ,fZon,
715         I    viscAh_Z,viscA4_Z,myThid)
716    
717    C     Laplacian and bi-harmonic termis, Merid Fluxes -> fMer
718            CALL MOM_V_YVISCFLUX(bi,bj,k,vFld,v4f,fMer,
719         I    viscAh_D,viscA4_D,myThid)
720    
721    C     Eddy component of vertical flux (interior component only) -> fVrUp & fVrDw
722           IF (.NOT.implicitViscosity) THEN
723            CALL MOM_V_RVISCFLUX(bi,bj, k, vVel,KappaRV,fVrUp,myThid)
724            CALL MOM_V_RVISCFLUX(bi,bj,k+1,vVel,KappaRV,fVrDw,myThid)
725           ENDIF
726    
727  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
728        DO j=jMin,jMax  C     anelastic: hor.visc.fluxes are not scaled by rhoFac (by vert.visc.flx is)
729         DO i=iMin,iMax          DO j=jMin,jMax
730          gV(i,j,k,bi,bj) =           DO i=iMin,iMax
731              gvDiss(i,j) =
732  #ifdef OLD_UV_GEOM  #ifdef OLD_UV_GEOM
733       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/       &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/
734       &    ( 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)) )
735  #else  #else
736       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)       &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
737       &    *recip_rAs(i,j,bi,bj)       &      *recip_rAs(i,j,bi,bj)*recip_deepFac2C(k)
738  #endif  #endif
739       &  *(fZon(i+1,j)          - fZon(i,j  )       &     *( ( fZon(i+1,j)  - fZon(i,j  ) )*AhDvdxFac
740       &   +fMer(i,j  )          - fMer(i,j-1)       &       +( fMer(i,  j)  - fMer(i,j-1) )*AhDvdyFac
741       &   +fVerV(i,j,kUp)*rkFac - fVerV(i,j,kDown)*rkFac       &       +( fVrDw(i,j)   - fVrUp(i,j) )*rkSign*ArDvdrFac
742       &   )       &                                     *recip_rhoFacC(k)
743       & _PHM( +phyFac*pf(i,j) )       &     )
744         ENDDO           ENDDO
745        ENDDO          ENDDO
746    
747  C-- No-slip and drag BCs appear as body forces in cell abutting topography  #ifdef ALLOW_DIAGNOSTICS
748        IF (momViscosity.AND.no_slip_sides) THEN          IF ( useDiagnostics ) THEN
749              CALL DIAGNOSTICS_FILL(fZon, 'VISCx_Vm',k,1,2,bi,bj,myThid)
750              CALL DIAGNOSTICS_FILL(fMer, 'VISCy_Vm',k,1,2,bi,bj,myThid)
751              IF (.NOT.implicitViscosity)
752         &    CALL DIAGNOSTICS_FILL(fVrUp,'VISrE_Vm',k,1,2,bi,bj,myThid)
753            ENDIF
754    #endif
755    
756    C-- No-slip and drag BCs appear as body forces in cell abutting topography
757            IF (no_slip_sides) THEN
758  C-     No-slip BCs impose a drag at walls...  C-     No-slip BCs impose a drag at walls...
759         CALL MOM_V_SIDEDRAG(bi,bj,k,vFld,v4F,hFacZ,vF,myThid)           CALL MOM_V_SIDEDRAG(
760         DO j=jMin,jMax       I        bi,bj,k,
761          DO i=iMin,iMax       I        vFld, v4f, hFacZ,
762           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)       I        viscAh_Z,viscA4_Z,
763          ENDDO       I        harmonic,biharmonic,useVariableViscosity,
764         ENDDO       O        vF,
765        ENDIF       I        myThid)
766             DO j=jMin,jMax
767              DO i=iMin,iMax
768               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
769              ENDDO
770             ENDDO
771            ENDIF
772  C-    No-slip BCs impose a drag at bottom  C-    No-slip BCs impose a drag at bottom
773        IF (momViscosity.AND.bottomDragTerms) THEN          IF (bottomDragTerms) THEN
774         CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)           CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)
775             DO j=jMin,jMax
776              DO i=iMin,iMax
777               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
778              ENDDO
779             ENDDO
780            ENDIF
781    
782    #ifdef ALLOW_SHELFICE
783            IF (useShelfIce) THEN
784             CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRU,vF,myThid)
785             DO j=jMin,jMax
786              DO i=iMin,iMax
787               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
788              ENDDO
789             ENDDO
790            ENDIF
791    #endif /* ALLOW_SHELFICE */
792    
793    C-    endif momViscosity
794          ENDIF
795    
796    C--   Forcing term (moved to timestep.F)
797    c     IF (momForcing)
798    c    & CALL EXTERNAL_FORCING_V(
799    c    I     iMin,iMax,jMin,jMax,bi,bj,k,
800    c    I     myTime,myThid)
801    
802    C--   Metric terms for curvilinear grid systems
803          IF (useNHMTerms) THEN
804    C      o Non-Hydrostatic (spherical) metric terms
805           CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,mT,myThid)
806         DO j=jMin,jMax         DO j=jMin,jMax
807          DO i=iMin,iMax          DO i=iMin,iMax
808           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+mtNHFacV*mT(i,j)
809          ENDDO          ENDDO
810         ENDDO         ENDDO
811        ENDIF        ENDIF
812          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  
813  C      o Spherical polar grid metric terms  C      o Spherical polar grid metric terms
814         CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,mT,myThid)         CALL MOM_V_METRIC_SPHERE(bi,bj,k,uFld,mT,myThid)
815         DO j=jMin,jMax         DO j=jMin,jMax
816          DO i=iMin,iMax          DO i=iMin,iMax
817           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)
818          ENDDO          ENDDO
819         ENDDO         ENDDO
820         CALL MOM_V_METRIC_SPHERE(bi,bj,k,uFld,mT,myThid)        ENDIF
821          IF ( usingCylindricalGrid .AND. metricTerms ) THEN
822    C      o Cylindrical grid metric terms
823           CALL MOM_V_METRIC_CYLINDER(bi,bj,k,uFld,vFld,mT,myThid)
824         DO j=jMin,jMax         DO j=jMin,jMax
825          DO i=iMin,iMax          DO i=iMin,iMax
826           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)
827          ENDDO          ENDDO
828         ENDDO         ENDDO
829        ENDIF        ENDIF
830    
831  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  
832    
833  C--   Coriolis term  C--   Coriolis term
834  C     Note. As coded here, coriolis will not work with "thin walls"  C     Note. As coded here, coriolis will not work with "thin walls"
835  #ifdef INCLUDE_CD_CODE  c     IF (useCDscheme) THEN
836        CALL MOM_CDSCHEME(bi,bj,k,phi_hyd,myThid)  c       CALL MOM_CDSCHEME(bi,bj,k,dPhiHydX,dPhiHydY,myThid)
837  #else  c     ELSE
838        CALL MOM_U_CORIOLIS(bi,bj,k,vFld,cf,myThid)        IF (.NOT.useCDscheme) THEN
839        DO j=jMin,jMax          CALL MOM_U_CORIOLIS(bi,bj,k,vFld,cf,myThid)
840         DO i=iMin,iMax          DO j=jMin,jMax
841          gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)           DO i=iMin,iMax
842         ENDDO            gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)
843        ENDDO           ENDDO
844        CALL MOM_V_CORIOLIS(bi,bj,k,uFld,cf,myThid)          ENDDO
845    #ifdef ALLOW_DIAGNOSTICS
846            IF ( useDiagnostics )
847         &    CALL DIAGNOSTICS_FILL(cf,'Um_Cori ',k,1,2,bi,bj,myThid)
848    #endif
849            CALL MOM_V_CORIOLIS(bi,bj,k,uFld,cf,myThid)
850            DO j=jMin,jMax
851             DO i=iMin,iMax
852              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+fvFac*cf(i,j)
853             ENDDO
854            ENDDO
855    #ifdef ALLOW_DIAGNOSTICS
856            IF ( useDiagnostics )
857         &    CALL DIAGNOSTICS_FILL(cf,'Vm_Cori ',k,1,2,bi,bj,myThid)
858    #endif
859          ENDIF
860    
861    C--   3.D Coriolis term (horizontal momentum, Eastward component: -fprime*w)
862          IF ( use3dCoriolis ) THEN
863            CALL MOM_U_CORIOLIS_NH(bi,bj,k,wVel,cf,myThid)
864            DO j=jMin,jMax
865             DO i=iMin,iMax
866              gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)
867             ENDDO
868            ENDDO
869           IF ( usingCurvilinearGrid ) THEN
870    C-     presently, non zero angleSinC array only supported with Curvilinear-Grid
871            CALL MOM_V_CORIOLIS_NH(bi,bj,k,wVel,cf,myThid)
872            DO j=jMin,jMax
873             DO i=iMin,iMax
874              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+fvFac*cf(i,j)
875             ENDDO
876            ENDDO
877           ENDIF
878          ENDIF
879    
880    C--   Set du/dt & dv/dt on boundaries to zero
881        DO j=jMin,jMax        DO j=jMin,jMax
882         DO i=iMin,iMax         DO i=iMin,iMax
883          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)
884            guDiss(i,j)     = guDiss(i,j)    *_maskW(i,j,k,bi,bj)
885            gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)
886            gvDiss(i,j)     = gvDiss(i,j)    *_maskS(i,j,k,bi,bj)
887         ENDDO         ENDDO
888        ENDDO        ENDDO
889  #endif /* INCLUDE_CD_CODE */  
890    #ifdef ALLOW_DIAGNOSTICS
891          IF ( useDiagnostics ) THEN
892            CALL DIAGNOSTICS_FILL(KE,    'momKE   ',k,1,2,bi,bj,myThid)
893            CALL DIAGNOSTICS_FILL(gU(1-OLx,1-OLy,k,bi,bj),
894         &                               'Um_Advec',k,1,2,bi,bj,myThid)
895            CALL DIAGNOSTICS_FILL(gV(1-OLx,1-OLy,k,bi,bj),
896         &                               'Vm_Advec',k,1,2,bi,bj,myThid)
897           IF (momViscosity) THEN
898            CALL DIAGNOSTICS_FILL(guDiss,'Um_Diss ',k,1,2,bi,bj,myThid)
899            CALL DIAGNOSTICS_FILL(gvDiss,'Vm_Diss ',k,1,2,bi,bj,myThid)
900           ENDIF
901          ENDIF
902    #endif /* ALLOW_DIAGNOSTICS */
903    
904        RETURN        RETURN
905        END        END
Legend:
Removed from v.1.4  
changed lines
  Added in v.1.43
  ViewVC Help
Powered by ViewVC 1.1.22