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