/[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.1 by adcroft, Mon Mar 4 19:01:29 2002 UTC revision 1.44 by jmc, Mon Nov 7 20:23:04 2011 UTC
# Line 4  C $Name$ Line 4  C $Name$
4  #include "PTRACERS_OPTIONS.h"  #include "PTRACERS_OPTIONS.h"
5    
6  CBOP  CBOP
7  C !ROUTINE: PTRACERS_INTEGERATE  C !ROUTINE: PTRACERS_INTEGRATE
8    
9  C !INTERFACE: ==========================================================  C !INTERFACE: ==========================================================
10        SUBROUTINE PTRACERS_INTEGERATE(        SUBROUTINE PTRACERS_INTEGRATE(
11       I                               bi,bj,k,       I                    bi,bj,k,
12       I                               xA,yA,uTrans,vTrans,rTrans,maskUp,       I                    xA, yA, maskUp, uFld, vFld, wFld,
13       X                               KappaRtr,       I                    uTrans, vTrans, rTrans, rTransKp1,
14       I                               myIter,myTime,myThid )       I                    KappaRtr,
15         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: ===============================================================
23        IMPLICIT NONE        IMPLICIT NONE
24  #include "SIZE.h"  #include "SIZE.h"
25  #include "EEPARAMS.h"  #include "EEPARAMS.h"
26  #include "PTRACERS.h"  #include "PARAMS.h"
27    #include "DYNVARS.h"
28    #ifdef ALLOW_LONGSTEP
29    #include "LONGSTEP_PARAMS.h"
30    #endif
31    #include "PTRACERS_SIZE.h"
32    #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 transport across level k  C  rTrans               :: vertical volume transport at interface k
51  C  maskUp               :: mask for vertical transport  C  rTransKp1            :: vertical volume transport at interface k+1
52  C  KappaRtr             :: vertical diffusion of passive tracers  C  KappaRtr             :: vertical diffusion of passive tracers, interf k
53  C            NOTE!         This is infact KappaRS from thermodynamics()  C  rFlx                 :: vertical flux
 C                          and is being used only temporarily  
 C                          until we removed the need to store  
 C                          a "3D" diffusivity  
 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        _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
68        _RL KappaRtr(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _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 59  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  rFlx                 :: vertical flux  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        _RL rFlx(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2,PTRACERS_num)        INTEGER GAD_TR
89          LOGICAL calcAdvection
90          INTEGER iterNb
91          _RL gTr_AB (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
92    #ifdef ALLOW_DIAGNOSTICS
93          CHARACTER*8 diagName
94          CHARACTER*4 diagSufx
95    C-    Functions:
96          CHARACTER*4 GAD_DIAG_SUFX
97          EXTERNAL    GAD_DIAG_SUFX
98    #endif /* ALLOW_DIAGNOSTICS */
99  CEOP  CEOP
100    
101    C Loop ranges for daughter routines
102          iMin = 1-OLx+2
103          iMax = sNx+OLx-1
104          jMin = 1-OLy+2
105          jMax = sNy+OLy-1
106    
107          km1  = MAX(1,k-1)
108          kUp  = 1+MOD(k+1,2)
109          kDown= 1+MOD(k,2)
110    
111  C Loop over tracers  C Loop over tracers
112        DO iTracer=1,PTRACERS_numInUse        DO iTracer=1,PTRACERS_numInUse
113    
114  C Initialize vertical flux to zero and set no-flux across k=Nr+1  #ifdef ALLOW_AUTODIFF_TAMC
115         IF (k.EQ.Nr) THEN            act0 = iTracer - 1
116          DO j=1-Oly,sNy+Oly            max0 = PTRACERS_num
117           DO i=1-Olx,sNx+Olx            act1 = bi - myBxLo(myThid)
118            rFlx(i,j,1,iTracer)=0.            max1 = myBxHi(myThid) - myBxLo(myThid) + 1
119            rFlx(i,j,2,iTracer)=0.            act2 = bj - myByLo(myThid)
120           ENDDO            max2 = myByHi(myThid) - myByLo(myThid) + 1
121          ENDDO            act3 = myThid - 1
122         ENDIF            max3 = nTx*nTy
123              act4 = ikey_dynamics - 1
124  C Loop ranges for daughter routines            iptrkey = (act0 + 1)
125         iMin = 1-OLx+2       &                      + act1*max0
126         iMax = sNx+OLx-1       &                      + act2*max0*max1
127         jMin = 1-OLy+2       &                      + act3*max0*max1*max2
128         jMax = sNy+OLy-1       &                      + act4*max0*max1*max2*max3
129              kkey = (iptrkey-1)*Nr + k
130         km1  = MAX(1,k-1)  #endif /* ALLOW_AUTODIFF_TAMC */
131         kUp  = 1+MOD(k+1,2)  
132         kDown= 1+MOD(k,2)  #ifdef ALLOW_AUTODIFF_TAMC
133           rFlx(1,1,kDown,iTracer) = rFlx(1,1,kDown,iTracer)
134    c
135    CADJ STORE pTracer(:,:,k,bi,bj,iTracer)
136    CADJ &      = comlev1_bibj_k_ptracers, key=kkey, byte=isbyte
137    CADJ STORE gpTrNm1(:,:,k,bi,bj,iTracer)
138    CADJ &      = comlev1_bibj_k_ptracers, key=kkey, byte=isbyte
139    # ifdef NONLIN_FRSURF
140    CADJ STORE gpTr(:,:,k,bi,bj,iTracer)
141    CADJ &      = comlev1_bibj_k_ptracers, key=kkey, byte=isbyte
142    CADJ STORE rFlx(:,:,:,iTracer)
143    CADJ &      = comlev1_bibj_k_ptracers, key=kkey, byte=isbyte
144    # endif
145    #endif /* ALLOW_AUTODIFF_TAMC */
146    
147  C Calculate active tracer tendencies (gPtr) due to internal processes  C Calculate active tracer tendencies (gPtr) due to internal processes
148  C (advection, [explicit] diffusion, parameterizations,...)  C (advection, [explicit] diffusion, parameterizations,...)
149           CALL GAD_CALC_RHS(         calcAdvection = .NOT.PTRACERS_MultiDimAdv(iTracer)
150       I                     bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,         GAD_TR = GAD_TR1 + iTracer - 1
151       I                     xA,yA,uTrans,vTrans,rTrans,maskUp,         CALL GAD_CALC_RHS(
152       I                     PTRACERS_diffKh(iTracer),       I                   bi,bj,iMin,iMax,jMin,jMax,k,km1,kUp,kDown,
153       I                     PTRACERS_diffK4(iTracer),       I                   xA, yA, maskUp, uFld, vFld, wFld,
154       I                     KappaRtr,       I                   uTrans, vTrans, rTrans, rTransKp1,
155       I                     pTracer(1-Olx,1-Oly,1,1,1,iTracer),       I                   PTRACERS_diffKh(iTracer),
156       I                     GAD_TR1,       I                   PTRACERS_diffK4(iTracer),
157       I                     PTRACERS_advScheme(iTracer),       I                   KappaRtr(1-Olx,1-Oly,iTracer),
158       U                     rFlx(1-Olx,1-Oly,1,iTracer),       I                   gpTrNm1(1-Olx,1-Oly,1,1,1,iTracer),
159       U                     gPtr(1-Olx,1-Oly,1,1,1,iTracer),       I                   pTracer(1-Olx,1-Oly,1,1,1,iTracer),
160       I                     myThid )       I                   PTRACERS_dTLev, GAD_TR,
161         I                   PTRACERS_advScheme(iTracer),
162         I                   PTRACERS_advScheme(iTracer),
163         I                   calcAdvection, PTRACERS_ImplVertAdv(iTracer),
164         I                   .FALSE.,
165         I                   PTRACERS_useGMRedi(iTracer),
166         I                   PTRACERS_useKPP(iTracer),
167         U                   rFlx(1-Olx,1-Oly,1,iTracer),
168         U                   gPtr(1-Olx,1-Oly,1,1,1,iTracer),
169         I                   myTime, myIter, myThid )
170    
171  C External forcing term(s)  C External forcing term(s)
172           CALL PTRACERS_FORCING(         IF ( tracForcingOutAB.NE.1 )
173       I                        bi,bj,k,iTracer,       &   CALL PTRACERS_FORCING(
174       U                        gPtr,       I                      bi,bj,iMin,iMax,jMin,jMax,k,iTracer,
175       I                        myIter,myTime,myThid)       U                      gPtr(1-Olx,1-Oly,1,1,1,iTracer),
176         I                      surfaceForcingPTr(1-Olx,1-Oly,1,1,iTracer),
177  C If using Adams-Bashforth II, then extrapolate tendancies       I                      myIter,myTime,myThid)
178        IF ( PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND  
179       & .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD  C If using Adams-Bashforth II, then extrapolate tendencies
180       & .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH ) THEN  C gPtr is now the tracer tendency for explicit advection/diffusion
181    #ifdef ALLOW_MATRIX
182    C  If matrix is being computed, skip call to S/R ADAMS_BASHFORTH2 to
183    C  prevent gPtr from being replaced by the average of gPtr and gpTrNm1.
184           IF ( .NOT.useMATRIX .AND.
185         &      PTRACERS_AdamsBashGtr(iTracer) ) THEN
186    #else /* ALLOW_MATRIX */
187           IF ( PTRACERS_AdamsBashGtr(iTracer) ) THEN
188    #endif /* ALLOW_MATRIX */
189    C       compute iter at beginning of ptracer time step
190    #ifdef ALLOW_LONGSTEP
191            iterNb = myIter - LS_nIter + 1
192            IF (LS_whenToSample.GE.2) iterNb = myIter - LS_nIter
193    #else
194            iterNb = myIter
195            IF (staggerTimeStep) iterNb = myIter - 1
196    #endif
197          CALL ADAMS_BASHFORTH2(          CALL ADAMS_BASHFORTH2(
198       I                        bi,bj,K,       I                      bi,bj,k,
199       U                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                      gPtr(1-Olx,1-Oly,1,1,1,iTracer),
200       U                        gPtrNm1(1-Olx,1-Oly,1,1,1,iTracer),       U                      gpTrNm1(1-Olx,1-Oly,1,1,1,iTracer),
201       I                        myIter,myThid )       U                      gTr_AB,
202        ENDIF       I                      PTRACERS_startAB(iTracer), iterNb, myThid )
203    #ifdef ALLOW_DIAGNOSTICS
204            IF ( useDiagnostics ) THEN
205              diagSufx = GAD_DIAG_SUFX( GAD_TR, myThid )
206              diagName = 'AB_g'//diagSufx
207              CALL DIAGNOSTICS_FILL(gTr_AB,diagName,k,1,2,bi,bj,myThid)
208            ENDIF
209    #endif /* ALLOW_DIAGNOSTICS */
210           ENDIF
211    
212    C External forcing term(s)
213           IF ( tracForcingOutAB.EQ.1 )
214         &   CALL PTRACERS_FORCING(
215         I                      bi,bj,iMin,iMax,jMin,jMax,k,iTracer,
216         U                      gPtr(1-Olx,1-Oly,1,1,1,iTracer),
217         I                      surfaceForcingPTr(1-Olx,1-Oly,1,1,iTracer),
218         I                      myIter,myTime,myThid)
219    
220  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
221  C Account for change in level thickness  C Account for change in level thickness
222        IF (nonlinFreeSurf.GT.0) THEN        IF (nonlinFreeSurf.GT.0) THEN
223          CALL FREESURF_RESCALE_G(          CALL FREESURF_RESCALE_G(
224       I                          bi,bj,K,       I                          bi,bj,k,
225       U                          gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                          gPtr(1-Olx,1-Oly,1,1,1,iTracer),
226       I                          myThid )       I                          myThid )
227            IF ( PTRACERS_AdamsBashGtr(iTracer) )
228         &  CALL FREESURF_RESCALE_G(
229         I                          bi,bj,k,
230         U                          gpTrNm1(1-Olx,1-Oly,1,1,1,iTracer),
231         I                          myThid )
232        ENDIF        ENDIF
233  #endif /* NONLIN_FRSURF */  #endif /* NONLIN_FRSURF */
234    
235  C Integrate forward in time, storing in gPtr:  G=T+dt*G  C Integrate forward in time, storing in gPtr:  G=T+dt*G
236           CALL TIMESTEP_TRACER(           CALL TIMESTEP_TRACER(
237       I                        bi,bj,iMin,iMax,jMin,jMax,k,       I                        bi, bj, k, PTRACERS_dTLev(k),
      I                        PTRACERS_advScheme(iTracer),  
238       I                        pTracer(1-Olx,1-Oly,1,1,1,iTracer),       I                        pTracer(1-Olx,1-Oly,1,1,1,iTracer),
239       I                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),
240       I                        myIter,myThid )       I                        myIter, myThid )
241    
242  C end of tracer loop  C end of tracer loop
243        ENDDO        ENDDO
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.44
  ViewVC Help
Powered by ViewVC 1.1.22