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