/[MITgcm]/MITgcm/pkg/ptracers/ptracers_integrate.F
ViewVC logotype

Diff of /MITgcm/pkg/ptracers/ptracers_integrate.F

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

revision 1.20 by mlosch, Fri Nov 19 01:34:27 2004 UTC revision 1.31 by heimbach, Tue Apr 4 14:52:43 2006 UTC
# Line 2  C $Header$ Line 2  C $Header$
2  C $Name$  C $Name$
3    
4  #include "PTRACERS_OPTIONS.h"  #include "PTRACERS_OPTIONS.h"
 cswdptr -- add ---  
 #ifdef ALLOW_GCHEM  
 # include "GCHEM_OPTIONS.h"  
 #endif  
 cswdptr -- end add ---  
5    
6  CBOP  CBOP
7  C !ROUTINE: PTRACERS_INTEGRATE  C !ROUTINE: PTRACERS_INTEGRATE
# Line 20  C !INTERFACE: ========================== Line 15  C !INTERFACE: ==========================
15       I                               myIter,myTime,myThid )       I                               myIter,myTime,myThid )
16    
17  C !DESCRIPTION:  C !DESCRIPTION:
18  C     Calculates tendancy for passive tracers and integrates forward  C     Calculates tendency for passive tracers and integrates forward
19  C     in time.  C     in time.
20    
21  C !USES: ===============================================================  C !USES: ===============================================================
# Line 32  C !USES: =============================== Line 27  C !USES: ===============================
27  #include "PTRACERS_SIZE.h"  #include "PTRACERS_SIZE.h"
28  #include "PTRACERS.h"  #include "PTRACERS.h"
29  #include "GAD.h"  #include "GAD.h"
30    #ifdef ALLOW_AUTODIFF_TAMC
31    # include "tamc.h"
32    # include "tamc_keys.h"
33    #endif
34    
35  C !INPUT PARAMETERS: ===================================================  C !INPUT PARAMETERS: ===================================================
36  C  bi,bj                :: tile indices  C  bi,bj                :: tile indices
# Line 68  C  none Line 67  C  none
67  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
68    
69  C !LOCAL VARIABLES: ====================================================  C !LOCAL VARIABLES: ====================================================
70  C  i,j,k,bi,bj,iTracer  :: loop indices  C  iTracer              :: tracer index
71  C  iMin,iMax,jMin,jMax  :: loop ranges  C  iMin,iMax,jMin,jMax  :: loop ranges
72  C  kUp,kDown            :: toggle indices for even/odd level fluxes  C  kUp,kDown            :: toggle indices for even/odd level fluxes
73  C  km1                  :: =min(1,k-1)  C  km1                  :: =min(1,k-1)
74  C  GAD_TR               :: passive tracer id (GAD_TR1+iTracer-1)  C  GAD_TR               :: passive tracer id (GAD_TR1+iTracer-1)
75        INTEGER i,j,iTracer        INTEGER iTracer
76        INTEGER iMin,iMax,jMin,jMax        INTEGER iMin,iMax,jMin,jMax
77        INTEGER kUp,kDown,km1        INTEGER kUp,kDown,km1
78        INTEGER GAD_TR        INTEGER GAD_TR
79        LOGICAL calcAdvection        LOGICAL calcAdvection
80          INTEGER iterNb
81  CEOP  CEOP
82    
83    C Loop ranges for daughter routines
84          iMin = 1-OLx+2
85          iMax = sNx+OLx-1
86          jMin = 1-OLy+2
87          jMax = sNy+OLy-1
88          
89          km1  = MAX(1,k-1)
90          kUp  = 1+MOD(k+1,2)
91          kDown= 1+MOD(k,2)
92    
93  C Loop over tracers  C Loop over tracers
94        DO iTracer=1,PTRACERS_numInUse        DO iTracer=1,PTRACERS_numInUse
95    
96  C Loop ranges for daughter routines  #ifdef ALLOW_AUTODIFF_TAMC
97         iMin = 1-OLx+2            act0 = iTracer - 1
98         iMax = sNx+OLx-1            max0 = PTRACERS_num
99         jMin = 1-OLy+2            act1 = bi - myBxLo(myThid)
100         jMax = sNy+OLy-1            max1 = myBxHi(myThid) - myBxLo(myThid) + 1
101              act2 = bj - myByLo(myThid)
102         km1  = MAX(1,k-1)            max2 = myByHi(myThid) - myByLo(myThid) + 1
103         kUp  = 1+MOD(k+1,2)            act3 = myThid - 1
104         kDown= 1+MOD(k,2)            max3 = nTx*nTy
105              act4 = ikey_dynamics - 1
106              iptrkey = (act0 + 1)
107         &                      + act1*max0
108         &                      + act2*max0*max1
109         &                      + act3*max0*max1*max2
110         &                      + act4*max0*max1*max2*max3
111              kkey = (iptrkey-1)*Nr + k
112    #endif /* ALLOW_AUTODIFF_TAMC */
113    
114    #ifdef ALLOW_AUTODIFF_TAMC
115          rFlx(1,1,kDown,iTracer) = rFlx(1,1,kDown,iTracer)
116    c
117    CADJ STORE ptracer(:,:,k,bi,bj,iTracer)
118    CADJ &      = comlev1_bibj_k_ptracers, key=kkey, byte=isbyte
119    CADJ STORE gPtrnm1(:,:,k,bi,bj,iTracer)
120    CADJ &      = comlev1_bibj_k_ptracers, key=kkey, byte=isbyte
121    #endif /* ALLOW_AUTODIFF_TAMC */
122    
123  C Calculate active tracer tendencies (gPtr) due to internal processes  C Calculate active tracer tendencies (gPtr) due to internal processes
124  C (advection, [explicit] diffusion, parameterizations,...)  C (advection, [explicit] diffusion, parameterizations,...)
125         calcAdvection = .NOT.multiDimAdvection         calcAdvection = .NOT.multiDimAdvection
# Line 107  C (advection, [explicit] diffusion, para Line 134  C (advection, [explicit] diffusion, para
134       I                   PTRACERS_diffKh(iTracer),       I                   PTRACERS_diffKh(iTracer),
135       I                   PTRACERS_diffK4(iTracer),       I                   PTRACERS_diffK4(iTracer),
136       I                   KappaRtr(1-Olx,1-Oly,iTracer),       I                   KappaRtr(1-Olx,1-Oly,iTracer),
137         I                   gPtrNm1(1-Olx,1-Oly,1,1,1,iTracer),
138       I                   pTracer(1-Olx,1-Oly,1,1,1,iTracer),       I                   pTracer(1-Olx,1-Oly,1,1,1,iTracer),
139       I                   GAD_TR,       I                   GAD_TR,
140       I                   PTRACERS_advScheme(iTracer),       I                   PTRACERS_advScheme(iTracer),
141       I                   PTRACERS_advScheme(iTracer),       I                   PTRACERS_advScheme(iTracer),
142       I                   calcAdvection, .FALSE.,       I                   calcAdvection, PTRACERS_ImplVertAdv(iTracer),
143         I                   .FALSE.,
144       U                   rFlx(1-Olx,1-Oly,1,iTracer),       U                   rFlx(1-Olx,1-Oly,1,iTracer),
145       U                   gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                   gPtr(1-Olx,1-Oly,1,1,1,iTracer),
146       I                   myTime, myIter, myThid )       I                   myTime, myIter, myThid )
147    
148  C External forcing term(s)  C External forcing term(s)
149  cswdptr --add --         IF ( tracForcingOutAB.NE.1 )
 #ifdef ALLOW_GCHEM  
 #ifndef PTRACERS_SEPARATE_FORCING  
        IF ( forcing_In_AB .AND. useGCHEM )  
      &    CALL GCHEM_FORCING_INT(  
      I                        bi,bj,iMin,iMax,jMin,jMax,k,  
      I                        iTracer,  
      I                        myTime,myIter, myThid)  
 #endif  
 #else  
 cswdptr - end add ---  
        IF ( forcing_In_AB )  
