/[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.8 by heimbach, Fri Oct 10 23:00:01 2003 UTC revision 1.20 by adcroft, Wed Jun 2 13:23:55 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 51  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  #ifndef DISABLE_MOM_VECINV  #ifdef ALLOW_MOM_VECINV
61    
62  C     == Functions ==  C     == Functions ==
63        LOGICAL  DIFFERENT_MULTIPLE        LOGICAL  DIFFERENT_MULTIPLE
# Line 115  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 152  C     Initialise intermediate terms Line 162  C     Initialise intermediate terms
162  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
163          strain(i,j)  = 0. _d 0          strain(i,j)  = 0. _d 0
164          tension(i,j) = 0. _d 0          tension(i,j) = 0. _d 0
         fVerU(i,j,1) = 0. _d 0  
         fVerU(i,j,2) = 0. _d 0  
         fVerV(i,j,1) = 0. _d 0  
         fVerV(i,j,2) = 0. _d 0  
165  #endif  #endif
166         ENDDO         ENDDO
167        ENDDO        ENDDO
# Line 227  C note (jmc) : Dissipation and Vort3 adv Line 233  C note (jmc) : Dissipation and Vort3 adv
233  C              use the same maskZ (and hFacZ)  => needs 2 call(s)  C              use the same maskZ (and hFacZ)  => needs 2 call(s)
234  c     CALL MOM_VI_HFACZ_DISS(bi,bj,k,hFacZ,r_hFacZ,myThid)  c     CALL MOM_VI_HFACZ_DISS(bi,bj,k,hFacZ,r_hFacZ,myThid)
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)        IF (useAbsVorticity)
243         & CALL MOM_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)
244    
245        IF (momViscosity) THEN        IF (momViscosity) THEN
246  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
247         IF (viscA4.NE.0.) THEN         IF (viscA4.NE.0.
248         &     .OR. viscA4Grid.NE.0.
249         &     .OR. viscC4leith.NE.0.
250         &    ) THEN
251           CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ,           CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ,
252       O                      del2u,del2v,       O                      del2u,del2v,
253       &                      myThid)       &                      myThid)
254           CALL MOM_VI_CALC_HDIV(bi,bj,k,del2u,del2v,dStar,myThid)           CALL MOM_CALC_HDIV(bi,bj,k,2,del2u,del2v,dStar,myThid)
255           CALL MOM_VI_CALC_RELVORT3(           CALL MOM_CALC_RELVORT3(
256       &                         bi,bj,k,del2u,del2v,hFacZ,zStar,myThid)       &                         bi,bj,k,del2u,del2v,hFacZ,zStar,myThid)
257         ENDIF         ENDIF
258  C      Calculate dissipation terms for U and V equations  C      Calculate dissipation terms for U and V equations
259  C      in terms of vorticity and divergence  C      in terms of vorticity and divergence
260         IF (viscAh.NE.0. .OR. viscA4.NE.0.) THEN         IF (viscAh.NE.0. .OR. viscA4.NE.0.
261         &    .OR.  viscAhGrid.NE.0. .OR. viscA4Grid.NE.0.
262         &    .OR.  viscC2leith.NE.0. .OR. viscC4leith.NE.0.
263         &    ) THEN
264           CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,hFacZ,dStar,zStar,           CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,hFacZ,dStar,zStar,
265       O                       uDiss,vDiss,       O                       uDiss,vDiss,
266       &                       myThid)       &                       myThid)
# Line 390  c      ENDDO Line 403  c      ENDDO
403  c     ENDIF  c     ENDIF
404    
405  C--   Horizontal Coriolis terms  C--   Horizontal Coriolis terms
406        IF (useCoriolis .AND. .NOT.useCDscheme) THEN        IF (useCoriolis .AND. .NOT.useCDscheme
407         CALL MOM_VI_CORIOLIS(bi,bj,k,uFld,vFld,omega3,hFacZ,r_hFacZ,       &    .AND. .NOT. useAbsVorticity) THEN
408           CALL MOM_VI_CORIOLIS(bi,bj,k,uFld,vFld,hFacZ,r_hFacZ,
409       &                      uCf,vCf,myThid)       &                      uCf,vCf,myThid)
410         DO j=jMin,jMax         DO j=jMin,jMax
411          DO i=iMin,iMax          DO i=iMin,iMax
# Line 399  C--   Horizontal Coriolis terms Line 413  C--   Horizontal Coriolis terms
413           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)
414          ENDDO          ENDDO
415         ENDDO         ENDDO
416           IF ( writeDiag ) THEN
417            CALL WRITE_LOCAL_RL('fV','I10',1,uCf,bi,bj,k,myIter,myThid)
418            CALL WRITE_LOCAL_RL('fU','I10',1,vCf,bi,bj,k,myIter,myThid)
419           ENDIF
420        ENDIF        ENDIF
421    
422        IF (momAdvection) THEN        IF (momAdvection) THEN
423  C--   Horizontal advection of relative vorticity  C--   Horizontal advection of relative vorticity
424  c      CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid)         IF (useAbsVorticity) THEN
425         CALL MOM_VI_U_CORIOLIS(bi,bj,k,vFld,vort3,hFacZ,r_hFacZ,          CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,hFacZ,r_hFacZ,
426       &                        uCf,myThid)       &                         uCf,myThid)
427           ELSE
428            CALL MOM_VI_U_CORIOLIS(bi,bj,k,vFld,vort3,hFacZ,r_hFacZ,
429         &                         uCf,myThid)
430           ENDIF
431  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)
432         DO j=jMin,jMax         DO j=jMin,jMax
433          DO i=iMin,iMax          DO i=iMin,iMax
434           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)
435          ENDDO          ENDDO
436         ENDDO         ENDDO
437  c      CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,r_hFacZ,vCf,myThid)         IF (useAbsVorticity) THEN
438         CALL MOM_VI_V_CORIOLIS(bi,bj,k,uFld,vort3,hFacZ,r_hFacZ,          CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,hFacZ,r_hFacZ,
439       &                        vCf,myThid)       &                         vCf,myThid)
440           ELSE
441            CALL MOM_VI_V_CORIOLIS(bi,bj,k,uFld,vort3,hFacZ,r_hFacZ,
442         &                         vCf,myThid)
443           ENDIF
444  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)
445         DO j=jMin,jMax         DO j=jMin,jMax
446          DO i=iMin,iMax          DO i=iMin,iMax
# Line 422  c      CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K Line 448  c      CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K
448          ENDDO          ENDDO
449         ENDDO         ENDDO
450    
451           IF ( writeDiag ) THEN
452            CALL WRITE_LOCAL_RL('zV','I10',1,uCf,bi,bj,k,myIter,myThid)
453            CALL WRITE_LOCAL_RL('zU','I10',1,vCf,bi,bj,k,myIter,myThid)
454           ENDIF
455  #ifdef ALLOW_TIMEAVE  #ifdef ALLOW_TIMEAVE
456    #ifndef HRCUBE
457         IF (taveFreq.GT.0.) THEN         IF (taveFreq.GT.0.) THEN
458           CALL TIMEAVE_CUMUL_1K1T(uZetatave,vCf,deltaTClock,           CALL TIMEAVE_CUMUL_1K1T(uZetatave,vCf,deltaTClock,
459       &                           Nr, k, bi, bj, myThid)       &                           Nr, k, bi, bj, myThid)
460           CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock,           CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock,
461       &                           Nr, k, bi, bj, myThid)       &                           Nr, k, bi, bj, myThid)
462         ENDIF         ENDIF
463  #endif  #endif /* ALLOW_TIMEAVE */
464    #endif /* ndef HRCUBE */
465    
466  C--   Vertical shear terms (-w*du/dr & -w*dv/dr)  C--   Vertical shear terms (-w*du/dr & -w*dv/dr)
467         CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid)         IF ( .NOT. momImplVertAdv ) THEN
468         DO j=jMin,jMax          CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid)
469          DO i=iMin,iMax          DO j=jMin,jMax
470           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)           DO i=iMin,iMax
471          ENDDO            gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
472         ENDDO           ENDDO
473         CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid)          ENDDO
474         DO j=jMin,jMax          CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid)
475          DO i=iMin,iMax          DO j=jMin,jMax
476           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)           DO i=iMin,iMax
477              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
478             ENDDO
479          ENDDO          ENDDO
480         ENDDO         ENDIF
481    
482  C--   Bernoulli term  C--   Bernoulli term
483         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 458  C--   Bernoulli term Line 492  C--   Bernoulli term
492           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)
493          ENDDO          ENDDO
494         ENDDO         ENDDO
495           IF ( writeDiag ) THEN
496            CALL WRITE_LOCAL_RL('KEx','I10',1,uCf,bi,bj,k,myIter,myThid)
497            CALL WRITE_LOCAL_RL('KEy','I10',1,vCf,bi,bj,k,myIter,myThid)
498           ENDIF
499    
500  C--   end if momAdvection  C--   end if momAdvection
501        ENDIF        ENDIF
502    
# Line 470  C--   Set du/dt & dv/dt on boundaries to Line 509  C--   Set du/dt & dv/dt on boundaries to
509        ENDDO        ENDDO
510    
511    
512        IF (        IF ( writeDiag ) THEN
      &  DIFFERENT_MULTIPLE(diagFreq,myCurrentTime,  
      &                     myCurrentTime-deltaTClock)  
      & ) THEN  
513         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)
514         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)  
515         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)
516         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)
517         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)
518  c      CALL WRITE_LOCAL_RL('W3','I10',1,omega3,bi,bj,k,myIter,myThid)         CALL WRITE_LOCAL_RL('W3','I10',1,omega3,bi,bj,k,myIter,myThid)
519         CALL WRITE_LOCAL_RL('KE','I10',1,KE,bi,bj,k,myIter,myThid)         CALL WRITE_LOCAL_RL('KE','I10',1,KE,bi,bj,k,myIter,myThid)
520         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)
521        ENDIF        ENDIF
522    
523  #endif /* DISABLE_MOM_VECINV */  #endif /* ALLOW_MOM_VECINV */
524    
525        RETURN        RETURN
526        END        END
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.20
  ViewVC Help
Powered by ViewVC 1.1.22