/[MITgcm]/MITgcm/pkg/generic_advdiff/gad_advection.F
ViewVC logotype

Contents of /MITgcm/pkg/generic_advdiff/gad_advection.F

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.46 - (show annotations) (download)
Sat Jan 20 21:20:11 2007 UTC (17 years, 5 months ago) by adcroft
Branch: MAIN
Changes since 1.45: +13 -1 lines
Added new advection scheme, OS7MP, which is seventh order and monotonicity preserving (note: not the same as monotonic!)
 o enabled with advScheme set to "7". (Who chose 77 for Superbee? Oh, that was me ...)
 o scheme requires a halo of 4
   - no error checking for this at the moment
 o scheme is coded for convenience rather than efficiency
   - can easily switch down order or select the TVD limiter by commenting lines
   - the y direction is coded with invert do i; do j loops (for now)

1 C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/gad_advection.F,v 1.45 2007/01/10 18:53:25 jmc Exp $
2 C $Name: $
3
4 #include "GAD_OPTIONS.h"
5 #undef MULTIDIM_OLD_VERSION
6
7 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
8 CBOP
9 C !ROUTINE: GAD_ADVECTION
10
11 C !INTERFACE: ==========================================================
12 SUBROUTINE GAD_ADVECTION(
13 I implicitAdvection, advectionScheme, vertAdvecScheme,
14 I tracerIdentity,
15 I uVel, vVel, wVel, tracer,
16 O gTracer,
17 I bi,bj, myTime,myIter,myThid)
18
19 C !DESCRIPTION:
20 C Calculates the tendency of a tracer due to advection.
21 C It uses the multi-dimensional method given in \ref{sect:multiDimAdvection}
22 C and can only be used for the non-linear advection schemes such as the
23 C direct-space-time method and flux-limiters.
24 C
25 C The algorithm is as follows:
26 C \begin{itemize}
27 C \item{$\theta^{(n+1/3)} = \theta^{(n)}
28 C - \Delta t \partial_x (u\theta^{(n)}) + \theta^{(n)} \partial_x u$}
29 C \item{$\theta^{(n+2/3)} = \theta^{(n+1/3)}
30 C - \Delta t \partial_y (v\theta^{(n+1/3)}) + \theta^{(n)} \partial_y v$}
31 C \item{$\theta^{(n+3/3)} = \theta^{(n+2/3)}
32 C - \Delta t \partial_r (w\theta^{(n+2/3)}) + \theta^{(n)} \partial_r w$}
33 C \item{$G_\theta = ( \theta^{(n+3/3)} - \theta^{(n)} )/\Delta t$}
34 C \end{itemize}
35 C
36 C The tendency (output) is over-written by this routine.
37
38 C !USES: ===============================================================
39 IMPLICIT NONE
40 #include "SIZE.h"
41 #include "EEPARAMS.h"
42 #include "PARAMS.h"
43 #include "GRID.h"
44 #include "GAD.h"
45 #ifdef ALLOW_AUTODIFF_TAMC
46 # include "tamc.h"
47 # include "tamc_keys.h"
48 # ifdef ALLOW_PTRACERS
49 # include "PTRACERS_SIZE.h"
50 # endif
51 #endif
52 #ifdef ALLOW_EXCH2
53 #include "W2_EXCH2_TOPOLOGY.h"
54 #include "W2_EXCH2_PARAMS.h"
55 #endif /* ALLOW_EXCH2 */
56
57 C !INPUT PARAMETERS: ===================================================
58 C implicitAdvection :: implicit vertical advection (later on)
59 C advectionScheme :: advection scheme to use (Horizontal plane)
60 C vertAdvecScheme :: advection scheme to use (vertical direction)
61 C tracerIdentity :: tracer identifier (required only for OBCS)
62 C uVel :: velocity, zonal component
63 C vVel :: velocity, meridional component
64 C wVel :: velocity, vertical component
65 C tracer :: tracer field
66 C bi,bj :: tile indices
67 C myTime :: current time
68 C myIter :: iteration number
69 C myThid :: thread number
70 LOGICAL implicitAdvection
71 INTEGER advectionScheme, vertAdvecScheme
72 INTEGER tracerIdentity
73 _RL uVel (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
74 _RL vVel (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
75 _RL wVel (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
76 _RL tracer(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
77 INTEGER bi,bj
78 _RL myTime
79 INTEGER myIter
80 INTEGER myThid
81
82 C !OUTPUT PARAMETERS: ==================================================
83 C gTracer :: tendency array
84 _RL gTracer(1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr,nSx,nSy)
85
86 C !LOCAL VARIABLES: ====================================================
87 C maskUp :: 2-D array for mask at W points
88 C maskLocW :: 2-D array for mask at West points
89 C maskLocS :: 2-D array for mask at South points
90 C iMin,iMax, :: loop range for called routines
91 C jMin,jMax :: loop range for called routines
92 C [iMin,iMax]Upd :: loop range to update tracer field
93 C [jMin,jMax]Upd :: loop range to update tracer field
94 C i,j,k :: loop indices
95 C kUp :: index into 2 1/2D array, toggles between 1 and 2
96 C kDown :: index into 2 1/2D array, toggles between 2 and 1
97 C kp1 :: =k+1 for k<Nr, =Nr for k=Nr
98 C xA,yA :: areas of X and Y face of tracer cells
99 C uFld,vFld :: 2-D local copy of horizontal velocity, U,V components
100 C wFld :: 2-D local copy of vertical velocity
101 C uTrans,vTrans :: 2-D arrays of volume transports at U,V points
102 C rTrans :: 2-D arrays of volume transports at W points
103 C rTransKp1 :: vertical volume transport at interface k+1
104 C af :: 2-D array for horizontal advective flux
105 C afx :: 2-D array for horizontal advective flux, x direction
106 C afy :: 2-D array for horizontal advective flux, y direction
107 C fVerT :: 2 1/2D arrays for vertical advective flux
108 C localTij :: 2-D array, temporary local copy of tracer fld
109 C localTijk :: 3-D array, temporary local copy of tracer fld
110 C kp1Msk :: flag (0,1) for over-riding mask for W levels
111 C calc_fluxes_X :: logical to indicate to calculate fluxes in X dir
112 C calc_fluxes_Y :: logical to indicate to calculate fluxes in Y dir
113 C interiorOnly :: only update the interior of myTile, but not the edges
114 C overlapOnly :: only update the edges of myTile, but not the interior
115 C nipass :: number of passes in multi-dimensional method
116 C ipass :: number of the current pass being made
117 C myTile :: variables used to determine which cube face
118 C nCFace :: owns a tile for cube grid runs using
119 C :: multi-dim advection.
120 C [N,S,E,W]_edge :: true if N,S,E,W edge of myTile is an Edge of the cube
121 c _RS maskUp (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
122 _RS maskLocW(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
123 _RS maskLocS(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
124 INTEGER iMin,iMax,jMin,jMax
125 INTEGER iMinUpd,iMaxUpd,jMinUpd,jMaxUpd
126 INTEGER i,j,k,kUp,kDown
127 _RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
128 _RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
129 _RL uFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
130 _RL vFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
131 _RL wFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
132 _RL uTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
133 _RL vTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
134 _RL rTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
135 _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
136 _RL af (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
137 _RL afx (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
138 _RL afy (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
139 _RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
140 _RL localTij(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
141 _RL localTijk(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
142 _RL kp1Msk
143 LOGICAL calc_fluxes_X, calc_fluxes_Y, withSigns
144 LOGICAL interiorOnly, overlapOnly
145 INTEGER nipass,ipass
146 INTEGER nCFace
147 LOGICAL N_edge, S_edge, E_edge, W_edge
148 #ifdef ALLOW_EXCH2
149 INTEGER myTile
150 #endif
151 #ifdef ALLOW_DIAGNOSTICS
152 CHARACTER*8 diagName
153 CHARACTER*4 GAD_DIAG_SUFX, diagSufx
154 EXTERNAL GAD_DIAG_SUFX
155 #endif
156 CEOP
157
158 #ifdef ALLOW_AUTODIFF_TAMC
159 act0 = tracerIdentity - 1
160 max0 = maxpass
161 act1 = bi - myBxLo(myThid)
162 max1 = myBxHi(myThid) - myBxLo(myThid) + 1
163 act2 = bj - myByLo(myThid)
164 max2 = myByHi(myThid) - myByLo(myThid) + 1
165 act3 = myThid - 1
166 max3 = nTx*nTy
167 act4 = ikey_dynamics - 1
168 igadkey = (act0 + 1)
169 & + act1*max0
170 & + act2*max0*max1
171 & + act3*max0*max1*max2
172 & + act4*max0*max1*max2*max3
173 if (tracerIdentity.GT.maxpass) then
174 print *, 'ph-pass gad_advection ', maxpass, tracerIdentity
175 STOP 'maxpass seems smaller than tracerIdentity'
176 endif
177 #endif /* ALLOW_AUTODIFF_TAMC */
178
179 #ifdef ALLOW_DIAGNOSTICS
180 C-- Set diagnostic suffix for the current tracer
181 IF ( useDiagnostics ) THEN
182 diagSufx = GAD_DIAG_SUFX( tracerIdentity, myThid )
183 ENDIF
184 #endif
185
186 C-- Set up work arrays with valid (i.e. not NaN) values
187 C These inital values do not alter the numerical results. They
188 C just ensure that all memory references are to valid floating
189 C point numbers. This prevents spurious hardware signals due to
190 C uninitialised but inert locations.
191 DO j=1-OLy,sNy+OLy
192 DO i=1-OLx,sNx+OLx
193 xA(i,j) = 0. _d 0
194 yA(i,j) = 0. _d 0
195 uTrans(i,j) = 0. _d 0
196 vTrans(i,j) = 0. _d 0
197 rTrans(i,j) = 0. _d 0
198 fVerT(i,j,1) = 0. _d 0
199 fVerT(i,j,2) = 0. _d 0
200 rTransKp1(i,j)= 0. _d 0
201 #ifdef ALLOW_AUTODIFF_TAMC
202 localTij(i,j) = 0. _d 0
203 wfld(i,j) = 0. _d 0
204 #endif
205 ENDDO
206 ENDDO
207
208 C-- Set tile-specific parameters for horizontal fluxes
209 IF (useCubedSphereExchange) THEN
210 nipass=3
211 #ifdef ALLOW_AUTODIFF_TAMC
212 IF ( nipass.GT.maxcube ) STOP 'maxcube needs to be = 3'
213 #endif
214 #ifdef ALLOW_EXCH2
215 myTile = W2_myTileList(bi)
216 nCFace = exch2_myFace(myTile)
217 N_edge = exch2_isNedge(myTile).EQ.1
218 S_edge = exch2_isSedge(myTile).EQ.1
219 E_edge = exch2_isEedge(myTile).EQ.1
220 W_edge = exch2_isWedge(myTile).EQ.1
221 #else
222 nCFace = bi
223 N_edge = .TRUE.
224 S_edge = .TRUE.
225 E_edge = .TRUE.
226 W_edge = .TRUE.
227 #endif
228 ELSE
229 nipass=2
230 nCFace = bi
231 N_edge = .FALSE.
232 S_edge = .FALSE.
233 E_edge = .FALSE.
234 W_edge = .FALSE.
235 ENDIF
236
237 iMin = 1-OLx
238 iMax = sNx+OLx
239 jMin = 1-OLy
240 jMax = sNy+OLy
241
242 C-- Start of k loop for horizontal fluxes
243 DO k=1,Nr
244 #ifdef ALLOW_AUTODIFF_TAMC
245 kkey = (igadkey-1)*Nr + k
246 CADJ STORE tracer(:,:,k,bi,bj) =
247 CADJ & comlev1_bibj_k_gad, key=kkey, byte=isbyte
248 #endif /* ALLOW_AUTODIFF_TAMC */
249
250 C-- Get temporary terms used by tendency routines
251 CALL CALC_COMMON_FACTORS (
252 I uVel, vVel,
253 O uFld, vFld, uTrans, vTrans, xA, yA,
254 I k,bi,bj, myThid )
255
256 #ifdef ALLOW_GMREDI
257 C-- Residual transp = Bolus transp + Eulerian transp
258 IF (useGMRedi)
259 & CALL GMREDI_CALC_UVFLOW(
260 U uFld, vFld, uTrans, vTrans,
261 I k, bi, bj, myThid )
262 #endif /* ALLOW_GMREDI */
263
264 C-- Make local copy of tracer array and mask West & South
265 DO j=1-OLy,sNy+OLy
266 DO i=1-OLx,sNx+OLx
267 localTij(i,j)=tracer(i,j,k,bi,bj)
268 maskLocW(i,j)=maskW(i,j,k,bi,bj)
269 maskLocS(i,j)=maskS(i,j,k,bi,bj)
270 ENDDO
271 ENDDO
272
273 #ifndef ALLOW_AUTODIFF_TAMC
274 IF (useCubedSphereExchange) THEN
275 withSigns = .FALSE.
276 CALL FILL_CS_CORNER_UV_RS(
277 & withSigns, maskLocW,maskLocS, bi,bj, myThid )
278 ENDIF
279 #endif
280
281 C-- Multiple passes for different directions on different tiles
282 C-- For cube need one pass for each of red, green and blue axes.
283 DO ipass=1,nipass
284 #ifdef ALLOW_AUTODIFF_TAMC
285 passkey = ipass + (k-1) *maxcube
286 & + (igadkey-1)*maxcube*Nr
287 IF (nipass .GT. maxpass) THEN
288 STOP 'GAD_ADVECTION: nipass > maxcube. check tamc.h'
289 ENDIF
290 #endif /* ALLOW_AUTODIFF_TAMC */
291
292 interiorOnly = .FALSE.
293 overlapOnly = .FALSE.
294 IF (useCubedSphereExchange) THEN
295 #ifdef MULTIDIM_OLD_VERSION
296 C- CubedSphere : pass 3 times, with full update of local tracer field
297 IF (ipass.EQ.1) THEN
298 calc_fluxes_X = nCFace.EQ.1 .OR. nCFace.EQ.2
299 calc_fluxes_Y = nCFace.EQ.4 .OR. nCFace.EQ.5
300 ELSEIF (ipass.EQ.2) THEN
301 calc_fluxes_X = nCFace.EQ.3 .OR. nCFace.EQ.4
302 calc_fluxes_Y = nCFace.EQ.6 .OR. nCFace.EQ.1
303 #else /* MULTIDIM_OLD_VERSION */
304 C- CubedSphere : pass 3 times, with partial update of local tracer field
305 IF (ipass.EQ.1) THEN
306 overlapOnly = MOD(nCFace,3).EQ.0
307 interiorOnly = MOD(nCFace,3).NE.0
308 calc_fluxes_X = nCFace.EQ.6 .OR. nCFace.EQ.1 .OR. nCFace.EQ.2
309 calc_fluxes_Y = nCFace.EQ.3 .OR. nCFace.EQ.4 .OR. nCFace.EQ.5
310 ELSEIF (ipass.EQ.2) THEN
311 overlapOnly = MOD(nCFace,3).EQ.2
312 calc_fluxes_X = nCFace.EQ.2 .OR. nCFace.EQ.3 .OR. nCFace.EQ.4
313 calc_fluxes_Y = nCFace.EQ.5 .OR. nCFace.EQ.6 .OR. nCFace.EQ.1
314 #endif /* MULTIDIM_OLD_VERSION */
315 ELSE
316 calc_fluxes_X = nCFace.EQ.5 .OR. nCFace.EQ.6
317 calc_fluxes_Y = nCFace.EQ.2 .OR. nCFace.EQ.3
318 ENDIF
319 ELSE
320 C- not CubedSphere
321 calc_fluxes_X = MOD(ipass,2).EQ.1
322 calc_fluxes_Y = .NOT.calc_fluxes_X
323 ENDIF
324
325 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
326 C-- X direction
327 C- Advective flux in X
328 DO j=1-Oly,sNy+Oly
329 DO i=1-Olx,sNx+Olx
330 af(i,j) = 0.
331 ENDDO
332 ENDDO
333 C
334 #ifdef ALLOW_AUTODIFF_TAMC
335 # ifndef DISABLE_MULTIDIM_ADVECTION
336 CADJ STORE localTij(:,:) =
337 CADJ & comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
338 CADJ STORE af(:,:) =
339 CADJ & comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
340 # endif
341 #endif /* ALLOW_AUTODIFF_TAMC */
342 C
343 IF (calc_fluxes_X) THEN
344
345 C- Do not compute fluxes if
346 C a) needed in overlap only
347 C and b) the overlap of myTile are not cube-face Edges
348 IF ( .NOT.overlapOnly .OR. N_edge .OR. S_edge ) THEN
349
350 #ifndef ALLOW_AUTODIFF_TAMC
351 C- Internal exchange for calculations in X
352 #ifdef MULTIDIM_OLD_VERSION
353 IF ( useCubedSphereExchange ) THEN
354 #else
355 IF ( useCubedSphereExchange .AND.
356 & ( overlapOnly .OR. ipass.EQ.1 ) ) THEN
357 #endif
358 CALL FILL_CS_CORNER_TR_RL( .TRUE., localTij, bi,bj, myThid )
359 ENDIF
360 #endif
361
362 #ifdef ALLOW_AUTODIFF_TAMC
363 # ifndef DISABLE_MULTIDIM_ADVECTION
364 CADJ STORE localTij(:,:) =
365 CADJ & comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
366 # endif
367 #endif /* ALLOW_AUTODIFF_TAMC */
368
369 IF ( advectionScheme.EQ.ENUM_UPWIND_1RST
370 & .OR. advectionScheme.EQ.ENUM_DST2 ) THEN
371 CALL GAD_DST2U1_ADV_X( bi,bj,k, advectionScheme,
372 I dTtracerLev(k),uTrans,uFld,localTij,
373 O af, myThid )
374 ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
375 CALL GAD_FLUXLIMIT_ADV_X( bi,bj,k, dTtracerLev(k),
376 I uTrans, uFld, maskLocW, localTij,
377 O af, myThid )
378 ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
379 CALL GAD_DST3_ADV_X( bi,bj,k, dTtracerLev(k),
380 I uTrans, uFld, maskLocW, localTij,
381 O af, myThid )
382 ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
383 CALL GAD_DST3FL_ADV_X( bi,bj,k, dTtracerLev(k),
384 I uTrans, uFld, maskLocW, localTij,
385 O af, myThid )
386 ELSEIF (advectionScheme.EQ.ENUM_OS7MP ) THEN
387 CALL GAD_OS7MP_ADV_X( bi,bj,k, dTtracerLev(k),
388 I uTrans, uFld, maskLocW, localTij,
389 O af, myThid )
390 ELSE
391 STOP 'GAD_ADVECTION: adv. scheme incompatibale with multi-dim'
392 ENDIF
393
394 C- Advective flux in X : done
395 ENDIF
396
397 #ifndef ALLOW_AUTODIFF_TAMC
398 C- Internal exchange for next calculations in Y
399 IF ( overlapOnly .AND. ipass.EQ.1 ) THEN
400 CALL FILL_CS_CORNER_TR_RL(.FALSE., localTij, bi,bj, myThid )
401 ENDIF
402 #endif
403
404 C- Update the local tracer field where needed:
405
406 C update in overlap-Only
407 IF ( overlapOnly ) THEN
408 iMinUpd = 1-Olx+1
409 iMaxUpd = sNx+Olx-1
410 C- notes: these 2 lines below have no real effect (because recip_hFac=0
411 C in corner region) but safer to keep them.
412 IF ( W_edge ) iMinUpd = 1
413 IF ( E_edge ) iMaxUpd = sNx
414
415 IF ( S_edge ) THEN
416 DO j=1-Oly,0
417 DO i=iMinUpd,iMaxUpd
418 localTij(i,j) = localTij(i,j)
419 & -dTtracerLev(k)*recip_rhoFacC(k)
420 & *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
421 & *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
422 & *( af(i+1,j)-af(i,j)
423 & -tracer(i,j,k,bi,bj)*(uTrans(i+1,j)-uTrans(i,j))
424 & )
425 ENDDO
426 ENDDO
427 ENDIF
428 IF ( N_edge ) THEN
429 DO j=sNy+1,sNy+Oly
430 DO i=iMinUpd,iMaxUpd
431 localTij(i,j) = localTij(i,j)
432 & -dTtracerLev(k)*recip_rhoFacC(k)
433 & *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
434 & *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
435 & *( af(i+1,j)-af(i,j)
436 & -tracer(i,j,k,bi,bj)*(uTrans(i+1,j)-uTrans(i,j))
437 & )
438 ENDDO
439 ENDDO
440 ENDIF
441
442 ELSE
443 C do not only update the overlap
444 jMinUpd = 1-Oly
445 jMaxUpd = sNy+Oly
446 IF ( interiorOnly .AND. S_edge ) jMinUpd = 1
447 IF ( interiorOnly .AND. N_edge ) jMaxUpd = sNy
448 DO j=jMinUpd,jMaxUpd
449 DO i=1-Olx+1,sNx+Olx-1
450 localTij(i,j) = localTij(i,j)
451 & -dTtracerLev(k)*recip_rhoFacC(k)
452 & *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
453 & *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
454 & *( af(i+1,j)-af(i,j)
455 & -tracer(i,j,k,bi,bj)*(uTrans(i+1,j)-uTrans(i,j))
456 & )
457 ENDDO
458 ENDDO
459 C- keep advective flux (for diagnostics)
460 DO j=1-Oly,sNy+Oly
461 DO i=1-Olx,sNx+Olx
462 afx(i,j) = af(i,j)
463 ENDDO
464 ENDDO
465
466 #ifdef ALLOW_OBCS
467 C- Apply open boundary conditions
468 IF ( useOBCS ) THEN
469 IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
470 CALL OBCS_APPLY_TLOC( bi, bj, k, localTij, myThid )
471 ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
472 CALL OBCS_APPLY_SLOC( bi, bj, k, localTij, myThid )
473 #ifdef ALLOW_PTRACERS
474 ELSEIF (tracerIdentity.GE.GAD_TR1) THEN
475 CALL OBCS_APPLY_PTRACER( bi, bj, k,
476 & tracerIdentity-GAD_TR1+1, localTij, myThid )
477 #endif /* ALLOW_PTRACERS */
478 ENDIF
479 ENDIF
480 #endif /* ALLOW_OBCS */
481
482 C- end if/else update overlap-Only
483 ENDIF
484
485 C-- End of X direction
486 ENDIF
487
488 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
489 C-- Y direction
490 cph-test
491 C- Advective flux in Y
492 DO j=1-Oly,sNy+Oly
493 DO i=1-Olx,sNx+Olx
494 af(i,j) = 0.
495 ENDDO
496 ENDDO
497 C
498 #ifdef ALLOW_AUTODIFF_TAMC
499 # ifndef DISABLE_MULTIDIM_ADVECTION
500 CADJ STORE localTij(:,:) =
501 CADJ & comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
502 CADJ STORE af(:,:) =
503 CADJ & comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
504 # endif
505 #endif /* ALLOW_AUTODIFF_TAMC */
506 C
507 IF (calc_fluxes_Y) THEN
508
509 C- Do not compute fluxes if
510 C a) needed in overlap only
511 C and b) the overlap of myTile are not cube-face edges
512 IF ( .NOT.overlapOnly .OR. E_edge .OR. W_edge ) THEN
513
514 #ifndef ALLOW_AUTODIFF_TAMC
515 C- Internal exchange for calculations in Y
516 #ifdef MULTIDIM_OLD_VERSION
517 IF ( useCubedSphereExchange ) THEN
518 #else
519 IF ( useCubedSphereExchange .AND.
520 & ( overlapOnly .OR. ipass.EQ.1 ) ) THEN
521 #endif
522 CALL FILL_CS_CORNER_TR_RL(.FALSE., localTij, bi,bj, myThid )
523 ENDIF
524 #endif
525
526 C- Advective flux in Y
527 DO j=1-Oly,sNy+Oly
528 DO i=1-Olx,sNx+Olx
529 af(i,j) = 0.
530 ENDDO
531 ENDDO
532
533 #ifdef ALLOW_AUTODIFF_TAMC
534 #ifndef DISABLE_MULTIDIM_ADVECTION
535 CADJ STORE localTij(:,:) =
536 CADJ & comlev1_bibj_k_gad_pass, key=passkey, byte=isbyte
537 #endif
538 #endif /* ALLOW_AUTODIFF_TAMC */
539
540 IF ( advectionScheme.EQ.ENUM_UPWIND_1RST
541 & .OR. advectionScheme.EQ.ENUM_DST2 ) THEN
542 CALL GAD_DST2U1_ADV_Y( bi,bj,k, advectionScheme,
543 I dTtracerLev(k),vTrans,vFld,localTij,
544 O af, myThid )
545 ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN
546 CALL GAD_FLUXLIMIT_ADV_Y( bi,bj,k, dTtracerLev(k),
547 I vTrans, vFld, maskLocS, localTij,
548 O af, myThid )
549 ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN
550 CALL GAD_DST3_ADV_Y( bi,bj,k, dTtracerLev(k),
551 I vTrans, vFld, maskLocS, localTij,
552 O af, myThid )
553 ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
554 CALL GAD_DST3FL_ADV_Y( bi,bj,k, dTtracerLev(k),
555 I vTrans, vFld, maskLocS, localTij,
556 O af, myThid )
557 ELSEIF (advectionScheme.EQ.ENUM_OS7MP ) THEN
558 CALL GAD_OS7MP_ADV_Y( bi,bj,k, dTtracerLev(k),
559 I vTrans, vFld, maskLocS, localTij,
560 O af, myThid )
561 ELSE
562 STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
563 ENDIF
564
565 C- Advective flux in Y : done
566 ENDIF
567
568 #ifndef ALLOW_AUTODIFF_TAMC
569 C- Internal exchange for next calculations in X
570 IF ( overlapOnly .AND. ipass.EQ.1 ) THEN
571 CALL FILL_CS_CORNER_TR_RL( .TRUE., localTij, bi,bj, myThid )
572 ENDIF
573 #endif
574
575 C- Update the local tracer field where needed:
576
577 C update in overlap-Only
578 IF ( overlapOnly ) THEN
579 jMinUpd = 1-Oly+1
580 jMaxUpd = sNy+Oly-1
581 C- notes: these 2 lines below have no real effect (because recip_hFac=0
582 C in corner region) but safer to keep them.
583 IF ( S_edge ) jMinUpd = 1
584 IF ( N_edge ) jMaxUpd = sNy
585
586 IF ( W_edge ) THEN
587 DO j=jMinUpd,jMaxUpd
588 DO i=1-Olx,0
589 localTij(i,j) = localTij(i,j)
590 & -dTtracerLev(k)*recip_rhoFacC(k)
591 & *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
592 & *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
593 & *( af(i,j+1)-af(i,j)
594 & -tracer(i,j,k,bi,bj)*(vTrans(i,j+1)-vTrans(i,j))
595 & )
596 ENDDO
597 ENDDO
598 ENDIF
599 IF ( E_edge ) THEN
600 DO j=jMinUpd,jMaxUpd
601 DO i=sNx+1,sNx+Olx
602 localTij(i,j) = localTij(i,j)
603 & -dTtracerLev(k)*recip_rhoFacC(k)
604 & *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
605 & *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
606 & *( af(i,j+1)-af(i,j)
607 & -tracer(i,j,k,bi,bj)*(vTrans(i,j+1)-vTrans(i,j))
608 & )
609 ENDDO
610 ENDDO
611 ENDIF
612
613 ELSE
614 C do not only update the overlap
615 iMinUpd = 1-Olx
616 iMaxUpd = sNx+Olx
617 IF ( interiorOnly .AND. W_edge ) iMinUpd = 1
618 IF ( interiorOnly .AND. E_edge ) iMaxUpd = sNx
619 DO j=1-Oly+1,sNy+Oly-1
620 DO i=iMinUpd,iMaxUpd
621 localTij(i,j) = localTij(i,j)
622 & -dTtracerLev(k)*recip_rhoFacC(k)
623 & *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
624 & *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
625 & *( af(i,j+1)-af(i,j)
626 & -tracer(i,j,k,bi,bj)*(vTrans(i,j+1)-vTrans(i,j))
627 & )
628 ENDDO
629 ENDDO
630 C- keep advective flux (for diagnostics)
631 DO j=1-Oly,sNy+Oly
632 DO i=1-Olx,sNx+Olx
633 afy(i,j) = af(i,j)
634 ENDDO
635 ENDDO
636
637 #ifdef ALLOW_OBCS
638 C- Apply open boundary conditions
639 IF (useOBCS) THEN
640 IF (tracerIdentity.EQ.GAD_TEMPERATURE) THEN
641 CALL OBCS_APPLY_TLOC( bi, bj, k, localTij, myThid )
642 ELSEIF (tracerIdentity.EQ.GAD_SALINITY) THEN
643 CALL OBCS_APPLY_SLOC( bi, bj, k, localTij, myThid )
644 #ifdef ALLOW_PTRACERS
645 ELSEIF (tracerIdentity.GE.GAD_TR1) THEN
646 CALL OBCS_APPLY_PTRACER( bi, bj, k,
647 & tracerIdentity-GAD_TR1+1, localTij, myThid )
648 #endif /* ALLOW_PTRACERS */
649 ENDIF
650 ENDIF
651 #endif /* ALLOW_OBCS */
652
653 C end if/else update overlap-Only
654 ENDIF
655
656 C-- End of Y direction
657 ENDIF
658
659 C-- End of ipass loop
660 ENDDO
661
662 IF ( implicitAdvection ) THEN
663 C- explicit advection is done ; store tendency in gTracer:
664 DO j=1-Oly,sNy+Oly
665 DO i=1-Olx,sNx+Olx
666 gTracer(i,j,k,bi,bj)=
667 & (localTij(i,j)-tracer(i,j,k,bi,bj))/dTtracerLev(k)
668 ENDDO
669 ENDDO
670 ELSE
671 C- horizontal advection done; store intermediate result in 3D array:
672 DO j=1-Oly,sNy+Oly
673 DO i=1-Olx,sNx+Olx
674 localTijk(i,j,k)=localTij(i,j)
675 ENDDO
676 ENDDO
677 ENDIF
678
679 #ifdef ALLOW_DIAGNOSTICS
680 IF ( useDiagnostics ) THEN
681 diagName = 'ADVx'//diagSufx
682 CALL DIAGNOSTICS_FILL(afx,diagName, k,1, 2,bi,bj, myThid)
683 diagName = 'ADVy'//diagSufx
684 CALL DIAGNOSTICS_FILL(afy,diagName, k,1, 2,bi,bj, myThid)
685 ENDIF
686 #endif
687
688 #ifdef ALLOW_DEBUG
689 IF ( debugLevel .GE. debLevB
690 & .AND. tracerIdentity.EQ.GAD_TEMPERATURE
691 & .AND. k.LE.3 .AND. myIter.EQ.1+nIter0
692 & .AND. nPx.EQ.1 .AND. nPy.EQ.1
693 & .AND. useCubedSphereExchange ) THEN
694 CALL DEBUG_CS_CORNER_UV( ' afx,afy from GAD_ADVECTION',
695 & afx,afy, k, standardMessageUnit,bi,bj,myThid )
696 ENDIF
697 #endif /* ALLOW_DEBUG */
698
699 C-- End of K loop for horizontal fluxes
700 ENDDO
701
702 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
703
704 IF ( .NOT.implicitAdvection ) THEN
705 C-- Start of k loop for vertical flux
706 DO k=Nr,1,-1
707 #ifdef ALLOW_AUTODIFF_TAMC
708 kkey = (igadkey-1)*Nr + k
709 #endif /* ALLOW_AUTODIFF_TAMC */
710 C-- kUp Cycles through 1,2 to point to w-layer above
711 C-- kDown Cycles through 2,1 to point to w-layer below
712 kUp = 1+MOD(k+1,2)
713 kDown= 1+MOD(k,2)
714 c kp1=min(Nr,k+1)
715 kp1Msk=1.
716 if (k.EQ.Nr) kp1Msk=0.
717
718 C-- Compute Vertical transport
719 #ifdef ALLOW_AIM
720 C- a hack to prevent Water-Vapor vert.transport into the stratospheric level Nr
721 IF ( k.EQ.1 .OR.
722 & (useAIM .AND. tracerIdentity.EQ.GAD_SALINITY .AND. k.EQ.Nr)
723 & ) THEN
724 #else
725 IF ( k.EQ.1 ) THEN
726 #endif
727
728 #ifdef ALLOW_AUTODIFF_TAMC
729 CADJ STORE rtrans(:,:) =
730 CADJ & comlev1_bibj_k_gad, key=kkey, byte=isbyte
731 CADJ STORE wfld(:,:) =
732 CADJ & comlev1_bibj_k_gad, key=kkey, byte=isbyte
733 #endif /* ALLOW_AUTODIFF_TAMC */
734
735 C- Surface interface :
736 DO j=1-Oly,sNy+Oly
737 DO i=1-Olx,sNx+Olx
738 rTransKp1(i,j) = kp1Msk*rTrans(i,j)
739 wFld(i,j) = 0.
740 rTrans(i,j) = 0.
741 fVerT(i,j,kUp) = 0.
742 ENDDO
743 ENDDO
744
745 ELSE
746
747 #ifdef ALLOW_AUTODIFF_TAMC
748 CADJ STORE rtrans(:,:) =
749 CADJ & comlev1_bibj_k_gad, key=kkey, byte=isbyte
750 CADJ STORE wfld(:,:) =
751 CADJ & comlev1_bibj_k_gad, key=kkey, byte=isbyte
752 #endif /* ALLOW_AUTODIFF_TAMC */
753
754 C- Interior interface :
755 DO j=1-Oly,sNy+Oly
756 DO i=1-Olx,sNx+Olx
757 rTransKp1(i,j) = kp1Msk*rTrans(i,j)
758 wFld(i,j) = wVel(i,j,k,bi,bj)
759 rTrans(i,j) = wVel(i,j,k,bi,bj)*rA(i,j,bi,bj)
760 & *deepFac2F(k)*rhoFacF(k)
761 & *maskC(i,j,k-1,bi,bj)
762 fVerT(i,j,kUp) = 0.
763 ENDDO
764 ENDDO
765
766 #ifdef ALLOW_GMREDI
767 C-- Residual transp = Bolus transp + Eulerian transp
768 IF (useGMRedi)
769 & CALL GMREDI_CALC_WFLOW(
770 U wFld, rTrans,
771 I k, bi, bj, myThid )
772 #endif /* ALLOW_GMREDI */
773
774 #ifdef ALLOW_AUTODIFF_TAMC
775 CADJ STORE localTijk(:,:,k)
776 CADJ & = comlev1_bibj_k_gad, key=kkey, byte=isbyte
777 CADJ STORE rTrans(:,:)
778 CADJ & = comlev1_bibj_k_gad, key=kkey, byte=isbyte
779 #endif /* ALLOW_AUTODIFF_TAMC */
780
781 C- Compute vertical advective flux in the interior:
782 IF ( vertAdvecScheme.EQ.ENUM_UPWIND_1RST
783 & .OR. vertAdvecScheme.EQ.ENUM_DST2 ) THEN
784 CALL GAD_DST2U1_ADV_R( bi,bj,k, advectionScheme,
785 I dTtracerLev(k),rTrans,wFld,localTijk,
786 O fVerT(1-Olx,1-Oly,kUp), myThid )
787 ELSEIF( vertAdvecScheme.EQ.ENUM_FLUX_LIMIT) THEN
788 CALL GAD_FLUXLIMIT_ADV_R( bi,bj,k, dTtracerLev(k),
789 I rTrans, wFld, localTijk,
790 O fVerT(1-Olx,1-Oly,kUp), myThid )
791 ELSEIF( vertAdvecScheme.EQ.ENUM_DST3 ) THEN
792 CALL GAD_DST3_ADV_R( bi,bj,k, dTtracerLev(k),
793 I rTrans, wFld, localTijk,
794 O fVerT(1-Olx,1-Oly,kUp), myThid )
795 ELSEIF( vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN
796 CALL GAD_DST3FL_ADV_R( bi,bj,k, dTtracerLev(k),
797 I rTrans, wFld, localTijk,
798 O fVerT(1-Olx,1-Oly,kUp), myThid )
799 ELSEIF (vertAdvecScheme.EQ.ENUM_OS7MP ) THEN
800 CALL GAD_OS7MP_ADV_R( bi,bj,k, dTtracerLev(k),
801 I rTrans, wFld, localTijk,
802 O fVerT(1-Olx,1-Oly,kUp), myThid )
803 ELSE
804 STOP 'GAD_ADVECTION: adv. scheme incompatibale with mutli-dim'
805 ENDIF
806
807 C- end Surface/Interior if bloc
808 ENDIF
809
810 #ifdef ALLOW_AUTODIFF_TAMC
811 CADJ STORE rTrans(:,:)
812 CADJ & = comlev1_bibj_k_gad, key=kkey, byte=isbyte
813 CADJ STORE rTranskp1(:,:)
814 CADJ & = comlev1_bibj_k_gad, key=kkey, byte=isbyte
815 #endif /* ALLOW_AUTODIFF_TAMC */
816
817 C-- Divergence of vertical fluxes
818 DO j=1-Oly,sNy+Oly
819 DO i=1-Olx,sNx+Olx
820 localTij(i,j) = localTijk(i,j,k)
821 & -dTtracerLev(k)*recip_rhoFacC(k)
822 & *_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
823 & *recip_rA(i,j,bi,bj)*recip_deepFac2C(k)
824 & *( fVerT(i,j,kDown)-fVerT(i,j,kUp)
825 & -tracer(i,j,k,bi,bj)*(rTransKp1(i,j)-rTrans(i,j))
826 & )*rkSign
827 gTracer(i,j,k,bi,bj)=
828 & (localTij(i,j)-tracer(i,j,k,bi,bj))/dTtracerLev(k)
829 ENDDO
830 ENDDO
831
832 #ifdef ALLOW_DIAGNOSTICS
833 IF ( useDiagnostics ) THEN
834 diagName = 'ADVr'//diagSufx
835 CALL DIAGNOSTICS_FILL( fVerT(1-Olx,1-Oly,kUp),
836 & diagName, k,1, 2,bi,bj, myThid)
837 ENDIF
838 #endif
839
840 C-- End of K loop for vertical flux
841 ENDDO
842 C-- end of if not.implicitAdvection block
843 ENDIF
844
845 RETURN
846 END

  ViewVC Help
Powered by ViewVC 1.1.22