/[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.6 by jmc, Thu Apr 17 13:42:53 2003 UTC revision 1.19 by adcroft, Wed May 26 14:50:10 2004 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4    #include "PACKAGES_CONFIG.h"
5  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
6    
7        SUBROUTINE MOM_VECINV(        SUBROUTINE MOM_VECINV(
8       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,
9       I        dPhiHydX,dPhiHydY,KappaRU,KappaRV,       I        dPhiHydX,dPhiHydY,KappaRU,KappaRV,
10       U        fVerU, fVerV,       U        fVerU, fVerV,
11       I        myCurrentTime, myIter, myThid)       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 31  C     == Global variables == Line 32  C     == Global variables ==
32  #include "EEPARAMS.h"  #include "EEPARAMS.h"
33  #include "PARAMS.h"  #include "PARAMS.h"
34  #include "GRID.h"  #include "GRID.h"
35    #ifdef ALLOW_TIMEAVE
36    #include "TIMEAVE_STATV.h"
37    #endif
38    
39  C     == Routine arguments ==  C     == Routine arguments ==
40  C     fVerU   - Flux of momentum in the vertical  C     fVerU   - Flux of momentum in the vertical
# Line 48  C     myThid - Instance number for this Line 52  C     myThid - Instance number for this
52        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
53        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
54        INTEGER kUp,kDown        INTEGER kUp,kDown
55        _RL     myCurrentTime        _RL     myTime
56        INTEGER myIter        INTEGER myIter
57        INTEGER myThid        INTEGER myThid
58        INTEGER bi,bj,iMin,iMax,jMin,jMax        INTEGER bi,bj,iMin,iMax,jMin,jMax
59    
60    #ifdef ALLOW_MOM_VECINV
61    
62  C     == Functions ==  C     == Functions ==
63        LOGICAL  DIFFERENT_MULTIPLE        LOGICAL  DIFFERENT_MULTIPLE
64        EXTERNAL DIFFERENT_MULTIPLE        EXTERNAL DIFFERENT_MULTIPLE
# Line 73  C     == Local variables == Line 79  C     == Local variables ==
79        _RS r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
80        _RS xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
81        _RS yA(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)  
82        _RL uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
83        _RL vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
84        _RL dStar(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL dStar(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
# Line 112  C     xxxFac - On-off tracer parameters Line 116  C     xxxFac - On-off tracer parameters
116        _RL  phyFac        _RL  phyFac
117        _RL  vForcFac        _RL  vForcFac
118        _RL  mtFacV        _RL  mtFacV
       INTEGER km1,kp1  
119        _RL wVelBottomOverride        _RL wVelBottomOverride
120        LOGICAL bottomDragTerms        LOGICAL bottomDragTerms
121          LOGICAL writeDiag
122        _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
123        _RL omega3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL omega3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
124        _RL vort3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vort3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
125        _RL hDiv(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL hDiv(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
126    
127        km1=MAX(1,k-1)  #ifdef ALLOW_AUTODIFF_TAMC
128        kp1=MIN(Nr,k+1)  C--   only the kDown part of fverU/V is set in this subroutine
129    C--   the kUp is still required
130    C--   In the case of mom_fluxform Kup is set as well
131    C--   (at least in part)
132          fVerU(1,1,kUp) = fVerU(1,1,kUp)
133          fVerV(1,1,kUp) = fVerV(1,1,kUp)
134    #endif
135    
136        rVelMaskOverride=1.        rVelMaskOverride=1.
137        IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac        IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac
138        wVelBottomOverride=1.        wVelBottomOverride=1.
139        IF (k.EQ.Nr) wVelBottomOverride=0.        IF (k.EQ.Nr) wVelBottomOverride=0.
140          writeDiag = DIFFERENT_MULTIPLE(diagFreq, myTime,
141         &                                         myTime-deltaTClock)
142    
143  C     Initialise intermediate terms  C     Initialise intermediate terms
144        DO J=1-OLy,sNy+OLy        DO J=1-OLy,sNy+OLy
# Line 146  C     Initialise intermediate terms Line 159  C     Initialise intermediate terms
159          vort3(i,j) = 0.          vort3(i,j) = 0.
160          omega3(i,j) = 0.          omega3(i,j) = 0.
161          ke(i,j) = 0.          ke(i,j) = 0.
162    #ifdef ALLOW_AUTODIFF_TAMC
163            strain(i,j)  = 0. _d 0
164            tension(i,j) = 0. _d 0
165    #endif
166         ENDDO         ENDDO
167        ENDDO        ENDDO
168    
# Line 212  C     Make local copies of horizontal fl Line 229  C     Make local copies of horizontal fl
229         ENDDO         ENDDO
230        ENDDO        ENDDO
231    
232  C     Calculate velocity field "volume transports" through tracer cell faces.  C note (jmc) : Dissipation and Vort3 advection do not necesary
233        DO j=1-OLy,sNy+OLy  C              use the same maskZ (and hFacZ)  => needs 2 call(s)
234         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  
235    
236        CALL MOM_VI_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid)        CALL MOM_CALC_KE(bi,bj,k,2,uFld,vFld,KE,myThid)
237    
238        CALL MOM_VI_CALC_HDIV(bi,bj,k,uFld,vFld,hDiv,myThid)        CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid)
239    
240        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)
241    
242  c     CALL MOM_VI_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)  c     CALL MOM_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)
243    
244        IF (momViscosity) THEN        IF (momViscosity) THEN
245  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
246         IF (viscA4.NE.0.) THEN         IF (viscA4.NE.0.
247         &     .OR. viscA4Grid.NE.0.
248         &     .OR. viscC4leith.NE.0.
249         &    ) THEN
250           CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ,           CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ,
251       O                      del2u,del2v,       O                      del2u,del2v,
252       &                      myThid)       &                      myThid)
253           CALL MOM_VI_CALC_HDIV(bi,bj,k,del2u,del2v,dStar,myThid)           CALL MOM_CALC_HDIV(bi,bj,k,2,del2u,del2v,dStar,myThid)
254           CALL MOM_VI_CALC_RELVORT3(           CALL MOM_CALC_RELVORT3(
255       &                         bi,bj,k,del2u,del2v,hFacZ,zStar,myThid)       &                         bi,bj,k,del2u,del2v,hFacZ,zStar,myThid)
256         ENDIF         ENDIF
257  C      Calculate dissipation terms for U and V equations  C      Calculate dissipation terms for U and V equations
258  C      in terms of vorticity and divergence  C      in terms of vorticity and divergence
259         IF (viscAh.NE.0. .OR. viscA4.NE.0.) THEN         IF (viscAh.NE.0. .OR. viscA4.NE.0.
260         &    .OR.  viscAhGrid.NE.0. .OR. viscA4Grid.NE.0.
261         &    .OR.  viscC2leith.NE.0. .OR. viscC4leith.NE.0.
262         &    ) THEN
263           CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,hFacZ,dStar,zStar,           CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,hFacZ,dStar,zStar,
264       O                       uDiss,vDiss,       O                       uDiss,vDiss,
265       &                       myThid)       &                       myThid)
# Line 260  C      or in terms of tension and strain Line 279  C      or in terms of tension and strain
279         ENDIF         ENDIF
280        ENDIF        ENDIF
281    
282    C-    Return to standard hfacZ (min-4) and mask vort3 accordingly:
283    c     CALL MOM_VI_MASK_VORT3(bi,bj,k,hFacZ,r_hFacZ,vort3,myThid)
284    
285  C---- Zonal momentum equation starts here  C---- Zonal momentum equation starts here
286    
287  C--   Vertical flux (fVer is at upper face of "u" cell)  C--   Vertical flux (fVer is at upper face of "u" cell)
# Line 298  C-     No-slip BCs impose a drag at wall Line 320  C-     No-slip BCs impose a drag at wall
320          ENDDO          ENDDO
321         ENDDO         ENDDO
322        ENDIF        ENDIF
323    
324  C-    No-slip BCs impose a drag at bottom  C-    No-slip BCs impose a drag at bottom
325        IF (momViscosity.AND.bottomDragTerms) THEN        IF (momViscosity.AND.bottomDragTerms) THEN
326         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
# Line 308  C-    No-slip BCs impose a drag at botto Line 331  C-    No-slip BCs impose a drag at botto
331         ENDDO         ENDDO
332        ENDIF        ENDIF
333    
 C--   Forcing term (moved to timestep.F)  
 c     IF (momForcing)  
 c    &  CALL EXTERNAL_FORCING_U(  
 c    I     iMin,iMax,jMin,jMax,bi,bj,k,  
 c    I     myCurrentTime,myThid)  
   