150       &   CALL PTRACERS_FORCING(       &   CALL PTRACERS_FORCING(
151       I                      bi,bj,iMin,iMax,jMin,jMax,k,       I                      bi,bj,iMin,iMax,jMin,jMax,k,iTracer,
152       U                      gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                      gPtr(1-Olx,1-Oly,1,1,1,iTracer),
153       I                      surfaceForcingPtr(1-Olx,1-Oly,1,1,iTracer),       I                      surfaceForcingPtr(1-Olx,1-Oly,1,1,iTracer),
154       I                      myIter,myTime,myThid)       I                      myIter,myTime,myThid)
 cswdptr --add---  
 #endif  
 cswdptr -- end add ---  
155    
156  C If using Adams-Bashforth II, then extrapolate tendancies  C If using Adams-Bashforth II, then extrapolate tendencies
157    C gPtr is now the tracer tendency for explicit advection/diffusion
158        IF ( PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND        IF ( PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND
159       & .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD       & .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD
160       & .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH ) THEN       & .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH ) THEN
161    #ifdef ALLOW_MATRIX
162    C  If matrix is being computed, block call to S/R ADAMS_BASHFORTH2 to
163    C  prevent gPtr from being replaced by the average of gPtr and gPtrNm1.    
164            IF (.NOT.useMATRIX) THEN
165    #endif          
166            iterNb = myIter
167            IF (staggerTimeStep) iterNb = myIter - 1
168          CALL ADAMS_BASHFORTH2(          CALL ADAMS_BASHFORTH2(
169       I                        bi,bj,K,       I                        bi,bj,K,
170       U                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),
171       U                        gPtrNm1(1-Olx,1-Oly,1,1,1,iTracer),       U                        gPtrNm1(1-Olx,1-Oly,1,1,1,iTracer),
172       I                        myIter,myThid )       I                        iterNb, myThid )
173    #ifdef ALLOW_MATRIX
174            ENDIF
175    #endif    
176        ENDIF        ENDIF
177    
178  C External forcing term(s)  C External forcing term(s)
179  cswdptr - add--         IF ( tracForcingOutAB.EQ.1 )
 #ifdef ALLOW_GCHEM  
 #ifndef PTRACERS_SEPARATE_FORCING  
        IF ( .NOT.forcing_In_AB .AND. useGCHEM )  
      &    CALL GCHEM_FORCING_INT(  
      I                        bi,bj,iMin,iMax,jMin,jMax,k,  
      I                        iTracer,  
      I                        myTime,myIter, myThid)  
 #endif  
 #else  
 cswdptr - end add ---  
        IF ( .NOT.forcing_In_AB )  
