1 |
C $Header: /u/gcmpack/models/MITgcmUV/model/src/ini_cg2d.F,v 1.36 2001/07/06 21:39:37 jmc Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#include "CPP_OPTIONS.h" |
5 |
|
6 |
CBOP |
7 |
C !ROUTINE: INI_CG2D |
8 |
C !INTERFACE: |
9 |
SUBROUTINE INI_CG2D( myThid ) |
10 |
|
11 |
C !DESCRIPTION: \bv |
12 |
C *==========================================================* |
13 |
C | SUBROUTINE INI_CG2D |
14 |
C | o Initialise 2d conjugate gradient solver operators. |
15 |
C *==========================================================* |
16 |
C | These arrays are purely a function of the basin geom. |
17 |
C | We set then here once and them use then repeatedly. |
18 |
C *==========================================================* |
19 |
C \ev |
20 |
|
21 |
C !USES: |
22 |
IMPLICIT NONE |
23 |
C === Global variables === |
24 |
#include "SIZE.h" |
25 |
#include "EEPARAMS.h" |
26 |
#include "PARAMS.h" |
27 |
#include "GRID.h" |
28 |
c#include "DYNVARS.h" |
29 |
#include "SURFACE.h" |
30 |
#include "CG2D.h" |
31 |
#ifdef ALLOW_OBCS |
32 |
#include "OBCS.h" |
33 |
#endif |
34 |
|
35 |
C !INPUT/OUTPUT PARAMETERS: |
36 |
C === Routine arguments === |
37 |
C myThid - Thread no. that called this routine. |
38 |
INTEGER myThid |
39 |
|
40 |
C !LOCAL VARIABLES: |
41 |
C === Local variables === |
42 |
C xG, yG - Global coordinate location. |
43 |
C zG |
44 |
C iG, jG - Global coordinate index |
45 |
C bi,bj - Loop counters |
46 |
C faceArea - Temporary used to hold cell face areas. |
47 |
C I,J,K |
48 |
C myNorm - Work variable used in calculating normalisation factor |
49 |
C sumArea - Work variable used to compute the total Domain Area |
50 |
CHARACTER*(MAX_LEN_MBUF) msgBuf |
51 |
INTEGER bi, bj |
52 |
INTEGER I, J, K |
53 |
_RL faceArea |
54 |
_RS myNorm |
55 |
_RL sumArea |
56 |
_RL aC, aCw, aCs |
57 |
CEOP |
58 |
|
59 |
C-- Initialise laplace operator |
60 |
C aW2d: integral in Z Ax/dX |
61 |
C aS2d: integral in Z Ay/dY |
62 |
myNorm = 0. _d 0 |
63 |
DO bj=myByLo(myThid),myByHi(myThid) |
64 |
DO bi=myBxLo(myThid),myBxHi(myThid) |
65 |
DO J=1,sNy |
66 |
DO I=1,sNx |
67 |
aW2d(I,J,bi,bj) = 0. _d 0 |
68 |
aS2d(I,J,bi,bj) = 0. _d 0 |
69 |
ENDDO |
70 |
ENDDO |
71 |
DO K=1,Nr |
72 |
DO J=1,sNy |
73 |
DO I=1,sNx |
74 |
faceArea = _dyG(I,J,bi,bj)*drF(K) |
75 |
& *_hFacW(I,J,K,bi,bj) |
76 |
aW2d(I,J,bi,bj) = aW2d(I,J,bi,bj) + |
77 |
& implicSurfPress*implicDiv2DFlow |
78 |
& *faceArea*recip_dxC(I,J,bi,bj) |
79 |
faceArea = _dxG(I,J,bi,bj)*drF(K) |
80 |
& *_hFacS(I,J,K,bi,bj) |
81 |
aS2d(I,J,bi,bj) = aS2d(I,J,bi,bj) + |
82 |
& implicSurfPress*implicDiv2DFlow |
83 |
& *faceArea*recip_dyC(I,J,bi,bj) |
84 |
ENDDO |
85 |
ENDDO |
86 |
ENDDO |
87 |
#ifdef ALLOW_OBCS |
88 |
IF (useOBCS) THEN |
89 |
DO I=1,sNx |
90 |
IF (OB_Jn(I,bi,bj).NE.0) aS2d(I,OB_Jn(I,bi,bj),bi,bj)=0. |
91 |
IF (OB_Jn(I,bi,bj).NE.0) aS2d(I,OB_Jn(I,bi,bj)+1,bi,bj)=0. |
92 |
IF (OB_Js(I,bi,bj).NE.0) aS2d(I,OB_Js(I,bi,bj)+1,bi,bj)=0. |
93 |
IF (OB_Js(I,bi,bj).NE.0) aS2d(I,OB_Js(I,bi,bj),bi,bj)=0. |
94 |
ENDDO |
95 |
DO J=1,sNy |
96 |
IF (OB_Ie(J,bi,bj).NE.0) aW2d(OB_Ie(J,bi,bj),J,bi,bj)=0. |
97 |
IF (OB_Ie(J,bi,bj).NE.0) aW2d(OB_Ie(J,bi,bj)+1,J,bi,bj)=0. |
98 |
IF (OB_Iw(J,bi,bj).NE.0) aW2d(OB_Iw(J,bi,bj)+1,J,bi,bj)=0. |
99 |
IF (OB_Iw(J,bi,bj).NE.0) aW2d(OB_Iw(J,bi,bj),J,bi,bj)=0. |
100 |
ENDDO |
101 |
ENDIF |
102 |
#endif |
103 |
DO J=1,sNy |
104 |
DO I=1,sNx |
105 |
myNorm = MAX(ABS(aW2d(I,J,bi,bj)),myNorm) |
106 |
myNorm = MAX(ABS(aS2d(I,J,bi,bj)),myNorm) |
107 |
ENDDO |
108 |
ENDDO |
109 |
ENDDO |
110 |
ENDDO |
111 |
_GLOBAL_MAX_R4( myNorm, myThid ) |
112 |
IF ( myNorm .NE. 0. _d 0 ) THEN |
113 |
myNorm = 1. _d 0/myNorm |
114 |
ELSE |
115 |
myNorm = 1. _d 0 |
116 |
ENDIF |
117 |
cg2dNorm = myNorm |
118 |
_BEGIN_MASTER( myThid ) |
119 |
CcnhDebugStarts |
120 |
WRITE(msgBuf,'(A,E40.25)') '// CG2D normalisation factor = ', |
121 |
& cg2dNorm |
122 |
CALL PRINT_MESSAGE( msgBuf,standardMessageUnit,SQUEEZE_RIGHT,1) |
123 |
WRITE(msgBuf,*) ' ' |
124 |
CALL PRINT_MESSAGE( msgBuf,standardMessageUnit,SQUEEZE_RIGHT,1) |
125 |
CcnhDebugEnds |
126 |
_END_MASTER( myThid ) |
127 |
DO bj=myByLo(myThid),myByHi(myThid) |
128 |
DO bi=myBxLo(myThid),myBxHi(myThid) |
129 |
DO J=1,sNy |
130 |
DO I=1,sNx |
131 |
aW2d(I,J,bi,bj) = aW2d(I,J,bi,bj)*myNorm |
132 |
aS2d(I,J,bi,bj) = aS2d(I,J,bi,bj)*myNorm |
133 |
ENDDO |
134 |
ENDDO |
135 |
ENDDO |
136 |
ENDDO |
137 |
|
138 |
C-- Update overlap regions |
139 |
CcnhDebugStarts |
140 |
C CALL PLOT_FIELD_XYRS( aW2d, 'AW2D INI_CG2D.1' , 1, myThid ) |
141 |
C CALL PLOT_FIELD_XYRS( aS2d, 'AS2D INI_CG2D.1' , 1, myThid ) |
142 |
CcnhDebugEnds |
143 |
c _EXCH_XY_R4(aW2d, myThid) |
144 |
c _EXCH_XY_R4(aS2d, myThid) |
145 |
CALL EXCH_UV_XY_RS(aW2d,aS2d,.FALSE.,myThid) |
146 |
CcnhDebugStarts |
147 |
C CALL PLOT_FIELD_XYRS( aW2d, 'AW2D INI_CG2D.2' , 1, myThid ) |
148 |
C CALL PLOT_FIELD_XYRS( aS2d, 'AS2D INI_CG2D.2' , 1, myThid ) |
149 |
CcnhDebugEnds |
150 |
|
151 |
C-- Define the solver tolerance in the appropriate Unit : |
152 |
cg2dNormaliseRHS = cg2dTargetResWunit.LE.0 |
153 |
IF (cg2dNormaliseRHS) THEN |
154 |
C- when using a normalisation of RHS, tolerance has no unit => no conversion |
155 |
cg2dTolerance = cg2dTargetResidual |
156 |
ELSE |
157 |
C- compute the total Area of the domain : |
158 |
sumArea = 0. |
159 |
DO bj=myByLo(myThid),myByHi(myThid) |
160 |
DO bi=myBxLo(myThid),myBxHi(myThid) |
161 |
DO j=1,sNy |
162 |
DO i=1,sNx |
163 |
IF (Ro_surf(i,j,bi,bj).GT.R_low(i,j,bi,bj)) THEN |
164 |
sumArea = sumArea + rA(i,j,bi,bj) |
165 |
ENDIF |
166 |
ENDDO |
167 |
ENDDO |
168 |
ENDDO |
169 |
ENDDO |
170 |
c WRITE(*,*) ' mythid, sumArea = ', mythid, sumArea |
171 |
_GLOBAL_SUM_R8( sumArea, myThid ) |
172 |
C- convert Target-Residual (in W unit) to cg2d-solver residual unit [m^2/s^2] |
173 |
cg2dTolerance = cg2dNorm * cg2dTargetResWunit |
174 |
& * sumArea / deltaTMom |
175 |
WRITE(*,'(2A,1P2E22.14)') ' ini_cg2d: ', |
176 |
& 'sumArea,cg2dTolerance =', sumArea,cg2dTolerance |
177 |
ENDIF |
178 |
|
179 |
C-- Initialise preconditioner |
180 |
C Note. 20th May 1998 |
181 |
C I made a weird discovery! In the model paper we argue |
182 |
C for the form of the preconditioner used here ( see |
183 |
C A Finite-volume, Incompressible Navier-Stokes Model |
184 |
C ...., Marshall et. al ). The algebra gives a simple |
185 |
C 0.5 factor for the averaging of ac and aCw to get a |
186 |
C symmettric pre-conditioner. By using a factor of 0.51 |
187 |
C i.e. scaling the off-diagonal terms in the |
188 |
C preconditioner down slightly I managed to get the |
189 |
C number of iterations for convergence in a test case to |
190 |
C drop form 192 -> 134! Need to investigate this further! |
191 |
C For now I have introduced a parameter cg2dpcOffDFac which |
192 |
C defaults to 0.51 but can be set at runtime. |
193 |
DO bj=myByLo(myThid),myByHi(myThid) |
194 |
DO bi=myBxLo(myThid),myBxHi(myThid) |
195 |
DO J=1,sNy |
196 |
DO I=1,sNx |
197 |
pC(I,J,bi,bj) = 1. _d 0 |
198 |
aC = -( |
199 |
& aW2d(I,J,bi,bj) + aW2d(I+1,J ,bi,bj) |
200 |
& +aS2d(I,J,bi,bj) + aS2d(I ,J+1,bi,bj) |
201 |
& +freeSurfFac*myNorm*recip_Bo(I,J,bi,bj)* |
202 |
& rA(I,J,bi,bj)/deltaTMom/deltaTMom |
203 |
& ) |
204 |
aCs = -( |
205 |
& aW2d(I,J-1,bi,bj) + aW2d(I+1,J-1,bi,bj) |
206 |
& +aS2d(I,J-1,bi,bj) + aS2d(I ,J ,bi,bj) |
207 |
& +freeSurfFac*myNorm*recip_Bo(I,J-1,bi,bj)* |
208 |
& rA(I,J-1,bi,bj)/deltaTMom/deltaTMom |
209 |
& ) |
210 |
aCw = -( |
211 |
& aW2d(I-1,J,bi,bj) + aW2d(I ,J ,bi,bj) |
212 |
& +aS2d(I-1,J,bi,bj) + aS2d(I-1,J+1,bi,bj) |
213 |
& +freeSurfFac*myNorm*recip_Bo(I-1,J,bi,bj)* |
214 |
& rA(I-1,J,bi,bj)/deltaTMom/deltaTMom |
215 |
& ) |
216 |
IF ( aC .EQ. 0. ) THEN |
217 |
pC(I,J,bi,bj) = 1. _d 0 |
218 |
ELSE |
219 |
pC(I,J,bi,bj) = 1. _d 0 / aC |
220 |
ENDIF |
221 |
IF ( aC + aCw .EQ. 0. ) THEN |
222 |
pW(I,J,bi,bj) = 0. |
223 |
ELSE |
224 |
pW(I,J,bi,bj) = |
225 |
& -aW2d(I ,J ,bi,bj)/((cg2dpcOffDFac *(aCw+aC))**2 ) |
226 |
ENDIF |
227 |
IF ( aC + aCs .EQ. 0. ) THEN |
228 |
pS(I,J,bi,bj) = 0. |
229 |
ELSE |
230 |
pS(I,J,bi,bj) = |
231 |
& -aS2d(I ,J ,bi,bj)/((cg2dpcOffDFac *(aCs+aC))**2 ) |
232 |
ENDIF |
233 |
C pC(I,J,bi,bj) = 1. |
234 |
C pW(I,J,bi,bj) = 0. |
235 |
C pS(I,J,bi,bj) = 0. |
236 |
ENDDO |
237 |
ENDDO |
238 |
ENDDO |
239 |
ENDDO |
240 |
C-- Update overlap regions |
241 |
_EXCH_XY_R4(pC, myThid) |
242 |
c _EXCH_XY_R4(pW, myThid) |
243 |
c _EXCH_XY_R4(pS, myThid) |
244 |
CALL EXCH_UV_XY_RS(pW,pS,.FALSE.,myThid) |
245 |
CcnhDebugStarts |
246 |
C CALL PLOT_FIELD_XYRS( pC, 'pC INI_CG2D.2' , 1, myThid ) |
247 |
C CALL PLOT_FIELD_XYRS( pW, 'pW INI_CG2D.2' , 1, myThid ) |
248 |
C CALL PLOT_FIELD_XYRS( pS, 'pS INI_CG2D.2' , 1, myThid ) |
249 |
CcnhDebugEnds |
250 |
|
251 |
RETURN |
252 |
END |