/[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.16 by heimbach, Tue Nov 25 23:31:44 2003 UTC revision 1.19 by edhill, Sat Mar 27 03:51:51 2004 UTC
# Line 6  C !TITLE: pkg/generic\_advdiff Line 6  C !TITLE: pkg/generic\_advdiff
6  C !AUTHORS: adcroft@mit.edu  C !AUTHORS: adcroft@mit.edu
7  C !INTRODUCTION: Generic Advection Diffusion Package  C !INTRODUCTION: Generic 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).
11  C  C
12  C Many different advection schemes are available: the standard centered  C Many different advection schemes are available: the standard centered
# Line 28  C  time-stepping. Line 28  C  time-stepping.
28  C  \end{itemize}  C  \end{itemize}
29  CEOI  CEOI
30    
 #include "PACKAGES_CONFIG.h"  
31  #include "GAD_OPTIONS.h"  #include "GAD_OPTIONS.h"
 #ifdef ALLOW_AUTODIFF  
 # include "CPP_OPTIONS.h"  
 #endif  
32    
33    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
34  CBOP  CBOP
35  C !ROUTINE: GAD_ADVECTION  C !ROUTINE: GAD_ADVECTION
36    
37  C !INTERFACE: ==========================================================  C !INTERFACE: ==========================================================
38        SUBROUTINE GAD_ADVECTION(bi,bj,advectionScheme,tracerIdentity,        SUBROUTINE GAD_ADVECTION(
39       U                         Tracer,Gtracer,       I           implicitAdvection, advectionScheme, tracerIdentity,
40       I                         myTime,myIter,myThid)       I           uVel, vVel, wVel, tracer,
41         O           gTracer,
42         I           bi,bj, myTime,myIter,myThid)
43    
44  C !DESCRIPTION:  C !DESCRIPTION:
45  C Calculates the tendancy of a tracer due to advection.  C Calculates the tendancy of a tracer due to advection.
# Line 66  C !USES: =============================== Line 65  C !USES: ===============================
65  #include "SIZE.h"  #include "SIZE.h"
66  #include "EEPARAMS.h"  #include "EEPARAMS.h"
67  #include "PARAMS.h"  #include "PARAMS.h"
 #include "DYNVARS.h"  