334  C--   Metric terms for curvilinear grid systems  C--   Metric terms for curvilinear grid systems
335  c     IF (usingSphericalPolarMTerms) THEN  c     IF (usingSphericalPolarMTerms) THEN
336  C      o Spherical polar grid metric terms  C      o Spherical polar grid metric terms
# Line 325  c       ENDDO Line 342  c       ENDDO
342  c      ENDDO  c      ENDDO
343  c     ENDIF  c     ENDIF
344    
   
345  C---- Meridional momentum equation starts here  C---- Meridional momentum equation starts here
346    
347  C--   Vertical flux (fVer is at upper face of "v" cell)  C--   Vertical flux (fVer is at upper face of "v" cell)
# Line 374  C-    No-slip BCs impose a drag at botto Line 390  C-    No-slip BCs impose a drag at botto
390         ENDDO         ENDDO
391        ENDIF        ENDIF
392    
 C--   Forcing term (moved to timestep.F)  
 c     IF (momForcing)  
 c    & CALL EXTERNAL_FORCING_V(  
 c    I     iMin,iMax,jMin,jMax,bi,bj,k,  
 c    I     myCurrentTime,myThid)  
   
393  C--   Metric terms for curvilinear grid systems  C--   Metric terms for curvilinear grid systems
394  c     IF (usingSphericalPolarMTerms) THEN  c     IF (usingSphericalPolarMTerms) THEN
395  C      o Spherical polar grid metric terms  C      o Spherical polar grid metric terms
# Line 393  c     ENDIF Line 403  c     ENDIF
403    
404  C--   Horizontal Coriolis terms  C--   Horizontal Coriolis terms
405        IF (useCoriolis .AND. .NOT.useCDscheme) THEN        IF (useCoriolis .AND. .NOT.useCDscheme) THEN
406         CALL MOM_VI_CORIOLIS(bi,bj,K,uFld,vFld,omega3,r_hFacZ,         CALL MOM_VI_CORIOLIS(bi,bj,k,uFld,vFld,omega3,hFacZ,r_hFacZ,
407       &                      uCf,vCf,myThid)       &                      uCf,vCf,myThid)
408         DO j=jMin,jMax         DO j=jMin,jMax
409          DO i=iMin,iMax          DO i=iMin,iMax
# Line 401  C--   Horizontal Coriolis terms Line 411  C--   Horizontal Coriolis terms
411           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
412          ENDDO          ENDDO
413         ENDDO         ENDDO
414           IF ( writeDiag ) THEN
415            CALL WRITE_LOCAL_RL('fV','I10',1,uCf,bi,bj,k,myIter,myThid)
416            CALL WRITE_LOCAL_RL('fU','I10',1,vCf,bi,bj,k,myIter,myThid)
417           ENDIF
418        ENDIF        ENDIF
419    
420        IF (momAdvection) THEN        IF (momAdvection) THEN
421  C--   Horizontal advection of relative vorticity  C--   Horizontal advection of relative vorticity
422  c      CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid)  c      CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid)
423         CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid)         CALL MOM_VI_U_CORIOLIS(bi,bj,k,vFld,vort3,hFacZ,r_hFacZ,
424         &                        uCf,myThid)
425  c      CALL MOM_VI_U_CORIOLIS_C4(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid)  c      CALL MOM_VI_U_CORIOLIS_C4(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid)
426         DO j=jMin,jMax         DO j=jMin,jMax
427          DO i=iMin,iMax          DO i=iMin,iMax
# Line 414  c      CALL MOM_VI_U_CORIOLIS_C4(bi,bj,K Line 429  c      CALL MOM_VI_U_CORIOLIS_C4(bi,bj,K
429          ENDDO          ENDDO
430         ENDDO         ENDDO
431  c      CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,r_hFacZ,vCf,myThid)  c      CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,r_hFacZ,vCf,myThid)
432         CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,vort3,r_hFacZ,vCf,myThid)         CALL MOM_VI_V_CORIOLIS(bi,bj,k,uFld,vort3,hFacZ,r_hFacZ,
433         &                        vCf,myThid)
434  c      CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,vort3,r_hFacZ,vCf,myThid)  c      CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,vort3,r_hFacZ,vCf,myThid)
435         DO j=jMin,jMax         DO j=jMin,jMax
436          DO i=iMin,iMax          DO i=iMin,iMax
# Line 422  c      CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K Line 438  c      CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K
438          ENDDO          ENDDO
439         ENDDO         ENDDO
440    
441           IF ( writeDiag ) THEN
442            CALL WRITE_LOCAL_RL('zV','I10',1,uCf,bi,bj,k,myIter,myThid)
443            CALL WRITE_LOCAL_RL('zU','I10',1,vCf,bi,bj,k,myIter,myThid)
444           ENDIF
445    #ifdef ALLOW_TIMEAVE
446    #ifndef HRCUBE
447           IF (taveFreq.GT.0.) THEN
448             CALL TIMEAVE_CUMUL_1K1T(uZetatave,vCf,deltaTClock,
449         &                           Nr, k, bi, bj, myThid)
450             CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock,
451         &                           Nr, k, bi, bj, myThid)
452           ENDIF
453    #endif /* ALLOW_TIMEAVE */
454    #endif /* ndef HRCUBE */
455    
456  C--   Vertical shear terms (-w*du/dr & -w*dv/dr)  C--   Vertical shear terms (-w*du/dr & -w*dv/dr)
457         CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid)         IF ( .NOT. momImplVertAdv ) THEN
458         DO j=jMin,jMax          CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid)
459          DO i=iMin,iMax          DO j=jMin,jMax
460           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)           DO i=iMin,iMax
461          ENDDO            gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
462         ENDDO           ENDDO
463         CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid)          ENDDO
464         DO j=jMin,jMax          CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid)
465          DO i=iMin,iMax          DO j=jMin,jMax
466           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)           DO i=iMin,iMax
467              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
468             ENDDO
469          ENDDO          ENDDO
470         ENDDO         ENDIF
471    
472  C--   Bernoulli term  C--   Bernoulli term
473         CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid)         CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid)
# Line 449  C--   Bernoulli term Line 482  C--   Bernoulli term
482           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
483          ENDDO          ENDDO
484         ENDDO         ENDDO
485           IF ( writeDiag ) THEN
486            CALL WRITE_LOCAL_RL('KEx','I10',1,uCf,bi,bj,k,myIter,myThid)
487            CALL WRITE_LOCAL_RL('KEy','I10',1,vCf,bi,bj,k,myIter,myThid)
488           ENDIF
489    
490  C--   end if momAdvection  C--   end if momAdvection
491        ENDIF        ENDIF
492    
# Line 461  C--   Set du/dt & dv/dt on boundaries to Line 499  C--   Set du/dt & dv/dt on boundaries to
499        ENDDO        ENDDO
500    
501    
502        IF (        IF ( writeDiag ) THEN
      &  DIFFERENT_MULTIPLE(diagFreq,myCurrentTime,  
      &                     myCurrentTime-deltaTClock)  
      & ) THEN  
