/[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.4 by jmc, Thu Jun 20 23:46:22 2002 UTC revision 1.31 by heimbach, Tue Apr 4 14:52:43 2006 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,uTrans,vTrans,rTrans,
13       X                               KappaRtr,       I                               rTransKp1,maskUp,
14         X                               rFlx,KappaRtr,
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: ===============================================================
22        IMPLICIT NONE        IMPLICIT NONE
23  #include "SIZE.h"  #include "SIZE.h"
24  #include "EEPARAMS.h"  #include "EEPARAMS.h"
25    #include "PARAMS.h"
26    #include "DYNVARS.h"
27    #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 31  C  xA                   :: face area at Line 39  C  xA                   :: face area at
39  C  yA                   :: face area at V points in level k  C  yA                   :: face area at V points in level k
40  C  uTrans               :: zonal transport in level k  C  uTrans               :: zonal transport in level k
41  C  vTrans               :: meridional transport in level k  C  vTrans               :: meridional transport in level k
42  C  rTrans               :: vertical transport across level k  C  rTrans               :: vertical volume transport at interface k
43    C  rTransKp1            :: vertical volume transport at interface k+1
44  C  maskUp               :: mask for vertical transport  C  maskUp               :: mask for vertical transport
45  C  KappaRtr             :: vertical diffusion of passive tracers  C  rFlx                 :: vertical flux
46  C            NOTE!         This is infact KappaRS from thermodynamics()  C  KappaRtr             :: vertical diffusion of passive tracers, interf k
 C                          and is being used only temporarily  
 C                          until we removed the need to store  
 C                          a "3D" diffusivity  
47  C  myIter               :: time-step number  C  myIter               :: time-step number
48  C  myTime               :: model time  C  myTime               :: model time
49  C  myThid               :: thread number  C  myThid               :: thread number
# Line 47  C  myThid               :: thread number Line 53  C  myThid               :: thread number
53        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
54        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
55        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
56          _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
57        _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
58        _RL KappaRtr(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL rFlx(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2,PTRACERS_num)
59          _RL KappaRtr(1-Olx:sNx+Olx,1-Oly:sNy+Oly,PTRACERS_num)
60        INTEGER myIter        INTEGER myIter
61        _RL myTime        _RL myTime
62        INTEGER myThid        INTEGER myThid
# Line 59  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  rFlx                 :: vertical flux  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        _RL rFlx(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2,PTRACERS_num)        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 Initialize vertical flux to zero and set no-flux across k=Nr+1  #ifdef ALLOW_AUTODIFF_TAMC
97         IF (k.EQ.Nr) THEN            act0 = iTracer - 1
98          DO j=1-Oly,sNy+Oly            max0 = PTRACERS_num
99           DO i=1-Olx,sNx+Olx            act1 = bi - myBxLo(myThid)
100            rFlx(i,j,1,iTracer)=0.            max1 = myBxHi(myThid) - myBxLo(myThid) + 1
101            rFlx(i,j,2,iTracer)=0.            act2 = bj - myByLo(myThid)
102           ENDDO            max2 = myByHi(myThid) - myByLo(myThid) + 1
103          ENDDO            act3 = myThid - 1
104         ENDIF            max3 = nTx*nTy
105              act4 = ikey_dynamics - 1
106  C Loop ranges for daughter routines            iptrkey = (act0 + 1)
107         iMin = 1-OLx+2       &                      + act1*max0
108         iMax = sNx+OLx-1       &                      + act2*max0*max1
109         jMin = 1-OLy+2       &                      + act3*max0*max1*max2
110         jMax = sNy+OLy-1       &                      + act4*max0*max1*max2*max3
111              kkey = (iptrkey-1)*Nr + k
112         km1  = MAX(1,k-1)  #endif /* ALLOW_AUTODIFF_TAMC */
113         kUp  = 1+MOD(k+1,2)  
114         kDown= 1+MOD(k,2)  #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
126       &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND       &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND
127       &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD       &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD
128       &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH       &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH
129           CALL GAD_CALC_RHS(         GAD_TR = GAD_TR1 + iTracer - 1
130       I                     bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,         CALL GAD_CALC_RHS(
131       I                     xA,yA,uTrans,vTrans,rTrans,maskUp,       I                   bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,
132       I                     PTRACERS_diffKh(iTracer),       I                   xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
133       I                     PTRACERS_diffK4(iTracer),       I                   uVel, vVel, wVel,
134       I                     KappaRtr,       I                   PTRACERS_diffKh(iTracer),
135       I                     pTracer(1-Olx,1-Oly,1,1,1,iTracer),       I                   PTRACERS_diffK4(iTracer),
136       I                     GAD_TR1,       I                   KappaRtr(1-Olx,1-Oly,iTracer),
137       I                     PTRACERS_advScheme(iTracer),calcAdvection,       I                   gPtrNm1(1-Olx,1-Oly,1,1,1,iTracer),
138       U                     rFlx(1-Olx,1-Oly,1,iTracer),       I                   pTracer(1-Olx,1-Oly,1,1,1,iTracer),
139       U                     gPtr(1-Olx,1-Oly,1,1,1,iTracer),       I                   GAD_TR,
140       I                     myThid )       I                   PTRACERS_advScheme(iTracer),
141         I                   PTRACERS_advScheme(iTracer),
142         I                   calcAdvection, PTRACERS_ImplVertAdv(iTracer),
143         I                   .FALSE.,
144         U                   rFlx(1-Olx,1-Oly,1,iTracer),
145         U                   gPtr(1-Olx,1-Oly,1,1,1,iTracer),
146         I                   myTime, myIter, myThid )
147    
148  C External forcing term(s)  C External forcing term(s)
149         IF ( forcing_In_AB )         IF ( tracForcingOutAB.NE.1 )
150       &   CALL PTRACERS_FORCING(       &   CALL PTRACERS_FORCING(
151       I                        bi,bj,k,iTracer,       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                        myIter,myTime,myThid)       I                      surfaceForcingPtr(1-Olx,1-Oly,1,1,iTracer),
154         I                      myIter,myTime,myThid)
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         IF ( .NOT.forcing_In_AB )         IF ( tracForcingOutAB.EQ.1 )
180       &   CALL PTRACERS_FORCING(       &   CALL PTRACERS_FORCING(
181       I                        bi,bj,k,iTracer,       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                        myIter,myTime,myThid)       I                      surfaceForcingPtr(1-Olx,1-Oly,1,1,iTracer),
184         I                      myIter,myTime,myThid)
185    
186  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
187  C Account for change in level thickness  C Account for change in level thickness
# Line 163  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.4  
changed lines
  Added in v.1.31
  ViewVC Help
Powered by ViewVC 1.1.22