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