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

Diff of /MITgcm/pkg/mom_vecinv/mom_vecinv.F

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

revision 1.1 by adcroft, Thu Aug 16 17:16:03 2001 UTC revision 1.44 by jmc, Sat Jul 30 23:52:10 2005 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4  #include "CPP_OPTIONS.h"  #include "MOM_VECINV_OPTIONS.h"
5    
6        SUBROUTINE MOM_VECINV(        SUBROUTINE MOM_VECINV(
7       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,
8       I        phi_hyd,KappaRU,KappaRV,       I        KappaRU, KappaRV,
9       U        fVerU, fVerV,       U        fVerU, fVerV,
10       I        myCurrentTime, myThid)       O        guDiss, gvDiss,
11         I        myTime, myIter, myThid)
12  C     /==========================================================\  C     /==========================================================\
13  C     | S/R MOM_VECINV                                           |  C     | S/R MOM_VECINV                                           |
14  C     | o Form the right hand-side of the momentum equation.     |  C     | o Form the right hand-side of the momentum equation.     |
# Line 30  C     == Global variables == Line 31  C     == Global variables ==
31  #include "DYNVARS.h"  #include "DYNVARS.h"
32  #include "EEPARAMS.h"  #include "EEPARAMS.h"
33  #include "PARAMS.h"  #include "PARAMS.h"
34    #ifdef ALLOW_MNC
35    #include "MNC_PARAMS.h"
36    #endif
37  #include "GRID.h"  #include "GRID.h"
38    #ifdef ALLOW_TIMEAVE
39    #include "TIMEAVE_STATV.h"
40    #endif
41    
42  C     == Routine arguments ==  C     == Routine arguments ==
43  C     fVerU   - Flux of momentum in the vertical  C     fVerU  :: Flux of momentum in the vertical direction, out of the upper
44  C     fVerV     direction out of the upper face of a cell K  C     fVerV  :: face of a cell K ( flux into the cell above ).
45  C               ( flux into the cell above ).  C     guDiss :: dissipation tendency (all explicit terms), u component
46  C     phi_hyd - Hydrostatic pressure  C     gvDiss :: dissipation tendency (all explicit terms), v component
47  C     bi, bj, iMin, iMax, jMin, jMax - Range of points for which calculation  C     bi, bj, iMin, iMax, jMin, jMax - Range of points for which calculation
48  C                                      results will be set.  C                                      results will be set.
49  C     kUp, kDown                     - Index for upper and lower layers.  C     kUp, kDown                     - Index for upper and lower layers.
50  C     myThid - Instance number for this innvocation of CALC_MOM_RHS  C     myThid - Instance number for this innvocation of CALC_MOM_RHS
       _RL phi_hyd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
51        _RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
52        _RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
53        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
54        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
55          _RL guDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
56          _RL gvDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
57        INTEGER kUp,kDown        INTEGER kUp,kDown
58          _RL     myTime
59          INTEGER myIter
60        INTEGER myThid        INTEGER myThid
       _RL     myCurrentTime  
61        INTEGER bi,bj,iMin,iMax,jMin,jMax        INTEGER bi,bj,iMin,iMax,jMin,jMax
62    
63    #ifdef ALLOW_MOM_VECINV
64    
65    C     == Functions ==
66          LOGICAL  DIFFERENT_MULTIPLE
67          EXTERNAL DIFFERENT_MULTIPLE
68    
69  C     == Local variables ==  C     == Local variables ==
       _RL      aF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
