/[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.5 by adcroft, Fri Sep 21 13:11:43 2001 UTC revision 1.16 by heimbach, Tue Nov 25 23:31:44 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 29  C  time-stepping. Line 28  C  time-stepping.
28  C  \end{itemize}  C  \end{itemize}
29  CEOI  CEOI
30    
31    #include "PACKAGES_CONFIG.h"
32  #include "GAD_OPTIONS.h"  #include "GAD_OPTIONS.h"
33    #ifdef ALLOW_AUTODIFF
34    # include "CPP_OPTIONS.h"
35    #endif
36    
37  CBOP  CBOP
38  C !ROUTINE: GAD_ADVECTION  C !ROUTINE: GAD_ADVECTION
# Line 66  C !USES: =============================== Line 69  C !USES: ===============================
69  #include "DYNVARS.h"  #include "DYNVARS.h"
70  #include "GRID.h"  #include "GRID.h"
71  #include "GAD.h"  #include "GAD.h"
72    #ifdef ALLOW_AUTODIFF_TAMC
73    # include "tamc.h"
74    # include "tamc_keys.h"
75    #endif
76    
77  C !INPUT PARAMETERS: ===================================================  C !INPUT PARAMETERS: ===================================================
78  C  bi,bj                :: tile indices  C  bi,bj                :: tile indices
# Line 78  C  myThid               :: thread number Line 85  C  myThid               :: thread number
85        INTEGER bi,bj        INTEGER bi,bj
86        INTEGER advectionScheme        INTEGER advectionScheme
87        INTEGER tracerIdentity        INTEGER tracerIdentity
88        _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)
89        _RL myTime        _RL myTime
90        INTEGER myIter        INTEGER myIter
91        INTEGER myThid        INTEGER myThid
92    
93  C !OUTPUT PARAMETERS: ==================================================  C !OUTPUT PARAMETERS: ==================================================
94  C  gTracer              :: tendancy array  C  gTracer              :: tendancy array
95        _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)
96    
97  C !LOCAL VARIABLES: ====================================================  C !LOCAL VARIABLES: ====================================================
98  C  maskUp               :: 2-D array for mask at W points  C  maskUp               :: 2-D array for mask at W points
# Line 96  C  kdown                :: index into 2 Line 103  C  kdown                :: index into 2
103  C  kp1                  :: =k+1 for k<Nr, =Nr for k=Nr  C  kp1                  :: =k+1 for k<Nr, =Nr for k=Nr
104  C  xA,yA                :: areas of X and Y face of tracer cells  C  xA,yA                :: areas of X and Y face of tracer cells
105  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
106    C  rTransKp1            :: vertical volume transport at interface k+1
107  C  af                   :: 2-D array for horizontal advective flux  C  af                   :: 2-D array for horizontal advective flux
108  C  fVerT                :: 2 1/2D arrays for vertical advective flux  C  fVerT                :: 2 1/2D arrays for vertical advective flux
109  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 107  C  nipass               :: number of pas Line 115  C  nipass               :: number of pas
115  C  ipass                :: number of the current pass being made  C  ipass                :: number of the current pass being made
116        _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
117        INTEGER iMin,iMax,jMin,jMax        INTEGER iMin,iMax,jMin,jMax
118        INTEGER i,j,k,kup,kDown,kp1        INTEGER i,j,k,kup,kDown
119        _RS xA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS xA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
120        _RS yA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS yA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
121        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
122        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
123        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
124          _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
125        _RL af      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL af      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
126        _RL fVerT   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerT   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
127        _RL localTij(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL localTij(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
# Line 122  C  ipass                :: number of the Line 131  C  ipass                :: number of the
131        INTEGER nipass,ipass        INTEGER nipass,ipass
132  CEOP  CEOP
133    
134    #ifdef ALLOW_AUTODIFF_TAMC
135              act0 = tracerIdentity - 1
136              max0 = maxpass
137              act1 = bi - myBxLo(myThid)
138              max1 = myBxHi(myThid) - myBxLo(myThid) + 1
139              act2 = bj - myByLo(myThid)
140              max2 = myByHi(myThid) - myByLo(myThid) + 1
141              act3 = myThid - 1
142              max3 = nTx*nTy
143              act4 = ikey_dynamics - 1
144              igadkey = (act0 + 1)
145         &                      + act1*max0
146         &                      + act2*max0*max1
147         &                      + act3*max0*max1*max2
148         &                      + act4*max0*max1*max2*max3
149              if (tracerIdentity.GT.maxpass) then
150                 print *, 'ph-pass gad_advection ', maxpass, tracerIdentity
151                 STOP 'maxpass seems smaller than tracerIdentity'
152              endif
153    #endif /* ALLOW_AUTODIFF_TAMC */
154    
155  C--   Set up work arrays with valid (i.e. not NaN) values  C--   Set up work arrays with valid (i.e. not NaN) values
156  C     These inital values do not alter the numerical results. They  C     These inital values do not alter the numerical results. They
157  C     just ensure that all memory references are to valid floating  C     just ensure that all memory references are to valid floating
# Line 136  C     uninitialised but inert locations. Line 166  C     uninitialised but inert locations.
166          rTrans(i,j)  = 0. _d 0          rTrans(i,j)  = 0. _d 0
167          fVerT(i,j,1) = 0. _d 0          fVerT(i,j,1) = 0. _d 0
168          fVerT(i,j,2) = 0. _d 0          fVerT(i,j,2) = 0. _d 0
169            rTransKp1(i,j)= 0. _d 0
170         ENDDO         ENDDO
171        ENDDO        ENDDO
172    
# Line 146  C     uninitialised but inert locations. Line 177  C     uninitialised but inert locations.
177    
178  C--   Start of k loop for horizontal fluxes  C--   Start of k loop for horizontal fluxes
179        DO k=1,Nr        DO k=1,Nr
180    #ifdef ALLOW_AUTODIFF_TAMC
181             kkey = (igadkey-1)*Nr + k
182    CADJ STORE tracer(:,:,k,bi,bj) =
183    CADJ &     comlev1_bibj_k_gad, key=kkey, byte=isbyte
184    #endif /* ALLOW_AUTODIFF_TAMC */
185    
186  C--   Get temporary terms used by tendency routines  C--   Get temporary terms used by tendency routines
187        CALL CALC_COMMON_FACTORS (        CALL CALC_COMMON_FACTORS (
# Line 153  C--   Get temporary terms used by tenden Line 189  C--   Get temporary terms used by tenden
189       O         xA,yA,uTrans,vTrans,rTrans,maskUp,       O         xA,yA,uTrans,vTrans,rTrans,maskUp,
190       I         myThid)       I         myThid)
191    
192    #ifdef ALLOW_GMREDI
193    C--   Residual transp = Bolus transp + Eulerian transp
194           IF (useGMRedi)
195         &   CALL GMREDI_CALC_UVFLOW(
196         &            uTrans, vTrans, bi, bj, k, myThid)
197    #endif /* ALLOW_GMREDI */
198    
199  C--   Make local copy of tracer array  C--   Make local copy of tracer array
200        DO j=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
201         DO i=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
# Line 162  C--   Make local copy of tracer array Line 205  C--   Make local copy of tracer array
205    
206        IF (useCubedSphereExchange) THEN        IF (useCubedSphereExchange) THEN
207         nipass=3         nipass=3
208    #ifdef ALLOW_AUTODIFF_TAMC
209           if ( nipass.GT.maxcube )
210         &      STOP 'maxcube needs to be = 3'
211    #endif
212        ELSE        ELSE
213         nipass=1         nipass=1
214        ENDIF        ENDIF
215         nipass=1  cph       nipass=1
216    
217  C--   Multiple passes for different directions on different tiles  C--   Multiple passes for different directions on different tiles
218        DO ipass=1,nipass        DO ipass=1,nipass
219    #ifdef ALLOW_AUTODIFF_TAMC
220             passkey = ipass + (k-1)      *maxcube
221         &                   + (igadkey-1)*maxcube*Nr
222             IF (nipass .GT. maxpass) THEN
223              STOP 'GAD_ADVECTION: nipass > maxcube. check tamc.h'
224             ENDIF
225    #endif /* ALLOW_AUTODIFF_TAMC */
226    
227        IF (nipass.EQ.3) THEN        IF (nipass.EQ.3) THEN
228         calc_fluxes_X=.FALSE.         calc_fluxes_X=.FALSE.
# Line 212  C-    Advective flux in X Line 266  C-    Advective flux in X
266          af(i,j) = 0.          af(i,j) = 0.
267         ENDDO         ENDDO
268        ENDDO        ENDDO
269    
270    #ifdef ALLOW_AUTODIFF_TAMC
271    #ifndef DISABLE_MULTIDIM_ADVECTION
272    CADJ STORE localTij(:,:)  =
273    CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
274    #endif
275    #endif /* ALLOW_AUTODIFF_TAMC */
276    
277        IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN        IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
278         CALL GAD_FLUXLIMIT_ADV_X(         CALL GAD_FLUXLIMIT_ADV_X(
279       &      bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)       &      bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)
# Line 222  C-    Advective flux in X Line 284  C-    Advective flux in X
284         CALL GAD_DST3FL_ADV_X(         CALL GAD_DST3FL_ADV_X(
285       &       bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)       &       bi,bj,k,deltaTtracer,uTrans,uVel,localTij,af,myThid)
286        ELSE        ELSE
287         STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'         STOP 'GAD_ADVECTION: adv. scheme incompatibale with multi-dim'
288        ENDIF        ENDIF
289    
290        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
291         DO i=1-Olx,sNx+Olx-1         DO i=1-Olx,sNx+Olx-1
292          localTij(i,j)=localTij(i,j)-deltaTtracer*          localTij(i,j)=localTij(i,j)-deltaTtracer*
# Line 270  C-    Advective flux in Y Line 333  C-    Advective flux in Y
333          af(i,j) = 0.          af(i,j) = 0.
334         ENDDO         ENDDO
335        ENDDO        ENDDO
336    
337    #ifdef ALLOW_AUTODIFF_TAMC
338    #ifndef DISABLE_MULTIDIM_ADVECTION
339    CADJ STORE localTij(:,:)  =
340    CADJ &     comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
341    #endif
342    #endif /* ALLOW_AUTODIFF_TAMC */
343    
344        IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN        IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
345         CALL GAD_FLUXLIMIT_ADV_Y(         CALL GAD_FLUXLIMIT_ADV_Y(
346       &       bi,bj,k,deltaTtracer,vTrans,vVel,localTij,af,myThid)       &       bi,bj,k,deltaTtracer,vTrans,vVel,localTij,af,myThid)
# Line 282  C-    Advective flux in Y Line 353  C-    Advective flux in Y
353        ELSE        ELSE
354         STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'         STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
355        ENDIF        ENDIF
356    
357        DO j=1-Oly,sNy+Oly-1        DO j=1-Oly,sNy+Oly-1
358         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx
359          localTij(i,j)=localTij(i,j)-deltaTtracer*          localTij(i,j)=localTij(i,j)-deltaTtracer*
# Line 321  C--   End of K loop for horizontal fluxe Line 393  C--   End of K loop for horizontal fluxe
393    
394  C--   Start of k loop for vertical flux  C--   Start of k loop for vertical flux
395        DO k=Nr,1,-1        DO k=Nr,1,-1
396    #ifdef ALLOW_AUTODIFF_TAMC
397             kkey = (igadkey-1)*Nr + k
398    #endif /* ALLOW_AUTODIFF_TAMC */
399    
400  C--   kup    Cycles through 1,2 to point to w-layer above  C--   kup    Cycles through 1,2 to point to w-layer above
401  C--   kDown  Cycles through 2,1 to point to w-layer below  C--   kDown  Cycles through 2,1 to point to w-layer below
402        kup  = 1+MOD(k+1,2)        kup  = 1+MOD(k+1,2)
403        kDown= 1+MOD(k,2)        kDown= 1+MOD(k,2)
404    c     kp1=min(Nr,k+1)
405          kp1Msk=1.
406          if (k.EQ.Nr) kp1Msk=0.
407    
408  C--   Get temporary terms used by tendency routines  C-- Compute Vertical transport
409        CALL CALC_COMMON_FACTORS (  C     Note: wVel needs to be masked
      I         bi,bj,iMin,iMax,jMin,jMax,k,  
      O         xA,yA,uTrans,vTrans,rTrans,maskUp,  
      I         myThid)  
410    
411  C-    Advective flux in R        IF (k.EQ.1) THEN
412        DO j=1-Oly,sNy+Oly  C- Surface interface :
413         DO i=1-Olx,sNx+Olx  
414          af(i,j) = 0.         DO j=1-Oly,sNy+Oly
415            DO i=1-Olx,sNx+Olx
416             rTransKp1(i,j) = rTrans(i,j)
417             rTrans(i,j) = 0.
418             fVerT(i,j,kUp) = 0.
419             af(i,j) = 0.
420            ENDDO
421         ENDDO         ENDDO
       ENDDO  
422    
423  C     Note: wVel needs to be masked        ELSE
424        IF (K.GE.2) THEN  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    #ifdef ALLOW_AUTODIFF_TAMC
442    CADJ STORE localTijk(:,:,k)  
443    CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
444    CADJ STORE rTrans(:,:)  
445    CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
446    #endif /* ALLOW_AUTODIFF_TAMC */
447    
448  C-    Compute vertical advective flux in the interior:  C-    Compute vertical advective flux in the interior:
449         IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN         IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
450          CALL GAD_FLUXLIMIT_ADV_R(          CALL GAD_FLUXLIMIT_ADV_R(
# Line 355  C-    Compute vertical advective flux in Line 458  C-    Compute vertical advective flux in
458         ELSE         ELSE
459          STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'          STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
460         ENDIF         ENDIF
461  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 :  
462         DO j=1-Oly,sNy+Oly         DO j=1-Oly,sNy+Oly
463          DO i=1-Olx,sNx+Olx          DO i=1-Olx,sNx+Olx
464           af(i,j) = rTrans(i,j)*localTijk(i,j,k)           fVerT(i,j,kUp) = af(i,j)
465          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)  
466         ENDDO         ENDDO
467        ENDDO  
468    C- end Surface/Interior if bloc
469          ENDIF
470    
471    #ifdef ALLOW_AUTODIFF_TAMC
472    CADJ STORE rTrans(:,:)  
473    CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
474    CADJ STORE rTranskp1(:,:)  
475    CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
476    #endif /* ALLOW_AUTODIFF_TAMC */
477    
478  C--   Divergence of fluxes  C--   Divergence of fluxes
       kp1=min(Nr,k+1)  
       kp1Msk=1.  
       if (k.EQ.Nr) kp1Msk=0.  
479        DO j=1-Oly,sNy+Oly        DO j=1-Oly,sNy+Oly
480         DO i=1-Olx,sNx+Olx         DO i=1-Olx,sNx+Olx
481          localTij(i,j)=localTijk(i,j,k)-deltaTtracer*          localTij(i,j)=localTijk(i,j,k)-deltaTtracer*
482       &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)       &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
483       &    *recip_rA(i,j,bi,bj)       &    *recip_rA(i,j,bi,bj)
484       &    *( fVerT(i,j,kUp)-fVerT(i,j,kDown)       &    *( fVerT(i,j,kUp)-fVerT(i,j,kDown)
485       &      -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))  
486       &     )*rkFac       &     )*rkFac
487          gTracer(i,j,k,bi,bj)=          gTracer(i,j,k,bi,bj)=
488       &   (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.5  
changed lines
  Added in v.1.16
  ViewVC Help
Powered by ViewVC 1.1.22