/[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.3 by jmc, Sat Jun 15 03:37:44 2002 UTC revision 1.30 by jmc, Tue Mar 7 15:28:39 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    
# Line 31  C  xA                   :: face area at Line 35  C  xA                   :: face area at
35  C  yA                   :: face area at V points in level k  C  yA                   :: face area at V points in level k
36  C  uTrans               :: zonal transport in level k  C  uTrans               :: zonal transport in level k
37  C  vTrans               :: meridional transport in level k  C  vTrans               :: meridional transport in level k
38  C  rTrans               :: vertical transport across level k  C  rTrans               :: vertical volume transport at interface k
39    C  rTransKp1            :: vertical volume transport at interface k+1
40  C  maskUp               :: mask for vertical transport  C  maskUp               :: mask for vertical transport
41  C  KappaRtr             :: vertical diffusion of passive tracers  C  rFlx                 :: vertical flux
42  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  
43  C  myIter               :: time-step number  C  myIter               :: time-step number
44  C  myTime               :: model time  C  myTime               :: model time
45  C  myThid               :: thread number  C  myThid               :: thread number
# Line 47  C  myThid               :: thread number Line 49  C  myThid               :: thread number
49        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
50        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
51        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
52          _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
53        _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
54        _RL KappaRtr(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL rFlx(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2,PTRACERS_num)
55          _RL KappaRtr(1-Olx:sNx+Olx,1-Oly:sNy+Oly,PTRACERS_num)
56        INTEGER myIter        INTEGER myIter
57        _RL myTime        _RL myTime
58        INTEGER myThid        INTEGER myThid
# Line 59  C  none Line 63  C  none
63  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
64    
65  C !LOCAL VARIABLES: ====================================================  C !LOCAL VARIABLES: ====================================================
66  C  i,j,k,bi,bj,iTracer  :: loop indices  C  iTracer              :: tracer index
67  C  iMin,iMax,jMin,jMax  :: loop ranges  C  iMin,iMax,jMin,jMax  :: loop ranges
68  C  kUp,kDown            :: toggle indices for even/odd level fluxes  C  kUp,kDown            :: toggle indices for even/odd level fluxes
69  C  km1                  :: =min(1,k-1)  C  km1                  :: =min(1,k-1)
70  C  rFlx                 :: vertical flux  C  GAD_TR               :: passive tracer id (GAD_TR1+iTracer-1)
71        INTEGER i,j,iTracer        INTEGER iTracer
72        INTEGER iMin,iMax,jMin,jMax        INTEGER iMin,iMax,jMin,jMax
73        INTEGER kUp,kDown,km1        INTEGER kUp,kDown,km1
74        _RL rFlx(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2,PTRACERS_num)        INTEGER GAD_TR
75        LOGICAL calcAdvection        LOGICAL calcAdvection
76          INTEGER iterNb
77  CEOP  CEOP
78    
79  C Loop over tracers  C Loop over tracers
80        DO iTracer=1,PTRACERS_numInUse        DO iTracer=1,PTRACERS_numInUse
81    
 C Initialize vertical flux to zero and set no-flux across k=Nr+1  
        IF (k.EQ.Nr) THEN  
         DO j=1-Oly,sNy+Oly  
          DO i=1-Olx,sNx+Olx  
           rFlx(i,j,1,iTracer)=0.  
           rFlx(i,j,2,iTracer)=0.  
          ENDDO  
         ENDDO  
        ENDIF  
   
82  C Loop ranges for daughter routines  C Loop ranges for daughter routines
83         iMin = 1-OLx+2         iMin = 1-OLx+2
84         iMax = sNx+OLx-1         iMax = sNx+OLx-1
# Line 100  C (advection, [explicit] diffusion, para Line 95  C (advection, [explicit] diffusion, para
95       &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND       &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND
96       &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD       &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD
97       &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH       &      .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH
98           CALL GAD_CALC_RHS(         GAD_TR = GAD_TR1 + iTracer - 1
99       I                     bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,         CALL GAD_CALC_RHS(
100       I                     xA,yA,uTrans,vTrans,rTrans,maskUp,       I                   bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,
101       I                     PTRACERS_diffKh(iTracer),       I                   xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
102       I                     PTRACERS_diffK4(iTracer),       I                   uVel, vVel, wVel,
103       I                     KappaRtr,       I                   PTRACERS_diffKh(iTracer),
104       I                     pTracer(1-Olx,1-Oly,1,1,1,iTracer),       I                   PTRACERS_diffK4(iTracer),
105       I                     GAD_TR1,       I                   KappaRtr(1-Olx,1-Oly,iTracer),
106       I                     PTRACERS_advScheme(iTracer),calcAdvection,       I                   gPtrNm1(1-Olx,1-Oly,1,1,1,iTracer),
107       U                     rFlx(1-Olx,1-Oly,1,iTracer),       I                   pTracer(1-Olx,1-Oly,1,1,1,iTracer),
108       U                     gPtr(1-Olx,1-Oly,1,1,1,iTracer),       I                   GAD_TR,
109       I                     myThid )       I                   PTRACERS_advScheme(iTracer),
110         I                   PTRACERS_advScheme(iTracer),
111         I                   calcAdvection, PTRACERS_ImplVertAdv(iTracer),
112         I                   .FALSE.,
113         U                   rFlx(1-Olx,1-Oly,1,iTracer),
114         U                   gPtr(1-Olx,1-Oly,1,1,1,iTracer),
115         I                   myTime, myIter, myThid )
116    
117  C External forcing term(s)  C External forcing term(s)
118         IF ( forcing_In_AB )         IF ( tracForcingOutAB.NE.1 )
119       &   CALL PTRACERS_FORCING(       &   CALL PTRACERS_FORCING(
120       I                        bi,bj,k,iTracer,       I                      bi,bj,iMin,iMax,jMin,jMax,k,iTracer,
121       U                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                      gPtr(1-Olx,1-Oly,1,1,1,iTracer),
122       I                        myIter,myTime,myThid)       I                      surfaceForcingPtr(1-Olx,1-Oly,1,1,iTracer),
123         I                      myIter,myTime,myThid)
124    
125  C If using Adams-Bashforth II, then extrapolate tendancies  C If using Adams-Bashforth II, then extrapolate tendencies
126    C gPtr is now the tracer tendency for explicit advection/diffusion
127        IF ( PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND        IF ( PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND
128       & .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD       & .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD
129       & .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH ) THEN       & .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH ) THEN
130    #ifdef ALLOW_MATRIX
131    C  If matrix is being computed, block call to S/R ADAMS_BASHFORTH2 to
132    C  prevent gPtr from being replaced by the average of gPtr and gPtrNm1.    
133            IF (.NOT.useMATRIX) THEN
134    #endif          
135            iterNb = myIter
136            IF (staggerTimeStep) iterNb = myIter - 1
137          CALL ADAMS_BASHFORTH2(          CALL ADAMS_BASHFORTH2(
138       I                        bi,bj,K,       I                        bi,bj,K,
139       U                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),
140       U                        gPtrNm1(1-Olx,1-Oly,1,1,1,iTracer),       U                        gPtrNm1(1-Olx,1-Oly,1,1,1,iTracer),
141       I                        myIter,myThid )       I                        iterNb, myThid )
142    #ifdef ALLOW_MATRIX
143            ENDIF
144    #endif    
145        ENDIF        ENDIF
146    
147  C External forcing term(s)  C External forcing term(s)
148         IF ( .NOT.forcing_In_AB )         IF ( tracForcingOutAB.EQ.1 )
149       &   CALL PTRACERS_FORCING(       &   CALL PTRACERS_FORCING(
150       I                        bi,bj,k,iTracer,       I                      bi,bj,iMin,iMax,jMin,jMax,k,iTracer,
151       U                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                      gPtr(1-Olx,1-Oly,1,1,1,iTracer),
152       I                        myIter,myTime,myThid)       I                      surfaceForcingPtr(1-Olx,1-Oly,1,1,iTracer),
153         I                      myIter,myTime,myThid)
154    
155  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
156  C Account for change in level thickness  C Account for change in level thickness
# Line 145  C Account for change in level thickness Line 159  C Account for change in level thickness
159       I                          bi,bj,K,       I                          bi,bj,K,
160       U                          gPtr(1-Olx,1-Oly,1,1,1,iTracer),       U                          gPtr(1-Olx,1-Oly,1,1,1,iTracer),
161       I                          myThid )       I                          myThid )
162            IF ( PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND
163         &   .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD
164         &   .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH )
165         &  CALL FREESURF_RESCALE_G(
166         I                          bi,bj,K,
167         U                          gPtrNm1(1-Olx,1-Oly,1,1,1,iTracer),
168         I                          myThid )
169        ENDIF        ENDIF
170  #endif /* NONLIN_FRSURF */  #endif /* NONLIN_FRSURF */
171    
# Line 156  C Integrate forward in time, storing in Line 177  C Integrate forward in time, storing in
177       I                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),       I                        gPtr(1-Olx,1-Oly,1,1,1,iTracer),
178       I                        myIter,myThid )       I                        myIter,myThid )
179    
180    #ifdef   ALLOW_OBCS
181    C Apply open boundary conditions
182             IF (useOBCS) THEN
183              CALL OBCS_APPLY_PTRACER(
184         I         bi, bj, k, iTracer,
185         U         gPtr(1-Olx,1-Oly,k,bi,bj,iTracer),
186         I         myThid )
187             END IF
188    #endif   /* ALLOW_OBCS */
189  C end of tracer loop  C end of tracer loop
190        ENDDO        ENDDO
191    
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.30
  ViewVC Help
Powered by ViewVC 1.1.22