/[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.25 by mlosch, Mon Oct 10 05:53:48 2005 UTC revision 1.38 by jahn, Fri Jun 26 23:10:10 2009 UTC
# Line 8  C !ROUTINE: PTRACERS_INTEGRATE Line 8  C !ROUTINE: PTRACERS_INTEGRATE
8    
9  C !INTERFACE: ==========================================================  C !INTERFACE: ==========================================================
10        SUBROUTINE PTRACERS_INTEGRATE(        SUBROUTINE PTRACERS_INTEGRATE(
11       I                               bi,bj,k,       I                    bi,bj,k,
12       I                               xA,yA,uTrans,vTrans,rTrans,       I                    xA, yA, maskUp, uFld, vFld, wFld,
13       I                               rTransKp1,maskUp,       I                    uTrans, vTrans, rTrans, rTransKp1,
14       X                               rFlx,KappaRtr,       I                    KappaRtr,
15       I                               myIter,myTime,myThid )       U                    rFlx,
16         I                    myTime,myIter,myThid )
17    
18  C !DESCRIPTION:  C !DESCRIPTION:
19  C     Calculates tendancy for passive tracers and integrates forward  C     Calculates tendency for passive tracers and integrates forward
20  C     in time.  C     in time.
21    
22  C !USES: ===============================================================  C !USES: ===============================================================
# Line 24  C !USES: =============================== Line 25  C !USES: ===============================
25  #include "EEPARAMS.h"  #include "EEPARAMS.h"
26  #include "PARAMS.h"  #include "PARAMS.h"
27  #include "DYNVARS.h"  #include "DYNVARS.h"
28    #ifdef ALLOW_LONGSTEP
29    #include "LONGSTEP_PARAMS.h"
30    #endif
31  #include "PTRACERS_SIZE.h"  #include "PTRACERS_SIZE.h"
32  #include "PTRACERS.h"  #include "PTRACERS_PARAMS.h"
33    #include "PTRACERS_RESTART.h"
34    #include "PTRACERS_FIELDS.h"
35  #include "GAD.h"  #include "GAD.h"
36    #ifdef ALLOW_AUTODIFF_TAMC
37    # include "tamc.h"
38    # include "tamc_keys.h"
39    #endif
40    
41  C !INPUT PARAMETERS: ===================================================  C !INPUT PARAMETERS: ===================================================
42  C  bi,bj                :: tile indices  C  bi,bj                :: tile indices
43  C  k                    :: vertical level number  C  k                    :: vertical level number
44  C  xA                   :: face area at U points in level k  C  xA                   :: face area at U points in level k
45  C  yA                   :: face area at V points in level k  C  yA                   :: face area at V points in level k
46    C  maskUp               :: mask for vertical transport
47    C  uFld,vFld,wFld       :: Local copy of velocity field (3 components)
48  C  uTrans               :: zonal transport in level k  C  uTrans               :: zonal transport in level k
49  C  vTrans               :: meridional transport in level k  C  vTrans               :: meridional transport in level k
50  C  rTrans               :: vertical volume transport at interface k  C  rTrans               :: vertical volume transport at interface k
51  C  rTransKp1            :: vertical volume transport at interface k+1  C  rTransKp1            :: vertical volume transport at interface k+1
52  C  maskUp               :: mask for vertical transport  C  KappaRtr             :: vertical diffusion of passive tracers, interf k
53  C  rFlx                 :: vertical flux  C  rFlx                 :: vertical flux
 C  KappaRtr             :: vertical diffusion of passive tracers, interf k  
 C  myIter               :: time-step number  
54  C  myTime               :: model time  C  myTime               :: model time
55    C  myIter               :: time-step number
56  C  myThid               :: thread number  C  myThid               :: thread number
57        INTEGER bi,bj,k        INTEGER bi,bj,k
58        _RS xA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS xA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
59        _RS yA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS yA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
60          _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
61          _RL uFld    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
62          _RL vFld    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
63          _RL wFld    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
64        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
65        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
66        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
67        _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
       _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL rFlx(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2,PTRACERS_num)  
68        _RL KappaRtr(1-Olx:sNx+Olx,1-Oly:sNy+Oly,PTRACERS_num)        _RL KappaRtr(1-Olx:sNx+Olx,1-Oly:sNy+Oly,PTRACERS_num)
69        INTEGER myIter        _RL rFlx    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2,PTRACERS_num)
70        _RL myTime        _RL myTime
71          INTEGER myIter
72        INTEGER myThid        INTEGER myThid
73    
74  C !OUTPUT PARAMETERS: ==================================================  C !OUTPUT PARAMETERS: ==================================================
# Line 63  C  none Line 77  C  none
77  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
78    
79  C !LOCAL VARIABLES: ====================================================  C !LOCAL VARIABLES: ====================================================
80  C  i,j,k,bi,bj,iTracer  :: loop indices  C  iTracer              :: tracer index
81  C  iMin,iMax,jMin,jMax  :: loop ranges  C  iMin,iMax,jMin,jMax  :: loop ranges
82  C  kUp,kDown            :: toggle indices for even/odd level fluxes  C  kUp,kDown            :: toggle indices for even/odd level fluxes
83  C  km1                  :: =min(1,k-1)  C  km1                  :: =min(1,k-1)
84  C  GAD_TR               :: passive tracer id (GAD_TR1+iTracer-1)  C  GAD_TR               :: passive tracer id (GAD_TR1+iTracer-1)
85        INTEGER i,j,iTracer        INTEGER iTracer
86        INTEGER iMin,iMax,jMin,jMax        INTEGER iMin,iMax,jMin,jMax
87        INTEGER kUp,kDown,km1        INTEGER kUp,kDown,km1
88        INTEGER GAD_TR        INTEGER GAD_TR
# Line 76  C  GAD_TR               :: passive trace Line 90  C  GAD_TR               :: passive trace
90        INTEGER iterNb        INTEGER iterNb
91  CEOP  CEOP
92    
93    C Loop ranges for daughter routines
94          iMin = 1-OLx+2
95          iMax = sNx+OLx-1
96          jMin = 1-OLy+2
97          jMax = sNy+OLy-1
98    
99          km1  = MAX(1,k-1)
100          kUp  = 1+MOD(k+1,2)
101          kDown= 1+MOD(k,2)
102    
103  C Loop over tracers  C Loop over tracers
104        DO iTracer=1,PTRACERS_numInUse        DO iTracer=1,PTRACERS_numInUse
105    
106  C Loop ranges for daughter routines  #ifdef ALLOW_AUTODIFF_TAMC
107         iMin = 1-OLx+2            act0 = iTracer - 1
108         iMax = sNx+OLx-1            max0 = PTRACERS_num
109         jMin = 1-OLy+2            act1 = bi - myBxLo(myThid)
110         jMax = sNy+OLy-1            max1 = myBxHi(myThid) - myBxLo(myThid) + 1
111              act2 = bj - myByLo(myThid)
112         km1  = MAX(1,k-1)            max2 = myByHi(myThid) - myByLo(myThid) + 1
113         kUp  = 1+MOD(k+1,2)            act3 = myThid - 1
114         kDown= 1+MOD(k,2)            max3 = nTx*nTy
115              act4 = ikey_dynamics - 1
116              iptrkey = (act0 + 1)
117         &                      + act1*max0
118         &                      + act2*max0*max1
119         &                      + act3*max0*max1*max2
120         &                      + act4*max0*max1*max2*max3
121              kkey = (iptrkey-1)*Nr + k
122    #endif /* ALLOW_AUTODIFF_TAMC */
123    
124    #ifdef ALLOW_AUTODIFF_TAMC
125          rFlx(1,1,kDown,iTracer) = rFlx(1,1,kDown,iTracer)
126    c
127    CADJ STORE pTracer(:,:,k,bi,bj,iTracer)
128    CADJ &      = comlev1_bibj_k_ptracers, key=kkey, byte=isbyte
129    CADJ STORE gpTrNm1(:,:,k,bi,bj,iTracer)
130    CADJ &      = comlev1_bibj_k_ptracers, key=kkey, byte=isbyte
131    #endif /* ALLOW_AUTODIFF_TAMC */
132    
133  C Calculate active tracer tendencies (gPtr) due to internal processes  C Calculate active tracer tendencies (gPtr) due to internal processes
134  C (advection, [explicit] diffusion, parameterizations,...)  C (advection, [explicit] diffusion, parameterizations,...)
135         calcAdvection = .NOT.multiDimAdvection         calcAdvection = .NOT.PTRACERS_MultiDimAdv(iTracer)
      &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND  
      &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD  
      &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH  