503         CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid)         CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid)
504         CALL WRITE_LOCAL_RL('Dt','I10',1,tension,bi,bj,k,myIter,myThid)         CALL WRITE_LOCAL_RL('Dt','I10',1,tension,bi,bj,k,myIter,myThid)
        CALL WRITE_LOCAL_RL('fV','I10',1,uCf,bi,bj,k,myIter,myThid)  
        CALL WRITE_LOCAL_RL('fU','I10',1,vCf,bi,bj,k,myIter,myThid)  
505         CALL WRITE_LOCAL_RL('Du','I10',1,uDiss,bi,bj,k,myIter,myThid)         CALL WRITE_LOCAL_RL('Du','I10',1,uDiss,bi,bj,k,myIter,myThid)
506         CALL WRITE_LOCAL_RL('Dv','I10',1,vDiss,bi,bj,k,myIter,myThid)         CALL WRITE_LOCAL_RL('Dv','I10',1,vDiss,bi,bj,k,myIter,myThid)
507         CALL WRITE_LOCAL_RL('Z3','I10',1,vort3,bi,bj,k,myIter,myThid)         CALL WRITE_LOCAL_RL('Z3','I10',1,vort3,bi,bj,k,myIter,myThid)
# Line 477  c      CALL WRITE_LOCAL_RL('W3','I10',1, Line 510  c      CALL WRITE_LOCAL_RL('W3','I10',1,
510         CALL WRITE_LOCAL_RL('D','I10',1,hdiv,bi,bj,k,myIter,myThid)         CALL WRITE_LOCAL_RL('D','I10',1,hdiv,bi,bj,k,myIter,myThid)
511        ENDIF        ENDIF
512    
513    #endif /* ALLOW_MOM_VECINV */
514    
515        RETURN        RETURN
516        END        END
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.19
  ViewVC Help
Powered by ViewVC 1.1.22