/[MITgcm]/MITgcm/pkg/exf/exf_interp.F
ViewVC logotype

Annotation of /MITgcm/pkg/exf/exf_interp.F

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


Revision 1.29 - (hide annotations) (download)
Thu Jan 5 20:24:02 2012 UTC (12 years, 5 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint63i, checkpoint63j, checkpoint63k
Changes since 1.28: +201 -325 lines
- remove OLD_EXF_INTERP_LAT_INDEX code ;
- move interpolation into separated S/R and file: exf_interpolate.F
- extended input field (2 rows) near the N & S poles:
 * fill in with the symetric value (when even Nb of data in longitude)
 * add average value at the poles only for scalar quantities (for vector
   component interpolation, skip the averaging and keep duplicated values)
- add argument myIter and add debug print on 1rst iter if debugLevel >=2

1 jmc 1.29 C $Header: /u/gcmpack/MITgcm/pkg/exf/exf_interp.F,v 1.28 2012/01/01 15:25:23 jmc Exp $
2 jmc 1.19 C $Name: $
3    
4 edhill 1.3 #include "EXF_OPTIONS.h"
5 dimitri 1.1
6 jmc 1.24 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
7 dimitri 1.1
8 jmc 1.27 CBOP
9     C !ROUTINE: EXF_INTERP
10     C !INTERFACE:
11     SUBROUTINE EXF_INTERP(
12 jmc 1.29 I inFile, filePrec,
13 jmc 1.27 O arrayout,
14     I irecord, xG_in, yG,
15 jmc 1.29 I lon_0, lon_inc, lat_0, lat_inc,
16     I nxIn, nyIn, method, myIter, myThid )
17 jmc 1.27
18     C !DESCRIPTION: \bv
19     C *==========================================================*
20     C | SUBROUTINE EXF_INTERP
21     C | o Load from file a regular lat-lon input field
22     C | and interpolate on to the model grid location
23     C *==========================================================*
24     C \ev
25    
26     C !USES:
27     IMPLICIT NONE
28     C === Global variables ===
29     #include "SIZE.h"
30     #include "EEPARAMS.h"
31     #include "PARAMS.h"
32 dimitri 1.1
33 jmc 1.27 C !INPUT/OUTPUT PARAMETERS:
34     C inFile (string) :: name of the binary input file (direct access)
35 jmc 1.20 C filePrec (integer) :: number of bits per word in file (32 or 64)
36 jmc 1.27 C arrayout ( _RL ) :: output array
37 jmc 1.20 C irecord (integer) :: record number to read
38 jmc 1.27 C xG_in,yG :: coordinates for output grid to interpolate to
39 jmc 1.20 C lon_0, lat_0 :: lon and lat of sw corner of global input grid
40     C lon_inc :: scalar x-grid increment
41     C lat_inc :: vector y-grid increments
42 jmc 1.27 C nxIn,nyIn (integer) :: size in x & y direction of input file to read
43 jmc 1.20 C method :: 1,11,21 for bilinear; 2,12,22 for bicubic
44     C :: 1,2 for tracer; 11,12 for U; 21,22 for V
45 jmc 1.29 C myIter (integer) :: current iteration number
46 jmc 1.20 C myThid (integer) :: My Thread Id number
47 dimitri 1.2
48 jmc 1.29 CHARACTER*(*) inFile
49 jmc 1.27 INTEGER filePrec, irecord, nxIn, nyIn
50 dimitri 1.2 _RL arrayout(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
51 jmc 1.20 _RS xG_in (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
52 dimitri 1.2 _RS yG (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
53     _RL lon_0, lon_inc
54 jmc 1.27 c _RL lat_0, lat_inc(nyIn-1)
55 jmc 1.24 _RL lat_0, lat_inc(*)
56 jmc 1.29 INTEGER method, myIter, myThid
57 dimitri 1.1
58 jmc 1.27 C !FUNCTIONS:
59 jmc 1.29 #ifdef ALLOW_DEBUG
60 jmc 1.27 INTEGER ILNBLNK
61     EXTERNAL ILNBLNK
62 jmc 1.29 #endif
63 jmc 1.27
64     C !LOCAL VARIABLES:
65 jmc 1.29 C arrayin :: input field array (loaded from file)
66     C x_in :: longitude vector defining input field grid
67     C y_in :: latitude vector defining input field grid
68     C w_ind :: input field longitudinal index, on western side of model grid pt
69     C s_ind :: input field latitudinal index, on southern side of model grid pt
70     C bi, bj :: tile indices
71     C i, j, k, l :: loop indices
72 jmc 1.27 C msgBuf :: Informational/error message buffer
73     _RL arrayin( -1:nxIn+2, -1:nyIn+2 )
74     _RL x_in(-1:nxIn+2), y_in(-1:nyIn+2)
75 jmc 1.29 INTEGER w_ind(sNx,sNy), s_ind(sNx,sNy)
76     INTEGER bi, bj
77     INTEGER i, j, k, l
78 jmc 1.27 INTEGER nLoop
79 jmc 1.28 _RL tmpVar
80 heimbach 1.13 _RS xG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
81 jmc 1.20 _RS threeSixtyRS
82 jmc 1.29 _RL yPole, symSign, poleValue
83 heimbach 1.13 PARAMETER ( threeSixtyRS = 360. )
84 jmc 1.29 PARAMETER ( yPole = 90. )
85     INTEGER nxd2
86     LOGICAL xIsPeriodic, poleSymmetry
87     #ifdef ALLOW_DEBUG
88     LOGICAL debugFlag
89     CHARACTER*(MAX_LEN_MBUF) msgBuf
90     _RS prtPole(-1:4)
91     #endif
92 jmc 1.27 CEOP
93 heimbach 1.12
94 jmc 1.29 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
95     C--- Load inut field
96 jmc 1.27
97     CALL EXF_INTERP_READ(
98     I inFile, filePrec,
99     O arrayin,
100     I irecord, nxIn, nyIn, myThid )
101 dimitri 1.2
102 jmc 1.29 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
103     C--- Prepare input grid and input field
104    
105 jmc 1.27 C-- setup input longitude grid
106     DO i=-1,nxIn+2
107 dimitri 1.18 x_in(i) = lon_0 + (i-1)*lon_inc
108 jmc 1.27 ENDDO
109     xIsPeriodic = nxIn.EQ.NINT( threeSixtyRS / lon_inc )
110 jmc 1.29 nxd2 = NINT( nxIn*0.5 )
111     poleSymmetry = xIsPeriodic .AND. ( nxIn.EQ.2*nxd2 )
112     #ifdef EXF_USE_OLD_INTERP_POLE
113     poleSymmetry = .FALSE.
114     #endif
115 heimbach 1.12
116 jmc 1.27 C-- setup input latitude grid
117 dimitri 1.18 y_in(1) = lat_0
118 jmc 1.27 DO j=1,nyIn+1
119     i = MIN(j,nyIn-1)
120     y_in(j+1) = y_in(j) + lat_inc(i)
121     ENDDO
122     y_in(0) = y_in(1) - lat_inc(1)
123     y_in(-1)= y_in(0) - lat_inc(1)
124 jmc 1.29 #ifdef ALLOW_DEBUG
125     DO l=-1,4
126     prtPole(l) = 0.
127     ENDDO
128     #endif
129     C-- For tracer (method=1,2) add 1 row @ the pole (if last row is not)
130     C and will fill it with the polarmost-row zonally averaged value.
131     C For vector component, cannot do much without the other component;
132     C averaging properly done if uvInterp=T in S/R EXF_INTERP_UV
133     #ifdef EXF_USE_OLD_INTERP_POLE
134     IF ( .TRUE. ) THEN
135     #else
136     IF ( method.LT.10 ) THEN
137     C- Add 2 row @ southern end; if one is beyond S.pole, put one @ S.pole
138     j = 0
139     IF ( ABS(y_in(j+1)).LT.yPole .AND. ABS(y_in(j)).GT.yPole ) THEN
140     y_in(j) = -yPole
141     y_in(j-1) = -2.*yPole - y_in(1)
142     #ifdef ALLOW_DEBUG
143     prtPole(j) = 1.
144     prtPole(j-1) = 2.
145     #endif
146     ENDIF
147     j = -1
148     IF ( ABS(y_in(j+1)).GT.yPole .AND. ABS(y_in(j)).GT.yPole ) THEN
149     y_in(j) = -yPole
150     #ifdef ALLOW_DEBUG
151     prtPole(j) = 1.
152     #endif
153     ENDIF
154     #endif /* EXF_USE_OLD_INTERP_POLE */
155 jmc 1.27 C- Add 2 row @ northern end; if one is beyond N.pole, put one @ N.pole
156 jmc 1.29 j = nyIn+1
157     IF ( ABS(y_in(j-1)).LT.yPole .AND. ABS(y_in(j)).GT.yPole ) THEN
158     y_in(j) = yPole
159     y_in(j+1) = 2.*yPole - y_in(j-1)
160     #ifdef ALLOW_DEBUG
161     prtPole(3) = 1.
162     prtPole(3+1) = 2.
163     #endif
164     ENDIF
165     j = nyIn+2
166     IF ( ABS(y_in(j-1)).LT.yPole .AND. ABS(y_in(j)).GT.yPole ) THEN
167     y_in(j) = yPole
168     #ifdef ALLOW_DEBUG
169     prtPole(4) = 1.
170     #endif
171     ENDIF
172 jmc 1.27 ENDIF
173    
174 jmc 1.29 C-- Enlarge boundary
175 jmc 1.27 IF ( xIsPeriodic ) THEN
176 jmc 1.29 C- fill-in added column assuming periodicity
177 jmc 1.27 DO j=1,nyIn
178     arrayin( 0,j) = arrayin(nxIn ,j)
179     arrayin(-1,j) = arrayin(nxIn-1,j)
180     arrayin(nxIn+1,j) = arrayin(1,j)
181     arrayin(nxIn+2,j) = arrayin(2,j)
182     ENDDO
183     ELSE
184 jmc 1.29 C- fill-in added column from nearest column
185 jmc 1.27 DO j=1,nyIn
186     arrayin( 0,j) = arrayin(1,j)
187     arrayin(-1,j) = arrayin(1,j)
188     arrayin(nxIn+1,j) = arrayin(nxIn,j)
189     arrayin(nxIn+2,j) = arrayin(nxIn,j)
190     ENDDO
191     ENDIF
192 jmc 1.29 symSign = 1. _d 0
193     IF ( method.GE.10 ) symSign = -1. _d 0
194     DO l=-1,2
195     j = l
196     IF ( l.GE.1 ) j = nyIn+l
197     k = MAX(1,MIN(j,nyIn))
198     IF ( poleSymmetry .AND. ABS(y_in(j)).GT.yPole ) THEN
199     C- fill-in added row assuming pole-symmetry
200     DO i=-1,nxd2
201     arrayin(i,j) = symSign*arrayin(i+nxd2,k)
202     ENDDO
203     DO i=1,nxd2+2
204     arrayin(i+nxd2,j) = symSign*arrayin(i,k)
205     ENDDO
206     #ifdef ALLOW_DEBUG
207     i = l + 2*( (l+1)/2 )
208     prtPole(i) = prtPole(i) + 0.2
209     #endif
210     ELSE
211     C- fill-in added row from nearest column values
212     DO i=-1,nxIn+2
213     arrayin(i,j) = arrayin(i,k)
214     ENDDO
215     ENDIF
216 jmc 1.27 ENDDO
217 dimitri 1.4
218 jmc 1.29 C-- For tracer (method=1,2) set to northernmost zonal-mean value
219 dimitri 1.15 C at 90N to avoid sharp zonal gradients near the Pole.
220 jmc 1.29 C For vector component, cannot do much without the other component;
221     C averaging properly done if uvInterp=T in S/R EXF_INTERP_UV
222     #ifdef EXF_USE_OLD_INTERP_POLE
223     IF ( .TRUE. ) THEN
224     DO l= 3,4
225     #else
226     IF ( method.LT.10 ) THEN
227     DO l=-1,4
228     #endif
229     j = l
230     IF ( l.GE.2 ) j = nyIn+l-2
231     IF ( ABS(y_in(j)).EQ.yPole ) THEN
232     IF (method.EQ.1 .OR. method.EQ.2) THEN
233     poleValue = 0.
234     DO i=1,nxIn
235     poleValue = poleValue + arrayin(i,j)
236     ENDDO
237     poleValue = poleValue / nxIn
238     DO i=-1,nxIn+2
239     arrayin(i,j) = poleValue
240     ENDDO
241     #ifdef ALLOW_DEBUG
242     prtPole(l) = prtPole(l) + 0.1
243     #endif
244     #ifdef EXF_USE_OLD_INTERP_POLE
245     ELSEIF (method.EQ.11 .OR. method.EQ.12) THEN
246     DO i=-1,nxIn+2
247     arrayin(i,j) = 0.
248     ENDDO
249     #ifdef ALLOW_DEBUG
250     prtPole(l) = prtPole(l) + 0.9
251     #endif
252     #endif /* EXF_USE_OLD_INTERP_POLE */
253     ENDIF
254 jmc 1.27 ENDIF
255 jmc 1.29 ENDDO
256     ENDIF
257    
258     #ifdef ALLOW_DEBUG
259     debugFlag = ( debugLevel.GE.debLevC )
260     & .OR. ( debugLevel.GE.debLevB .AND. myIter.LE.nIter0 )
261     C prtPole(l)=0 : extended, =1 : changed to pole, =2 : changed to symetric
262     IF ( debugFlag ) THEN
263     l = ILNBLNK(inFile)
264     WRITE(msgBuf,'(3A,I6,A,2L5)')
265     & 'EXF_INTERP: file="',inFile(1:l),'", rec=', irecord,
266     & ' , x-Per,P.Sym=', xIsPeriodic, poleSymmetry
267     CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
268     & SQUEEZE_RIGHT, myThid )
269     WRITE(msgBuf,'(2A,3F4.1,A,3F12.6)') 'S.edge (j=-1,0,1) :',
270     & ' proc=', (prtPole(j),j=-1,1), ', yIn=', (y_in(j),j=-1,1)
271     CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
272     & SQUEEZE_RIGHT, myThid )
273     WRITE(msgBuf,'(2A,3F4.1,A,3F12.6)') 'N.edge (j=+0,+1,+2)',
274     & ' proc=', (prtPole(j),j=2,4), ', yIn=',(y_in(j),j=nyIn,nyIn+2)
275     CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
276     & SQUEEZE_RIGHT, myThid )
277     ENDIF
278     #endif /* ALLOW_DEBUG */
279 dimitri 1.15
280 jmc 1.29 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
281     C--- Prepare output grid and interpolate for each tile
282 dimitri 1.2
283 jmc 1.29 C-- put xG in interval [ lon_0 , lon_0+360 [
284     DO bj=myByLo(myThid),myByHi(myThid)
285     DO bi=myBxLo(myThid),myBxHi(myThid)
286     DO j=1-OLy,sNy+OLy
287     DO i=1-OLx,sNx+OLx
288     xG(i,j,bi,bj) = xG_in(i,j,bi,bj)-lon_0
289     & + threeSixtyRS*2.
290     xG(i,j,bi,bj) = lon_0+MOD(xG(i,j,bi,bj),threeSixtyRS)
291     ENDDO
292     ENDDO
293     #ifdef ALLOW_DEBUG
294 jmc 1.27 C-- Check validity of input/output coordinates
295 jmc 1.29 IF ( debugFlag ) THEN
296 jmc 1.27 DO j=1,sNy
297     DO i=1,sNx
298     IF ( xG(i,j,bi,bj) .LT. x_in(0) .OR.
299     & xG(i,j,bi,bj) .GE. x_in(nxIn+1) .OR.
300     & yG(i,j,bi,bj) .LT. y_in(0) .OR.
301     & yG(i,j,bi,bj) .GE. y_in(nyIn+1) ) THEN
302     l = ILNBLNK(inFile)
303     WRITE(msgBuf,'(3A,I6)')
304     & 'EXF_INTERP: file="', inFile(1:l), '", rec=', irecord
305     CALL PRINT_ERROR( msgBuf, myThid )
306     WRITE(msgBuf,'(A)')
307     & 'EXF_INTERP: input grid must encompass output grid.'
308     CALL PRINT_ERROR( msgBuf, myThid )
309     WRITE(msgBuf,'(A,2I8,2I6,A,1P2E14.6)') 'i,j,bi,bj=',
310     & i,j,bi,bj, ' , xG,yG=', xG(i,j,bi,bj), yG(i,j,bi,bj)
311     CALL PRINT_ERROR( msgBuf, myThid )
312     WRITE(msgBuf,'(A,I9,A,1P2E14.6)') 'nxIn=', nxIn,
313     & ' , x_in(0,nxIn+1)=', x_in(0) ,x_in(nxIn+1)
314     CALL PRINT_ERROR( msgBuf, myThid )
315     WRITE(msgBuf,'(A,I9,A,1P2E14.6)') 'nyIn=', nyIn,
316     & ' , y_in(0,nyIn+1)=', y_in(0) ,y_in(nyIn+1)
317     CALL PRINT_ERROR( msgBuf, myThid )
318     STOP 'ABNORMAL END: S/R EXF_INTERP'
319     ENDIF
320     ENDDO
321     ENDDO
322     ENDIF
323 dimitri 1.6 #endif /* ALLOW_DEBUG */
324 jmc 1.29 ENDDO
325     ENDDO
326    
327     DO bj = myByLo(myThid), myByHi(myThid)
328     DO bi = myBxLo(myThid), myBxHi(myThid)
329 dimitri 1.1
330 jmc 1.29 C-- Compute interpolation lon & lat index mapping
331 jmc 1.27 C-- latitude index
332     DO j=1,sNy
333     DO i=1,sNx
334     s_ind(i,j) = 0
335     w_ind(i,j) = nyIn+1
336     ENDDO
337     ENDDO
338     C # of pts = nyIn+2 ; # of interval = nyIn+1 ; evaluate nLoop as
339     C 1 + truncated log2(# interval -1); add epsil=1.e-3 for safey
340 jmc 1.28 tmpVar = nyIn + 1. _d -3
341     nLoop = 1 + INT( LOG(tmpVar)/LOG(2. _d 0) )
342 jmc 1.27 DO l=1,nLoop
343     DO j=1,sNy
344     DO i=1,sNx
345     IF ( w_ind(i,j).GT.s_ind(i,j)+1 ) THEN
346     k = NINT( (s_ind(i,j)+w_ind(i,j))*0.5 )
347     IF ( yG(i,j,bi,bj) .LT. y_in(k) ) THEN
348     w_ind(i,j) = k
349     ELSE
350     s_ind(i,j) = k
351     ENDIF
352     ENDIF
353     ENDDO
354     ENDDO
355     ENDDO
356     #ifdef ALLOW_DEBUG
357 jmc 1.29 IF ( debugFlag ) THEN
358 jmc 1.27 C- Check that we found the right lat. index
359     DO j=1,sNy
360     DO i=1,sNx
361     IF ( w_ind(i,j).NE.s_ind(i,j)+1 ) THEN
362     l = ILNBLNK(inFile)
363     WRITE(msgBuf,'(3A,I4,A,I4)')
364     & 'EXF_INTERP: file="', inFile(1:l), '", rec=', irecord,
365     & ', nLoop=', nLoop
366     CALL PRINT_ERROR( msgBuf, myThid )
367     WRITE(msgBuf,'(A)')
368     & 'EXF_INTERP: did not found Latitude index for grid-pt:'
369     CALL PRINT_ERROR( msgBuf, myThid )
370     WRITE(msgBuf,'(A,2I8,2I6,A,1PE16.8)')
371     & 'EXF_INTERP: i,j,bi,bj=',i,j,bi,bj,' , yG=',yG(i,j,bi,bj)
372     CALL PRINT_ERROR( msgBuf, myThid )
373     WRITE(msgBuf,'(A,I8,A,1PE16.8)')
374     & 'EXF_INTERP: s_ind=',s_ind(i,j),', lat=',y_in(s_ind(i,j))
375     CALL PRINT_ERROR( msgBuf, myThid )
376     WRITE(msgBuf,'(A,I8,A,1PE16.8)')
377     & 'EXF_INTERP: n_ind=',w_ind(i,j),', lat=',y_in(w_ind(i,j))
378     CALL PRINT_ERROR( msgBuf, myThid )
379     STOP 'ABNORMAL END: S/R EXF_INTERP'
380     ENDIF
381     ENDDO
382     ENDDO
383     ENDIF
384     #endif /* ALLOW_DEBUG */
385     C-- longitude index
386     DO j=1,sNy
387     DO i=1,sNx
388     w_ind(i,j) = INT((xG(i,j,bi,bj)-x_in(-1))/lon_inc) - 1
389     ENDDO
390     ENDDO
391 dimitri 1.1
392 jmc 1.29 C-- Do interpolation using lon & lat index mapping
393     CALL EXF_INTERPOLATE(
394     I inFile, irecord, method,
395     I nxIn, nyIn, x_in, y_in,
396     O arrayin,
397     O arrayout,
398     I xG, yG,
399     I w_ind, s_ind,
400     I bi, bj, myThid )
401 dimitri 1.1
402 jmc 1.27 ENDDO
403     ENDDO
404 dimitri 1.1
405 jmc 1.20 RETURN
406 dimitri 1.1 END

  ViewVC Help
Powered by ViewVC 1.1.22