1 |
jmc |
1.16 |
C $Header: /u/gcmpack/MITgcm/model/src/temp_integrate.F,v 1.15 2014/08/14 16:53:42 jmc Exp $ |
2 |
jmc |
1.7 |
C $Name: $ |
3 |
jmc |
1.1 |
|
4 |
|
|
#include "PACKAGES_CONFIG.h" |
5 |
|
|
#include "CPP_OPTIONS.h" |
6 |
jmc |
1.7 |
#ifdef ALLOW_AUTODIFF |
7 |
|
|
# include "AUTODIFF_OPTIONS.h" |
8 |
|
|
#endif |
9 |
jmc |
1.4 |
#ifdef ALLOW_GENERIC_ADVDIFF |
10 |
|
|
# include "GAD_OPTIONS.h" |
11 |
|
|
#endif |
12 |
jmc |
1.1 |
|
13 |
|
|
CBOP |
14 |
|
|
C !ROUTINE: TEMP_INTEGRATE |
15 |
|
|
C !INTERFACE: |
16 |
|
|
SUBROUTINE TEMP_INTEGRATE( |
17 |
jmc |
1.5 |
I bi, bj, recip_hFac, |
18 |
jmc |
1.4 |
I uFld, vFld, wFld, |
19 |
|
|
U KappaRk, |
20 |
jmc |
1.1 |
I myTime, myIter, myThid ) |
21 |
|
|
C !DESCRIPTION: \bv |
22 |
|
|
C *==========================================================* |
23 |
|
|
C | SUBROUTINE TEMP_INTEGRATE |
24 |
jmc |
1.13 |
C | o Calculate tendency for temperature and integrates |
25 |
|
|
C | forward in time. The temperature array is updated here |
26 |
|
|
C | while adjustments (filters, conv.adjustment) are applied |
27 |
|
|
C | later, in S/R TRACERS_CORRECTION_STEP. |
28 |
jmc |
1.1 |
C *==========================================================* |
29 |
jmc |
1.8 |
C | A procedure called APPLY_FORCING_T is called from |
30 |
jmc |
1.1 |
C | here. These procedures can be used to add per problem |
31 |
|
|
C | heat flux source terms. |
32 |
|
|
C | Note: Although it is slightly counter-intuitive the |
33 |
|
|
C | EXTERNAL_FORCING routine is not the place to put |
34 |
|
|
C | file I/O. Instead files that are required to |
35 |
|
|
C | calculate the external source terms are generally |
36 |
|
|
C | read during the model main loop. This makes the |
37 |
|
|
C | logistics of multi-processing simpler and also |
38 |
|
|
C | makes the adjoint generation simpler. It also |
39 |
|
|
C | allows for I/O to overlap computation where that |
40 |
|
|
C | is supported by hardware. |
41 |
|
|
C | Aside from the problem specific term the code here |
42 |
|
|
C | forms the tendency terms due to advection and mixing |
43 |
|
|
C | The baseline implementation here uses a centered |
44 |
|
|
C | difference form for the advection term and a tensorial |
45 |
|
|
C | divergence of a flux form for the diffusive term. The |
46 |
jmc |
1.4 |
C | diffusive term is formulated so that isopycnal mixing |
47 |
|
|
C | and GM-style subgrid-scale terms can be incorporated by |
48 |
|
|
C | simply setting the diffusion tensor terms appropriately. |
49 |
jmc |
1.1 |
C *==========================================================* |
50 |
|
|
C \ev |
51 |
|
|
|
52 |
|
|
C !USES: |
53 |
|
|
IMPLICIT NONE |
54 |
|
|
C == GLobal variables == |
55 |
|
|
#include "SIZE.h" |
56 |
|
|
#include "EEPARAMS.h" |
57 |
|
|
#include "PARAMS.h" |
58 |
jmc |
1.5 |
#include "GRID.h" |
59 |
|
|
#include "DYNVARS.h" |
60 |
jmc |
1.1 |
#include "RESTART.h" |
61 |
|
|
#ifdef ALLOW_GENERIC_ADVDIFF |
62 |
jmc |
1.4 |
# include "GAD.h" |
63 |
|
|
# include "GAD_SOM_VARS.h" |
64 |
jmc |
1.1 |
#endif |
65 |
jmc |
1.5 |
#ifdef ALLOW_TIMEAVE |
66 |
|
|
# include "TIMEAVE_STATV.h" |
67 |
|
|
#endif |
68 |
jmc |
1.7 |
#ifdef ALLOW_AUTODIFF |
69 |
jmc |
1.1 |
# include "tamc.h" |
70 |
|
|
# include "tamc_keys.h" |
71 |
|
|
#endif |
72 |
|
|
|
73 |
|
|
C !INPUT/OUTPUT PARAMETERS: |
74 |
|
|
C == Routine arguments == |
75 |
jmc |
1.5 |
C bi, bj, :: tile indices |
76 |
|
|
C recip_hFac :: reciprocal of cell open-depth factor (@ next iter) |
77 |
|
|
C uFld,vFld :: Local copy of horizontal velocity field |
78 |
|
|
C wFld :: Local copy of vertical velocity field |
79 |
|
|
C KappaRk :: Vertical diffusion for Tempertature |
80 |
|
|
C myTime :: current time |
81 |
|
|
C myIter :: current iteration number |
82 |
|
|
C myThid :: my Thread Id. number |
83 |
jmc |
1.4 |
INTEGER bi, bj |
84 |
jmc |
1.5 |
_RS recip_hFac(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
85 |
|
|
_RL uFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
86 |
|
|
_RL vFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
87 |
|
|
_RL wFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
88 |
|
|
_RL KappaRk (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
89 |
jmc |
1.1 |
_RL myTime |
90 |
|
|
INTEGER myIter |
91 |
|
|
INTEGER myThid |
92 |
|
|
CEOP |
93 |
|
|
|
94 |
|
|
#ifdef ALLOW_GENERIC_ADVDIFF |
95 |
jmc |
1.10 |
#ifdef ALLOW_DIAGNOSTICS |
96 |
|
|
C !FUNCTIONS: |
97 |
|
|
LOGICAL DIAGNOSTICS_IS_ON |
98 |
|
|
EXTERNAL DIAGNOSTICS_IS_ON |
99 |
|
|
#endif /* ALLOW_DIAGNOSTICS */ |
100 |
|
|
|
101 |
jmc |
1.1 |
C !LOCAL VARIABLES: |
102 |
jmc |
1.5 |
C iMin, iMax :: 1rst index loop range |
103 |
|
|
C jMin, jMax :: 2nd index loop range |
104 |
|
|
C k :: vertical index |
105 |
|
|
C kM1 :: =k-1 for k>1, =1 for k=1 |
106 |
|
|
C kUp :: index into 2 1/2D array, toggles between 1|2 |
107 |
|
|
C kDown :: index into 2 1/2D array, toggles between 2|1 |
108 |
|
|
C xA :: Tracer cell face area normal to X |
109 |
|
|
C yA :: Tracer cell face area normal to X |
110 |
|
|
C maskUp :: Land/water mask for Wvel points (interface k) |
111 |
|
|
C uTrans :: Zonal volume transport through cell face |
112 |
|
|
C vTrans :: Meridional volume transport through cell face |
113 |
|
|
C rTrans :: Vertical volume transport at interface k |
114 |
|
|
C rTransKp :: Vertical volume transport at inteface k+1 |
115 |
|
|
C fZon :: Flux of temperature (T) in the zonal direction |
116 |
|
|
C fMer :: Flux of temperature (T) in the meridional direction |
117 |
|
|
C fVer :: Flux of temperature (T) in the vertical direction |
118 |
|
|
C at the upper(U) and lower(D) faces of a cell. |
119 |
jmc |
1.15 |
C gT_loc :: Temperature tendency (local to this S/R) |
120 |
jmc |
1.10 |
C gtForc :: Temperature forcing tendency |
121 |
jmc |
1.8 |
C gt_AB :: Adams-Bashforth temperature tendency increment |
122 |
jmc |
1.5 |
C useVariableK :: T when vertical diffusion is not constant |
123 |
jmc |
1.4 |
INTEGER iMin, iMax, jMin, jMax |
124 |
jmc |
1.1 |
INTEGER i, j, k |
125 |
|
|
INTEGER kUp, kDown, kM1 |
126 |
|
|
_RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
127 |
|
|
_RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
128 |
|
|
_RS maskUp (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
129 |
|
|
_RL uTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
130 |
|
|
_RL vTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
131 |
|
|
_RL rTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
132 |
|
|
_RL rTransKp(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
133 |
jmc |
1.5 |
_RL fZon (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
134 |
|
|
_RL fMer (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
135 |
|
|
_RL fVer (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
136 |
jmc |
1.15 |
_RL gT_loc (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
137 |
jmc |
1.10 |
_RL gtForc (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
138 |
jmc |
1.1 |
_RL gt_AB (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
139 |
jmc |
1.10 |
#ifdef ALLOW_DIAGNOSTICS |
140 |
|
|
LOGICAL diagForcing, diagAB_tend |
141 |
|
|
#endif |
142 |
jmc |
1.1 |
LOGICAL calcAdvection |
143 |
|
|
INTEGER iterNb |
144 |
|
|
#ifdef ALLOW_ADAMSBASHFORTH_3 |
145 |
jmc |
1.11 |
INTEGER m2 |
146 |
jmc |
1.1 |
#endif |
147 |
jmc |
1.5 |
#ifdef ALLOW_TIMEAVE |
148 |
|
|
LOGICAL useVariableK |
149 |
|
|
#endif |
150 |
|
|
|
151 |
jmc |
1.4 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
152 |
|
|
|
153 |
|
|
C- Loop ranges for daughter routines |
154 |
|
|
iMin = 1-OLx+2 |
155 |
|
|
iMax = sNx+OLx-1 |
156 |
|
|
jMin = 1-OLy+2 |
157 |
|
|
jMax = sNy+OLy-1 |
158 |
|
|
|
159 |
|
|
iterNb = myIter |
160 |
jmc |
1.5 |
IF (staggerTimeStep) iterNb = myIter - 1 |
161 |
jmc |
1.1 |
|
162 |
jmc |
1.10 |
#ifdef ALLOW_DIAGNOSTICS |
163 |
|
|
diagForcing = .FALSE. |
164 |
|
|
diagAB_tend = .FALSE. |
165 |
|
|
IF ( useDiagnostics .AND. tempForcing ) |
166 |
|
|
& diagForcing = DIAGNOSTICS_IS_ON( 'gT_Forc ', myThid ) |
167 |
|
|
IF ( useDiagnostics .AND. AdamsBashforthGt ) |
168 |
|
|
& diagAB_tend = DIAGNOSTICS_IS_ON( 'AB_gT ', myThid ) |
169 |
|
|
#endif |
170 |
|
|
|
171 |
jmc |
1.1 |
#ifdef ALLOW_AUTODIFF_TAMC |
172 |
|
|
act1 = bi - myBxLo(myThid) |
173 |
|
|
max1 = myBxHi(myThid) - myBxLo(myThid) + 1 |
174 |
|
|
act2 = bj - myByLo(myThid) |
175 |
|
|
max2 = myByHi(myThid) - myByLo(myThid) + 1 |
176 |
|
|
act3 = myThid - 1 |
177 |
|
|
max3 = nTx*nTy |
178 |
|
|
act4 = ikey_dynamics - 1 |
179 |
|
|
itdkey = (act1 + 1) + act2*max1 |
180 |
|
|
& + act3*max1*max2 |
181 |
|
|
& + act4*max1*max2*max3 |
182 |
|
|
#endif /* ALLOW_AUTODIFF_TAMC */ |
183 |
|
|
|
184 |
jmc |
1.4 |
C- Tracer tendency needs to be set to zero (moved here from gad_calc_rhs): |
185 |
|
|
DO k=1,Nr |
186 |
|
|
DO j=1-OLy,sNy+OLy |
187 |
|
|
DO i=1-OLx,sNx+OLx |
188 |
jmc |
1.15 |
gT_loc(i,j,k) = 0. _d 0 |
189 |
jmc |
1.4 |
ENDDO |
190 |
|
|
ENDDO |
191 |
|
|
ENDDO |
192 |
jmc |
1.1 |
DO j=1-OLy,sNy+OLy |
193 |
|
|
DO i=1-OLx,sNx+OLx |
194 |
jmc |
1.5 |
fVer(i,j,1) = 0. _d 0 |
195 |
|
|
fVer(i,j,2) = 0. _d 0 |
196 |
jmc |
1.1 |
ENDDO |
197 |
|
|
ENDDO |
198 |
jmc |
1.4 |
#ifdef ALLOW_AUTODIFF |
199 |
|
|
DO k=1,Nr |
200 |
|
|
DO j=1-OLy,sNy+OLy |
201 |
|
|
DO i=1-OLx,sNx+OLx |
202 |
|
|
kappaRk(i,j,k) = 0. _d 0 |
203 |
|
|
ENDDO |
204 |
|
|
ENDDO |
205 |
|
|
ENDDO |
206 |
jmc |
1.5 |
CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte |
207 |
|
|
CADJ STORE wFld(:,:,:) = comlev1_bibj , key=itdkey, byte=isbyte |
208 |
jmc |
1.4 |
#endif /* ALLOW_AUTODIFF */ |
209 |
|
|
|
210 |
|
|
#ifdef INCLUDE_CALC_DIFFUSIVITY_CALL |
211 |
jmc |
1.5 |
CALL CALC_3D_DIFFUSIVITY( |
212 |
jmc |
1.4 |
I bi, bj, iMin, iMax, jMin, jMax, |
213 |
|
|
I GAD_TEMPERATURE, useGMredi, useKPP, |
214 |
|
|
O kappaRk, |
215 |
|
|
I myThid ) |
216 |
|
|
#endif /* INCLUDE_CALC_DIFFUSIVITY_CALL */ |
217 |
|
|
|
218 |
|
|
#ifndef DISABLE_MULTIDIM_ADVECTION |
219 |
|
|
C-- Some advection schemes are better calculated using a multi-dimensional |
220 |
|
|
C method in the absence of any other terms and, if used, is done here. |
221 |
|
|
C |
222 |
|
|
C The CPP flag DISABLE_MULTIDIM_ADVECTION is currently unset in GAD_OPTIONS.h |
223 |
|
|
C The default is to use multi-dimensinal advection for non-linear advection |
224 |
|
|
C schemes. However, for the sake of efficiency of the adjoint it is necessary |
225 |
|
|
C to be able to exclude this scheme to avoid excessive storage and |
226 |
|
|
C recomputation. It *is* differentiable, if you need it. |
227 |
|
|
C Edit GAD_OPTIONS.h and #define DISABLE_MULTIDIM_ADVECTION to |
228 |
|
|
C disable this section of code. |
229 |
|
|
#ifdef GAD_ALLOW_TS_SOM_ADV |
230 |
|
|
# ifdef ALLOW_AUTODIFF_TAMC |
231 |
|
|
CADJ STORE som_T = comlev1_bibj, key=itdkey, byte=isbyte |
232 |
|
|
# endif |
233 |
|
|
IF ( tempSOM_Advection ) THEN |
234 |
|
|
# ifdef ALLOW_DEBUG |
235 |
|
|
IF (debugMode) CALL DEBUG_CALL('GAD_SOM_ADVECT',myThid) |
236 |
|
|
# endif |
237 |
|
|
CALL GAD_SOM_ADVECT( |
238 |
jmc |
1.8 |
I tempImplVertAdv, |
239 |
|
|
I tempAdvScheme, tempVertAdvScheme, GAD_TEMPERATURE, |
240 |
|
|
I dTtracerLev, uFld, vFld, wFld, theta, |
241 |
jmc |
1.4 |
U som_T, |
242 |
jmc |
1.15 |
O gT_loc, |
243 |
jmc |
1.4 |
I bi, bj, myTime, myIter, myThid ) |
244 |
|
|
ELSEIF (tempMultiDimAdvec) THEN |
245 |
|
|
#else /* GAD_ALLOW_TS_SOM_ADV */ |
246 |
|
|
IF (tempMultiDimAdvec) THEN |
247 |
|
|
#endif /* GAD_ALLOW_TS_SOM_ADV */ |
248 |
|
|
# ifdef ALLOW_DEBUG |
249 |
|
|
IF (debugMode) CALL DEBUG_CALL('GAD_ADVECTION',myThid) |
250 |
|
|
# endif |
251 |
|
|
CALL GAD_ADVECTION( |
252 |
jmc |
1.8 |
I tempImplVertAdv, |
253 |
|
|
I tempAdvScheme, tempVertAdvScheme, GAD_TEMPERATURE, |
254 |
|
|
I dTtracerLev, uFld, vFld, wFld, theta, |
255 |
jmc |
1.15 |
O gT_loc, |
256 |
jmc |
1.4 |
I bi, bj, myTime, myIter, myThid ) |
257 |
|
|
ENDIF |
258 |
|
|
#endif /* DISABLE_MULTIDIM_ADVECTION */ |
259 |
jmc |
1.1 |
|
260 |
jmc |
1.4 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
261 |
|
|
|
262 |
|
|
C- Start vertical index (k) loop (Nr:1) |
263 |
|
|
calcAdvection = tempAdvection .AND. .NOT.tempMultiDimAdvec |
264 |
jmc |
1.1 |
DO k=Nr,1,-1 |
265 |
|
|
#ifdef ALLOW_AUTODIFF_TAMC |
266 |
|
|
kkey = (itdkey-1)*Nr + k |
267 |
|
|
#endif /* ALLOW_AUTODIFF_TAMC */ |
268 |
|
|
kM1 = MAX(1,k-1) |
269 |
|
|
kUp = 1+MOD(k+1,2) |
270 |
|
|
kDown= 1+MOD(k,2) |
271 |
|
|
|
272 |
|
|
#ifdef ALLOW_AUTODIFF_TAMC |
273 |
jmc |
1.5 |
CADJ STORE fVer(:,:,:) = comlev1_bibj_k, key=kkey, |
274 |
jmc |
1.1 |
CADJ & byte=isbyte, kind = isbyte |
275 |
jmc |
1.15 |
CADJ STORE gT_loc(:,:,k) = comlev1_bibj_k, key=kkey, |
276 |
jmc |
1.1 |
CADJ & byte=isbyte, kind = isbyte |
277 |
|
|
# ifdef ALLOW_ADAMSBASHFORTH_3 |
278 |
|
|
CADJ STORE gtNm(:,:,k,bi,bj,1) = comlev1_bibj_k, key=kkey, |
279 |
|
|
CADJ & byte=isbyte, kind = isbyte |
280 |
|
|
CADJ STORE gtNm(:,:,k,bi,bj,2) = comlev1_bibj_k, key=kkey, |
281 |
|
|
CADJ & byte=isbyte, kind = isbyte |
282 |
|
|
# else |
283 |
|
|
CADJ STORE gtNm1(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, |
284 |
|
|
CADJ & byte=isbyte, kind = isbyte |
285 |
|
|
# endif |
286 |
|
|
#endif /* ALLOW_AUTODIFF_TAMC */ |
287 |
|
|
CALL CALC_ADV_FLOW( |
288 |
|
|
I uFld, vFld, wFld, |
289 |
|
|
U rTrans, |
290 |
|
|
O uTrans, vTrans, rTransKp, |
291 |
|
|
O maskUp, xA, yA, |
292 |
|
|
I k, bi, bj, myThid ) |
293 |
|
|
|
294 |
jmc |
1.10 |
C-- Collect forcing term in local array gtForc: |
295 |
|
|
DO j=1-OLy,sNy+OLy |
296 |
|
|
DO i=1-OLx,sNx+OLx |
297 |
|
|
gtForc(i,j) = 0. _d 0 |
298 |
|
|
ENDDO |
299 |
|
|
ENDDO |
300 |
|
|
IF ( tempForcing ) THEN |
301 |
|
|
CALL APPLY_FORCING_T( |
302 |
|
|
U gtForc, |
303 |
|
|
I iMin,iMax,jMin,jMax, k, bi,bj, |
304 |
|
|
I myTime, myIter, myThid ) |
305 |
|
|
#ifdef ALLOW_DIAGNOSTICS |
306 |
|
|
IF ( diagForcing ) THEN |
307 |
|
|
CALL DIAGNOSTICS_FILL(gtForc,'gT_Forc ',k,1,2,bi,bj,myThid) |
308 |
|
|
ENDIF |
309 |
|
|
#endif /* ALLOW_DIAGNOSTICS */ |
310 |
|
|
ENDIF |
311 |
|
|
|
312 |
jmc |
1.1 |
#ifdef ALLOW_ADAMSBASHFORTH_3 |
313 |
jmc |
1.11 |
c m1 = 1 + MOD(iterNb+1,2) |
314 |
jmc |
1.1 |
m2 = 1 + MOD( iterNb ,2) |
315 |
|
|
CALL GAD_CALC_RHS( |
316 |
|
|
I bi, bj, iMin,iMax,jMin,jMax, k, kM1, kUp, kDown, |
317 |
|
|
I xA, yA, maskUp, uFld(1-OLx,1-OLy,k), |
318 |
|
|
I vFld(1-OLx,1-OLy,k), wFld(1-OLx,1-OLy,k), |
319 |
|
|
I uTrans, vTrans, rTrans, rTransKp, |
320 |
|
|
I diffKhT, diffK4T, KappaRk(1-OLx,1-OLy,k), diffKr4T, |
321 |
jmc |
1.16 |
I theta(1-OLx,1-OLy,1,bi,bj), |
322 |
|
|
I gtNm(1-OLx,1-OLy,1,bi,bj,m2), dTtracerLev, |
323 |
jmc |
1.1 |
I GAD_TEMPERATURE, tempAdvScheme, tempVertAdvScheme, |
324 |
|
|
I calcAdvection, tempImplVertAdv, AdamsBashforth_T, |
325 |
|
|
I tempVertDiff4, useGMRedi, useKPP, |
326 |
jmc |
1.5 |
O fZon, fMer, |
327 |
jmc |
1.15 |
U fVer, gT_loc, |
328 |
jmc |
1.1 |
I myTime, myIter, myThid ) |
329 |
|
|
#else /* ALLOW_ADAMSBASHFORTH_3 */ |
330 |
|
|
CALL GAD_CALC_RHS( |
331 |
|
|
I bi, bj, iMin,iMax,jMin,jMax, k, kM1, kUp, kDown, |
332 |
|
|
I xA, yA, maskUp, uFld(1-OLx,1-OLy,k), |
333 |
|
|
I vFld(1-OLx,1-OLy,k), wFld(1-OLx,1-OLy,k), |
334 |
|
|
I uTrans, vTrans, rTrans, rTransKp, |
335 |
|
|
I diffKhT, diffK4T, KappaRk(1-OLx,1-OLy,k), diffKr4T, |
336 |
jmc |
1.16 |
I theta(1-OLx,1-OLy,1,bi,bj), |
337 |
|
|
I gtNm1(1-OLx,1-OLy,1,bi,bj), dTtracerLev, |
338 |
jmc |
1.1 |
I GAD_TEMPERATURE, tempAdvScheme, tempVertAdvScheme, |
339 |
|
|
I calcAdvection, tempImplVertAdv, AdamsBashforth_T, |
340 |
|
|
I tempVertDiff4, useGMRedi, useKPP, |
341 |
jmc |
1.5 |
O fZon, fMer, |
342 |
jmc |
1.15 |
U fVer, gT_loc, |
343 |
jmc |
1.1 |
I myTime, myIter, myThid ) |
344 |
|
|
#endif |
345 |
|
|
|
346 |
|
|
C-- External thermal forcing term(s) inside Adams-Bashforth: |
347 |
jmc |
1.10 |
IF ( tempForcing .AND. tracForcingOutAB.NE.1 ) THEN |
348 |
|
|
DO j=1-OLy,sNy+OLy |
349 |
|
|
DO i=1-OLx,sNx+OLx |
350 |
jmc |
1.15 |
gT_loc(i,j,k) = gT_loc(i,j,k) + gtForc(i,j) |
351 |
jmc |
1.10 |
ENDDO |
352 |
|
|
ENDDO |
353 |
|
|
ENDIF |
354 |
jmc |
1.1 |
|
355 |
|
|
IF ( AdamsBashforthGt ) THEN |
356 |
|
|
#ifdef ALLOW_ADAMSBASHFORTH_3 |
357 |
|
|
CALL ADAMS_BASHFORTH3( |
358 |
|
|
I bi, bj, k, Nr, |
359 |
jmc |
1.15 |
U gT_loc, gtNm, |
360 |
|
|
O gt_AB, |
361 |
jmc |
1.1 |
I tempStartAB, iterNb, myThid ) |
362 |
|
|
#else |
363 |
|
|
CALL ADAMS_BASHFORTH2( |
364 |
|
|
I bi, bj, k, Nr, |
365 |
jmc |
1.15 |
U gT_loc, gtNm1(1-OLx,1-OLy,1,bi,bj), |
366 |
|
|
O gt_AB, |
367 |
jmc |
1.1 |
I tempStartAB, iterNb, myThid ) |
368 |
|
|
#endif |
369 |
|
|
#ifdef ALLOW_DIAGNOSTICS |
370 |
jmc |
1.10 |
IF ( diagAB_tend ) THEN |
371 |
jmc |
1.1 |
CALL DIAGNOSTICS_FILL(gt_AB,'AB_gT ',k,1,2,bi,bj,myThid) |
372 |
|
|
ENDIF |
373 |
|
|
#endif /* ALLOW_DIAGNOSTICS */ |
374 |
|
|
ENDIF |
375 |
|
|
|
376 |
|
|
C-- External thermal forcing term(s) outside Adams-Bashforth: |
377 |
jmc |
1.10 |
IF ( tempForcing .AND. tracForcingOutAB.EQ.1 ) THEN |
378 |
|
|
DO j=1-OLy,sNy+OLy |
379 |
|
|
DO i=1-OLx,sNx+OLx |
380 |
jmc |
1.15 |
gT_loc(i,j,k) = gT_loc(i,j,k) + gtForc(i,j) |
381 |
jmc |
1.10 |
ENDDO |
382 |
|
|
ENDDO |
383 |
|
|
ENDIF |
384 |
jmc |
1.1 |
|
385 |
|
|
#ifdef NONLIN_FRSURF |
386 |
|
|
IF (nonlinFreeSurf.GT.0) THEN |
387 |
|
|
CALL FREESURF_RESCALE_G( |
388 |
|
|
I bi, bj, k, |
389 |
jmc |
1.15 |
U gT_loc, |
390 |
jmc |
1.1 |
I myThid ) |
391 |
|
|
IF ( AdamsBashforthGt ) THEN |
392 |
|
|
#ifdef ALLOW_ADAMSBASHFORTH_3 |
393 |
|
|
# ifdef ALLOW_AUTODIFF_TAMC |
394 |
|
|
CADJ STORE gtNm(:,:,k,bi,bj,1) = comlev1_bibj_k, key=kkey, |
395 |
|
|
CADJ & byte=isbyte, kind = isbyte |
396 |
|
|
CADJ STORE gtNm(:,:,k,bi,bj,2) = comlev1_bibj_k, key=kkey, |
397 |
|
|
CADJ & byte=isbyte, kind = isbyte |
398 |
|
|
# endif |
399 |
|
|
CALL FREESURF_RESCALE_G( |
400 |
|
|
I bi, bj, k, |
401 |
jmc |
1.15 |
U gtNm(1-OLx,1-OLy,1,bi,bj,1), |
402 |
jmc |
1.1 |
I myThid ) |
403 |
|
|
CALL FREESURF_RESCALE_G( |
404 |
|
|
I bi, bj, k, |
405 |
jmc |
1.15 |
U gtNm(1-OLx,1-OLy,1,bi,bj,2), |
406 |
jmc |
1.1 |
I myThid ) |
407 |
|
|
#else |
408 |
|
|
CALL FREESURF_RESCALE_G( |
409 |
|
|
I bi, bj, k, |
410 |
jmc |
1.15 |
U gtNm1(1-OLx,1-OLy,1,bi,bj), |
411 |
jmc |
1.1 |
I myThid ) |
412 |
|
|
#endif |
413 |
|
|
ENDIF |
414 |
|
|
ENDIF |
415 |
|
|
#endif /* NONLIN_FRSURF */ |
416 |
|
|
|
417 |
|
|
C- end of vertical index (k) loop (Nr:1) |
418 |
|
|
ENDDO |
419 |
|
|
|
420 |
jmc |
1.5 |
#ifdef ALLOW_DOWN_SLOPE |
421 |
|
|
IF ( useDOWN_SLOPE ) THEN |
422 |
|
|
IF ( usingPCoords ) THEN |
423 |
|
|
CALL DWNSLP_APPLY( |
424 |
|
|
I GAD_TEMPERATURE, bi, bj, kSurfC, |
425 |
jmc |
1.14 |
I theta(1-OLx,1-OLy,1,bi,bj), |
426 |
jmc |
1.15 |
U gT_loc, |
427 |
jmc |
1.14 |
I recip_hFac, recip_rA, recip_drF, |
428 |
|
|
I dTtracerLev, myTime, myIter, myThid ) |
429 |
jmc |
1.5 |
ELSE |
430 |
|
|
CALL DWNSLP_APPLY( |
431 |
|
|
I GAD_TEMPERATURE, bi, bj, kLowC, |
432 |
jmc |
1.14 |
I theta(1-OLx,1-OLy,1,bi,bj), |
433 |
jmc |
1.15 |
U gT_loc, |
434 |
jmc |
1.14 |
I recip_hFac, recip_rA, recip_drF, |
435 |
|
|
I dTtracerLev, myTime, myIter, myThid ) |
436 |
jmc |
1.5 |
ENDIF |
437 |
|
|
ENDIF |
438 |
|
|
#endif /* ALLOW_DOWN_SLOPE */ |
439 |
|
|
|
440 |
jmc |
1.15 |
C- Integrate forward in time, storing in gT_loc: gT <= T + dt*gT |
441 |
jmc |
1.14 |
CALL TIMESTEP_TRACER( |
442 |
|
|
I bi, bj, dTtracerLev, |
443 |
|
|
I theta(1-OLx,1-OLy,1,bi,bj), |
444 |
jmc |
1.15 |
U gT_loc, |
445 |
jmc |
1.14 |
I myTime, myIter, myThid ) |
446 |
|
|
|
447 |
jmc |
1.5 |
iMin = 0 |
448 |
|
|
iMax = sNx+1 |
449 |
|
|
jMin = 0 |
450 |
|
|
jMax = sNy+1 |
451 |
|
|
|
452 |
|
|
C-- Implicit vertical advection & diffusion |
453 |
|
|
|
454 |
|
|
#ifdef INCLUDE_IMPLVERTADV_CODE |
455 |
|
|
IF ( tempImplVertAdv ) THEN |
456 |
|
|
#ifdef ALLOW_AUTODIFF_TAMC |
457 |
jmc |
1.7 |
CADJ STORE kappaRk(:,:,:) = comlev1_bibj , key=itdkey, byte=isbyte |
458 |
jmc |
1.15 |
CADJ STORE gT_loc(:,:,:) = comlev1_bibj , key=itdkey, byte=isbyte |
459 |
jmc |
1.7 |
CADJ STORE wFld(:,:,:) = comlev1_bibj , key=itdkey, byte=isbyte |
460 |
|
|
CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte |
461 |
|
|
CADJ STORE recip_hFac(:,:,:) = comlev1_bibj , key=itdkey, byte=isbyte |
462 |
jmc |
1.5 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
463 |
|
|
CALL GAD_IMPLICIT_R( |
464 |
|
|
I tempImplVertAdv, tempVertAdvScheme, GAD_TEMPERATURE, |
465 |
jmc |
1.15 |
I dTtracerLev, kappaRk, recip_hFac, wFld, |
466 |
|
|
I theta(1-OLx,1-OLy,1,bi,bj), |
467 |
|
|
U gT_loc, |
468 |
jmc |
1.5 |
I bi, bj, myTime, myIter, myThid ) |
469 |
|
|
ELSEIF ( implicitDiffusion ) THEN |
470 |
|
|
#else /* INCLUDE_IMPLVERTADV_CODE */ |
471 |
|
|
IF ( implicitDiffusion ) THEN |
472 |
|
|
#endif /* INCLUDE_IMPLVERTADV_CODE */ |
473 |
|
|
#ifdef ALLOW_AUTODIFF_TAMC |
474 |
jmc |
1.7 |
CADJ STORE kappaRk(:,:,:) = comlev1_bibj , key=itdkey, byte=isbyte |
475 |
jmc |
1.15 |
CADJ STORE gT_loc(:,:,:) = comlev1_bibj , key=itdkey, byte=isbyte |
476 |
jmc |
1.5 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
477 |
|
|
CALL IMPLDIFF( |
478 |
|
|
I bi, bj, iMin, iMax, jMin, jMax, |
479 |
|
|
I GAD_TEMPERATURE, kappaRk, recip_hFac, |
480 |
jmc |
1.15 |
U gT_loc, |
481 |
jmc |
1.5 |
I myThid ) |
482 |
|
|
ENDIF |
483 |
|
|
|
484 |
|
|
#ifdef ALLOW_TIMEAVE |
485 |
jmc |
1.12 |
useVariableK = useKPP .OR. usePP81 .OR. useKL10 .OR. useMY82 |
486 |
|
|
& .OR. useGGL90 .OR. useGMredi .OR. ivdc_kappa.NE.0. |
487 |
jmc |
1.5 |
IF ( taveFreq.GT.0. .AND. useVariableK |
488 |
|
|
& .AND.implicitDiffusion ) THEN |
489 |
jmc |
1.15 |
CALL TIMEAVE_CUMUL_DIF_1T( TdiffRtave, |
490 |
|
|
I gT_loc, kappaRk, |
491 |
|
|
I Nr, 3, deltaTClock, bi, bj, myThid ) |
492 |
jmc |
1.5 |
ENDIF |
493 |
|
|
#endif /* ALLOW_TIMEAVE */ |
494 |
|
|
|
495 |
jmc |
1.13 |
#ifdef ALLOW_ADAMSBASHFORTH_3 |
496 |
|
|
IF ( AdamsBashforth_T ) THEN |
497 |
|
|
C- Save current tracer field (for AB on tracer) and then update tracer |
498 |
|
|
CALL CYCLE_AB_TRACER( |
499 |
jmc |
1.16 |
I bi, bj, gT_loc, |
500 |
|
|
U theta(1-OLx,1-OLy,1,bi,bj), |
501 |
|
|
O gtNm(1-OLx,1-OLy,1,bi,bj,m2), |
502 |
jmc |
1.13 |
I myTime, myIter, myThid ) |
503 |
|
|
ELSEIF ( tempStepping ) THEN |
504 |
|
|
#else /* ALLOW_ADAMSBASHFORTH_3 */ |
505 |
|
|
IF ( tempStepping ) THEN |
506 |
|
|
#endif /* ALLOW_ADAMSBASHFORTH_3 */ |
507 |
|
|
C- Update tracer fields: T(n) = T** |
508 |
|
|
CALL CYCLE_TRACER( |
509 |
|
|
I bi, bj, |
510 |
jmc |
1.16 |
O theta(1-OLx,1-OLy,1,bi,bj), |
511 |
|
|
I gT_loc, myTime, myIter, myThid ) |
512 |
jmc |
1.13 |
ENDIF |
513 |
|
|
|
514 |
jmc |
1.1 |
#endif /* ALLOW_GENERIC_ADVDIFF */ |
515 |
|
|
|
516 |
|
|
RETURN |
517 |
|
|
END |