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