180       &   CALL PTRACERS_FORCING(       &   CALL PTRACERS_FORCING(
181       I                      bi,bj,iMin,iMax,jMin,jMax,k,       I                      bi,bj,iMin,iMax,jMin,jMax,k,iTracer,
182       U                      gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                      gPtr(1-Olx,1-Oly,1,1,1,iTracer),
183       I                      surfaceForcingPtr(1-Olx,1-Oly,1,1,iTracer),       I                      surfaceForcingPtr(1-Olx,1-Oly,1,1,iTracer),
184       I                      myIter,myTime,myThid)       I                      myIter,myTime,myThid)
 cswdptr - add--  
 #endif  
 cswdptr -- end add ---  
185    
186  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
187  C Account for change in level thickness  C Account for change in level thickness
# Line 196  C Integrate forward in time, storing in Line 208  C Integrate forward in time, storing in
208       I                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),       I                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),
209       I                        myIter,myThid )       I                        myIter,myThid )
210    
211    #ifdef   ALLOW_OBCS
212    C Apply open boundary conditions
213             IF (useOBCS) THEN
214              CALL OBCS_APPLY_PTRACER(
215         I         bi, bj, k, iTracer,
216         U         gPtr(1-Olx,1-Oly,k,bi,bj,iTracer),
217         I         myThid )
218             END IF
219    #endif   /* ALLOW_OBCS */
220  C end of tracer loop  C end of tracer loop
221        ENDDO        ENDDO
222    
Legend:
Removed from v.1.20  
changed lines
  Added in v.1.31
  ViewVC Help
Powered by ViewVC 1.1.22