1 |
C $Header: /u/gcmpack/MITgcm/pkg/ptracers/ptracers_integrate.F,v 1.35 2007/11/05 18:48:04 jmc Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#include "PTRACERS_OPTIONS.h" |
5 |
|
6 |
CBOP |
7 |
C !ROUTINE: PTRACERS_INTEGRATE |
8 |
|
9 |
C !INTERFACE: ========================================================== |
10 |
SUBROUTINE PTRACERS_INTEGRATE( |
11 |
I bi,bj,k, |
12 |
I xA, yA, maskUp, uFld, vFld, wFld, |
13 |
I uTrans, vTrans, rTrans, rTransKp1, |
14 |
I KappaRtr, |
15 |
U rFlx, |
16 |
I myTime,myIter,myThid ) |
17 |
|
18 |
C !DESCRIPTION: |
19 |
C Calculates tendency for passive tracers and integrates forward |
20 |
C in time. |
21 |
|
22 |
C !USES: =============================================================== |
23 |
IMPLICIT NONE |
24 |
#include "SIZE.h" |
25 |
#include "EEPARAMS.h" |
26 |
#include "PARAMS.h" |
27 |
#include "DYNVARS.h" |
28 |
#include "PTRACERS_SIZE.h" |
29 |
#include "PTRACERS_PARAMS.h" |
30 |
#include "PTRACERS_RESTART.h" |
31 |
#include "PTRACERS_FIELDS.h" |
32 |
#include "GAD.h" |
33 |
#ifdef ALLOW_AUTODIFF_TAMC |
34 |
# include "tamc.h" |
35 |
# include "tamc_keys.h" |
36 |
#endif |
37 |
|
38 |
C !INPUT PARAMETERS: =================================================== |
39 |
C bi,bj :: tile indices |
40 |
C k :: vertical level number |
41 |
C xA :: face area at U points in level k |
42 |
C yA :: face area at V points in level k |
43 |
C maskUp :: mask for vertical transport |
44 |
C uFld,vFld,wFld :: Local copy of velocity field (3 components) |
45 |
C uTrans :: zonal transport in level k |
46 |
C vTrans :: meridional transport in level k |
47 |
C rTrans :: vertical volume transport at interface k |
48 |
C rTransKp1 :: vertical volume transport at interface k+1 |
49 |
C KappaRtr :: vertical diffusion of passive tracers, interf k |
50 |
C rFlx :: vertical flux |
51 |
C myTime :: model time |
52 |
C myIter :: time-step number |
53 |
C myThid :: thread number |
54 |
INTEGER bi,bj,k |
55 |
_RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
56 |
_RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
57 |
_RS maskUp (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
58 |
_RL uFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
59 |
_RL vFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
60 |
_RL wFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
61 |
_RL uTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
62 |
_RL vTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
63 |
_RL rTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
64 |
_RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
65 |
_RL KappaRtr(1-Olx:sNx+Olx,1-Oly:sNy+Oly,PTRACERS_num) |
66 |
_RL rFlx (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2,PTRACERS_num) |
67 |
_RL myTime |
68 |
INTEGER myIter |
69 |
INTEGER myThid |
70 |
|
71 |
C !OUTPUT PARAMETERS: ================================================== |
72 |
C none |
73 |
|
74 |
#ifdef ALLOW_PTRACERS |
75 |
|
76 |
C !LOCAL VARIABLES: ==================================================== |
77 |
C iTracer :: tracer index |
78 |
C iMin,iMax,jMin,jMax :: loop ranges |
79 |
C kUp,kDown :: toggle indices for even/odd level fluxes |
80 |
C km1 :: =min(1,k-1) |
81 |
C GAD_TR :: passive tracer id (GAD_TR1+iTracer-1) |
82 |
INTEGER iTracer |
83 |
INTEGER iMin,iMax,jMin,jMax |
84 |
INTEGER kUp,kDown,km1 |
85 |
INTEGER GAD_TR |
86 |
LOGICAL calcAdvection |
87 |
INTEGER iterNb |
88 |
CEOP |
89 |
|
90 |
C Loop ranges for daughter routines |
91 |
iMin = 1-OLx+2 |
92 |
iMax = sNx+OLx-1 |
93 |
jMin = 1-OLy+2 |
94 |
jMax = sNy+OLy-1 |
95 |
|
96 |
km1 = MAX(1,k-1) |
97 |
kUp = 1+MOD(k+1,2) |
98 |
kDown= 1+MOD(k,2) |
99 |
|
100 |
C Loop over tracers |
101 |
DO iTracer=1,PTRACERS_numInUse |
102 |
|
103 |
#ifdef ALLOW_AUTODIFF_TAMC |
104 |
act0 = iTracer - 1 |
105 |
max0 = PTRACERS_num |
106 |
act1 = bi - myBxLo(myThid) |
107 |
max1 = myBxHi(myThid) - myBxLo(myThid) + 1 |
108 |
act2 = bj - myByLo(myThid) |
109 |
max2 = myByHi(myThid) - myByLo(myThid) + 1 |
110 |
act3 = myThid - 1 |
111 |
max3 = nTx*nTy |
112 |
act4 = ikey_dynamics - 1 |
113 |
iptrkey = (act0 + 1) |
114 |
& + act1*max0 |
115 |
& + act2*max0*max1 |
116 |
& + act3*max0*max1*max2 |
117 |
& + act4*max0*max1*max2*max3 |
118 |
kkey = (iptrkey-1)*Nr + k |
119 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
120 |
|
121 |
#ifdef ALLOW_AUTODIFF_TAMC |
122 |
rFlx(1,1,kDown,iTracer) = rFlx(1,1,kDown,iTracer) |
123 |
c |
124 |
CADJ STORE pTracer(:,:,k,bi,bj,iTracer) |
125 |
CADJ & = comlev1_bibj_k_ptracers, key=kkey, byte=isbyte |
126 |
CADJ STORE gpTrNm1(:,:,k,bi,bj,iTracer) |
127 |
CADJ & = comlev1_bibj_k_ptracers, key=kkey, byte=isbyte |
128 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
129 |
|
130 |
C Calculate active tracer tendencies (gPtr) due to internal processes |
131 |
C (advection, [explicit] diffusion, parameterizations,...) |
132 |
calcAdvection = .NOT.PTRACERS_MultiDimAdv(iTracer) |
133 |
GAD_TR = GAD_TR1 + iTracer - 1 |
134 |
CALL GAD_CALC_RHS( |
135 |
I bi,bj,iMin,iMax,jMin,jMax,k,km1,kUp,kDown, |
136 |
I xA, yA, maskUp, uFld, vFld, wFld, |
137 |
I uTrans, vTrans, rTrans, rTransKp1, |
138 |
I PTRACERS_diffKh(iTracer), |
139 |
I PTRACERS_diffK4(iTracer), |
140 |
I KappaRtr(1-Olx,1-Oly,iTracer), |
141 |
I gpTrNm1(1-Olx,1-Oly,1,1,1,iTracer), |
142 |
I pTracer(1-Olx,1-Oly,1,1,1,iTracer), |
143 |
I GAD_TR, |
144 |
I PTRACERS_advScheme(iTracer), |
145 |
I PTRACERS_advScheme(iTracer), |
146 |
I calcAdvection, PTRACERS_ImplVertAdv(iTracer), |
147 |
I .FALSE., |
148 |
I PTRACERS_useGMRedi(iTracer), |
149 |
I PTRACERS_useKPP(iTracer), |
150 |
U rFlx(1-Olx,1-Oly,1,iTracer), |
151 |
U gPtr(1-Olx,1-Oly,1,1,1,iTracer), |
152 |
I myTime, myIter, myThid ) |
153 |
|
154 |
C External forcing term(s) |
155 |
IF ( tracForcingOutAB.NE.1 ) |
156 |
& CALL PTRACERS_FORCING( |
157 |
I bi,bj,iMin,iMax,jMin,jMax,k,iTracer, |
158 |
U gPtr(1-Olx,1-Oly,1,1,1,iTracer), |
159 |
I surfaceForcingPTr(1-Olx,1-Oly,1,1,iTracer), |
160 |
I myIter,myTime,myThid) |
161 |
|
162 |
C If using Adams-Bashforth II, then extrapolate tendencies |
163 |
C gPtr is now the tracer tendency for explicit advection/diffusion |
164 |
IF ( PTRACERS_AdamsBashGtr(iTracer) ) THEN |
165 |
#ifdef ALLOW_MATRIX |
166 |
C If matrix is being computed, block call to S/R ADAMS_BASHFORTH2 to |
167 |
C prevent gPtr from being replaced by the average of gPtr and gpTrNm1. |
168 |
IF (.NOT.useMATRIX) THEN |
169 |
#endif |
170 |
iterNb = myIter |
171 |
IF (staggerTimeStep) iterNb = myIter - 1 |
172 |
CALL ADAMS_BASHFORTH2( |
173 |
I bi,bj,K, |
174 |
U gPtr(1-Olx,1-Oly,1,1,1,iTracer), |
175 |
U gpTrNm1(1-Olx,1-Oly,1,1,1,iTracer), |
176 |
I PTRACERS_startAB(iTracer), iterNb, myThid ) |
177 |
#ifdef ALLOW_MATRIX |
178 |
ENDIF |
179 |
#endif |
180 |
ENDIF |
181 |
|
182 |
C External forcing term(s) |
183 |
IF ( tracForcingOutAB.EQ.1 ) |
184 |
& CALL PTRACERS_FORCING( |
185 |
I bi,bj,iMin,iMax,jMin,jMax,k,iTracer, |
186 |
U gPtr(1-Olx,1-Oly,1,1,1,iTracer), |
187 |
I surfaceForcingPTr(1-Olx,1-Oly,1,1,iTracer), |
188 |
I myIter,myTime,myThid) |
189 |
|
190 |
#ifdef NONLIN_FRSURF |
191 |
C Account for change in level thickness |
192 |
IF (nonlinFreeSurf.GT.0) THEN |
193 |
CALL FREESURF_RESCALE_G( |
194 |
I bi,bj,K, |
195 |
U gPtr(1-Olx,1-Oly,1,1,1,iTracer), |
196 |
I myThid ) |
197 |
IF ( PTRACERS_AdamsBashGtr(iTracer) ) THEN |
198 |
& CALL FREESURF_RESCALE_G( |
199 |
I bi,bj,K, |
200 |
U gpTrNm1(1-Olx,1-Oly,1,1,1,iTracer), |
201 |
I myThid ) |
202 |
ENDIF |
203 |
#endif /* NONLIN_FRSURF */ |
204 |
|
205 |
C Integrate forward in time, storing in gPtr: G=T+dt*G |
206 |
CALL TIMESTEP_TRACER( |
207 |
I bi,bj,iMin,iMax,jMin,jMax,k, |
208 |
I PTRACERS_advScheme(iTracer), |
209 |
I pTracer(1-Olx,1-Oly,1,1,1,iTracer), |
210 |
I gPtr(1-Olx,1-Oly,1,1,1,iTracer), |
211 |
I myIter,myThid ) |
212 |
|
213 |
#ifdef ALLOW_OBCS |
214 |
C Apply open boundary conditions |
215 |
IF (useOBCS) THEN |
216 |
CALL OBCS_APPLY_PTRACER( |
217 |
I bi, bj, k, iTracer, |
218 |
U gPtr(1-Olx,1-Oly,k,bi,bj,iTracer), |
219 |
I myThid ) |
220 |
ENDIF |
221 |
#endif /* ALLOW_OBCS */ |
222 |
C end of tracer loop |
223 |
ENDDO |
224 |
|
225 |
#endif /* ALLOW_PTRACERS */ |
226 |
|
227 |
RETURN |
228 |
END |