136         GAD_TR = GAD_TR1 + iTracer - 1         GAD_TR = GAD_TR1 + iTracer - 1
137         CALL GAD_CALC_RHS(         CALL GAD_CALC_RHS(
138       I                   bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,       I                   bi,bj,iMin,iMax,jMin,jMax,k,km1,kUp,kDown,
139       I                   xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,       I                   xA, yA, maskUp, uFld, vFld, wFld,
140       I                   uVel, vVel, wVel,       I                   uTrans, vTrans, rTrans, rTransKp1,
141       I                   PTRACERS_diffKh(iTracer),       I                   PTRACERS_diffKh(iTracer),
142       I                   PTRACERS_diffK4(iTracer),       I                   PTRACERS_diffK4(iTracer),
143       I                   KappaRtr(1-Olx,1-Oly,iTracer),       I                   KappaRtr(1-Olx,1-Oly,iTracer),
144         I                   gpTrNm1(1-Olx,1-Oly,1,1,1,iTracer),
145       I                   pTracer(1-Olx,1-Oly,1,1,1,iTracer),       I                   pTracer(1-Olx,1-Oly,1,1,1,iTracer),
146       I                   GAD_TR,       I                   PTRACERS_dTLev, GAD_TR,
147       I                   PTRACERS_advScheme(iTracer),       I                   PTRACERS_advScheme(iTracer),
148       I                   PTRACERS_advScheme(iTracer),       I                   PTRACERS_advScheme(iTracer),
149       I                   calcAdvection, PTRACERS_ImplVertAdv(iTracer),       I                   calcAdvection, PTRACERS_ImplVertAdv(iTracer),
150         I                   .FALSE.,
151         I                   PTRACERS_useGMRedi(iTracer),
152         I                   PTRACERS_useKPP(iTracer),
153       U                   rFlx(1-Olx,1-Oly,1,iTracer),       U                   rFlx(1-Olx,1-Oly,1,iTracer),
154       U                   gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                   gPtr(1-Olx,1-Oly,1,1,1,iTracer),
155       I                   myTime, myIter, myThid )       I                   myTime, myIter, myThid )
156    
157  C External forcing term(s)  C External forcing term(s)
158         IF ( forcing_In_AB )         IF ( tracForcingOutAB.NE.1 )
159       &   CALL PTRACERS_FORCING(       &   CALL PTRACERS_FORCING(
160       I                      bi,bj,iMin,iMax,jMin,jMax,k,iTracer,       I                      bi,bj,iMin,iMax,jMin,jMax,k,iTracer,
161       U                      gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                      gPtr(1-Olx,1-Oly,1,1,1,iTracer),
162       I                      surfaceForcingPtr(1-Olx,1-Oly,1,1,iTracer),       I                      surfaceForcingPTr(1-Olx,1-Oly,1,1,iTracer),
163       I                      myIter,myTime,myThid)       I                      myIter,myTime,myThid)
164    
165  C If using Adams-Bashforth II, then extrapolate tendancies  C If using Adams-Bashforth II, then extrapolate tendencies
166  C gPtr is now the tracer tendency for explicit advection/diffusion  C gPtr is now the tracer tendency for explicit advection/diffusion
167        IF ( PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND        IF ( PTRACERS_AdamsBashGtr(iTracer) ) THEN
      & .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD  
      & .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH ) THEN  
