1 |
C $Header: /u/gcmpack/MITgcm/pkg/gmredi/gmredi_xtransport.F,v 1.17 2008/05/30 02:50:17 gforget Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#include "GMREDI_OPTIONS.h" |
5 |
|
6 |
SUBROUTINE GMREDI_XTRANSPORT( |
7 |
I iMin,iMax,jMin,jMax,bi,bj,K, |
8 |
I xA,Tracer,tracerIdentity, |
9 |
U df, |
10 |
I myThid) |
11 |
C *==========================================================* |
12 |
C | o SUBROUTINE GMREDI_XTRANSPORT |
13 |
C | Add horizontal x transport terms from GM/Redi |
14 |
C | parameterization. |
15 |
C *==========================================================* |
16 |
IMPLICIT NONE |
17 |
|
18 |
C == GLobal variables == |
19 |
#include "SIZE.h" |
20 |
#include "EEPARAMS.h" |
21 |
#include "PARAMS.h" |
22 |
#include "GRID.h" |
23 |
#include "GMREDI.h" |
24 |
|
25 |
#ifdef ALLOW_AUTODIFF_TAMC |
26 |
# include "tamc.h" |
27 |
# include "tamc_keys.h" |
28 |
# ifdef ALLOW_PTRACERS |
29 |
# include "PTRACERS_SIZE.h" |
30 |
# endif |
31 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
32 |
|
33 |
C == Routine arguments == |
34 |
C iMin,iMax,jMin, - Range of points for which calculation |
35 |
C jMax,bi,bj,k results will be set. |
36 |
C xA - Area of X face |
37 |
C Tracer - 3D Tracer field |
38 |
C df - Diffusive flux component work array. |
39 |
INTEGER iMin,iMax,jMin,jMax,bi,bj,k |
40 |
_RS xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
41 |
_RL Tracer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
42 |
integer tracerIdentity |
43 |
_RL df (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
44 |
INTEGER myThid |
45 |
|
46 |
#ifdef ALLOW_GMREDI |
47 |
|
48 |
C == Local variables == |
49 |
C I, J - Loop counters |
50 |
INTEGER I, J |
51 |
#if ( defined (GM_EXTRA_DIAGONAL) || defined (GM_BOLUS_ADVEC) ) |
52 |
INTEGER kp1 |
53 |
#endif |
54 |
#ifdef GM_EXTRA_DIAGONAL |
55 |
INTEGER km1 |
56 |
_RL dTdz (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
57 |
#endif |
58 |
#ifdef GM_BOLUS_ADVEC |
59 |
_RL maskp1 |
60 |
_RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
61 |
#ifdef ALLOW_DIAGNOSTICS |
62 |
LOGICAL DIAGNOSTICS_IS_ON |
63 |
EXTERNAL DIAGNOSTICS_IS_ON |
64 |
_RL tmp1k(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
65 |
#endif |
66 |
#endif /* GM_BOLUS_ADVEC */ |
67 |
|
68 |
#ifdef ALLOW_AUTODIFF_TAMC |
69 |
act0 = tracerIdentity - 1 |
70 |
max0 = maxpass |
71 |
act1 = bi - myBxLo(myThid) |
72 |
max1 = myBxHi(myThid) - myBxLo(myThid) + 1 |
73 |
act2 = bj - myByLo(myThid) |
74 |
max2 = myByHi(myThid) - myByLo(myThid) + 1 |
75 |
act3 = myThid - 1 |
76 |
max3 = nTx*nTy |
77 |
act4 = ikey_dynamics - 1 |
78 |
igadkey = (act0 + 1) |
79 |
& + act1*max0 |
80 |
& + act2*max0*max1 |
81 |
& + act3*max0*max1*max2 |
82 |
& + act4*max0*max1*max2*max3 |
83 |
kkey = (igadkey-1)*Nr + k |
84 |
if (tracerIdentity.GT.maxpass) then |
85 |
print *, 'ph-pass gmredi_xtrans ', maxpass, tracerIdentity |
86 |
STOP 'maxpass seems smaller than tracerIdentity' |
87 |
endif |
88 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
89 |
|
90 |
IF (useGMRedi) THEN |
91 |
|
92 |
#ifdef ALLOW_AUTODIFF_TAMC |
93 |
# ifdef GM_NON_UNITY_DIAGONAL |
94 |
CADJ STORE Kux(:,:,k,bi,bj) = |
95 |
CADJ & comlev1_gmredi_k_gad, key=kkey, byte=isbyte |
96 |
# endif |
97 |
# ifdef GM_EXTRA_DIAGONAL |
98 |
CADJ STORE Kuz(:,:,k,bi,bj) = |
99 |
CADJ & comlev1_gmredi_k_gad, key=kkey, byte=isbyte |
100 |
# endif |
101 |
#endif |
102 |
|
103 |
C-- Area integrated zonal flux |
104 |
DO j=jMin,jMax |
105 |
DO i=iMin,iMax |
106 |
df(i,j) = df(i,j) |
107 |
& -xA(i,j) |
108 |
#ifdef GM_NON_UNITY_DIAGONAL |
109 |
& *Kux(i,j,k,bi,bj) |
110 |
#else |
111 |
#ifdef ALLOW_KAPREDI_CONTROL |
112 |
& *(kapredi(i,j,k,bi,bj) |
113 |
#else |
114 |
& *(GM_isopycK |
115 |
#endif |
116 |
#ifdef GM_VISBECK_VARIABLE_K |
117 |
& +op5*(VisbeckK(i,j,bi,bj)+VisbeckK(i-1,j,bi,bj)) |
118 |
#endif |
119 |
& ) |
120 |
#endif /* GM_NON_UNITY_DIAGONAL */ |
121 |
& *_recip_dxC(i,j,bi,bj) |
122 |
& *(Tracer(i,j,k,bi,bj)-Tracer(i-1,j,k,bi,bj)) |
123 |
ENDDO |
124 |
ENDDO |
125 |
|
126 |
#ifdef GM_EXTRA_DIAGONAL |
127 |
IF (GM_ExtraDiag) THEN |
128 |
km1 = MAX(k-1,1) |
129 |
kp1 = MIN(k+1,Nr) |
130 |
|
131 |
DO j=jMin,jMax |
132 |
DO i=iMin,iMax |
133 |
C- Vertical gradients interpolated to U points |
134 |
dTdz(i,j) = op5*( |
135 |
& +op5*recip_drC(k)* |
136 |
& ( maskC(i-1,j,k,bi,bj)* |
137 |
& (Tracer(i-1,j,km1,bi,bj)-Tracer(i-1,j,k,bi,bj)) |
138 |
& +maskC( i ,j,k,bi,bj)* |
139 |
& (Tracer( i ,j,km1,bi,bj)-Tracer( i ,j,k,bi,bj)) |
140 |
& ) |
141 |
& +op5*recip_drC(kp1)* |
142 |
& ( maskC(i-1,j,kp1,bi,bj)* |
143 |
& (Tracer(i-1,j,k,bi,bj)-Tracer(i-1,j,kp1,bi,bj)) |
144 |
& +maskC( i ,j,kp1,bi,bj)* |
145 |
& (Tracer( i ,j,k,bi,bj)-Tracer( i ,j,kp1,bi,bj)) |
146 |
& ) ) |
147 |
|
148 |
|
149 |
ENDDO |
150 |
ENDDO |
151 |
#ifdef GM_AUTODIFF_EXCESSIVE_STORE |
152 |
CADJ STORE dtdz(:,:) = |
153 |
CADJ & comlev1_gmredi_k_gad, key=kkey, byte=isbyte |
154 |
#endif |
155 |
DO j=jMin,jMax |
156 |
DO i=iMin,iMax |
157 |
C- Off-diagonal components of horizontal flux |
158 |
df(i,j) = df(i,j) - xA(i,j)*Kuz(i,j,k,bi,bj)*dTdz(i,j) |
159 |
ENDDO |
160 |
ENDDO |
161 |
ENDIF |
162 |
#endif /* GM_EXTRA_DIAGONAL */ |
163 |
|
164 |
#ifdef GM_BOLUS_ADVEC |
165 |
IF (GM_AdvForm .AND. GM_AdvSeparate |
166 |
& .AND. .NOT.GM_InMomAsStress) THEN |
167 |
kp1 = MIN(k+1,Nr) |
168 |
maskp1 = 1. |
169 |
IF (k.GE.Nr) maskp1 = 0. |
170 |
DO j=jMin,jMax |
171 |
DO i=iMin,iMax |
172 |
uTrans(i,j) = dyG(i,j,bi,bj)*( GM_PsiX(i,j,kp1,bi,bj)*maskp1 |
173 |
& -GM_PsiX(i,j,k,bi,bj) ) |
174 |
& *maskW(i,j,k,bi,bj) |
175 |
ENDDO |
176 |
ENDDO |
177 |
#ifdef GM_AUTODIFF_EXCESSIVE_STORE |
178 |
CADJ STORE utrans(:,:) = |
179 |
CADJ & comlev1_gmredi_k_gad, key=kkey, byte=isbyte |
180 |
#endif |
181 |
DO j=jMin,jMax |
182 |
DO i=iMin,iMax |
183 |
df(i,j) = df(i,j) |
184 |
& +uTrans(i,j)*op5*(Tracer(i,j,k,bi,bj)+Tracer(i-1,j,k,bi,bj)) |
185 |
ENDDO |
186 |
ENDDO |
187 |
ENDIF |
188 |
|
189 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
190 |
|
191 |
#ifdef ALLOW_DIAGNOSTICS |
192 |
IF ( useDiagnostics |
193 |
& .AND. DIAGNOSTICS_IS_ON('GM_ubT ', myThid ) |
194 |
& .AND. tracerIdentity .EQ. 1) THEN |
195 |
kp1 = MIN(k+1,Nr) |
196 |
maskp1 = 1. |
197 |
IF (k.GE.Nr) maskp1 = 0. |
198 |
DO j=jMin,jMax |
199 |
DO i=iMin,iMax |
200 |
tmp1k(i,j) = dyG(i,j,bi,bj)*( GM_PsiX(i,j,kp1,bi,bj)*maskp1 |
201 |
& -GM_PsiX(i,j,k,bi,bj) ) |
202 |
& *maskW(i,j,k,bi,bj) |
203 |
& *op5*(Tracer(i,j,k,bi,bj)+Tracer(i-1,j,k,bi,bj)) |
204 |
ENDDO |
205 |
ENDDO |
206 |
CALL DIAGNOSTICS_FILL(tmp1k,'GM_ubT ', k,1,2,bi,bj,myThid) |
207 |
|
208 |
ENDIF |
209 |
#endif /* ALLOW_DIAGNOSTICS */ |
210 |
|
211 |
#endif /* GM_BOLUS_ADVEC */ |
212 |
|
213 |
ENDIF |
214 |
#endif /* ALLOW_GMREDI */ |
215 |
|
216 |
RETURN |
217 |
END |