/[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.6 by adcroft, Tue Nov 5 19:58:21 2002 UTC revision 1.39 by jmc, Tue Dec 5 05:30:38 2006 UTC
# Line 25  C where ${\bf v}=(u,v,w)$ and $\tau$, th Line 25  C where ${\bf v}=(u,v,w)$ and $\tau$, th
25  C stresses as well as internal viscous stresses.  C stresses as well as internal viscous stresses.
26  CEOI  CEOI
27    
28  #include "CPP_OPTIONS.h"  #include "MOM_FLUXFORM_OPTIONS.h"
29    
30  CBOP  CBOP
31  C !ROUTINE: MOM_FLUXFORM  C !ROUTINE: MOM_FLUXFORM
32    
33  C !INTERFACE: ==========================================================  C !INTERFACE: ==========================================================
34        SUBROUTINE MOM_FLUXFORM(        SUBROUTINE MOM_FLUXFORM(
35       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,
36       I        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    
162        km1=MAX(1,k-1)  #ifdef ALLOW_AUTODIFF_TAMC
163        kp1=MIN(Nr,k+1)            act0 = k - 1
164        rVelMaskOverride=1.            max0 = Nr
165        IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac            act1 = bi - myBxLo(myThid)
166        wVelBottomOverride=1.            max1 = myBxHi(myThid) - myBxLo(myThid) + 1
167        IF (k.EQ.Nr) wVelBottomOverride=0.            act2 = bj - myByLo(myThid)
168              max2 = myByHi(myThid) - myByLo(myThid) + 1
169              act3 = myThid - 1
170              max3 = nTx*nTy
171              act4 = ikey_dynamics - 1
172              imomkey = (act0 + 1)
173         &                    + act1*max0
174         &                    + act2*max0*max1
175         &                    + act3*max0*max1*max2
176         &                    + act4*max0*max1*max2*max3
177    #endif /* ALLOW_AUTODIFF_TAMC */
178    
179  C     Initialise intermediate terms  C     Initialise intermediate terms
180        DO J=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
181         DO I=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
         aF(i,j)   = 0.  
182          vF(i,j)   = 0.          vF(i,j)   = 0.
183          v4F(i,j)  = 0.          v4F(i,j)  = 0.
         vrF(i,j)  = 0.  
184          cF(i,j)   = 0.          cF(i,j)   = 0.
185          mT(i,j)   = 0.          mT(i,j)   = 0.
         pF(i,j)   = 0.  
186          fZon(i,j) = 0.          fZon(i,j) = 0.
187          fMer(i,j) = 0.          fMer(i,j) = 0.
188            fVrUp(i,j)= 0.
189            fVrDw(i,j)= 0.
190            rTransU(i,j)= 0.
191            rTransV(i,j)= 0.
192    c       KE(i,j)     = 0.
193    c       hDiv(i,j)   = 0.
194            vort3(i,j)  = 0.
195            strain(i,j) = 0.
196            tension(i,j)= 0.
197            guDiss(i,j) = 0.
198            gvDiss(i,j) = 0.
199         ENDDO         ENDDO
200        ENDDO        ENDDO
201    
# Line 181  C--   Term by term tracer parmeters Line 203  C--   Term by term tracer parmeters
203  C     o U momentum equation  C     o U momentum equation
204        uDudxFac     = afFacMom*1.        uDudxFac     = afFacMom*1.
205        AhDudxFac    = vfFacMom*1.        AhDudxFac    = vfFacMom*1.
       A4DuxxdxFac  = vfFacMom*1.  
206        vDudyFac     = afFacMom*1.        vDudyFac     = afFacMom*1.
207        AhDudyFac    = vfFacMom*1.        AhDudyFac    = vfFacMom*1.
       A4DuyydyFac  = vfFacMom*1.  
208        rVelDudrFac  = afFacMom*1.        rVelDudrFac  = afFacMom*1.
209        ArDudrFac    = vfFacMom*1.        ArDudrFac    = vfFacMom*1.
210        mTFacU       = mtFacMom*1.        mtFacU       = mtFacMom*1.
211          mtNHFacU     = 1.
212        fuFac        = cfFacMom*1.        fuFac        = cfFacMom*1.
       phxFac       = pfFacMom*1.  
213  C     o V momentum equation  C     o V momentum equation
214        uDvdxFac     = afFacMom*1.        uDvdxFac     = afFacMom*1.
215        AhDvdxFac    = vfFacMom*1.        AhDvdxFac    = vfFacMom*1.
       A4DvxxdxFac  = vfFacMom*1.  
216        vDvdyFac     = afFacMom*1.        vDvdyFac     = afFacMom*1.
217        AhDvdyFac    = vfFacMom*1.        AhDvdyFac    = vfFacMom*1.
       A4DvyydyFac  = vfFacMom*1.  
218        rVelDvdrFac  = afFacMom*1.        rVelDvdrFac  = afFacMom*1.
219        ArDvdrFac    = vfFacMom*1.        ArDvdrFac    = vfFacMom*1.
220        mTFacV       = mtFacMom*1.        mtFacV       = mtFacMom*1.
221          mtNHFacV     = 1.
222        fvFac        = cfFacMom*1.        fvFac        = cfFacMom*1.
223        phyFac       = pfFacMom*1.  
224        vForcFac     = foFacMom*1.        IF (implicitViscosity) THEN
225            ArDudrFac  = 0.
226            ArDvdrFac  = 0.
227          ENDIF
228    
229    C note: using standard stencil (no mask) results in under-estimating
230    C       vorticity at a no-slip boundary by a factor of 2 = sideDragFactor
231          IF ( no_slip_sides ) THEN
232            sideMaskFac = sideDragFactor
233          ELSE
234            sideMaskFac = 0. _d 0
235          ENDIF
236    
237        IF (     no_slip_bottom        IF (     no_slip_bottom
238       &    .OR. bottomDragQuadratic.NE.0.       &    .OR. bottomDragQuadratic.NE.0.
# Line 212  C     o V momentum equation Line 242  C     o V momentum equation
242         bottomDragTerms=.FALSE.         bottomDragTerms=.FALSE.
243        ENDIF        ENDIF
244    
 C-- with stagger time stepping, grad Phi_Hyp is directly incoporated in TIMESTEP  
       IF (staggerTimeStep) THEN  
         phxFac = 0.  
         phyFac = 0.  
       ENDIF  
   
245  C--   Calculate open water fraction at vorticity points  C--   Calculate open water fraction at vorticity points
246        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)
247    
# Line 225  C---- Calculate common quantities used i Line 249  C---- Calculate common quantities used i
249  C     Calculate tracer cell face open areas  C     Calculate tracer cell face open areas
250        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
251         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
252          xA(i,j) = _dyG(i,j,bi,bj)          xA(i,j) = _dyG(i,j,bi,bj)*deepFacC(k)
253       &   *drF(k)*_hFacW(i,j,k,bi,bj)       &          *drF(k)*_hFacW(i,j,k,bi,bj)
254          yA(i,j) = _dxG(i,j,bi,bj)          yA(i,j) = _dxG(i,j,bi,bj)*deepFacC(k)
255       &   *drF(k)*_hFacS(i,j,k,bi,bj)       &          *drF(k)*_hFacS(i,j,k,bi,bj)
256         ENDDO         ENDDO
257        ENDDO        ENDDO
258    
# Line 241  C     Make local copies of horizontal fl Line 265  C     Make local copies of horizontal fl
265        ENDDO        ENDDO
266    
267  C     Calculate velocity field "volume transports" through tracer cell faces.  C     Calculate velocity field "volume transports" through tracer cell faces.
268    C     anelastic: transports are scaled by rhoFacC (~ mass transport)
269        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
270         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
271          uTrans(i,j) = uFld(i,j)*xA(i,j)          uTrans(i,j) = uFld(i,j)*xA(i,j)*rhoFacC(k)
272          vTrans(i,j) = vFld(i,j)*yA(i,j)          vTrans(i,j) = vFld(i,j)*yA(i,j)*rhoFacC(k)
273         ENDDO         ENDDO
274        ENDDO        ENDDO
275    
276        CALL MOM_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid)        CALL MOM_CALC_KE(bi,bj,k,2,uFld,vFld,KE,myThid)
277          IF ( momViscosity) THEN
278            CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid)
279            CALL MOM_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)
280            CALL MOM_CALC_TENSION(bi,bj,k,uFld,vFld,tension,myThid)
281            CALL MOM_CALC_STRAIN(bi,bj,k,uFld,vFld,hFacZ,strain,myThid)
282            DO j=1-Oly,sNy+Oly
283             DO i=1-Olx,sNx+Olx
284               IF ( hFacZ(i,j).EQ.0. ) THEN
285                 vort3(i,j)  = sideMaskFac*vort3(i,j)
286                 strain(i,j) = sideMaskFac*strain(i,j)
287               ENDIF
288             ENDDO
289            ENDDO
290    #ifdef ALLOW_DIAGNOSTICS
291            IF ( useDiagnostics ) THEN
292              CALL DIAGNOSTICS_FILL(hDiv,   'momHDiv ',k,1,2,bi,bj,myThid)
293              CALL DIAGNOSTICS_FILL(vort3,  'momVort3',k,1,2,bi,bj,myThid)
294              CALL DIAGNOSTICS_FILL(tension,'Tension ',k,1,2,bi,bj,myThid)
295              CALL DIAGNOSTICS_FILL(strain, 'Strain  ',k,1,2,bi,bj,myThid)
296            ENDIF
297    #endif
298          ENDIF
299    
300  C---- Zonal momentum equation starts here  C---  First call (k=1): compute vertical adv. flux fVerU(kUp) & fVerV(kUp)
301          IF (momAdvection.AND.k.EQ.1) THEN
302    
303  C     Bi-harmonic term del^2 U -> v4F  C-    Calculate vertical transports above U & V points (West & South face):
       IF (momViscosity)  
      & CALL MOM_U_DEL2U(bi,bj,k,uFld,hFacZ,v4f,myThid)  
304    
305  C---  Calculate mean and eddy fluxes between cells for zonal flow.  #ifdef ALLOW_AUTODIFF_TAMC
306    # ifdef NONLIN_FRSURF
307    #  ifndef DISABLE_RSTAR_CODE
308    CADJ STORE dwtransc(:,:,bi,bj) =
309    CADJ &     comlev1_bibj_k, key = imomkey, byte = isbyte
310    CADJ STORE dwtransu(:,:,bi,bj) =
311    CADJ &     comlev1_bibj_k, key = imomkey, byte = isbyte
312    CADJ STORE dwtransv(:,:,bi,bj) =
313    CADJ &     comlev1_bibj_k, key = imomkey, byte = isbyte
314    #  endif
315    # endif /* NONLIN_FRSURF */
316    #endif /* ALLOW_AUTODIFF_TAMC */
317            CALL MOM_CALC_RTRANS( k, bi, bj,
318         O                        rTransU, rTransV,
319         I                        myTime, myIter, myThid)
320    
321    C-    Free surface correction term (flux at k=1)
322            CALL MOM_U_ADV_WU( bi,bj,k,uVel,wVel,rTransU,
323         O                     fVerU(1-OLx,1-OLy,kUp), myThid )
324    
325            CALL MOM_V_ADV_WV( bi,bj,k,vVel,wVel,rTransV,
326         O                     fVerV(1-OLx,1-OLy,kUp), myThid )
327    
328    C---  endif momAdvection & k=1
329          ENDIF
330    
 C--   Zonal flux (fZon is at east face of "u" cell)  
331    
332  C     Mean flow component of zonal flux -> aF  C---  Calculate vertical transports (at k+1) below U & V points :
333        IF (momAdvection)        IF (momAdvection) THEN
334       & CALL MOM_U_ADV_UU(bi,bj,k,uTrans,uFld,aF,myThid)          CALL MOM_CALC_RTRANS( k+1, bi, bj,
335         O                        rTransU, rTransV,
336  C     Laplacian and bi-harmonic terms -> vF       I                        myTime, myIter, myThid)
337        IF (momViscosity)        ENDIF
338       & CALL MOM_U_XVISCFLUX(bi,bj,k,uFld,v4F,vF,myThid)  
339          IF (momViscosity) THEN
340           CALL MOM_CALC_VISC(
341         I        bi,bj,k,
342         O        viscAh_Z,viscAh_D,viscA4_Z,viscA4_D,
343         O        harmonic,biharmonic,useVariableViscosity,
344         I        hDiv,vort3,tension,strain,KE,hFacZ,
345         I        myThid)
346          ENDIF
347    
348  C     Combine fluxes -> fZon  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         fZon(i,j) = uDudxFac*aF(i,j) + AhDudxFac*vF(i,j)  
        ENDDO  
       ENDDO  
349    
350  C--   Meridional flux (fMer is at south face of "u" cell)  C---- Zonal momentum equation starts here
351    
352  C     Mean flow component of meridional flux        IF (momAdvection) THEN
353        IF (momAdvection)  C---  Calculate mean fluxes (advection)   between cells for zonal flow.
      & CALL MOM_U_ADV_VU(bi,bj,k,vTrans,uFld,aF,myThid)  
   
 C     Laplacian and bi-harmonic term  
       IF (momViscosity)  
      & CALL MOM_U_YVISCFLUX(bi,bj,k,uFld,v4F,hFacZ,vF,myThid)  
354    
355  C     Combine fluxes -> fMer  C--   Zonal flux (fZon is at east face of "u" cell)
356        DO j=jMin,jMax  C     Mean flow component of zonal flux -> fZon
357         DO i=iMin,iMax          CALL MOM_U_ADV_UU(bi,bj,k,uTrans,uFld,fZon,myThid)
358          fMer(i,j) = vDudyFac*aF(i,j) + AhDudyFac*vF(i,j)  
359         ENDDO  C--   Meridional flux (fMer is at south face of "u" cell)
360        ENDDO  C     Mean flow component of meridional flux -> fMer
361            CALL MOM_U_ADV_VU(bi,bj,k,vTrans,uFld,fMer,myThid)
362    
363  C--   Vertical flux (fVer is at upper face of "u" cell)  C--   Vertical flux (fVer is at upper face of "u" cell)
364    C     Mean flow component of vertical flux (at k+1) -> fVer
365            CALL MOM_U_ADV_WU(
366         I                     bi,bj,k+1,uVel,wVel,rTransU,
367         O                     fVerU(1-OLx,1-OLy,kDown), myThid )
368    
369  C--   Free surface correction term (flux at k=1)  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
370        IF (momAdvection.AND.k.EQ.1) THEN          DO j=jMin,jMax
371         CALL MOM_U_ADV_WU(bi,bj,k,uVel,wVel,af,myThid)           DO i=iMin,iMax
372         DO j=jMin,jMax            gU(i,j,k,bi,bj) =
373          DO i=iMin,iMax  #ifdef OLD_UV_GEOM
374           fVerU(i,j,kUp) = af(i,j)       &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/
375         &      ( 0.5 _d 0*(rA(i,j,bi,bj)+rA(i-1,j,bi,bj)) )
376    #else
377         &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
378         &     *recip_rAw(i,j,bi,bj)*recip_deepFac2C(k)*recip_rhoFacC(k)
379    #endif
380         &     *( ( fZon(i,j  )     - fZon(i-1,j) )*uDudxFac
381         &       +( fMer(i,j+1)     - fMer(i,  j) )*vDudyFac
382         &       +(fVerU(i,j,kDown) - fVerU(i,j,kUp))*rkSign*rVelDudrFac
383         &     )
384             ENDDO
385          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)  
386    
387  C     Eddy component of vertical flux (interior component only) -> vrF  #ifdef ALLOW_DIAGNOSTICS
388        IF (momViscosity.AND..NOT.implicitViscosity)          IF ( useDiagnostics ) THEN
389       & CALL MOM_U_RVISCFLUX(bi,bj,k,uVel,KappaRU,vrF,myThid)            CALL DIAGNOSTICS_FILL(fZon,'ADVx_Um ',k,1,2,bi,bj,myThid)
390              CALL DIAGNOSTICS_FILL(fMer,'ADVy_Um ',k,1,2,bi,bj,myThid)
391              CALL DIAGNOSTICS_FILL(fVerU(1-Olx,1-Oly,kUp),
392         &                               'ADVrE_Um',k,1,2,bi,bj,myThid)
393            ENDIF
394    #endif
395    
396  C     Combine fluxes  #ifdef NONLIN_FRSURF
397        DO j=jMin,jMax  C-- account for 3.D divergence of the flow in rStar coordinate:
398         DO i=iMin,iMax  # ifndef DISABLE_RSTAR_CODE
399          fVerU(i,j,kDown) = rVelDudrFac*aF(i,j) + ArDudrFac*vrF(i,j)          IF ( select_rStar.GT.0 ) THEN
400         ENDDO           DO j=jMin,jMax
401        ENDDO            DO i=iMin,iMax
402               gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)
403         &     - (rStarExpW(i,j,bi,bj) - 1. _d 0)/deltaTfreesurf
404         &       *uVel(i,j,k,bi,bj)
405              ENDDO
406             ENDDO
407            ENDIF
408            IF ( select_rStar.LT.0 ) THEN
409             DO j=jMin,jMax
410              DO i=iMin,iMax
411               gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)
412         &     - rStarDhWDt(i,j,bi,bj)*uVel(i,j,k,bi,bj)
413              ENDDO
414             ENDDO
415            ENDIF
416    # endif /* DISABLE_RSTAR_CODE */
417    #endif /* NONLIN_FRSURF */
418    
419  C---  Hydrostatic term ( -1/rhoConst . dphi/dx )        ELSE
420        IF (momPressureForcing) THEN  C-    if momAdvection / else
421         DO j=jMin,jMax          DO j=1-OLy,sNy+OLy
422          DO i=iMin,iMax           DO i=1-OLx,sNx+OLx
423           pf(i,j) = - _recip_dxC(i,j,bi,bj)             gU(i,j,k,bi,bj) = 0. _d 0
424       &    *(phi_hyd(i,j,k)-phi_hyd(i-1,j,k))           ENDDO
425          ENDDO          ENDDO
426         ENDDO  
427    C-    endif momAdvection.
428        ENDIF        ENDIF
429    
430  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term        IF (momViscosity) THEN
431        DO j=jMin,jMax  C---  Calculate eddy fluxes (dissipation) between cells for zonal flow.
432         DO i=iMin,iMax  
433          gU(i,j,k,bi,bj) =  C     Bi-harmonic term del^2 U -> v4F
434            IF (biharmonic)
435         &  CALL MOM_U_DEL2U(bi,bj,k,uFld,hFacZ,v4f,myThid)
436    
437    C     Laplacian and bi-harmonic terms, Zonal  Fluxes -> fZon
438            CALL MOM_U_XVISCFLUX(bi,bj,k,uFld,v4F,fZon,
439         I    viscAh_D,viscA4_D,myThid)
440    
441    C     Laplacian and bi-harmonic termis, Merid Fluxes -> fMer
442            CALL MOM_U_YVISCFLUX(bi,bj,k,uFld,v4F,hFacZ,fMer,
443         I    viscAh_Z,viscA4_Z,myThid)
444    
445    C     Eddy component of vertical flux (interior component only) -> fVrUp & fVrDw
446           IF (.NOT.implicitViscosity) THEN
447            CALL MOM_U_RVISCFLUX(bi,bj, k, uVel,KappaRU,fVrUp,myThid)
448            CALL MOM_U_RVISCFLUX(bi,bj,k+1,uVel,KappaRU,fVrDw,myThid)
449           ENDIF
450    
451    C--   Tendency is minus divergence of the fluxes
452    C     anelastic: hor.visc.fluxes are not scaled by rhoFac (by vert.visc.flx is)
453            DO j=jMin,jMax
454             DO i=iMin,iMax
455              guDiss(i,j) =
456  #ifdef OLD_UV_GEOM  #ifdef OLD_UV_GEOM
457       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/       &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)/
458       &    ( 0.5 _d 0*(rA(i,j,bi,bj)+rA(i-1,j,bi,bj)) )       &      ( 0.5 _d 0*(rA(i,j,bi,bj)+rA(i-1,j,bi,bj)) )
459  #else  #else
460       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)       &     -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
461       &   *recip_rAw(i,j,bi,bj)       &     *recip_rAw(i,j,bi,bj)*recip_deepFac2C(k)
462    #endif
463         &     *( ( fZon(i,j  ) - fZon(i-1,j) )*AhDudxFac
464         &       +( fMer(i,j+1) - fMer(i,  j) )*AhDudyFac
465         &       +( fVrDw(i,j)  - fVrUp(i,j)  )*rkSign*ArDudrFac
466         &                                     *recip_rhoFacC(k)
467         &     )
468             ENDDO
469            ENDDO
470    
471    #ifdef ALLOW_DIAGNOSTICS
472            IF ( useDiagnostics ) THEN
473              CALL DIAGNOSTICS_FILL(fZon, 'VISCx_Um',k,1,2,bi,bj,myThid)
474              CALL DIAGNOSTICS_FILL(fMer, 'VISCy_Um',k,1,2,bi,bj,myThid)
475              IF (.NOT.implicitViscosity)
476         &    CALL DIAGNOSTICS_FILL(fVrUp,'VISrE_Um',k,1,2,bi,bj,myThid)
477            ENDIF
478  #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  
479    
480  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
481        IF (momViscosity.AND.no_slip_sides) THEN          IF (no_slip_sides) THEN
482  C-     No-slip BCs impose a drag at walls...  C-     No-slip BCs impose a drag at walls...
483         CALL MOM_U_SIDEDRAG(bi,bj,k,uFld,v4F,hFacZ,vF,myThid)           CALL MOM_U_SIDEDRAG(
484         DO j=jMin,jMax       I        bi,bj,k,
485          DO i=iMin,iMax       I        uFld, v4f, hFacZ,
486           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)       I        viscAh_Z,viscA4_Z,
487          ENDDO       I        harmonic,biharmonic,useVariableViscosity,
488         ENDDO       O        vF,
489        ENDIF       I        myThid)
490             DO j=jMin,jMax
491              DO i=iMin,iMax
492               gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
493              ENDDO
494             ENDDO
495            ENDIF
496  C-    No-slip BCs impose a drag at bottom  C-    No-slip BCs impose a drag at bottom
497        IF (momViscosity.AND.bottomDragTerms) THEN          IF (bottomDragTerms) THEN
498         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)           CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
499         DO j=jMin,jMax           DO j=jMin,jMax
500          DO i=iMin,iMax            DO i=iMin,iMax
501           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)             gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
502          ENDDO            ENDDO
503         ENDDO           ENDDO
504        ENDIF          ENDIF
505    
506  C--   Forcing term  #ifdef ALLOW_SHELFICE
507        IF (momForcing)          IF (useShelfIce) THEN
508       &  CALL EXTERNAL_FORCING_U(           CALL SHELFICE_U_DRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
509       I     iMin,iMax,jMin,jMax,bi,bj,k,           DO j=jMin,jMax
510       I     myCurrentTime,myThid)            DO i=iMin,iMax
511               gUdiss(i,j) = gUdiss(i,j) + vF(i,j)
512              ENDDO
513             ENDDO
514            ENDIF
515    #endif /* ALLOW_SHELFICE */
516    
517    C-    endif momViscosity
518          ENDIF
519    
520    C--   Forcing term (moved to timestep.F)
521    c     IF (momForcing)
522    c    &  CALL EXTERNAL_FORCING_U(
523    c    I     iMin,iMax,jMin,jMax,bi,bj,k,
524    c    I     myTime,myThid)
525    
526  C--   Metric terms for curvilinear grid systems  C--   Metric terms for curvilinear grid systems
527        IF (useNHMTerms) THEN        IF (useNHMTerms) THEN
528  C      o Non-hydrosatic metric terms  C      o Non-Hydrostatic (spherical) metric terms
529         CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,mT,myThid)         CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,mT,myThid)
530         DO j=jMin,jMax         DO j=jMin,jMax
531          DO i=iMin,iMax          DO i=iMin,iMax
532           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+mTFacU*mT(i,j)           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+mtNHFacU*mT(i,j)
533          ENDDO          ENDDO
534         ENDDO         ENDDO
535        ENDIF        ENDIF
536        IF (usingSphericalPolarMTerms) THEN        IF ( usingSphericalPolarGrid .AND. metricTerms ) THEN
537    C      o Spherical polar grid metric terms
538         CALL MOM_U_METRIC_SPHERE(bi,bj,k,uFld,vFld,mT,myThid)         CALL MOM_U_METRIC_SPHERE(bi,bj,k,uFld,vFld,mT,myThid)
539         DO j=jMin,jMax         DO j=jMin,jMax
540          DO i=iMin,iMax          DO i=iMin,iMax
541           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)
542          ENDDO          ENDDO
543         ENDDO         ENDDO
544        ENDIF        ENDIF
545          IF ( usingCylindricalGrid .AND. metricTerms ) THEN
546  C--   Set du/dt on boundaries to zero  C      o Cylindrical grid metric terms
547        DO j=jMin,jMax         CALL MOM_U_METRIC_CYLINDER(bi,bj,k,uFld,vFld,mT,myThid)
548         DO i=iMin,iMax         DO j=jMin,jMax
549          gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)*_maskW(i,j,k,bi,bj)          DO i=iMin,iMax
550             gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+mtFacU*mT(i,j)
551            ENDDO
552         ENDDO         ENDDO
553        ENDDO        ENDIF
554    
555    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
556    
557  C---- Meridional momentum equation starts here  C---- Meridional momentum equation starts here
558    
559  C     Bi-harmonic term del^2 V -> v4F        IF (momAdvection) THEN
560        IF (momViscosity)  C---  Calculate mean fluxes (advection)   between cells for meridional flow.
561       & CALL MOM_V_DEL2V(bi,bj,k,vFld,hFacZ,v4f,myThid)  C     Mean flow component of zonal flux -> fZon
562            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  
563    
564  C--   Meridional flux (fMer is at north face of "v" cell)  C--   Meridional flux (fMer is at north face of "v" cell)
565    C     Mean flow component of meridional flux -> fMer
566  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  
567    
568  C--   Vertical flux (fVer is at upper face of "v" cell)  C--   Vertical flux (fVer is at upper face of "v" cell)
569    C     Mean flow component of vertical flux (at k+1) -> fVerV
570            CALL MOM_V_ADV_WV(
571         I                     bi,bj,k+1,vVel,wVel,rTransV,
572         O                     fVerV(1-OLx,1-OLy,kDown), myThid )
573    
574  C--   Free surface correction term (flux at k=1)  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
575        IF (momAdvection.AND.k.EQ.1) THEN          DO j=jMin,jMax
576         CALL MOM_V_ADV_WV(bi,bj,k,vVel,wVel,af,myThid)           DO i=iMin,iMax
577         DO j=jMin,jMax            gV(i,j,k,bi,bj) =
578          DO i=iMin,iMax  #ifdef OLD_UV_GEOM
579           fVerV(i,j,kUp) = af(i,j)       &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/
580         &      ( 0.5 _d 0*(_rA(i,j,bi,bj)+_rA(i,j-1,bi,bj)) )
581    #else
582         &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
583         &     *recip_rAs(i,j,bi,bj)*recip_deepFac2C(k)*recip_rhoFacC(k)
584    #endif
585         &     *( ( fZon(i+1,j)     - fZon(i,j  ) )*uDvdxFac
586         &       +( fMer(i,  j)     - fMer(i,j-1) )*vDvdyFac
587         &       +(fVerV(i,j,kDown) - fVerV(i,j,kUp))*rkSign*rVelDvdrFac
588         &     )
589             ENDDO
590          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)  
591    
592  C     Eddy component of vertical flux (interior component only) -> vrF  #ifdef ALLOW_DIAGNOSTICS
593        IF (momViscosity.AND..NOT.implicitViscosity)          IF ( useDiagnostics ) THEN
594       & CALL MOM_V_RVISCFLUX(bi,bj,k,vVel,KappaRV,vrf,myThid)            CALL DIAGNOSTICS_FILL(fZon,'ADVx_Vm ',k,1,2,bi,bj,myThid)
595              CALL DIAGNOSTICS_FILL(fMer,'ADVy_Vm ',k,1,2,bi,bj,myThid)
596              CALL DIAGNOSTICS_FILL(fVerV(1-Olx,1-Oly,kUp),
597         &                               'ADVrE_Vm',k,1,2,bi,bj,myThid)
598            ENDIF
599    #endif
600    
601  C     Combine fluxes -> fVerV  #ifdef NONLIN_FRSURF
602        DO j=jMin,jMax  C-- account for 3.D divergence of the flow in rStar coordinate:
603         DO i=iMin,iMax  # ifndef DISABLE_RSTAR_CODE
604          fVerV(i,j,kDown) = rVelDvdrFac*aF(i,j) + ArDvdrFac*vrF(i,j)          IF ( select_rStar.GT.0 ) THEN
605         ENDDO           DO j=jMin,jMax
606        ENDDO            DO i=iMin,iMax
607               gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)
608         &     - (rStarExpS(i,j,bi,bj) - 1. _d 0)/deltaTfreesurf
609         &       *vVel(i,j,k,bi,bj)
610              ENDDO
611             ENDDO
612            ENDIF
613            IF ( select_rStar.LT.0 ) THEN
614             DO j=jMin,jMax
615              DO i=iMin,iMax
616               gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)
617         &     - rStarDhSDt(i,j,bi,bj)*vVel(i,j,k,bi,bj)
618              ENDDO
619             ENDDO
620            ENDIF
621    # endif /* DISABLE_RSTAR_CODE */
622    #endif /* NONLIN_FRSURF */
623    
624  C---  Hydorstatic term (-1/rhoConst . dphi/dy )        ELSE
625        IF (momPressureForcing) THEN  C-    if momAdvection / else
626         DO j=jMin,jMax          DO j=1-OLy,sNy+OLy
627          DO i=iMin,iMax           DO i=1-OLx,sNx+OLx
628           pF(i,j) = -_recip_dyC(i,j,bi,bj)             gV(i,j,k,bi,bj) = 0. _d 0
629       &    *(phi_hyd(i,j,k)-phi_hyd(i,j-1,k))           ENDDO
630          ENDDO          ENDDO
631         ENDDO  
632    C-    endif momAdvection.
633        ENDIF        ENDIF
634    
635          IF (momViscosity) THEN
636    C---  Calculate eddy fluxes (dissipation) between cells for meridional flow.
637    C     Bi-harmonic term del^2 V -> v4F
638            IF (biharmonic)
639         &  CALL MOM_V_DEL2V(bi,bj,k,vFld,hFacZ,v4f,myThid)
640    
641    C     Laplacian and bi-harmonic terms, Zonal  Fluxes -> fZon
642            CALL MOM_V_XVISCFLUX(bi,bj,k,vFld,v4f,hFacZ,fZon,
643         I    viscAh_Z,viscA4_Z,myThid)
644    
645    C     Laplacian and bi-harmonic termis, Merid Fluxes -> fMer
646            CALL MOM_V_YVISCFLUX(bi,bj,k,vFld,v4f,fMer,
647         I    viscAh_D,viscA4_D,myThid)
648    
649    C     Eddy component of vertical flux (interior component only) -> fVrUp & fVrDw
650           IF (.NOT.implicitViscosity) THEN
651            CALL MOM_V_RVISCFLUX(bi,bj, k, vVel,KappaRV,fVrUp,myThid)
652            CALL MOM_V_RVISCFLUX(bi,bj,k+1,vVel,KappaRV,fVrDw,myThid)
653           ENDIF
654    
655  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term
656        DO j=jMin,jMax  C     anelastic: hor.visc.fluxes are not scaled by rhoFac (by vert.visc.flx is)
657         DO i=iMin,iMax          DO j=jMin,jMax
658          gV(i,j,k,bi,bj) =           DO i=iMin,iMax
659              gvDiss(i,j) =
660  #ifdef OLD_UV_GEOM  #ifdef OLD_UV_GEOM
661       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/       &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)/
662       &    ( 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)) )
663  #else  #else
664       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)       &     -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
665       &    *recip_rAs(i,j,bi,bj)       &      *recip_rAs(i,j,bi,bj)*recip_deepFac2C(k)
666  #endif  #endif
667       &  *(fZon(i+1,j)          - fZon(i,j  )       &     *( ( fZon(i+1,j)  - fZon(i,j  ) )*AhDvdxFac
668       &   +fMer(i,j  )          - fMer(i,j-1)       &       +( fMer(i,  j)  - fMer(i,j-1) )*AhDvdyFac
669       &   +fVerV(i,j,kUp)*rkFac - fVerV(i,j,kDown)*rkFac       &       +( fVrDw(i,j)   - fVrUp(i,j) )*rkSign*ArDvdrFac
670       &   )       &                                     *recip_rhoFacC(k)
671       & _PHM( +phyFac*pf(i,j) )       &     )
672         ENDDO           ENDDO
673        ENDDO          ENDDO
674    
675  C-- No-slip and drag BCs appear as body forces in cell abutting topography  #ifdef ALLOW_DIAGNOSTICS
676        IF (momViscosity.AND.no_slip_sides) THEN          IF ( useDiagnostics ) THEN
677              CALL DIAGNOSTICS_FILL(fZon, 'VISCx_Vm',k,1,2,bi,bj,myThid)
678              CALL DIAGNOSTICS_FILL(fMer, 'VISCy_Vm',k,1,2,bi,bj,myThid)
679              IF (.NOT.implicitViscosity)
680         &    CALL DIAGNOSTICS_FILL(fVrUp,'VISrE_Vm',k,1,2,bi,bj,myThid)
681            ENDIF
682    #endif
683    
684    C-- No-slip and drag BCs appear as body forces in cell abutting topography
685            IF (no_slip_sides) THEN
686  C-     No-slip BCs impose a drag at walls...  C-     No-slip BCs impose a drag at walls...
687         CALL MOM_V_SIDEDRAG(bi,bj,k,vFld,v4F,hFacZ,vF,myThid)           CALL MOM_V_SIDEDRAG(
688         DO j=jMin,jMax       I        bi,bj,k,
689          DO i=iMin,iMax       I        vFld, v4f, hFacZ,
690           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)       I        viscAh_Z,viscA4_Z,
691          ENDDO       I        harmonic,biharmonic,useVariableViscosity,
692         ENDDO       O        vF,
693        ENDIF       I        myThid)
694             DO j=jMin,jMax
695              DO i=iMin,iMax
696               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
697              ENDDO
698             ENDDO
699            ENDIF
700  C-    No-slip BCs impose a drag at bottom  C-    No-slip BCs impose a drag at bottom
701        IF (momViscosity.AND.bottomDragTerms) THEN          IF (bottomDragTerms) THEN
702         CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)           CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)
703             DO j=jMin,jMax
704              DO i=iMin,iMax
705               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
706              ENDDO
707             ENDDO
708            ENDIF
709    
710    #ifdef ALLOW_SHELFICE
711            IF (useShelfIce) THEN
712             CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRU,vF,myThid)
713             DO j=jMin,jMax
714              DO i=iMin,iMax
715               gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
716              ENDDO
717             ENDDO
718            ENDIF
719    #endif /* ALLOW_SHELFICE */
720    
721    C-    endif momViscosity
722          ENDIF
723    
724    C--   Forcing term (moved to timestep.F)
725    c     IF (momForcing)
726    c    & CALL EXTERNAL_FORCING_V(
727    c    I     iMin,iMax,jMin,jMax,bi,bj,k,
728    c    I     myTime,myThid)
729    
730    C--   Metric terms for curvilinear grid systems
731          IF (useNHMTerms) THEN
732    C      o Non-Hydrostatic (spherical) metric terms
733           CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,mT,myThid)
734         DO j=jMin,jMax         DO j=jMin,jMax
735          DO i=iMin,iMax          DO i=iMin,iMax
736           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)
737          ENDDO          ENDDO
738         ENDDO         ENDDO
739        ENDIF        ENDIF
740          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 (useNHMTerms) THEN  
741  C      o Spherical polar grid metric terms  C      o Spherical polar grid metric terms
742         CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,mT,myThid)         CALL MOM_V_METRIC_SPHERE(bi,bj,k,uFld,mT,myThid)
743         DO j=jMin,jMax         DO j=jMin,jMax
744          DO i=iMin,iMax          DO i=iMin,iMax
745           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)
746          ENDDO          ENDDO
747         ENDDO         ENDDO
748        ENDIF        ENDIF
749        IF (usingSphericalPolarMTerms) THEN        IF ( usingCylindricalGrid .AND. metricTerms ) THEN
750         CALL MOM_V_METRIC_SPHERE(bi,bj,k,uFld,mT,myThid)  C      o Cylindrical grid metric terms
751           CALL MOM_V_METRIC_CYLINDER(bi,bj,k,uFld,vFld,mT,myThid)
752         DO j=jMin,jMax         DO j=jMin,jMax
753          DO i=iMin,iMax          DO i=iMin,iMax
754           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)
755          ENDDO          ENDDO
756         ENDDO         ENDDO
757        ENDIF        ENDIF
758    
759  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  
760    
761  C--   Coriolis term  C--   Coriolis term
762  C     Note. As coded here, coriolis will not work with "thin walls"  C     Note. As coded here, coriolis will not work with "thin walls"
763  #ifdef INCLUDE_CD_CODE  c     IF (useCDscheme) THEN
764        CALL MOM_CDSCHEME(bi,bj,k,phi_hyd,myThid)  c       CALL MOM_CDSCHEME(bi,bj,k,dPhiHydX,dPhiHydY,myThid)
765  #else  c     ELSE
766        CALL MOM_U_CORIOLIS(bi,bj,k,vFld,cf,myThid)        IF (.NOT.useCDscheme) THEN
767        DO j=jMin,jMax          CALL MOM_U_CORIOLIS(bi,bj,k,vFld,cf,myThid)
768         DO i=iMin,iMax          DO j=jMin,jMax
769          gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)           DO i=iMin,iMax
770         ENDDO            gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)
771        ENDDO           ENDDO
772        CALL MOM_V_CORIOLIS(bi,bj,k,uFld,cf,myThid)          ENDDO
773    #ifdef ALLOW_DIAGNOSTICS
774            IF ( useDiagnostics )
775         &    CALL DIAGNOSTICS_FILL(cf,'Um_Cori ',k,1,2,bi,bj,myThid)
776    #endif
777            CALL MOM_V_CORIOLIS(bi,bj,k,uFld,cf,myThid)
778            DO j=jMin,jMax
779             DO i=iMin,iMax
780              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+fvFac*cf(i,j)
781             ENDDO
782            ENDDO
783    #ifdef ALLOW_DIAGNOSTICS
784            IF ( useDiagnostics )
785         &    CALL DIAGNOSTICS_FILL(cf,'Vm_Cori ',k,1,2,bi,bj,myThid)
786    #endif
787          ENDIF
788    
789    C--   3.D Coriolis term (horizontal momentum, Eastward component: -f'*w)
790          IF ( use3dCoriolis ) THEN
791            CALL MOM_U_CORIOLIS_NH(bi,bj,k,wVel,cf,myThid)
792            DO j=jMin,jMax
793             DO i=iMin,iMax
794              gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)
795             ENDDO
796            ENDDO
797           IF ( usingCurvilinearGrid ) THEN
798    C-     presently, non zero angleSinC array only supported with Curvilinear-Grid
799            CALL MOM_V_CORIOLIS_NH(bi,bj,k,wVel,cf,myThid)
800            DO j=jMin,jMax
801             DO i=iMin,iMax
802              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+fvFac*cf(i,j)
803             ENDDO
804            ENDDO
805           ENDIF
806          ENDIF
807    
808    C--   Set du/dt & dv/dt on boundaries to zero
809        DO j=jMin,jMax        DO j=jMin,jMax
810         DO i=iMin,iMax         DO i=iMin,iMax
811          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)
812            guDiss(i,j)     = guDiss(i,j)    *_maskW(i,j,k,bi,bj)
813            gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)
814            gvDiss(i,j)     = gvDiss(i,j)    *_maskS(i,j,k,bi,bj)
815         ENDDO         ENDDO
816        ENDDO        ENDDO
817  #endif /* INCLUDE_CD_CODE */  
818        IF (nonHydrostatic) THEN  #ifdef ALLOW_DIAGNOSTICS
819         CALL MOM_U_CORIOLIS_NH(bi,bj,k,wVel,cf,myThid)        IF ( useDiagnostics ) THEN
820         DO j=jMin,jMax          CALL DIAGNOSTICS_FILL(KE,    'momKE   ',k,1,2,bi,bj,myThid)
821          DO i=iMin,iMax          CALL DIAGNOSTICS_FILL(gU(1-Olx,1-Oly,k,bi,bj),
822           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+fuFac*cf(i,j)       &                               'Um_Advec',k,1,2,bi,bj,myThid)
823          ENDDO          CALL DIAGNOSTICS_FILL(gV(1-Olx,1-Oly,k,bi,bj),
824         ENDDO       &                               'Vm_Advec',k,1,2,bi,bj,myThid)
825           IF (momViscosity) THEN
826            CALL DIAGNOSTICS_FILL(guDiss,'Um_Diss ',k,1,2,bi,bj,myThid)
827            CALL DIAGNOSTICS_FILL(gvDiss,'Vm_Diss ',k,1,2,bi,bj,myThid)
828           ENDIF
829        ENDIF        ENDIF
830    #endif /* ALLOW_DIAGNOSTICS */
831    
832        RETURN        RETURN
833        END        END
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.39
  ViewVC Help
Powered by ViewVC 1.1.22