168  #ifdef ALLOW_MATRIX  #ifdef ALLOW_MATRIX
169  C  If matrix is being computed, block call to S/R ADAMS_BASHFORTH2 to  C  If matrix is being computed, block call to S/R ADAMS_BASHFORTH2 to
170  C  prevent gPtr from being replaced by the average of gPtr and gPtrNm1.      C  prevent gPtr from being replaced by the average of gPtr and gpTrNm1.
171          IF (.NOT.useMATRIX) THEN          IF (.NOT.useMATRIX) THEN
172  #endif            #endif
173    C       compute iter at beginning of ptracer time step
174    #ifdef ALLOW_LONGSTEP
175            iterNb = myIter - LS_nIter + 1
176            IF (LS_staggerTimeStep) iterNb = myIter - LS_nIter
177    #else
178          iterNb = myIter          iterNb = myIter
179          IF (staggerTimeStep) iterNb = myIter - 1          IF (staggerTimeStep) iterNb = myIter - 1
180    #endif
181          CALL ADAMS_BASHFORTH2(          CALL ADAMS_BASHFORTH2(
182       I                        bi,bj,K,       I                      bi,bj,K,
183       U                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                      gPtr(1-Olx,1-Oly,1,1,1,iTracer),
184       U                        gPtrNm1(1-Olx,1-Oly,1,1,1,iTracer),       U                      gpTrNm1(1-Olx,1-Oly,1,1,1,iTracer),
185       I                        iterNb, myThid )       I                      PTRACERS_startAB(iTracer), iterNb, myThid )
186  #ifdef ALLOW_MATRIX  #ifdef ALLOW_MATRIX
187          ENDIF          ENDIF
188  #endif      #endif
189        ENDIF        ENDIF
190    
191  C External forcing term(s)  C External forcing term(s)
192         IF ( .NOT.forcing_In_AB )         IF ( tracForcingOutAB.EQ.1 )
193       &   CALL PTRACERS_FORCING(       &   CALL PTRACERS_FORCING(
194       I                      bi,bj,iMin,iMax,jMin,jMax,k,iTracer,       I                      bi,bj,iMin,iMax,jMin,jMax,k,iTracer,
195       U                      gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                      gPtr(1-Olx,1-Oly,1,1,1,iTracer),
196       I                      surfaceForcingPtr(1-Olx,1-Oly,1,1,iTracer),       I                      surfaceForcingPTr(1-Olx,1-Oly,1,1,iTracer),
197       I                      myIter,myTime,myThid)       I                      myIter,myTime,myThid)
198    
199  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
# Line 157  C Account for change in level thickness Line 203  C Account for change in level thickness
203       I                          bi,bj,K,       I                          bi,bj,K,
204       U                          gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                          gPtr(1-Olx,1-Oly,1,1,1,iTracer),
205       I                          myThid )       I                          myThid )
206          IF ( PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND          IF ( PTRACERS_AdamsBashGtr(iTracer) )
      &   .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD  
      &   .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH )  
