9 |
C !INTERFACE: ========================================================== |
C !INTERFACE: ========================================================== |
10 |
SUBROUTINE GAD_CALC_RHS( |
SUBROUTINE GAD_CALC_RHS( |
11 |
I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown, |
I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown, |
12 |
I xA,yA,uTrans,vTrans,rTrans,maskUp, |
I xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp, |
13 |
|
I uVel, vVel, wVel, |
14 |
I diffKh, diffK4, KappaRT, Tracer, |
I diffKh, diffK4, KappaRT, Tracer, |
15 |
I tracerIdentity, advectionScheme, calcAdvection, |
I tracerIdentity, advectionScheme, vertAdvecScheme, |
16 |
|
I calcAdvection, implicitAdvection, |
17 |
U fVerT, gTracer, |
U fVerT, gTracer, |
18 |
I myThid ) |
I myThid ) |
19 |
|
|
42 |
#include "EEPARAMS.h" |
#include "EEPARAMS.h" |
43 |
#include "PARAMS.h" |
#include "PARAMS.h" |
44 |
#include "GRID.h" |
#include "GRID.h" |
|
#include "DYNVARS.h" |
|
45 |
#include "SURFACE.h" |
#include "SURFACE.h" |
46 |
#include "GAD.h" |
#include "GAD.h" |
47 |
|
|
51 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
#endif /* ALLOW_AUTODIFF_TAMC */ |
52 |
|
|
53 |
C !INPUT PARAMETERS: =================================================== |
C !INPUT PARAMETERS: =================================================== |
54 |
C bi,bj :: tile indices |
C bi,bj :: tile indices |
55 |
C iMin,iMax,jMin,jMax :: loop range for called routines |
C iMin,iMax :: loop range for called routines |
56 |
C kup :: index into 2 1/2D array, toggles between 1 and 2 |
C jMin,jMax :: loop range for called routines |
57 |
C kdown :: index into 2 1/2D array, toggles between 2 and 1 |
C kup :: index into 2 1/2D array, toggles between 1|2 |
58 |
C kp1 :: =k+1 for k<Nr, =Nr for k=Nr |
C kdown :: index into 2 1/2D array, toggles between 2|1 |
59 |
C xA,yA :: areas of X and Y face of tracer cells |
C kp1 :: =k+1 for k<Nr, =Nr for k=Nr |
60 |
C uTrans,vTrans,rTrans :: 2-D arrays of volume transports at U,V and W points |
C xA,yA :: areas of X and Y face of tracer cells |
61 |
C maskUp :: 2-D array for mask at W points |
C uTrans,vTrans :: 2-D arrays of volume transports at U,V points |
62 |
C diffKh :: horizontal diffusion coefficient |
C rTrans :: 2-D arrays of volume transports at W points |
63 |
C diffK4 :: bi-harmonic diffusion coefficient |
C rTransKp1 :: 2-D array of volume trans at W pts, interf k+1 |
64 |
C KappaRT :: 3-D array for vertical diffusion coefficient |
C maskUp :: 2-D array for mask at W points |
65 |
C Tracer :: tracer field |
C uVel,vVel,wVel :: 3 components of the velcity field (3-D array) |
66 |
C tracerIdentity :: identifier for the tracer (required only for KPP) |
C diffKh :: horizontal diffusion coefficient |
67 |
C advectionScheme :: advection scheme to use |
C diffK4 :: bi-harmonic diffusion coefficient |
68 |
C calcAdvection :: =False if Advec terms computed with multiDim scheme |
C KappaRT :: 3-D array for vertical diffusion coefficient |
69 |
C myThid :: thread number |
C Tracer :: tracer field |
70 |
|
C tracerIdentity :: tracer identifier (required for KPP,GM) |
71 |
|
C advectionScheme :: advection scheme to use (Horizontal plane) |
72 |
|
C vertAdvecScheme :: advection scheme to use (Vertical direction) |
73 |
|
C calcAdvection :: =False if Advec computed with multiDim scheme |
74 |
|
C implicitAdvection:: =True if vertical Advec computed implicitly |
75 |
|
C myThid :: thread number |
76 |
INTEGER bi,bj,iMin,iMax,jMin,jMax |
INTEGER bi,bj,iMin,iMax,jMin,jMax |
77 |
INTEGER k,kUp,kDown,kM1 |
INTEGER k,kUp,kDown,kM1 |
78 |
_RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
80 |
_RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
81 |
_RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
82 |
_RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
83 |
|
_RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
84 |
_RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
85 |
|
_RL uVel (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
86 |
|
_RL vVel (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
87 |
|
_RL wVel (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
88 |
_RL diffKh, diffK4 |
_RL diffKh, diffK4 |
89 |
_RL KappaRT(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
_RL KappaRT(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
90 |
_RL Tracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
_RL Tracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
91 |
INTEGER tracerIdentity |
INTEGER tracerIdentity |
92 |
INTEGER advectionScheme |
INTEGER advectionScheme, vertAdvecScheme |
93 |
LOGICAL calcAdvection |
LOGICAL calcAdvection |
94 |
|
LOGICAL implicitAdvection |
95 |
INTEGER myThid |
INTEGER myThid |
96 |
|
|
97 |
C !OUTPUT PARAMETERS: ================================================== |
C !OUTPUT PARAMETERS: ================================================== |
98 |
C gTracer :: tendancy array |
C gTracer :: tendancy array |
99 |
C fVerT :: 2 1/2D arrays for vertical advective flux |
C fVerT :: 2 1/2D arrays for vertical advective flux |
100 |
_RL gTracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
_RL gTracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
101 |
_RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
_RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
102 |
|
|
103 |
C !LOCAL VARIABLES: ==================================================== |
C !LOCAL VARIABLES: ==================================================== |
104 |
C i,j :: loop indices |
C i,j :: loop indices |
105 |
C df4 :: used for storing del^2 T for bi-harmonic term |
C df4 :: used for storing del^2 T for bi-harmonic term |
106 |
C fZon :: zonal flux |
C fZon :: zonal flux |
107 |
C fmer :: meridional flux |
C fmer :: meridional flux |
108 |
C af :: advective flux |
C af :: advective flux |
109 |
C df :: diffusive flux |
C df :: diffusive flux |
110 |
C localT :: local copy of tracer field |
C localT :: local copy of tracer field |
111 |
INTEGER i,j |
INTEGER i,j |
112 |
_RL df4 (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL df4 (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
113 |
_RL fZon (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL fZon (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
115 |
_RL af (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL af (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
116 |
_RL df (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL df (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
117 |
_RL localT(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL localT(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
118 |
|
_RL advFac, rAdvFac |
119 |
CEOP |
CEOP |
120 |
|
|
121 |
#ifdef ALLOW_AUTODIFF_TAMC |
#ifdef ALLOW_AUTODIFF_TAMC |
124 |
fVerT(1,1,kDown) = fVerT(1,1,kDown) |
fVerT(1,1,kDown) = fVerT(1,1,kDown) |
125 |
#endif |
#endif |
126 |
|
|
127 |
|
advFac = 0. _d 0 |
128 |
|
IF (calcAdvection) advFac = 1. _d 0 |
129 |
|
rAdvFac = rkFac*advFac |
130 |
|
IF (implicitAdvection) rAdvFac = 0. _d 0 |
131 |
|
|
132 |
DO j=1-OLy,sNy+OLy |
DO j=1-OLy,sNy+OLy |
133 |
DO i=1-OLx,sNx+OLx |
DO i=1-OLx,sNx+OLx |
134 |
fZon(i,j) = 0. _d 0 |
fZon(i,j) = 0. _d 0 |
136 |
fVerT(i,j,kUp) = 0. _d 0 |
fVerT(i,j,kUp) = 0. _d 0 |
137 |
df(i,j) = 0. _d 0 |
df(i,j) = 0. _d 0 |
138 |
df4(i,j) = 0. _d 0 |
df4(i,j) = 0. _d 0 |
|
localT(i,j) = 0. _d 0 |
|
139 |
ENDDO |
ENDDO |
140 |
ENDDO |
ENDDO |
141 |
|
|
148 |
|
|
149 |
C-- Unless we have already calculated the advection terms we initialize |
C-- Unless we have already calculated the advection terms we initialize |
150 |
C the tendency to zero. |
C the tendency to zero. |
151 |
IF (calcAdvection) THEN |
C <== now done earlier at the beginning of thermodynamics. |
152 |
DO j=1-Oly,sNy+Oly |
c IF (calcAdvection) THEN |
153 |
DO i=1-Olx,sNx+Olx |
c DO j=1-Oly,sNy+Oly |
154 |
gTracer(i,j,k,bi,bj)=0. _d 0 |
c DO i=1-Olx,sNx+Olx |
155 |
ENDDO |
c gTracer(i,j,k,bi,bj)=0. _d 0 |
156 |
ENDDO |
c ENDDO |
157 |
ENDIF |
c ENDDO |
158 |
|
c ENDIF |
159 |
|
|
160 |
C-- Pre-calculate del^2 T if bi-harmonic coefficient is non-zero |
C-- Pre-calculate del^2 T if bi-harmonic coefficient is non-zero |
161 |
IF (diffK4 .NE. 0.) THEN |
IF (diffK4 .NE. 0.) THEN |
308 |
ENDDO |
ENDDO |
309 |
ENDIF |
ENDIF |
310 |
|
|
|
#ifdef NONLIN_FRSURF |
|
|
C-- Compute vertical flux fVerT(kDown) at interface k+1 (between k & k+1): |
|
|
IF ( calcAdvection .AND. K.EQ.Nr .AND. |
|
|
& useRealFreshWaterFlux .AND. |
|
|
& buoyancyRelation .EQ. 'OCEANICP' ) THEN |
|
|
DO j=1-Oly,sNy+Oly |
|
|
DO i=1-Olx,sNx+Olx |
|
|
fVerT(i,j,kDown) = convertEmP2rUnit*PmEpR(i,j,bi,bj) |
|
|
& *rA(i,j,bi,bj)*maskC(i,j,k,bi,bj)*Tracer(i,j,k,bi,bj) |
|
|
ENDDO |
|
|
ENDDO |
|
|
ENDIF |
|
|
#endif /* NONLIN_FRSURF */ |
|
|
|
|
311 |
C-- Compute vertical flux fVerT(kUp) at interface k (between k-1 & k): |
C-- Compute vertical flux fVerT(kUp) at interface k (between k-1 & k): |
312 |
C- Advective flux in R |
C- Advective flux in R |
313 |
IF (calcAdvection) THEN |
#ifdef ALLOW_AIM |
314 |
C Note: wVel needs to be masked |
C- a hack to prevent Water-Vapor vert.transport into the stratospheric level Nr |
315 |
IF (K.GE.2) THEN |
IF (calcAdvection .AND. .NOT.implicitAdvection .AND. K.GE.2 .AND. |
316 |
|
& (.NOT.useAIM .OR.tracerIdentity.NE.GAD_SALINITY .OR.K.LT.Nr) |
317 |
|
& ) THEN |
318 |
|
#else |
319 |
|
IF (calcAdvection .AND. .NOT.implicitAdvection .AND. K.GE.2) THEN |
320 |
|
#endif |
321 |
C- Compute vertical advective flux in the interior: |
C- Compute vertical advective flux in the interior: |
322 |
IF (advectionScheme.EQ.ENUM_CENTERED_2ND) THEN |
IF (vertAdvecScheme.EQ.ENUM_CENTERED_2ND) THEN |
323 |
CALL GAD_C2_ADV_R(bi,bj,k,rTrans,tracer,af,myThid) |
CALL GAD_C2_ADV_R(bi,bj,k,rTrans,tracer,af,myThid) |
324 |
ELSEIF (advectionScheme.EQ.ENUM_FLUX_LIMIT) THEN |
ELSEIF (vertAdvecScheme.EQ.ENUM_FLUX_LIMIT) THEN |
325 |
CALL GAD_FLUXLIMIT_ADV_R( |
CALL GAD_FLUXLIMIT_ADV_R( |
326 |
& bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid) |
& bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid) |
327 |
ELSEIF (advectionScheme.EQ.ENUM_UPWIND_3RD ) THEN |
ELSEIF (vertAdvecScheme.EQ.ENUM_UPWIND_3RD ) THEN |
328 |
CALL GAD_U3_ADV_R(bi,bj,k,rTrans,tracer,af,myThid) |
CALL GAD_U3_ADV_R(bi,bj,k,rTrans,tracer,af,myThid) |
329 |
ELSEIF (advectionScheme.EQ.ENUM_CENTERED_4TH) THEN |
ELSEIF (vertAdvecScheme.EQ.ENUM_CENTERED_4TH) THEN |
330 |
CALL GAD_C4_ADV_R(bi,bj,k,rTrans,tracer,af,myThid) |
CALL GAD_C4_ADV_R(bi,bj,k,rTrans,tracer,af,myThid) |
331 |
ELSEIF (advectionScheme.EQ.ENUM_DST3 ) THEN |
ELSEIF (vertAdvecScheme.EQ.ENUM_DST3 ) THEN |
332 |
CALL GAD_DST3_ADV_R( |
CALL GAD_DST3_ADV_R( |
333 |
& bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid) |
& bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid) |
334 |
ELSEIF (advectionScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN |
ELSEIF (vertAdvecScheme.EQ.ENUM_DST3_FLUX_LIMIT ) THEN |
335 |
CALL GAD_DST3FL_ADV_R( |
CALL GAD_DST3FL_ADV_R( |
336 |
& bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid) |
& bi,bj,k,deltaTtracer,rTrans,wVel,tracer,af,myThid) |
337 |
ELSE |
ELSE |
338 |
STOP 'GAD_CALC_RHS: Bad advectionScheme (R)' |
STOP 'GAD_CALC_RHS: Bad vertAdvecScheme (R)' |
339 |
ENDIF |
ENDIF |
340 |
C- Surface "correction" term at k>1 : |
C- add the advective flux to fVerT |
|
DO j=1-Oly,sNy+Oly |
|
|
DO i=1-Olx,sNx+Olx |
|
|
af(i,j) = af(i,j) |
|
|
& + (maskC(i,j,k,bi,bj)-maskC(i,j,k-1,bi,bj))* |
|
|
& rTrans(i,j)*Tracer(i,j,k,bi,bj) |
|
|
ENDDO |
|
|
ENDDO |
|
|
ELSE |
|
|
C- Surface "correction" term at k=1 : |
|
341 |
DO j=1-Oly,sNy+Oly |
DO j=1-Oly,sNy+Oly |
342 |
DO i=1-Olx,sNx+Olx |
DO i=1-Olx,sNx+Olx |
343 |
af(i,j) = rTrans(i,j)*Tracer(i,j,k,bi,bj) |
fVerT(i,j,kUp) = fVerT(i,j,kUp) + af(i,j) |
344 |
ENDDO |
ENDDO |
|
ENDDO |
|
|
ENDIF |
|
|
C- add the advective flux to fVerT |
|
|
DO j=1-Oly,sNy+Oly |
|
|
DO i=1-Olx,sNx+Olx |
|
|
fVerT(i,j,kUp) = fVerT(i,j,kUp) + af(i,j) |
|
345 |
ENDDO |
ENDDO |
|
ENDDO |
|
346 |
ENDIF |
ENDIF |
347 |
|
|
348 |
C- Diffusive flux in R |
C- Diffusive flux in R |
395 |
I iMin,iMax,jMin,jMax,bi,bj,k,km1, |
I iMin,iMax,jMin,jMax,bi,bj,k,km1, |
396 |
I KappaRT, |
I KappaRT, |
397 |
U df ) |
U df ) |
398 |
|
#ifdef ALLOW_PTRACERS |
399 |
|
ELSEIF (tracerIdentity .GE. GAD_TR1) THEN |
400 |
|
CALL KPP_TRANSPORT_PTR( |
401 |
|
I iMin,iMax,jMin,jMax,bi,bj,k,km1, |
402 |
|
I tracerIdentity-GAD_TR1+1,KappaRT, |
403 |
|
U df ) |
404 |
|
#endif |
405 |
ELSE |
ELSE |
406 |
|
PRINT*,'invalid tracer indentity: ', tracerIdentity |
407 |
STOP 'GAD_CALC_RHS: Ooops' |
STOP 'GAD_CALC_RHS: Ooops' |
408 |
ENDIF |
ENDIF |
409 |
DO j=1-Oly,sNy+Oly |
DO j=1-Oly,sNy+Oly |
418 |
DO j=1-Oly,sNy+Oly-1 |
DO j=1-Oly,sNy+Oly-1 |
419 |
DO i=1-Olx,sNx+Olx-1 |
DO i=1-Olx,sNx+Olx-1 |
420 |
gTracer(i,j,k,bi,bj)=gTracer(i,j,k,bi,bj) |
gTracer(i,j,k,bi,bj)=gTracer(i,j,k,bi,bj) |
421 |
& -_recip_hFacC(i,j,k,bi,bj)*recip_drF(k) |
& -_recip_hFacC(i,j,k,bi,bj)*recip_drF(k)*recip_rA(i,j,bi,bj) |
422 |
& *recip_rA(i,j,bi,bj) |
& *( (fZon(i+1,j)-fZon(i,j)) |
423 |
& *( |
& +(fMer(i,j+1)-fMer(i,j)) |
424 |
& +( fZon(i+1,j)-fZon(i,j) ) |
& +(fVerT(i,j,kUp)-fVerT(i,j,kDown))*rkFac |
425 |
& +( fMer(i,j+1)-fMer(i,j) ) |
& -localT(i,j)*( (uTrans(i+1,j)-uTrans(i,j)) |
426 |
& +( fVerT(i,j,kUp)-fVerT(i,j,kDown) )*rkFac |
& +(vTrans(i,j+1)-vTrans(i,j)) |
427 |
|
& +(rTrans(i,j)-rTransKp1(i,j))*rAdvFac |
428 |
|
& )*advFac |
429 |
& ) |
& ) |
430 |
ENDDO |
ENDDO |
431 |
ENDDO |
ENDDO |
432 |
|
|
|
#ifdef NONLIN_FRSURF |
|
|
C-- account for 3.D divergence of the flow in rStar coordinate: |
|
|
IF (calcAdvection .AND. select_rStar.GT.0) THEN |
|
|
DO j=1-Oly,sNy+Oly-1 |
|
|
DO i=1-Olx,sNx+Olx-1 |
|
|
gTracer(i,j,k,bi,bj) = gTracer(i,j,k,bi,bj) |
|
|
& - (rStarExpC(i,j,bi,bj) - 1. _d 0)/deltaTfreesurf |
|
|
& *tracer(i,j,k,bi,bj)*maskC(i,j,k,bi,bj) |
|
|
ENDDO |
|
|
ENDDO |
|
|
ENDIF |
|
|
IF (calcAdvection .AND. select_rStar.LT.0) THEN |
|
|
DO j=1-Oly,sNy+Oly-1 |
|
|
DO i=1-Olx,sNx+Olx-1 |
|
|
gTracer(i,j,k,bi,bj) = gTracer(i,j,k,bi,bj) |
|
|
& - rStarDhCDt(i,j,bi,bj) |
|
|
& *tracer(i,j,k,bi,bj)*maskC(i,j,k,bi,bj) |
|
|
ENDDO |
|
|
ENDDO |
|
|
ENDIF |
|
|
#endif /* NONLIN_FRSURF */ |
|
|
|
|
|
|
|
433 |
RETURN |
RETURN |
434 |
END |
END |