/[MITgcm]/MITgcm/pkg/generic_advdiff/gad_advection.F
ViewVC logotype

Diff of /MITgcm/pkg/generic_advdiff/gad_advection.F

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

revision 1.8 by adcroft, Fri Sep 28 16:49:54 2001 UTC revision 1.14 by heimbach, Tue Nov 12 20:42:24 2002 UTC
# Line 81  C  myThid               :: thread number Line 81  C  myThid               :: thread number
81        INTEGER bi,bj        INTEGER bi,bj
82        INTEGER advectionScheme        INTEGER advectionScheme
83        INTEGER tracerIdentity        INTEGER tracerIdentity
84        _RL Gtracer(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)        _RL Tracer(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
85        _RL myTime        _RL myTime
86        INTEGER myIter        INTEGER myIter
87        INTEGER myThid        INTEGER myThid
88    
89  C !OUTPUT PARAMETERS: ==================================================  C !OUTPUT PARAMETERS: ==================================================
90  C  gTracer              :: tendancy array  C  gTracer              :: tendancy array
91        _RL Tracer(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)        _RL gTracer(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
92    
93  C !LOCAL VARIABLES: ====================================================  C !LOCAL VARIABLES: ====================================================
94  C  maskUp               :: 2-D array for mask at W points  C  maskUp               :: 2-D array for mask at W points
# Line 99  C  kdown                :: index into 2 Line 99  C  kdown                :: index into 2
99  C  kp1                  :: =k+1 for k<Nr, =Nr for k=Nr  C  kp1                  :: =k+1 for k<Nr, =Nr for k=Nr
100  C  xA,yA                :: areas of X and Y face of tracer cells  C  xA,yA                :: areas of X and Y face of tracer cells
101  C  uTrans,vTrans,rTrans :: 2-D arrays of volume transports at U,V and W points  C  uTrans,vTrans,rTrans :: 2-D arrays of volume transports at U,V and W points
102    C  rTransKp1            :: vertical volume transport at interface k+1
103  C  af                   :: 2-D array for horizontal advective flux  C  af                   :: 2-D array for horizontal advective flux
104  C  fVerT                :: 2 1/2D arrays for vertical advective flux  C  fVerT                :: 2 1/2D arrays for vertical advective flux
105  C  localTij             :: 2-D array used as temporary local copy of tracer fld  C  localTij             :: 2-D array used as temporary local copy of tracer fld
# Line 110  C  nipass               :: number of pas Line 111  C  nipass               :: number of pas
111  C  ipass                :: number of the current pass being made  C  ipass                :: number of the current pass being made
112        _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
113        INTEGER iMin,iMax,jMin,jMax        INTEGER iMin,iMax,jMin,jMax
114        INTEGER i,j,k,kup,kDown,kp1        INTEGER i,j,k,kup,kDown
115        _RS xA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS xA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
116        _RS yA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS yA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
117        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
118        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
119        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
120          _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
121        _RL af      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL af      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
122        _RL fVerT   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerT   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
123        _RL localTij(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL localTij(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
# Line 126  C  ipass                :: number of the Line 128  C  ipass                :: number of the
128  CEOP  CEOP
129    
130  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
131              act0 = tracerIdentity - 1
132              max0 = maxpass
133            act1 = bi - myBxLo(myThid)            act1 = bi - myBxLo(myThid)
134            max1 = myBxHi(myThid) - myBxLo(myThid) + 1            max1 = myBxHi(myThid) - myBxLo(myThid) + 1
135            act2 = bj - myByLo(myThid)            act2 = bj - myByLo(myThid)
# Line 133  CEOP Line 137  CEOP
137            act3 = myThid - 1            act3 = myThid - 1
138            max3 = nTx*nTy            max3 = nTx*nTy
139            act4 = ikey_dynamics - 1            act4 = ikey_dynamics - 1
140            ikey = (act1 + 1) + act2*max1            igadkey = (act0 + 1)
141       &                      + act3*max1*max2       &                      + act1*max0
142       &                      + act4*max1*max2*max3       &                      + act2*max0*max1
143         &                      + act3*max0*max1*max2
144         &                      + act4*max0*max1*max2*max3
145              if (tracerIdentity.GT.maxpass)
146         &         STOP 'maxpass seems smaller than tracerIdentity'
147  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
148    
149  C--   Set up work arrays with valid (i.e. not NaN) values  C--   Set up work arrays with valid (i.e. not NaN) values
# Line 152  C     uninitialised but inert locations. Line 160  C     uninitialised but inert locations.
160          rTrans(i,j)  = 0. _d 0          rTrans(i,j)  = 0. _d 0
161          fVerT(i,j,1) = 0. _d 0          fVerT(i,j,1) = 0. _d 0
162          fVerT(i,j,2) = 0. _d 0          fVerT(i,j,2) = 0. _d 0
163            rTransKp1(i,j)= 0. _d 0
164         ENDDO         ENDDO
165        ENDDO        ENDDO
166    
# Line 163  C     uninitialised but inert locations. Line 172  C     uninitialised but inert locations.
172  C--   Start of k loop for horizontal fluxes  C--   Start of k loop for horizontal fluxes
173        DO k=1,Nr        DO k=1,Nr
174  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
175           kkey = (ikey-1)*Nr + k           kkey = (igadkey-1)*Nr + k
176  CADJ STORE tracer(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ STORE tracer(:,:,k,bi,bj) =
177    CADJ &     comlev1_bibj_k_gad, key=kkey, byte=isbyte
178  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
179    
180  C--   Get temporary terms used by tendency routines  C--   Get temporary terms used by tendency routines
# Line 173  C--   Get temporary terms used by tenden Line 183  C--   Get temporary terms used by tenden
183       O         xA,yA,uTrans,vTrans,rTrans,maskUp,       O         xA,yA,uTrans,vTrans,rTrans,maskUp,
184       I         myThid)       I         myThid)
185    
186    #ifdef ALLOW_GMREDI
187    C--   Residual transp = Bolus transp + Eulerian transp
188           IF (useGMRedi)
189         &   CALL GMREDI_CALC_UVFLOW(
190         &            uTrans, vTrans, bi, bj, k, myThid)
191    #endif /* ALLOW_GMREDI */
192    
193  C--   Make local copy of tracer array  C--   Make local copy of tracer array
194        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
195         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
# Line 182  C--   Make local copy of tracer array Line 199  C--   Make local copy of tracer array
199    
200        IF (useCubedSphereExchange) THEN        IF (useCubedSphereExchange) THEN
201         nipass=3         nipass=3
202    #ifdef ALLOW_AUTODIFF_TAMC
203           if ( nipass.GT.maxcube )
204         &      STOP 'maxcube needs to be = 3'
205    #endif
206        ELSE        ELSE
207         nipass=1         nipass=1
208        ENDIF        ENDIF
# Line 190  cph       nipass=1 Line 211  cph       nipass=1
211  C--   Multiple passes for different directions on different tiles  C--   Multiple passes for different directions on different tiles
212        DO ipass=1,nipass        DO ipass=1,nipass
213  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
214           passkey = ipass + (k-1)   *maxpass           passkey = ipass + (k-1)      *maxcube
215       &                   + (ikey-1)*maxpass*Nr       &                   + (igadkey-1)*maxcube*Nr
216           IF (nipass .GT. maxpass) THEN           IF (nipass .GT. maxpass) THEN
217            STOP 'GAD_ADVECTION: nipass > maxpass. check tamc.h'            STOP 'GAD_ADVECTION: nipass > maxcube. check tamc.h'
218           ENDIF           ENDIF
219  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
220    
# Line 242  C-    Advective flux in X Line 263  C-    Advective flux in X
263    
264  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
265  #ifndef DISABLE_MULTIDIM_ADVECTION  #ifndef DISABLE_MULTIDIM_ADVECTION
266  CADJ STORE localTij(:,:)  = comlev1_bibj_pass, key=passkey, byte=isbyte  CADJ STORE localTij(:,:)  =
267    CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
268  #endif  #endif
269  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
270    
# Line 256  CADJ STORE localTij(:,:)  = comlev1_bibj Line 278  CADJ STORE localTij(:,:)  = comlev1_bibj
278         CALL GAD_DST3FL_ADV_X(         CALL GAD_DST3FL_ADV_X(
279       &       bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)       &       bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)
280        ELSE        ELSE
281         STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'         STOP 'GAD_ADVECTION: adv. scheme incompatibale with multi-dim'
282        ENDIF        ENDIF
283    
284        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
# Line 308  C-    Advective flux in Y Line 330  C-    Advective flux in Y
330    
331  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
332  #ifndef DISABLE_MULTIDIM_ADVECTION  #ifndef DISABLE_MULTIDIM_ADVECTION
333  CADJ STORE localTij(:,:)  = comlev1_bibj_pass, key=passkey, byte=isbyte  CADJ STORE localTij(:,:)  =
334    CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
335  #endif  #endif
336  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
337    
# Line 372  C--   kup    Cycles through 1,2 to point Line 395  C--   kup    Cycles through 1,2 to point
395  C--   kDown  Cycles through 2,1 to point to w-layer below  C--   kDown  Cycles through 2,1 to point to w-layer below
396        kup  = 1+MOD(k+1,2)        kup  = 1+MOD(k+1,2)
397        kDown= 1+MOD(k,2)        kDown= 1+MOD(k,2)
398    c     kp1=min(Nr,k+1)
399  C--   Get temporary terms used by tendency routines        kp1Msk=1.
400        CALL CALC_COMMON_FACTORS (        if (k.EQ.Nr) kp1Msk=0.
      I         bi,bj,iMin,iMax,jMin,jMax,k,  
      O         xA,yA,uTrans,vTrans,rTrans,maskUp,  
      I         myThid)  
   
 C-    Advective flux in R  
       DO j=1-Oly,sNy+Oly  
        DO i=1-Olx,sNx+Olx  
         af(i,j) = 0.  
        ENDDO  
       ENDDO  
401    
402  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
403  CADJ STORE localTijk(:,:,k)    CADJ STORE localTijk(:,:,k)  
404  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
405    CADJ STORE rTrans(:,:)  
406    CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
407  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
408    
409    C-- Compute Vertical transport
410  C     Note: wVel needs to be masked  C     Note: wVel needs to be masked
411        IF (K.GE.2) THEN  
412          IF (k.EQ.1) THEN
413    C- Surface interface :
414    
415           DO j=1-Oly,sNy+Oly
416            DO i=1-Olx,sNx+Olx
417             rTransKp1(i,j) = rTrans(i,j)
418             rTrans(i,j) = 0.
419             fVerT(i,j,kUp) = 0.
420            ENDDO
421           ENDDO
422    
423          ELSE
424    C- Interior interface :
425           DO j=1-Oly,sNy+Oly
426            DO i=1-Olx,sNx+Olx
427             rTransKp1(i,j) = kp1Msk*rTrans(i,j)
428             rTrans(i,j) = wVel(i,j,k,bi,bj)*rA(i,j,bi,bj)
429         &               *maskC(i,j,k-1,bi,bj)
430             af(i,j) = 0.
431            ENDDO
432           ENDDO
433    
434    #ifdef ALLOW_GMREDI
435    C--   Residual transp = Bolus transp + Eulerian transp
436           IF (useGMRedi)
437         &   CALL GMREDI_CALC_WFLOW(
438         &                    rTrans, bi, bj, k, myThid)
439    #endif /* ALLOW_GMREDI */
440    
441  C-    Compute vertical advective flux in the interior:  C-    Compute vertical advective flux in the interior:
442         IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN         IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
443          CALL GAD_FLUXLIMIT_ADV_R(          CALL GAD_FLUXLIMIT_ADV_R(
# Line 406  C-    Compute vertical advective flux in Line 451  C-    Compute vertical advective flux in
451         ELSE         ELSE
452          STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'          STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
453         ENDIF         ENDIF
454  C-    Surface "correction" term at k>1 :  C-    add the advective flux to fVerT
        DO j=1-Oly,sNy+Oly  
         DO i=1-Olx,sNx+Olx  
          af(i,j) = af(i,j)  
      &           + (maskC(i,j,k,bi,bj)-maskC(i,j,k-1,bi,bj))*  
      &             rTrans(i,j)*localTijk(i,j,k)  
         ENDDO  
        ENDDO  
       ELSE  
 C-    Surface "correction" term at k=1 :  
455         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
456          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
457           af(i,j) = rTrans(i,j)*localTijk(i,j,k)           fVerT(i,j,kUp) = af(i,j)
458          ENDDO          ENDDO
        ENDDO  
       ENDIF  
 C-    add the advective flux to fVerT  
       DO j=1-Oly,sNy+Oly  
        DO i=1-Olx,sNx+Olx  
         fVerT(i,j,kUp) = af(i,j)  
459         ENDDO         ENDDO
460        ENDDO  
461    C- end Surface/Interior if bloc
462          ENDIF
463    
464  C--   Divergence of fluxes  C--   Divergence of fluxes
       kp1=min(Nr,k+1)  
       kp1Msk=1.  
       if (k.EQ.Nr) kp1Msk=0.  
465        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
466         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx
467          localTij(i,j)=localTijk(i,j,k)-deltaTtracer*          localTij(i,j)=localTijk(i,j,k)-deltaTtracer*
468       &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)       &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
469       &    *recip_rA(i,j,bi,bj)       &    *recip_rA(i,j,bi,bj)
470       &    *( fVerT(i,j,kUp)-fVerT(i,j,kDown)       &    *( fVerT(i,j,kUp)-fVerT(i,j,kDown)
471       &      -tracer(i,j,k,bi,bj)*rA(i,j,bi,bj)*       &      -tracer(i,j,k,bi,bj)*(rTrans(i,j)-rTransKp1(i,j))
      &        (wVel(i,j,k,bi,bj)-kp1Msk*wVel(i,j,kp1,bi,bj))  
472       &     )*rkFac       &     )*rkFac
473          gTracer(i,j,k,bi,bj)=          gTracer(i,j,k,bi,bj)=
474       &   (localTij(i,j)-tracer(i,j,k,bi,bj))/deltaTtracer       &   (localTij(i,j)-tracer(i,j,k,bi,bj))/deltaTtracer

Legend:
Removed from v.1.8  
changed lines
  Added in v.1.14

  ViewVC Help
Powered by ViewVC 1.1.22