207       &  CALL FREESURF_RESCALE_G(       &  CALL FREESURF_RESCALE_G(
208       I                          bi,bj,K,       I                          bi,bj,K,
209       U                          gPtrNm1(1-Olx,1-Oly,1,1,1,iTracer),       U                          gpTrNm1(1-Olx,1-Oly,1,1,1,iTracer),
210       I                          myThid )       I                          myThid )
211        ENDIF        ENDIF
212  #endif /* NONLIN_FRSURF */  #endif /* NONLIN_FRSURF */
# Line 171  C Integrate forward in time, storing in Line 215  C Integrate forward in time, storing in
215           CALL TIMESTEP_TRACER(           CALL TIMESTEP_TRACER(
216       I                        bi,bj,iMin,iMax,jMin,jMax,k,       I                        bi,bj,iMin,iMax,jMin,jMax,k,
217       I                        PTRACERS_advScheme(iTracer),       I                        PTRACERS_advScheme(iTracer),
218         I                        PTRACERS_dTLev(k),
219       I                        pTracer(1-Olx,1-Oly,1,1,1,iTracer),       I                        pTracer(1-Olx,1-Oly,1,1,1,iTracer),
220       I                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),       I                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),
221       I                        myIter,myThid )       I                        myIter,myThid )
# Line 178  C Integrate forward in time, storing in Line 223  C Integrate forward in time, storing in
223  #ifdef   ALLOW_OBCS  #ifdef   ALLOW_OBCS
224  C Apply open boundary conditions  C Apply open boundary conditions
225           IF (useOBCS) THEN           IF (useOBCS) THEN
226            CALL OBCS_APPLY_PTRACER(            CALL OBCS_APPLY_PTRACER(
227       I         bi, bj, k, iTracer,       I         bi, bj, k, iTracer,
228       U         gPtr(1-Olx,1-Oly,k,bi,bj,iTracer),       U         gPtr(1-Olx,1-Oly,k,bi,bj,iTracer),
229       I         myThid )       I         myThid )
230           END IF           ENDIF
231  #endif   /* ALLOW_OBCS */  #endif   /* ALLOW_OBCS */
232  C end of tracer loop  C end of tracer loop
233        ENDDO        ENDDO
Legend:
Removed from v.1.25  
changed lines
  Added in v.1.38
  ViewVC Help
Powered by ViewVC 1.1.22