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 tendency for passive tracers and integrates forward |
C Calculates tendency for passive tracers and integrates forward |
25 |
#include "EEPARAMS.h" |
#include "EEPARAMS.h" |
26 |
#include "PARAMS.h" |
#include "PARAMS.h" |
27 |
#include "DYNVARS.h" |
#include "DYNVARS.h" |
28 |
|
#ifdef ALLOW_LONGSTEP |
29 |
|
#include "LONGSTEP_PARAMS.h" |
30 |
|
#endif |
31 |
#include "PTRACERS_SIZE.h" |
#include "PTRACERS_SIZE.h" |
32 |
#include "PTRACERS.h" |
#include "PTRACERS_PARAMS.h" |
33 |
|
#include "PTRACERS_START.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 volume transport at interface k |
C rTrans :: vertical volume transport at interface k |
51 |
C rTransKp1 :: vertical volume transport at interface k+1 |
C rTransKp1 :: vertical volume transport at interface k+1 |
52 |
C maskUp :: mask for vertical transport |
C KappaRtr :: vertical diffusion of passive tracers, interf k |
53 |
C rFlx :: vertical flux |
C rFlx :: vertical flux |
|
C KappaRtr :: vertical diffusion of passive tracers, interf k |
|
|
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 |
_RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
68 |
_RS maskUp (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL KappaRtr(1-OLx:sNx+OLx,1-OLy:sNy+OLy,PTRACERS_num) |
69 |
_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,PTRACERS_num) |
|
|
INTEGER myIter |
|
70 |
_RL myTime |
_RL myTime |
71 |
|
INTEGER myIter |
72 |
INTEGER myThid |
INTEGER myThid |
73 |
|
|
74 |
C !OUTPUT PARAMETERS: ================================================== |
C !OUTPUT PARAMETERS: ================================================== |
88 |
INTEGER GAD_TR |
INTEGER GAD_TR |
89 |
LOGICAL calcAdvection |
LOGICAL calcAdvection |
90 |
INTEGER iterNb |
INTEGER iterNb |
91 |
|
_RL gTr_AB (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
92 |
|
_RL dummy(Nr) |
93 |
|
#ifdef ALLOW_DIAGNOSTICS |
94 |
|
CHARACTER*8 diagName |
95 |
|
CHARACTER*4 diagSufx |
96 |
|
C- Functions: |
97 |
|
CHARACTER*4 GAD_DIAG_SUFX |
98 |
|
EXTERNAL GAD_DIAG_SUFX |
99 |
|
#endif /* ALLOW_DIAGNOSTICS */ |
100 |
CEOP |
CEOP |
101 |
|
|
102 |
|
C Loop ranges for daughter routines |
103 |
|
iMin = 1-OLx+2 |
104 |
|
iMax = sNx+OLx-1 |
105 |
|
jMin = 1-OLy+2 |
106 |
|
jMax = sNy+OLy-1 |
107 |
|
|
108 |
|
km1 = MAX(1,k-1) |
109 |
|
kUp = 1+MOD(k+1,2) |
110 |
|
kDown= 1+MOD(k,2) |
111 |
|
|
112 |
C Loop over tracers |
C Loop over tracers |
113 |
DO iTracer=1,PTRACERS_numInUse |
DO iTracer=1,PTRACERS_numInUse |
114 |
|
IF ( PTRACERS_StepFwd(iTracer) ) THEN |
115 |
|
|
116 |
C Loop ranges for daughter routines |
#ifdef ALLOW_AUTODIFF_TAMC |
117 |
iMin = 1-OLx+2 |
act0 = iTracer - 1 |
118 |
iMax = sNx+OLx-1 |
max0 = PTRACERS_num |
119 |
jMin = 1-OLy+2 |
act1 = bi - myBxLo(myThid) |
120 |
jMax = sNy+OLy-1 |
max1 = myBxHi(myThid) - myBxLo(myThid) + 1 |
121 |
|
act2 = bj - myByLo(myThid) |
122 |
km1 = MAX(1,k-1) |
max2 = myByHi(myThid) - myByLo(myThid) + 1 |
123 |
kUp = 1+MOD(k+1,2) |
act3 = myThid - 1 |
124 |
kDown= 1+MOD(k,2) |
max3 = nTx*nTy |
125 |
|
act4 = ikey_dynamics - 1 |
126 |
|
iptrkey = (act0 + 1) |
127 |
|
& + act1*max0 |
128 |
|
& + act2*max0*max1 |
129 |
|
& + act3*max0*max1*max2 |
130 |
|
& + act4*max0*max1*max2*max3 |
131 |
|
kkey = (iptrkey-1)*Nr + k |
132 |
|
#endif /* ALLOW_AUTODIFF_TAMC */ |
133 |
|
|
134 |
|
#ifdef ALLOW_AUTODIFF_TAMC |
135 |
|
rFlx(1,1,kDown,iTracer) = rFlx(1,1,kDown,iTracer) |
136 |
|
c |
137 |
|
CADJ STORE pTracer(:,:,k,bi,bj,iTracer) |
138 |
|
CADJ & = comlev1_bibj_k_ptracers, key=kkey, byte=isbyte |
139 |
|
CADJ STORE gpTrNm1(:,:,k,bi,bj,iTracer) |
140 |
|
CADJ & = comlev1_bibj_k_ptracers, key=kkey, byte=isbyte |
141 |
|
# ifdef NONLIN_FRSURF |
142 |
|
CADJ STORE gpTr(:,:,k,bi,bj,iTracer) |
143 |
|
CADJ & = comlev1_bibj_k_ptracers, key=kkey, byte=isbyte |
144 |
|
CADJ STORE rFlx(:,:,:,iTracer) |
145 |
|
CADJ & = comlev1_bibj_k_ptracers, key=kkey, byte=isbyte |
146 |
|
# endif |
147 |
|
#endif /* ALLOW_AUTODIFF_TAMC */ |
148 |
|
|
149 |
C Calculate active tracer tendencies (gPtr) due to internal processes |
C Calculate active tracer tendencies (gPtr) due to internal processes |
150 |
C (advection, [explicit] diffusion, parameterizations,...) |
C (advection, [explicit] diffusion, parameterizations,...) |
151 |
calcAdvection = .NOT.multiDimAdvection |
calcAdvection = .NOT.PTRACERS_MultiDimAdv(iTracer) |
|
& .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND |
|
|
& .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD |
|
|
& .OR. PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH |
|
152 |
GAD_TR = GAD_TR1 + iTracer - 1 |
GAD_TR = GAD_TR1 + iTracer - 1 |
153 |
CALL GAD_CALC_RHS( |
CALL GAD_CALC_RHS( |
154 |
I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown, |
I bi,bj,iMin,iMax,jMin,jMax,k,km1,kUp,kDown, |
155 |
I xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp, |
I xA, yA, maskUp, uFld, vFld, wFld, |
156 |
I uVel, vVel, wVel, |
I uTrans, vTrans, rTrans, rTransKp1, |
157 |
I PTRACERS_diffKh(iTracer), |
I PTRACERS_diffKh(iTracer), |
158 |
I PTRACERS_diffK4(iTracer), |
I PTRACERS_diffK4(iTracer), |
159 |
I KappaRtr(1-Olx,1-Oly,iTracer), |
I KappaRtr(1-OLx,1-OLy,iTracer), dummy, |
160 |
I gPtrNm1(1-Olx,1-Oly,1,1,1,iTracer), |
I gpTrNm1(1-OLx,1-OLy,1,1,1,iTracer), |
161 |
I pTracer(1-Olx,1-Oly,1,1,1,iTracer), |
I pTracer(1-OLx,1-OLy,1,1,1,iTracer), |
162 |
I GAD_TR, |
I PTRACERS_dTLev, GAD_TR, |
163 |
I PTRACERS_advScheme(iTracer), |
I PTRACERS_advScheme(iTracer), |
164 |
I PTRACERS_advScheme(iTracer), |
I PTRACERS_advScheme(iTracer), |
165 |
I calcAdvection, PTRACERS_ImplVertAdv(iTracer), |
I calcAdvection, PTRACERS_ImplVertAdv(iTracer), |
166 |
I .FALSE., |
I .FALSE., .FALSE., |
167 |
U rFlx(1-Olx,1-Oly,1,iTracer), |
I PTRACERS_useGMRedi(iTracer), |
168 |
U gPtr(1-Olx,1-Oly,1,1,1,iTracer), |
I PTRACERS_useKPP(iTracer), |
169 |
|
U rFlx(1-OLx,1-OLy,1,iTracer), |
170 |
|
U gPtr(1-OLx,1-OLy,1,1,1,iTracer), |
171 |
I myTime, myIter, myThid ) |
I myTime, myIter, myThid ) |
172 |
|
|
173 |
C External forcing term(s) |
C External forcing term(s) |
174 |
IF ( tracForcingOutAB.NE.1 ) |
IF ( tracForcingOutAB.NE.1 ) |
175 |
& CALL PTRACERS_FORCING( |
& CALL PTRACERS_FORCING( |
176 |
I bi,bj,iMin,iMax,jMin,jMax,k,iTracer, |
I bi,bj,iMin,iMax,jMin,jMax,k,iTracer, |
177 |
U gPtr(1-Olx,1-Oly,1,1,1,iTracer), |
U gPtr(1-OLx,1-OLy,1,1,1,iTracer), |
178 |
I surfaceForcingPtr(1-Olx,1-Oly,1,1,iTracer), |
I surfaceForcingPTr(1-OLx,1-OLy,1,1,iTracer), |
179 |
I myIter,myTime,myThid) |
I myIter,myTime,myThid) |
180 |
|
|
181 |
C If using Adams-Bashforth II, then extrapolate tendencies |
C If using Adams-Bashforth II, then extrapolate tendencies |
182 |
C gPtr is now the tracer tendency for explicit advection/diffusion |
C gPtr is now the tracer tendency for explicit advection/diffusion |
|
IF ( PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND |
|
|
& .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD |
|
|
& .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH ) THEN |
|
183 |
#ifdef ALLOW_MATRIX |
#ifdef ALLOW_MATRIX |
184 |
C If matrix is being computed, block call to S/R ADAMS_BASHFORTH2 to |
C If matrix is being computed, skip call to S/R ADAMS_BASHFORTH2 to |
185 |
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. |
186 |
IF (.NOT.useMATRIX) THEN |
IF ( .NOT.useMATRIX .AND. |
187 |
#endif |
& PTRACERS_AdamsBashGtr(iTracer) ) THEN |
188 |
|
#else /* ALLOW_MATRIX */ |
189 |
|
IF ( PTRACERS_AdamsBashGtr(iTracer) ) THEN |
190 |
|
#endif /* ALLOW_MATRIX */ |
191 |
|
C compute iter at beginning of ptracer time step |
192 |
|
#ifdef ALLOW_LONGSTEP |
193 |
|
iterNb = myIter - LS_nIter + 1 |
194 |
|
IF (LS_whenToSample.GE.2) iterNb = myIter - LS_nIter |
195 |
|
#else |
196 |
iterNb = myIter |
iterNb = myIter |
197 |
IF (staggerTimeStep) iterNb = myIter - 1 |
IF (staggerTimeStep) iterNb = myIter - 1 |
198 |
|
#endif |
199 |
CALL ADAMS_BASHFORTH2( |
CALL ADAMS_BASHFORTH2( |
200 |
I bi,bj,K, |
I bi,bj,k, |
201 |
U gPtr(1-Olx,1-Oly,1,1,1,iTracer), |
U gPtr(1-OLx,1-OLy,1,1,1,iTracer), |
202 |
U gPtrNm1(1-Olx,1-Oly,1,1,1,iTracer), |
U gpTrNm1(1-OLx,1-OLy,1,1,1,iTracer), |
203 |
I iterNb, myThid ) |
U gTr_AB, |
204 |
#ifdef ALLOW_MATRIX |
I PTRACERS_startAB(iTracer), iterNb, myThid ) |
205 |
|
#ifdef ALLOW_DIAGNOSTICS |
206 |
|
IF ( useDiagnostics ) THEN |
207 |
|
diagSufx = GAD_DIAG_SUFX( GAD_TR, myThid ) |
208 |
|
diagName = 'AB_g'//diagSufx |
209 |
|
CALL DIAGNOSTICS_FILL(gTr_AB,diagName,k,1,2,bi,bj,myThid) |
210 |
ENDIF |
ENDIF |
211 |
#endif |
#endif /* ALLOW_DIAGNOSTICS */ |
212 |
ENDIF |
ENDIF |
213 |
|
|
214 |
C External forcing term(s) |
C External forcing term(s) |
215 |
IF ( tracForcingOutAB.EQ.1 ) |
IF ( tracForcingOutAB.EQ.1 ) |
216 |
& CALL PTRACERS_FORCING( |
& CALL PTRACERS_FORCING( |
217 |
I bi,bj,iMin,iMax,jMin,jMax,k,iTracer, |
I bi,bj,iMin,iMax,jMin,jMax,k,iTracer, |
218 |
U gPtr(1-Olx,1-Oly,1,1,1,iTracer), |
U gPtr(1-OLx,1-OLy,1,1,1,iTracer), |
219 |
I surfaceForcingPtr(1-Olx,1-Oly,1,1,iTracer), |
I surfaceForcingPTr(1-OLx,1-OLy,1,1,iTracer), |
220 |
I myIter,myTime,myThid) |
I myIter,myTime,myThid) |
221 |
|
|
222 |
#ifdef NONLIN_FRSURF |
#ifdef NONLIN_FRSURF |
223 |
C Account for change in level thickness |
C Account for change in level thickness |
224 |
IF (nonlinFreeSurf.GT.0) THEN |
IF (nonlinFreeSurf.GT.0) THEN |
225 |
CALL FREESURF_RESCALE_G( |
CALL FREESURF_RESCALE_G( |
226 |
I bi,bj,K, |
I bi,bj,k, |
227 |
U gPtr(1-Olx,1-Oly,1,1,1,iTracer), |
U gPtr(1-OLx,1-OLy,1,1,1,iTracer), |
228 |
I myThid ) |
I myThid ) |
229 |
IF ( PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_2ND |
IF ( PTRACERS_AdamsBashGtr(iTracer) ) |
|
& .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_UPWIND_3RD |
|
|
& .OR.PTRACERS_advScheme(iTracer).EQ.ENUM_CENTERED_4TH ) |
|
230 |
& CALL FREESURF_RESCALE_G( |
& CALL FREESURF_RESCALE_G( |
231 |
I bi,bj,K, |
I bi,bj,k, |
232 |
U gPtrNm1(1-Olx,1-Oly,1,1,1,iTracer), |
U gpTrNm1(1-OLx,1-OLy,1,1,1,iTracer), |
233 |
I myThid ) |
I myThid ) |
234 |
ENDIF |
ENDIF |
235 |
#endif /* NONLIN_FRSURF */ |
#endif /* NONLIN_FRSURF */ |
236 |
|
|
237 |
C Integrate forward in time, storing in gPtr: G=T+dt*G |
C Integrate forward in time, storing in gPtr: G=T+dt*G |
238 |
CALL TIMESTEP_TRACER( |
CALL TIMESTEP_TRACER( |
239 |
I bi,bj,iMin,iMax,jMin,jMax,k, |
I bi, bj, k, PTRACERS_dTLev(k), |
240 |
I PTRACERS_advScheme(iTracer), |
I pTracer(1-OLx,1-OLy,1,1,1,iTracer), |
241 |
I pTracer(1-Olx,1-Oly,1,1,1,iTracer), |
U gPtr(1-OLx,1-OLy,1,1,1,iTracer), |
242 |
I gPtr(1-Olx,1-Oly,1,1,1,iTracer), |
I myIter, myThid ) |
243 |
I myIter,myThid ) |
|
|
|
|
|
#ifdef ALLOW_OBCS |
|
|
C Apply open boundary conditions |
|
|
IF (useOBCS) THEN |
|
|
CALL OBCS_APPLY_PTRACER( |
|
|
I bi, bj, k, iTracer, |
|
|
U gPtr(1-Olx,1-Oly,k,bi,bj,iTracer), |
|
|
I myThid ) |
|
|
END IF |
|
|
#endif /* ALLOW_OBCS */ |
|
244 |
C end of tracer loop |
C end of tracer loop |
245 |
|
ENDIF |
246 |
ENDDO |
ENDDO |
247 |
|
|
248 |
#endif /* ALLOW_PTRACERS */ |
#endif /* ALLOW_PTRACERS */ |