70        _RL      vF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL      vF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
71        _RL      vrF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL      vrF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
72        _RL      uCf (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL      uCf (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
73        _RL      vCf (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL      vCf (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
74        _RL      mT (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  c     _RL      mT (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
       _RL      pF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
75        _RL del2u(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL del2u(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
76        _RL del2v(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL del2v(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
77          _RL tension(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
78          _RL strain(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
79        _RS hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
80        _RS r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
       _RS xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RS yA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
81        _RL uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
82        _RL vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
83        _RL dStar(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL dStar(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
84        _RL zStar(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL zStar(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
       _RL uDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL vDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
85  C     I,J,K - Loop counters  C     I,J,K - Loop counters
86        INTEGER i,j,k        INTEGER i,j,k
 C     rVelMaskOverride - Factor for imposing special surface boundary conditions  
 C                        ( set according to free-surface condition ).  
 C     hFacROpen        - Lopped cell factos used tohold fraction of open  
 C     hFacRClosed        and closed cell wall.  
       _RL  rVelMaskOverride  
87  C     xxxFac - On-off tracer parameters used for switching terms off.  C     xxxFac - On-off tracer parameters used for switching terms off.
       _RL  uDudxFac  
       _RL  AhDudxFac  
       _RL  A4DuxxdxFac  
       _RL  vDudyFac  
       _RL  AhDudyFac  
       _RL  A4DuyydyFac  
       _RL  rVelDudrFac  
88        _RL  ArDudrFac        _RL  ArDudrFac
89        _RL  fuFac  c     _RL  mtFacU
       _RL  phxFac  
       _RL  mtFacU  
       _RL  uDvdxFac  
       _RL  AhDvdxFac  
       _RL  A4DvxxdxFac  
       _RL  vDvdyFac  
       _RL  AhDvdyFac  
       _RL  A4DvyydyFac  
       _RL  rVelDvdrFac  
90        _RL  ArDvdrFac        _RL  ArDvdrFac
91        _RL  fvFac  c     _RL  mtFacV
       _RL  phyFac  
       _RL  vForcFac  
       _RL  mtFacV  
       INTEGER km1,kp1  
       _RL wVelBottomOverride  
92        LOGICAL bottomDragTerms        LOGICAL bottomDragTerms
93          LOGICAL writeDiag
94        _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
95        _RL omega3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL omega3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
96        _RL vort3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vort3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
97        _RL hDiv(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL hDiv(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
98    
99        km1=MAX(1,k-1)  #ifdef ALLOW_MNC
100        kp1=MIN(Nr,k+1)        INTEGER offsets(9)
101        rVelMaskOverride=1.  #endif
102        IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac  
103        wVelBottomOverride=1.  #ifdef ALLOW_AUTODIFF_TAMC
104        IF (k.EQ.Nr) wVelBottomOverride=0.  C--   only the kDown part of fverU/V is set in this subroutine
105    C--   the kUp is still required
106    C--   In the case of mom_fluxform Kup is set as well
107    C--   (at least in part)
108          fVerU(1,1,kUp) = fVerU(1,1,kUp)
109          fVerV(1,1,kUp) = fVerV(1,1,kUp)
110    #endif
111    
112          writeDiag = DIFFERENT_MULTIPLE(diagFreq, myTime, deltaTClock)
113    
114    #ifdef ALLOW_MNC
115          IF (useMNC .AND. snapshot_mnc .AND. writeDiag) THEN
116            IF ((bi .EQ. 1).AND.(bj .EQ. 1).AND.(k .EQ. 1)) THEN
117              CALL MNC_CW_SET_UDIM('mom_vi', -1, myThid)
118              CALL MNC_CW_RL_W_S('D','mom_vi',0,0,'T',myTime,myThid)
119              CALL MNC_CW_SET_UDIM('mom_vi', 0, myThid)
120              CALL MNC_CW_I_W_S('I','mom_vi',0,0,'iter',myIter,myThid)
121            ENDIF
122            DO i = 1,9
123              offsets(i) = 0
124            ENDDO
125            offsets(3) = k
126    C       write(*,*) 'offsets = ',(offsets(i),i=1,9)
127          ENDIF
128    #endif /*  ALLOW_MNC  */
129    
130  C     Initialise intermediate terms  C     Initialise intermediate terms
131        DO J=1-OLy,sNy+OLy        DO J=1-OLy,sNy+OLy
132         DO I=1-OLx,sNx+OLx         DO I=1-OLx,sNx+OLx
133          aF(i,j)   = 0.          vF(i,j)    = 0.
134          vF(i,j)   = 0.          vrF(i,j)   = 0.
         vrF(i,j)  = 0.  
135          uCf(i,j)   = 0.          uCf(i,j)   = 0.
136          vCf(i,j)   = 0.          vCf(i,j)   = 0.
137          mT(i,j)   = 0.  c       mT(i,j)    = 0.
         pF(i,j)   = 0.  
138          del2u(i,j) = 0.          del2u(i,j) = 0.
139          del2v(i,j) = 0.          del2v(i,j) = 0.
140          dStar(i,j) = 0.          dStar(i,j) = 0.
141          zStar(i,j) = 0.          zStar(i,j) = 0.
142          uDiss(i,j) = 0.          guDiss(i,j)= 0.
143          vDiss(i,j) = 0.          gvDiss(i,j)= 0.
144          vort3(i,j) = 0.          vort3(i,j) = 0.
145          omega3(i,j) = 0.          omega3(i,j)= 0.
146          ke(i,j) = 0.          ke(i,j)    = 0.
147    #ifdef ALLOW_AUTODIFF_TAMC
148            strain(i,j)  = 0. _d 0
149            tension(i,j) = 0. _d 0
150    #endif
151         ENDDO         ENDDO
152        ENDDO        ENDDO
153    
154  C--   Term by term tracer parmeters  C--   Term by term tracer parmeters
155  C     o U momentum equation  C     o U momentum equation
       uDudxFac     = afFacMom*1.  
       AhDudxFac    = vfFacMom*1.  
       A4DuxxdxFac  = vfFacMom*1.  
       vDudyFac     = afFacMom*1.  
       AhDudyFac    = vfFacMom*1.  
       A4DuyydyFac  = vfFacMom*1.  
       rVelDudrFac  = afFacMom*1.  
156        ArDudrFac    = vfFacMom*1.        ArDudrFac    = vfFacMom*1.
157        mTFacU       = mtFacMom*1.  c     mTFacU       = mtFacMom*1.
       fuFac        = cfFacMom*1.  
       phxFac       = pfFacMom*1.  
158  C     o V momentum equation  C     o V momentum equation
       uDvdxFac     = afFacMom*1.  
       AhDvdxFac    = vfFacMom*1.  
       A4DvxxdxFac  = vfFacMom*1.  
       vDvdyFac     = afFacMom*1.  
       AhDvdyFac    = vfFacMom*1.  
       A4DvyydyFac  = vfFacMom*1.  
       rVelDvdrFac  = afFacMom*1.  
159        ArDvdrFac    = vfFacMom*1.        ArDvdrFac    = vfFacMom*1.
160        mTFacV       = mtFacMom*1.  c     mTFacV       = mtFacMom*1.
       fvFac        = cfFacMom*1.  
       phyFac       = pfFacMom*1.  
       vForcFac     = foFacMom*1.  
161    
162        IF (     no_slip_bottom        IF (     no_slip_bottom
163       &    .OR. bottomDragQuadratic.NE.0.       &    .OR. bottomDragQuadratic.NE.0.
# Line 176  C     o V momentum equation Line 167  C     o V momentum equation
167         bottomDragTerms=.FALSE.         bottomDragTerms=.FALSE.
168        ENDIF        ENDIF
169    
 C-- with stagger time stepping, grad Phi_Hyp is directly incoporated in TIMESTEP  
       IF (staggerTimeStep) THEN  
         phxFac = 0.  
         phyFac = 0.  
       ENDIF  
   
170  C--   Calculate open water fraction at vorticity points  C--   Calculate open water fraction at vorticity points
171        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)        CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid)
172    
 C---- Calculate common quantities used in both U and V equations  
 C     Calculate tracer cell face open areas  
       DO j=1-OLy,sNy+OLy  
        DO i=1-OLx,sNx+OLx  
         xA(i,j) = _dyG(i,j,bi,bj)  
      &   *drF(k)*_hFacW(i,j,k,bi,bj)  
         yA(i,j) = _dxG(i,j,bi,bj)  
      &   *drF(k)*_hFacS(i,j,k,bi,bj)  
        ENDDO  
       ENDDO  
   
173  C     Make local copies of horizontal flow field  C     Make local copies of horizontal flow field
174        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
175         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
# Line 204  C     Make local copies of horizontal fl Line 178  C     Make local copies of horizontal fl
178         ENDDO         ENDDO
179        ENDDO        ENDDO
180    
181  C     Calculate velocity field "volume transports" through tracer cell faces.  C note (jmc) : Dissipation and Vort3 advection do not necesary
182        DO j=1-OLy,sNy+OLy  C              use the same maskZ (and hFacZ)  => needs 2 call(s)
183         DO i=1-OLx,sNx+OLx  c     CALL MOM_VI_HFACZ_DISS(bi,bj,k,hFacZ,r_hFacZ,myThid)
         uTrans(i,j) = uFld(i,j)*xA(i,j)  
         vTrans(i,j) = vFld(i,j)*yA(i,j)  
        ENDDO  
       ENDDO  
184    
185        CALL MOM_VI_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid)        CALL MOM_CALC_KE(bi,bj,k,2,uFld,vFld,KE,myThid)
186    
187        CALL MOM_VI_CALC_HDIV(bi,bj,k,uFld,vFld,hDiv,myThid)        CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid)
188    
189        CALL MOM_VI_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)        CALL MOM_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)
190    
191        CALL MOM_VI_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)        IF (useAbsVorticity)
192         & CALL MOM_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)
193    
194        IF (momViscosity) THEN        IF (momViscosity) THEN
195  C      Calculate del^2 u and del^2 v for bi-harmonic term  C      Calculate del^2 u and del^2 v for bi-harmonic term
196         CALL MOM_VI_DEL2UV(         IF ( (viscA4.NE.0. .AND. no_slip_sides)
197       I                    bi,bj,k,hDiv,vort3,hFacZ,       &     .OR. viscA4D.NE.0. .OR. viscA4Z.NE.0.
198       O                    del2u,del2v,       &     .OR. viscA4Grid.NE.0.
199       &                    myThid)       &     .OR. viscC4leith.NE.0.
200         CALL MOM_VI_CALC_HDIV(bi,bj,k,del2u,del2v,dStar,myThid)       &     .OR. viscC4leithD.NE.0.
201         CALL MOM_VI_CALC_RELVORT3(bi,bj,k,del2u,del2v,hFacZ,zStar,myThid)       &    ) THEN
202             CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ,
203         O                      del2u,del2v,
204         &                      myThid)
205             CALL MOM_CALC_HDIV(bi,bj,k,2,del2u,del2v,dStar,myThid)
206             CALL MOM_CALC_RELVORT3(
207         &                         bi,bj,k,del2u,del2v,hFacZ,zStar,myThid)
208           ENDIF
209  C      Calculate dissipation terms for U and V equations  C      Calculate dissipation terms for U and V equations
210         CALL MOM_VI_HDISSIP(  C      in terms of vorticity and divergence
211       I                     bi,bj,k,hDiv,vort3,hFacZ,dStar,zStar,         IF (    viscAhD.NE.0. .OR. viscAhZ.NE.0.
212       O                     uDiss,vDiss,       &    .OR. viscA4D.NE.0. .OR. viscA4Z.NE.0.
213       &                     myThid)       &    .OR. viscAhGrid.NE.0. .OR. viscA4Grid.NE.0.
214         &    .OR. viscC2leith.NE.0. .OR. viscC4leith.NE.0.
215         &    .OR. viscC2leithD.NE.0. .OR. viscC4leithD.NE.0.
216         &    ) THEN
217             CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,hFacZ,dStar,zStar,
218         O                       guDiss,gvDiss,
219         &                       myThid)
220           ENDIF
221    C      or in terms of tension and strain
222           IF (viscAstrain.NE.0. .OR. viscAtension.NE.0.
223         O      .OR. viscC2smag.ne.0) THEN
224             CALL MOM_CALC_TENSION(bi,bj,k,uFld,vFld,
225         O                         tension,
226         I                         myThid)
227             CALL MOM_CALC_STRAIN(bi,bj,k,uFld,vFld,hFacZ,
228         O                        strain,
229         I                        myThid)
230             CALL MOM_HDISSIP(bi,bj,k,
231         I                    tension,strain,hFacZ,viscAtension,viscAstrain,
232         O                    guDiss,gvDiss,
233         I                    myThid)
234           ENDIF
235        ENDIF        ENDIF
236    
237    C-    Return to standard hfacZ (min-4) and mask vort3 accordingly:
238    c     CALL MOM_VI_MASK_VORT3(bi,bj,k,hFacZ,r_hFacZ,vort3,myThid)
239    
240  C---- Zonal momentum equation starts here  C---- Zonal momentum equation starts here
241    
242  C--   Vertical flux (fVer is at upper face of "u" cell)  C--   Vertical flux (fVer is at upper face of "u" cell)
243    
244  C     Eddy component of vertical flux (interior component only) -> vrF  C     Eddy component of vertical flux (interior component only) -> vrF
245        IF (momViscosity.AND..NOT.implicitViscosity)        IF (momViscosity.AND..NOT.implicitViscosity) THEN
246       & CALL MOM_U_RVISCFLUX(bi,bj,k,uVel,KappaRU,vrF,myThid)         CALL MOM_U_RVISCFLUX(bi,bj,k+1,uVel,KappaRU,vrF,myThid)
247    
248  C     Combine fluxes  C     Combine fluxes
249        DO j=jMin,jMax         DO j=jMin,jMax
250         DO i=iMin,iMax          DO i=iMin,iMax
251          fVerU(i,j,kDown) = ArDudrFac*vrF(i,j)           fVerU(i,j,kDown) = ArDudrFac*vrF(i,j)
        ENDDO  
       ENDDO  
   
 C---  Hydrostatic term ( -1/rhoConst . dphi/dx )  
       IF (momPressureForcing) THEN  
        DO j=1-Olx,sNy+Oly  
         DO i=2-Olx,sNx+Olx  
          pf(i,j) = - _recip_dxC(i,j,bi,bj)  
      &    *(phi_hyd(i,j,k)-phi_hyd(i-1,j,k))  
252          ENDDO          ENDDO
253         ENDDO         ENDDO
       ENDIF  
254    
255  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term  C--   Tendency is minus divergence of the fluxes
256        DO j=2-Oly,sNy+Oly-1         DO j=2-Oly,sNy+Oly-1
257         DO i=2-Olx,sNx+Olx-1          DO i=2-Olx,sNx+Olx-1
258          gU(i,j,k,bi,bj) = uDiss(i,j)           guDiss(i,j) = guDiss(i,j)
259       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
260       &   *recip_rAw(i,j,bi,bj)       &   *recip_rAw(i,j,bi,bj)
261       &  *(       &  *(
262       &   +fVerU(i,j,kUp)*rkFac - fVerU(i,j,kDown)*rkFac       &    fVerU(i,j,kDown) - fVerU(i,j,kUp)
263       &   )       &   )*rkSign
264       & _PHM( +phxFac * pf(i,j) )          ENDDO
265         ENDDO         ENDDO
266        ENDDO        ENDIF
267    
268  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
269        IF (momViscosity.AND.no_slip_sides) THEN        IF (momViscosity.AND.no_slip_sides) THEN
# Line 279  C-     No-slip BCs impose a drag at wall Line 271  C-     No-slip BCs impose a drag at wall
271         CALL MOM_U_SIDEDRAG(bi,bj,k,uFld,del2u,hFacZ,vF,myThid)         CALL MOM_U_SIDEDRAG(bi,bj,k,uFld,del2u,hFacZ,vF,myThid)
272         DO j=jMin,jMax         DO j=jMin,jMax
273          DO i=iMin,iMax          DO i=iMin,iMax
274           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)           guDiss(i,j) = guDiss(i,j)+vF(i,j)
275          ENDDO          ENDDO
276         ENDDO         ENDDO
277        ENDIF        ENDIF
278    
279  C-    No-slip BCs impose a drag at bottom  C-    No-slip BCs impose a drag at bottom
280        IF (momViscosity.AND.bottomDragTerms) THEN        IF (momViscosity.AND.bottomDragTerms) THEN
281         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
282         DO j=jMin,jMax         DO j=jMin,jMax
283          DO i=iMin,iMax          DO i=iMin,iMax
284           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+vF(i,j)           guDiss(i,j) = guDiss(i,j)+vF(i,j)
285          ENDDO          ENDDO
286         ENDDO         ENDDO
287        ENDIF        ENDIF
288    
 C--   Forcing term  
       IF (momForcing)  
      &  CALL EXTERNAL_FORCING_U(  
      I     iMin,iMax,jMin,jMax,bi,bj,k,  
      I     myCurrentTime,myThid)  
   
289  C--   Metric terms for curvilinear grid systems  C--   Metric terms for curvilinear grid systems
290  c     IF (usingSphericalPolarMTerms) THEN  c     IF (usingSphericalPolarMTerms) THEN
291  C      o Spherical polar grid metric terms  C      o Spherical polar grid metric terms
# Line 310  c       ENDDO Line 297  c       ENDDO
297  c      ENDDO  c      ENDDO
298  c     ENDIF  c     ENDIF
299    
 C--   Set du/dt on boundaries to zero  
       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  
   
   
300  C---- Meridional momentum equation starts here  C---- Meridional momentum equation starts here
301    
302  C--   Vertical flux (fVer is at upper face of "v" cell)  C--   Vertical flux (fVer is at upper face of "v" cell)
303    
304  C     Eddy component of vertical flux (interior component only) -> vrF  C     Eddy component of vertical flux (interior component only) -> vrF
305        IF (momViscosity.AND..NOT.implicitViscosity)        IF (momViscosity.AND..NOT.implicitViscosity) THEN
306       & CALL MOM_V_RVISCFLUX(bi,bj,k,vVel,KappaRV,vrf,myThid)         CALL MOM_V_RVISCFLUX(bi,bj,k+1,vVel,KappaRV,vrF,myThid)
307    
308  C     Combine fluxes -> fVerV  C     Combine fluxes -> fVerV
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         fVerV(i,j,kDown) = ArDvdrFac*vrF(i,j)  
        ENDDO  
       ENDDO  
   
 C---  Hydorstatic term (-1/rhoConst . dphi/dy )  
       IF (momPressureForcing) THEN  
309         DO j=jMin,jMax         DO j=jMin,jMax
310          DO i=iMin,iMax          DO i=iMin,iMax
311           pF(i,j) = -_recip_dyC(i,j,bi,bj)           fVerV(i,j,kDown) = ArDvdrFac*vrF(i,j)
      &    *(phi_hyd(i,j,k)-phi_hyd(i,j-1,k))  
312          ENDDO          ENDDO
313         ENDDO         ENDDO
       ENDIF  
314    
315  C--   Tendency is minus divergence of the fluxes + coriolis + pressure term  C--   Tendency is minus divergence of the fluxes
316        DO j=jMin,jMax         DO j=jMin,jMax
317         DO i=iMin,iMax          DO i=iMin,iMax
318          gV(i,j,k,bi,bj) = vDiss(i,j)           gvDiss(i,j) = gvDiss(i,j)
319       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
320       &    *recip_rAs(i,j,bi,bj)       &    *recip_rAs(i,j,bi,bj)
321       &  *(       &  *(
322       &   +fVerV(i,j,kUp)*rkFac - fVerV(i,j,kDown)*rkFac       &    fVerV(i,j,kDown) - fVerV(i,j,kUp)
323       &   )       &   )*rkSign
324       & _PHM( +phyFac*pf(i,j) )          ENDDO
325         ENDDO         ENDDO
326        ENDDO        ENDIF
327    
328  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
329        IF (momViscosity.AND.no_slip_sides) THEN        IF (momViscosity.AND.no_slip_sides) THEN
# Line 362  C-     No-slip BCs impose a drag at wall Line 331  C-     No-slip BCs impose a drag at wall
331         CALL MOM_V_SIDEDRAG(bi,bj,k,vFld,del2v,hFacZ,vF,myThid)         CALL MOM_V_SIDEDRAG(bi,bj,k,vFld,del2v,hFacZ,vF,myThid)
332         DO j=jMin,jMax         DO j=jMin,jMax
333          DO i=iMin,iMax          DO i=iMin,iMax
334           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)           gvDiss(i,j) = gvDiss(i,j)+vF(i,j)
335          ENDDO          ENDDO
336         ENDDO         ENDDO
337        ENDIF        ENDIF
# Line 371  C-    No-slip BCs impose a drag at botto Line 340  C-    No-slip BCs impose a drag at botto
340         CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)         CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)
341         DO j=jMin,jMax         DO j=jMin,jMax
342          DO i=iMin,iMax          DO i=iMin,iMax
343           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vF(i,j)           gvDiss(i,j) = gvDiss(i,j)+vF(i,j)
344          ENDDO          ENDDO
345         ENDDO         ENDDO
346        ENDIF        ENDIF
347    
 C--   Forcing term  
       IF (momForcing)  
      & CALL EXTERNAL_FORCING_V(  
      I     iMin,iMax,jMin,jMax,bi,bj,k,  
      I     myCurrentTime,myThid)  
   
348  C--   Metric terms for curvilinear grid systems  C--   Metric terms for curvilinear grid systems
349  c     IF (usingSphericalPolarMTerms) THEN  c     IF (usingSphericalPolarMTerms) THEN
350  C      o Spherical polar grid metric terms  C      o Spherical polar grid metric terms
# Line 393  c       ENDDO Line 356  c       ENDDO
356  c      ENDDO  c      ENDDO
357  c     ENDIF  c     ENDIF
358    
 C--   Set dv/dt on boundaries to zero  
       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  
   
359  C--   Horizontal Coriolis terms  C--   Horizontal Coriolis terms
360        CALL MOM_VI_CORIOLIS(bi,bj,K,uFld,vFld,omega3,r_hFacZ,  c     IF (useCoriolis .AND. .NOT.useCDscheme
361       &                     uCf,vCf,myThid)  c    &    .AND. .NOT. useAbsVorticity) THEN
362        DO j=jMin,jMax  C- jmc: change it to keep the Coriolis terms when useAbsVorticity=T & momAdvection=F
363         DO i=iMin,iMax        IF ( useCoriolis .AND.
364          gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j))       &     .NOT.( useCDscheme .OR. useAbsVorticity.AND.momAdvection )
365       &                    *_maskW(i,j,k,bi,bj)       &   ) THEN
366          gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))         IF (useAbsVorticity) THEN
367       &                    *_maskS(i,j,k,bi,bj)          CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,hFacZ,r_hFacZ,
368         ENDDO       &                         uCf,myThid)
369        ENDDO          CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,hFacZ,r_hFacZ,
370  c     CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid)       &                         vCf,myThid)
371        CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid)         ELSE
372  c     CALL MOM_VI_U_CORIOLIS_C4(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid)          CALL MOM_VI_CORIOLIS(bi,bj,k,uFld,vFld,hFacZ,r_hFacZ,
373        DO j=jMin,jMax       &                       uCf,vCf,myThid)
374         DO i=iMin,iMax         ENDIF
375          gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j))         DO j=jMin,jMax
376       &                    *_maskW(i,j,k,bi,bj)          DO i=iMin,iMax
377             gU(i,j,k,bi,bj) = uCf(i,j)
378             gV(i,j,k,bi,bj) = vCf(i,j)
379            ENDDO
380         ENDDO         ENDDO
381        ENDDO         IF ( writeDiag ) THEN
382  c     CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,r_hFacZ,vCf,myThid)           IF (snapshot_mdsio) THEN
383        CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,vort3,r_hFacZ,vCf,myThid)             CALL WRITE_LOCAL_RL('fV','I10',1,uCf,bi,bj,k,myIter,myThid)
384  c     CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,vort3,r_hFacZ,vCf,myThid)             CALL WRITE_LOCAL_RL('fU','I10',1,vCf,bi,bj,k,myIter,myThid)
385        DO j=jMin,jMax           ENDIF
386         DO i=iMin,iMax  #ifdef ALLOW_MNC
387          gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))           IF (useMNC .AND. snapshot_mnc) THEN
388       &                    *_maskS(i,j,k,bi,bj)             CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj, 'fV', uCf,
389         &          offsets, myThid)
390               CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj, 'fU', vCf,
391         &          offsets, myThid)
392             ENDIF
393    #endif /*  ALLOW_MNC  */
394           ENDIF
395          ELSE
396           DO j=jMin,jMax
397            DO i=iMin,iMax
398             gU(i,j,k,bi,bj) = 0. _d 0
399             gV(i,j,k,bi,bj) = 0. _d 0
400            ENDDO
401         ENDDO         ENDDO
402        ENDDO        ENDIF
403    
404        IF (momAdvection) THEN        IF (momAdvection) THEN
405  C--   Vertical shear terms (Coriolis)  C--   Horizontal advection of relative (or absolute) vorticity
406        CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid)         IF (highOrderVorticity.AND.useAbsVorticity) THEN
407        DO j=jMin,jMax          CALL MOM_VI_U_CORIOLIS_C4(bi,bj,k,vFld,omega3,r_hFacZ,
408         DO i=iMin,iMax       &                         uCf,myThid)
409          gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j))         ELSEIF (highOrderVorticity) THEN
410       &                    *_maskW(i,j,k,bi,bj)          CALL MOM_VI_U_CORIOLIS_C4(bi,bj,k,vFld,vort3, r_hFacZ,
411         &                         uCf,myThid)
412           ELSEIF (useAbsVorticity) THEN
413            CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,hFacZ,r_hFacZ,
414         &                         uCf,myThid)
415           ELSE
416            CALL MOM_VI_U_CORIOLIS(bi,bj,k,vFld,vort3, hFacZ,r_hFacZ,
417         &                         uCf,myThid)
418           ENDIF
419           DO j=jMin,jMax
420            DO i=iMin,iMax
421             gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
422            ENDDO
423         ENDDO         ENDDO
424        ENDDO         IF (highOrderVorticity.AND.useAbsVorticity) THEN
425        CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid)          CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,omega3,r_hFacZ,
426        DO j=jMin,jMax       &                         vCf,myThid)
427         DO i=iMin,iMax         ELSEIF (highOrderVorticity) THEN
428          gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))          CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,vort3, r_hFacZ,
429       &                    *_maskS(i,j,k,bi,bj)       &                         vCf,myThid)
430           ELSEIF (useAbsVorticity) THEN
431            CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,hFacZ,r_hFacZ,
432         &                         vCf,myThid)
433           ELSE
434            CALL MOM_VI_V_CORIOLIS(bi,bj,k,uFld,vort3, hFacZ,r_hFacZ,
435         &                         vCf,myThid)
436           ENDIF
437           DO j=jMin,jMax
438            DO i=iMin,iMax
439             gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
440            ENDDO
441         ENDDO         ENDDO
442        ENDDO  
443           IF ( writeDiag ) THEN
444             IF (snapshot_mdsio) THEN
445               CALL WRITE_LOCAL_RL('zV','I10',1,uCf,bi,bj,k,myIter,myThid)
446               CALL WRITE_LOCAL_RL('zU','I10',1,vCf,bi,bj,k,myIter,myThid)
447             ENDIF
448    #ifdef ALLOW_MNC
449             IF (useMNC .AND. snapshot_mnc) THEN
450               CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj, 'zV', uCf,
451         &          offsets, myThid)
452               CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj, 'zU', vCf,
453         &          offsets, myThid)
454             ENDIF
455    #endif /*  ALLOW_MNC  */
456           ENDIF
457    
458    #ifdef ALLOW_TIMEAVE
459    #ifndef MINIMAL_TAVE_OUTPUT
460           IF (taveFreq.GT.0.) THEN
461             CALL TIMEAVE_CUMUL_1K1T(uZetatave,vCf,deltaTClock,
462         &                           Nr, k, bi, bj, myThid)
463             CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock,
464         &                           Nr, k, bi, bj, myThid)
465           ENDIF
466    #endif /* ndef MINIMAL_TAVE_OUTPUT */
467    #endif /* ALLOW_TIMEAVE */
468    
469    C--   Vertical shear terms (-w*du/dr & -w*dv/dr)
470           IF ( .NOT. momImplVertAdv ) THEN
471            CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid)
472            DO j=jMin,jMax
473             DO i=iMin,iMax
474              gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
475             ENDDO
476            ENDDO
477            CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid)
478            DO j=jMin,jMax
479             DO i=iMin,iMax
480              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
481             ENDDO
482            ENDDO
483           ENDIF
484    
485  C--   Bernoulli term  C--   Bernoulli term
486        CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid)         CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid)
487        DO j=jMin,jMax         DO j=jMin,jMax
488         DO i=iMin,iMax          DO i=iMin,iMax
489          gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j))           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
490       &                    *_maskW(i,j,k,bi,bj)          ENDDO
491         ENDDO         ENDDO
492        ENDDO         CALL MOM_VI_V_GRAD_KE(bi,bj,K,KE,vCf,myThid)
493        CALL MOM_VI_V_GRAD_KE(bi,bj,K,KE,vCf,myThid)         DO j=jMin,jMax
494            DO i=iMin,iMax
495             gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
496            ENDDO
497           ENDDO
498           IF ( writeDiag ) THEN
499             IF (snapshot_mdsio) THEN
500               CALL WRITE_LOCAL_RL('KEx','I10',1,uCf,bi,bj,k,myIter,myThid)
501               CALL WRITE_LOCAL_RL('KEy','I10',1,vCf,bi,bj,k,myIter,myThid)
502             ENDIF
503    #ifdef ALLOW_MNC
504             IF (useMNC .AND. snapshot_mnc) THEN
505               CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj, 'KEx', uCf,
506         &          offsets, myThid)
507               CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj, 'KEy', vCf,
508         &          offsets, myThid)
509            ENDIF
510    #endif /*  ALLOW_MNC  */
511           ENDIF
512    
513    C--   end if momAdvection
514          ENDIF
515    
516    C--   Set du/dt & dv/dt on boundaries to zero
517        DO j=jMin,jMax        DO j=jMin,jMax
518         DO i=iMin,iMax         DO i=iMin,iMax
519          gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))          gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)*_maskW(i,j,k,bi,bj)
520       &                    *_maskS(i,j,k,bi,bj)          gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)
521         ENDDO         ENDDO
522        ENDDO        ENDDO
523    
524    #ifdef ALLOW_DEBUG
525          IF ( debugLevel .GE. debLevB
526         &   .AND. k.EQ.4 .AND. myIter.EQ.nIter0
527         &   .AND. nPx.EQ.1 .AND. nPy.EQ.1
528         &   .AND. useCubedSphereExchange ) THEN
529            CALL DEBUG_CS_CORNER_UV( ' uDiss,vDiss from MOM_VECINV',
530         &             guDiss,gvDiss, k, standardMessageUnit,bi,bj,myThid )
531        ENDIF        ENDIF
532    #endif /* ALLOW_DEBUG */
533    
534          IF ( writeDiag ) THEN
535            IF (snapshot_mdsio) THEN
536              CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid)
537              CALL WRITE_LOCAL_RL('Dt','I10',1,tension,bi,bj,k,myIter,
538         &         myThid)
539              CALL WRITE_LOCAL_RL('Du','I10',1,guDiss,bi,bj,k,myIter,myThid)
540              CALL WRITE_LOCAL_RL('Dv','I10',1,gvDiss,bi,bj,k,myIter,myThid)
541              CALL WRITE_LOCAL_RL('Z3','I10',1,vort3,bi,bj,k,myIter,myThid)
542              CALL WRITE_LOCAL_RL('W3','I10',1,omega3,bi,bj,k,myIter,myThid)
543              CALL WRITE_LOCAL_RL('KE','I10',1,KE,bi,bj,k,myIter,myThid)
544              CALL WRITE_LOCAL_RL('D','I10',1,hdiv,bi,bj,k,myIter,myThid)
545            ENDIF
546    #ifdef ALLOW_MNC
547            IF (useMNC .AND. snapshot_mnc) THEN
548              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'Ds',strain,
549         &          offsets, myThid)
550              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'Dt',tension,
551         &          offsets, myThid)
552              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'Du',guDiss,
553         &          offsets, myThid)
554              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'Dv',gvDiss,
555         &          offsets, myThid)
556              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'Z3',vort3,
557         &          offsets, myThid)
558              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'W3',omega3,
559         &          offsets, myThid)
560              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'KE',KE,
561         &          offsets, myThid)
562              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'D', hdiv,
563         &          offsets, myThid)
564            ENDIF
565    #endif /*  ALLOW_MNC  */
566          ENDIF
567    
568    #endif /* ALLOW_MOM_VECINV */
569    
570        RETURN        RETURN
571        END        END
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.44
  ViewVC Help
Powered by ViewVC 1.1.22