68  #include "GRID.h"  #include "GRID.h"
69  #include "GAD.h"  #include "GAD.h"
70  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
# Line 75  C !USES: =============================== Line 73  C !USES: ===============================
73  #endif  #endif
74    
75  C !INPUT PARAMETERS: ===================================================  C !INPUT PARAMETERS: ===================================================
76  C  bi,bj                :: tile indices  C  implicitAdvection    :: vertical advection treated implicitly (later on)
77  C  advectionScheme      :: advection scheme to use  C  advectionScheme      :: advection scheme to use
78  C  tracerIdentity       :: identifier for the tracer (required only for OBCS)  C  tracerIdentity       :: identifier for the tracer (required only for OBCS)
79  C  Tracer               :: tracer field  C  uVel                 :: velocity, zonal component
80    C  vVel                 :: velocity, meridional component
81    C  wVel                 :: velocity, vertical component
82    C  tracer               :: tracer field
83    C  bi,bj                :: tile indices
84  C  myTime               :: current time  C  myTime               :: current time
85  C  myIter               :: iteration number  C  myIter               :: iteration number
86  C  myThid               :: thread number  C  myThid               :: thread number
87        INTEGER bi,bj        LOGICAL implicitAdvection
88        INTEGER advectionScheme        INTEGER advectionScheme
89        INTEGER tracerIdentity        INTEGER tracerIdentity
90        _RL Tracer(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)        _RL uVel  (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
91          _RL vVel  (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
92          _RL wVel  (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
93          _RL tracer(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
94          INTEGER bi,bj
95        _RL myTime        _RL myTime
96        INTEGER myIter        INTEGER myIter
97        INTEGER myThid        INTEGER myThid
# Line 379  C--   Apply open boundary conditions Line 385  C--   Apply open boundary conditions
385  C--   End of Y direction  C--   End of Y direction
386        ENDIF        ENDIF
387    
       DO j=1-Oly,sNy+Oly  
        DO i=1-Olx,sNx+Olx  
         localTijk(i,j,k)=localTij(i,j)  
        ENDDO  
       ENDDO  
   
388  C--   End of ipass loop  C--   End of ipass loop
389        ENDDO        ENDDO
390    
391          IF ( implicitAdvection ) THEN
392    C-    explicit advection is done ; store tendency in gTracer:
393            DO j=1-Oly,sNy+Oly
394             DO i=1-Olx,sNx+Olx
395              gTracer(i,j,k,bi,bj)=
396         &     (localTij(i,j)-tracer(i,j,k,bi,bj))/deltaTtracer
397             ENDDO
398            ENDDO
399          ELSE
400    C-    horizontal advection done; store intermediate result in 3D array:
401           DO j=1-Oly,sNy+Oly
402            DO i=1-Olx,sNx+Olx
403             localTijk(i,j,k)=localTij(i,j)
404            ENDDO
405           ENDDO
406          ENDIF
407    
408  C--   End of K loop for horizontal fluxes  C--   End of K loop for horizontal fluxes
409        ENDDO        ENDDO
410    
411          IF ( .NOT.implicitAdvection ) THEN
412  C--   Start of k loop for vertical flux  C--   Start of k loop for vertical flux
413        DO k=Nr,1,-1         DO k=Nr,1,-1
414  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
415           kkey = (igadkey-1)*Nr + k           kkey = (igadkey-1)*Nr + k
416  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
   
417  C--   kup    Cycles through 1,2 to point to w-layer above  C--   kup    Cycles through 1,2 to point to w-layer above
418  C--   kDown  Cycles through 2,1 to point to w-layer below  C--   kDown  Cycles through 2,1 to point to w-layer below
419        kup  = 1+MOD(k+1,2)          kup  = 1+MOD(k+1,2)
420        kDown= 1+MOD(k,2)          kDown= 1+MOD(k,2)
421  c     kp1=min(Nr,k+1)  c       kp1=min(Nr,k+1)
422        kp1Msk=1.          kp1Msk=1.
423        if (k.EQ.Nr) kp1Msk=0.          if (k.EQ.Nr) kp1Msk=0.
424    
425  C-- Compute Vertical transport  C-- Compute Vertical transport
426  C     Note: wVel needs to be masked          IF (k.EQ.1) THEN
427    
       IF (k.EQ.1) THEN  
428  C- Surface interface :  C- Surface interface :
429             DO j=1-Oly,sNy+Oly
430              DO i=1-Olx,sNx+Olx
431               rTransKp1(i,j) = rTrans(i,j)
432               rTrans(i,j) = 0.
433               fVerT(i,j,kUp) = 0.
434               af(i,j) = 0.
435              ENDDO
436             ENDDO
437    
438         DO j=1-Oly,sNy+Oly          ELSE
         DO i=1-Olx,sNx+Olx  
          rTransKp1(i,j) = rTrans(i,j)  
          rTrans(i,j) = 0.  
          fVerT(i,j,kUp) = 0.  
          af(i,j) = 0.  
         ENDDO  
        ENDDO  
   
       ELSE  
439  C- Interior interface :  C- Interior interface :
440         DO j=1-Oly,sNy+Oly  
441          DO i=1-Olx,sNx+Olx           DO j=1-Oly,sNy+Oly
442           rTransKp1(i,j) = kp1Msk*rTrans(i,j)            DO i=1-Olx,sNx+Olx
443           rTrans(i,j) = wVel(i,j,k,bi,bj)*rA(i,j,bi,bj)             rTransKp1(i,j) = kp1Msk*rTrans(i,j)
444       &               *maskC(i,j,k-1,bi,bj)             rTrans(i,j) = wVel(i,j,k,bi,bj)*rA(i,j,bi,bj)
445           af(i,j) = 0.       &                 *maskC(i,j,k-1,bi,bj)
446          ENDDO             af(i,j) = 0.
447         ENDDO            ENDDO
448             ENDDO
449    
450  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
451  C--   Residual transp = Bolus transp + Eulerian transp  C--   Residual transp = Bolus transp + Eulerian transp
452         IF (useGMRedi)           IF (useGMRedi)
453       &   CALL GMREDI_CALC_WFLOW(       &   CALL GMREDI_CALC_WFLOW(
454       &                    rTrans, bi, bj, k, myThid)       &                    rTrans, bi, bj, k, myThid)
455  #endif /* ALLOW_GMREDI */  #endif /* ALLOW_GMREDI */
# Line 446  CADJ &     = comlev1_bibj_k_gad, key=kke Line 462  CADJ &     = comlev1_bibj_k_gad, key=kke
462  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
463    
464  C-    Compute vertical advective flux in the interior:  C-    Compute vertical advective flux in the interior:
465         IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN           IF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
466          CALL GAD_FLUXLIMIT_ADV_R(            CALL GAD_FLUXLIMIT_ADV_R(
467       &       bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)       &        bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)
468         ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN           ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
469          CALL GAD_DST3_ADV_R(            CALL GAD_DST3_ADV_R(
470       &       bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)       &        bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)
471         ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN           ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
472          CALL GAD_DST3FL_ADV_R(            CALL GAD_DST3FL_ADV_R(
473       &       bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)       &        bi,bj,k,deltaTtracer,rTrans,wVel,localTijk,af,myThid)
474         ELSE           ELSE
475          STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'            STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
476         ENDIF           ENDIF
477  C-    add the advective flux to fVerT  C-    add the advective flux to fVerT
478         DO j=1-Oly,sNy+Oly           DO j=1-Oly,sNy+Oly
479          DO i=1-Olx,sNx+Olx            DO i=1-Olx,sNx+Olx
480           fVerT(i,j,kUp) = af(i,j)             fVerT(i,j,kUp) = af(i,j)
481          ENDDO            ENDDO
482         ENDDO           ENDDO
483    
484  C- end Surface/Interior if bloc  C- end Surface/Interior if bloc
485        ENDIF          ENDIF
486    
487  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
488  CADJ STORE rTrans(:,:)    CADJ STORE rTrans(:,:)  
# Line 475  CADJ STORE rTranskp1(:,:) Line 491  CADJ STORE rTranskp1(:,:)
491  CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k_gad, key=kkey, byte=isbyte
492  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
493    
494  C--   Divergence of fluxes  C--   Divergence of vertical fluxes
495        DO j=1-Oly,sNy+Oly          DO j=1-Oly,sNy+Oly
496         DO i=1-Olx,sNx+Olx           DO i=1-Olx,sNx+Olx
497          localTij(i,j)=localTijk(i,j,k)-deltaTtracer*            localTij(i,j)=localTijk(i,j,k)-deltaTtracer*
498       &    _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)       &     _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
499       &    *recip_rA(i,j,bi,bj)       &     *recip_rA(i,j,bi,bj)
500       &    *( fVerT(i,j,kUp)-fVerT(i,j,kDown)       &     *( fVerT(i,j,kUp)-fVerT(i,j,kDown)
501       &      -tracer(i,j,k,bi,bj)*(rTrans(i,j)-rTransKp1(i,j))       &       -tracer(i,j,k,bi,bj)*(rTrans(i,j)-rTransKp1(i,j))
502       &     )*rkFac       &      )*rkFac
503          gTracer(i,j,k,bi,bj)=            gTracer(i,j,k,bi,bj)=
504       &   (localTij(i,j)-tracer(i,j,k,bi,bj))/deltaTtracer       &     (localTij(i,j)-tracer(i,j,k,bi,bj))/deltaTtracer
505         ENDDO           ENDDO
506        ENDDO          ENDDO
507    
508  C--   End of K loop for vertical flux  C--   End of K loop for vertical flux
509        ENDDO         ENDDO
510    C--   end of if not.implicitAdvection block
511          ENDIF
512    
513        RETURN        RETURN
514        END        END
Legend:
Removed from v.1.16  
changed lines
  Added in v.1.19
  ViewVC Help
Powered by ViewVC 1.1.22