/[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.7 by adcroft, Fri Sep 28 02:26:57 2001 UTC revision 1.15 by heimbach, Fri Jun 27 01:57:28 2003 UTC
# Line 4  C $Name$ Line 4  C $Name$
4  CBOI  CBOI
5  C !TITLE: pkg/generic\_advdiff  C !TITLE: pkg/generic\_advdiff
6  C !AUTHORS: adcroft@mit.edu  C !AUTHORS: adcroft@mit.edu
7  C !INTRODUCTION:  C !INTRODUCTION: Generic Advection Diffusion Package
 C \section{Generica Advection Diffusion Package}  
8  C  C
9  C Package "generic\_advdiff" provides a common set of routines for calculating  C Package "generic\_advdiff" provides a common set of routines for calculating
10  C advective/diffusive fluxes for tracers (cell centered quantities on a C-grid).  C advective/diffusive fluxes for tracers (cell centered quantities on a C-grid).
# Line 82  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 100  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 111  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 127  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 134  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) then
146                 print *, 'ph-pass gad_advection ', maxpass, tracerIdentity
147                 STOP 'maxpass seems smaller than tracerIdentity'
148              endif
149  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
150    
151  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 153  C     uninitialised but inert locations. Line 162  C     uninitialised but inert locations.
162          rTrans(i,j)  = 0. _d 0          rTrans(i,j)  = 0. _d 0
163          fVerT(i,j,1) = 0. _d 0          fVerT(i,j,1) = 0. _d 0
164          fVerT(i,j,2) = 0. _d 0          fVerT(i,j,2) = 0. _d 0
165            rTransKp1(i,j)= 0. _d 0
166         ENDDO         ENDDO
167        ENDDO        ENDDO
168    
# Line 164  C     uninitialised but inert locations. Line 174  C     uninitialised but inert locations.
174  C--   Start of k loop for horizontal fluxes  C--   Start of k loop for horizontal fluxes
175        DO k=1,Nr        DO k=1,Nr
176  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
177           kkey = (ikey-1)*Nr + k           kkey = (igadkey-1)*Nr + k
178  CADJ STORE tracer(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ STORE tracer(:,:,k,bi,bj) =
179    CADJ &     comlev1_bibj_k_gad, key=kkey, byte=isbyte
180  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
181    
182  C--   Get temporary terms used by tendency routines  C--   Get temporary terms used by tendency routines
# Line 174  C--   Get temporary terms used by tenden Line 185  C--   Get temporary terms used by tenden
185       O         xA,yA,uTrans,vTrans,rTrans,maskUp,       O         xA,yA,uTrans,vTrans,rTrans,maskUp,
186       I         myThid)       I         myThid)
187    
188    #ifdef ALLOW_GMREDI
189    C--   Residual transp = Bolus transp + Eulerian transp
190           IF (useGMRedi)
191         &   CALL GMREDI_CALC_UVFLOW(
192         &            uTrans, vTrans, bi, bj, k, myThid)
193    #endif /* ALLOW_GMREDI */
194    
195  C--   Make local copy of tracer array  C--   Make local copy of tracer array
196        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
197         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
# Line 183  C--   Make local copy of tracer array Line 201  C--   Make local copy of tracer array
201    
202        IF (useCubedSphereExchange) THEN        IF (useCubedSphereExchange) THEN
203         nipass=3         nipass=3
204    #ifdef ALLOW_AUTODIFF_TAMC
205           if ( nipass.GT.maxcube )
206         &      STOP 'maxcube needs to be = 3'
207    #endif
208        ELSE        ELSE
209         nipass=1         nipass=1
210        ENDIF        ENDIF
# Line 191  cph       nipass=1 Line 213  cph       nipass=1
213  C--   Multiple passes for different directions on different tiles  C--   Multiple passes for different directions on different tiles
214        DO ipass=1,nipass        DO ipass=1,nipass
215  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
216           passkey = ipass + (k-1)   *maxpass           passkey = ipass + (k-1)      *maxcube
217       &                   + (ikey-1)*maxpass*Nr       &                   + (igadkey-1)*maxcube*Nr
218           IF (nipass .GT. maxpass) THEN           IF (nipass .GT. maxpass) THEN
219            STOP 'GAD_ADVECTION: nipass > maxpass. check tamc.h'            STOP 'GAD_ADVECTION: nipass > maxcube. check tamc.h'
220           ENDIF           ENDIF
221  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
222    
# Line 243  C-    Advective flux in X Line 265  C-    Advective flux in X
265    
266  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
267  #ifndef DISABLE_MULTIDIM_ADVECTION  #ifndef DISABLE_MULTIDIM_ADVECTION
268  CADJ STORE localTij(:,:)  = comlev1_bibj_pass, key=passkey, byte=isbyte  CADJ STORE localTij(:,:)  =
269    CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
270  #endif  #endif
271  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
272    
# Line 257  CADJ STORE localTij(:,:)  = comlev1_bibj Line 280  CADJ STORE localTij(:,:)  = comlev1_bibj
280         CALL GAD_DST3FL_ADV_X(         CALL GAD_DST3FL_ADV_X(
281       &       bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)       &       bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)
282        ELSE        ELSE
283         STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'         STOP 'GAD_ADVECTION: adv. scheme incompatibale with multi-dim'
284        ENDIF        ENDIF
285    
286        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
# Line 309  C-    Advective flux in Y Line 332  C-    Advective flux in Y
332    
333  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
334  #ifndef DISABLE_MULTIDIM_ADVECTION  #ifndef DISABLE_MULTIDIM_ADVECTION
335  CADJ STORE localTij(:,:)  = comlev1_bibj_pass, key=passkey, byte=isbyte  CADJ STORE localTij(:,:)  =
336    CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
337  #endif  #endif
338  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
339    
# Line 373  C--   kup    Cycles through 1,2 to point Line 397  C--   kup    Cycles through 1,2 to point
397  C--   kDown  Cycles through 2,1 to point to w-layer below  C--   kDown  Cycles through 2,1 to point to w-layer below
398        kup  = 1+MOD(k+1,2)        kup  = 1+MOD(k+1,2)
399        kDown= 1+MOD(k,2)        kDown= 1+MOD(k,2)
400    c     kp1=min(Nr,k+1)
401  C--   Get temporary terms used by tendency routines        kp1Msk=1.
402        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  
403    
404  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
405  CADJ STORE localTijk(:,:,k)    CADJ STORE localTijk(:,:,k)  
406  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
407    CADJ STORE rTrans(:,:)  
408    CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
409  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
410    
411    C-- Compute Vertical transport
412  C     Note: wVel needs to be masked  C     Note: wVel needs to be masked
413        IF (K.GE.2) THEN  
414          IF (k.EQ.1) THEN
415    C- Surface interface :
416    
417           DO j=1-Oly,sNy+Oly
418            DO i=1-Olx,sNx+Olx
419             rTransKp1(i,j) = rTrans(i,j)
420             rTrans(i,j) = 0.
421             fVerT(i,j,kUp) = 0.
422            ENDDO
423           ENDDO
424    
425          ELSE
426    C- Interior interface :
427           DO j=1-Oly,sNy+Oly
428            DO i=1-Olx,sNx+Olx
429             rTransKp1(i,j) = kp1Msk*rTrans(i,j)
430             rTrans(i,j) = wVel(i,j,k,bi,bj)*rA(i,j,bi,bj)
431         &               *maskC(i,j,k-1,bi,bj)
432             af(i,j) = 0.
433            ENDDO
434           ENDDO
435    
436    #ifdef ALLOW_GMREDI
437    C--   Residual transp = Bolus transp + Eulerian transp
438           IF (useGMRedi)
439         &   CALL GMREDI_CALC_WFLOW(
440         &                    rTrans, bi, bj, k, myThid)
441    #endif /* ALLOW_GMREDI */
442    
443  C-    Compute vertical advective flux in the interior:  C-    Compute vertical advective flux in the interior:
444         IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN         IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
445          CALL GAD_FLUXLIMIT_ADV_R(          CALL GAD_FLUXLIMIT_ADV_R(
# Line 407  C-    Compute vertical advective flux in Line 453  C-    Compute vertical advective flux in
453         ELSE         ELSE
454          STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'          STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
455         ENDIF         ENDIF
456  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 :  
457         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
458          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
459           af(i,j) = rTrans(i,j)*localTijk(i,j,k)           fVerT(i,j,kUp) = af(i,j)
460          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)  
461         ENDDO         ENDDO
462        ENDDO  
463    C- end Surface/Interior if bloc
464          ENDIF
465    
466  C--   Divergence of fluxes  C--   Divergence of fluxes
       kp1=min(Nr,k+1)  
       kp1Msk=1.  
       if (k.EQ.Nr) kp1Msk=0.  
467        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
468         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx
469          localTij(i,j)=localTijk(i,j,k)-deltaTtracer*          localTij(i,j)=localTijk(i,j,k)-deltaTtracer*
470       &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)       &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
471       &    *recip_rA(i,j,bi,bj)       &    *recip_rA(i,j,bi,bj)
472       &    *( fVerT(i,j,kUp)-fVerT(i,j,kDown)       &    *( fVerT(i,j,kUp)-fVerT(i,j,kDown)
473       &      -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))  
474       &     )*rkFac       &     )*rkFac
475          gTracer(i,j,k,bi,bj)=          gTracer(i,j,k,bi,bj)=
476       &   (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.7  
changed lines
  Added in v.1.15
  ViewVC Help
Powered by ViewVC 1.1.22