pkg/exf/exf_interp_read.F

C $Header: /u/gcmpack/MITgcm/pkg/exf/exf_interp_read.F,v 1.14 2011/06/07 22:19:48 jmc Exp $
C $Name:  $

#include "EXF_OPTIONS.h"

CBOP
C !ROUTINE: EXF_INTERP_READ
C !INTERFACE:
       SUBROUTINE EXF_INTERP_READ(
     I                infile, filePrec,
     O                arrayin,
     I                irecord, nx_in, ny_in, myThid )

C !DESCRIPTION:

C !USES:
      IMPLICIT NONE

C Global variables / common blocks
#include "SIZE.h"
#include "EEPARAMS.h"
#include "EXF_PARAM.h"
#ifdef ALLOW_USE_MPI
# include "EESUPPORT.h"
#endif /* ALLOW_USE_MPI */
#include "PARAMS.h"


C !INPUT/OUTPUT PARAMETERS:
C  infile      (string)  :: name of the binary input file (direct access)
C  filePrec    (integer) :: number of bits per word in file (32 or 64)
C  arrayin     ( _RL )   :: array to read file into
C  irecord     (integer) :: record number to read
C  nx_in,ny_in (integer) :: size in x & y direction of input file to read
C  myThid      (integer) :: My Thread Id number

      CHARACTER*(*) infile
      INTEGER       filePrec, irecord, nx_in, ny_in
       _RL          arrayin( -1:nx_in+2 , -1:ny_in+2 )
      INTEGER       myThid
CEOP

C !FUNCTIONS
      INTEGER  ILNBLNK
      INTEGER MDS_RECLEN
      LOGICAL MASTER_CPU_IO
      EXTERNAL ILNBLNK
      EXTERNAL MDS_RECLEN
      EXTERNAL MASTER_CPU_IO

C !LOCAL VARIABLES
      INTEGER  i, j
      INTEGER  ioUnit, length_of_rec, IL
      CHARACTER*(MAX_LEN_MBUF) msgBuf
      LOGICAL  exst
#ifdef EXF_INTERP_USE_DYNALLOC
#ifdef EXF_IREAD_USE_GLOBAL_POINTER
C     When using threads the address of the local automatic array
C     "buffer" is not visible to the other threads. So we create
C     a pointer to share that address here. This is presently
C     in an ifdef because it won't go through g77 and I'm not
C     currently sure what TAF would do with this.
      COMMON /EXF_IOPTR8/ glPtr8
      REAL*8, POINTER :: glPtr8(:,:)
      COMMON /EXF_IOPTR4/ glPtr4
      REAL*4, POINTER :: glPtr4(:,:)

      Real*8, target ::  buffer_r8(nx_in,ny_in)
      Real*4, target ::  buffer_r4(nx_in,ny_in)
#else  /* ndef EXF_IREAD_USE_GLOBAL_POINTER */
      Real*8   buffer_r8(nx_in,ny_in)
      Real*4   buffer_r4(nx_in,ny_in)
#endif /* ndef EXF_IREAD_USE_GLOBAL_POINTER */
#else  /* ndef EXF_INTERP_USE_DYNALLOC */
      Real*8   buffer_r8(exf_interp_bufferSize)
      Real*4   buffer_r4(exf_interp_bufferSize)
      COMMON /EXF_INTERP_BUFFER/ buffer_r8, buffer_r4
      INTEGER ijs
#endif /* ndef EXF_INTERP_USE_DYNALLOC */
#ifdef ALLOW_USE_MPI
      INTEGER  ierr
#endif

C--   Check for consistency:
#ifdef EXF_INTERP_USE_DYNALLOC
#ifndef EXF_IREAD_USE_GLOBAL_POINTER
C     The CPP symbol EXF_IREAD_USE_GLOBAL_POINTER must be defined for the
C     case of nThreads > 1. Stop IF it isnt.
      IF ( nThreads .GT. 1 ) THEN
      STOP
     &'EXF_INTERP_READ: nThreads > 1 needs EXF_IREAD_USE_GLOBAL_POINTER'
      ENDIF
#endif
#else  /* ndef EXF_INTERP_USE_DYNALLOC */
#ifdef EXF_IREAD_USE_GLOBAL_POINTER
      STOP
     &'EXF_INTERP_READ: USE_GLOBAL_POINTER needs INTERP_USE_DYNALLOC'
#endif
      IF ( nx_in*ny_in .GT. exf_interp_bufferSize ) THEN
        STOP 'EXF_INTERP_READ: exf_interp_bufferSize too small'
      ENDIF
#endif /* ndef EXF_INTERP_USE_DYNALLOC */

C--   before starting to read, wait for everyone to finish
      _BARRIER

C---  read in input data

      IF ( MASTER_CPU_IO(myThid) ) THEN
C--   master thread of process 0, only, opens a global file

        IL  = ILNBLNK( infile )
        INQUIRE( file=infile, exist=exst )
        IF (exst) THEN
         IF ( debugLevel.GE.debLevB ) THEN
          WRITE(msgBuf,'(A,A)')
     &         ' EXF_INTERP_READ: opening file: ',infile(1:IL)
          CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &         SQUEEZE_RIGHT , myThid)
         ENDIF
        ELSE
         WRITE(msgBuf,'(2A)')
     &        ' EXF_INTERP_READ: filename: ', infile(1:IL)
         CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &                       SQUEEZE_RIGHT , myThid)
         CALL PRINT_ERROR( msgBuf, myThid )
         WRITE(msgBuf,'(A)')
     &        ' EXF_INTERP_READ: File does not exist'
         CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &                       SQUEEZE_RIGHT , myThid)
         CALL PRINT_ERROR( msgBuf, myThid )
         STOP 'ABNORMAL END: S/R EXF_INTERP_READ'
        ENDIF

        CALL MDSFINDUNIT( ioUnit, myThid )
        length_of_rec=MDS_RECLEN( filePrec, nx_in*ny_in, myThid )
        OPEN( ioUnit, file=infile, status='old', access='direct',
     &       recl=length_of_rec )
        IF ( filePrec .EQ. 32 ) THEN
#ifdef EXF_INTERP_USE_DYNALLOC
          READ(ioUnit,rec=irecord)  buffer_r4
#else
          READ(ioUnit,rec=irecord) (buffer_r4(i),i=1,nx_in*ny_in)
#endif
#ifdef _BYTESWAPIO
          CALL MDS_BYTESWAPR4(nx_in*ny_in,buffer_r4)
#endif /* _BYTESWAPIO */
        ELSE
#ifdef EXF_INTERP_USE_DYNALLOC
          READ(ioUnit,rec=irecord)  buffer_r8
#else
          READ(ioUnit,rec=irecord) (buffer_r8(i),i=1,nx_in*ny_in)
#endif
#ifdef _BYTESWAPIO
          CALL MDS_BYTESWAPR8(nx_in*ny_in,buffer_r8)
#endif /* _BYTESWAPIO */
        ENDIF
        CLOSE( ioUnit )
C--   end if MASTER_CPU_IO
      ENDIF

      _BEGIN_MASTER( myThid )
#ifdef ALLOW_USE_MPI
C--   broadcast to all processes
       IF ( useSingleCpuInput ) THEN
         IF ( filePrec .EQ. 32 ) THEN
           CALL MPI_BCAST(buffer_r4,nx_in*ny_in,MPI_REAL,
     &          0,MPI_COMM_MODEL,ierr)
         ELSE
           CALL MPI_BCAST(buffer_r8,nx_in*ny_in,MPI_DOUBLE_PRECISION,
     &          0,MPI_COMM_MODEL,ierr)
         ENDIF
       ENDIF
#endif /* ALLOW_USE_MPI */

#ifdef EXF_IREAD_USE_GLOBAL_POINTER
       IF ( filePrec .EQ. 32 ) THEN
         glPtr4 => buffer_r4
       ELSE
         glPtr8 => buffer_r8
       ENDIF
#endif
      _END_MASTER( myThid )
      _BARRIER

C---  Transfer buffer to "arrayin" array:
#ifdef EXF_INTERP_USE_DYNALLOC
#ifdef EXF_IREAD_USE_GLOBAL_POINTER
      IF ( filePrec .EQ. 32 ) THEN
        DO j=1,ny_in
          DO i=1,nx_in
            arrayin(i,j)=glPtr4(i,j)
          ENDDO
        ENDDO
      ELSE
        DO j=1,ny_in
          DO i=1,nx_in
            arrayin(i,j)=glPtr8(i,j)
          ENDDO
        ENDDO
      ENDIF
#else /* ndef EXF_IREAD_USE_GLOBAL_POINTER */
      IF ( filePrec .EQ. 32 ) THEN
        DO j=1,ny_in
          DO i=1,nx_in
            arrayin(i,j)=buffer_r4(i,j)
          ENDDO
        ENDDO
      ELSE
        DO j=1,ny_in
          DO i=1,nx_in
            arrayin(i,j)=buffer_r8(i,j)
          ENDDO
        ENDDO
      ENDIF
#endif /* ndef EXF_IREAD_USE_GLOBAL_POINTER */
#else  /* ndef EXF_INTERP_USE_DYNALLOC */
      IF ( filePrec .EQ. 32 ) THEN
        DO j=1,ny_in
          ijs = (j-1)*nx_in
          DO i=1,nx_in
            arrayin(i,j)=buffer_r4(i+ijs)
          ENDDO
        ENDDO
      ELSE
        DO j=1,ny_in
          ijs = (j-1)*nx_in
          DO i=1,nx_in
            arrayin(i,j)=buffer_r8(i+ijs)
          ENDDO
        ENDDO
      ENDIF
#endif /* ndef EXF_INTERP_USE_DYNALLOC */

      RETURN
      END
1	dimitri	1.15	C $Header: /u/gcmpack/MITgcm/pkg/exf/exf_interp_read.F,v 1.14 2011/06/07 22:19:48 jmc Exp $
2	jmc	1.5	C $Name: $
3
4	heimbach	1.1	#include "EXF_OPTIONS.h"
5
6	jmc	1.11	CBOP
7			C !ROUTINE: EXF_INTERP_READ
8			C !INTERFACE:
9			SUBROUTINE EXF_INTERP_READ(
10			I infile, filePrec,
11			O arrayin,
12			I irecord, nx_in, ny_in, myThid )
13	heimbach	1.1
14	jmc	1.11	C !DESCRIPTION:
15
16			C !USES:
17			IMPLICIT NONE
18
19			C Global variables / common blocks
20	heimbach	1.1	#include "SIZE.h"
21			#include "EEPARAMS.h"
22	jmc	1.11	#include "EXF_PARAM.h"
23	heimbach	1.1	#ifdef ALLOW_USE_MPI
24			# include "EESUPPORT.h"
25			#endif /* ALLOW_USE_MPI */
26			#include "PARAMS.h"
27
28	jmc	1.11
29			C !INPUT/OUTPUT PARAMETERS:
30			C infile (string) :: name of the binary input file (direct access)
31			C filePrec (integer) :: number of bits per word in file (32 or 64)
32			C arrayin ( _RL ) :: array to read file into
33			C irecord (integer) :: record number to read
34			C nx_in,ny_in (integer) :: size in x & y direction of input file to read
35			C myThid (integer) :: My Thread Id number
36
37			CHARACTER() infile
38			INTEGER filePrec, irecord, nx_in, ny_in
39			_RL arrayin( -1:nx_in+2 , -1:ny_in+2 )
40			INTEGER myThid
41			CEOP
42
43			C !FUNCTIONS
44	mlosch	1.12	INTEGER ILNBLNK
45	jmc	1.11	INTEGER MDS_RECLEN
46			LOGICAL MASTER_CPU_IO
47	mlosch	1.12	EXTERNAL ILNBLNK
48	jmc	1.11	EXTERNAL MDS_RECLEN
49			EXTERNAL MASTER_CPU_IO
50
51			C !LOCAL VARIABLES
52			INTEGER i, j
53	mlosch	1.12	INTEGER ioUnit, length_of_rec, IL
54			CHARACTER*(MAX_LEN_MBUF) msgBuf
55			LOGICAL exst
56	jmc	1.11	#ifdef EXF_INTERP_USE_DYNALLOC
57	cnh	1.3	#ifdef EXF_IREAD_USE_GLOBAL_POINTER
58			C When using threads the address of the local automatic array
59	jmc	1.11	C "buffer" is not visible to the other threads. So we create
60	cnh	1.3	C a pointer to share that address here. This is presently
61			C in an ifdef because it won't go through g77 and I'm not
62			C currently sure what TAF would do with this.
63	dimitri	1.9	COMMON /EXF_IOPTR8/ glPtr8
64			REAL*8, POINTER :: glPtr8(:,:)
65	jmc	1.11	COMMON /EXF_IOPTR4/ glPtr4
66			REAL*4, POINTER :: glPtr4(:,:)
67	cnh	1.3
68	jmc	1.11	Real*8, target :: buffer_r8(nx_in,ny_in)
69			Real*4, target :: buffer_r4(nx_in,ny_in)
70			#else /* ndef EXF_IREAD_USE_GLOBAL_POINTER */
71			Real*8 buffer_r8(nx_in,ny_in)
72			Real*4 buffer_r4(nx_in,ny_in)
73			#endif /* ndef EXF_IREAD_USE_GLOBAL_POINTER */
74			#else /* ndef EXF_INTERP_USE_DYNALLOC */
75			Real*8 buffer_r8(exf_interp_bufferSize)
76			Real*4 buffer_r4(exf_interp_bufferSize)
77			COMMON /EXF_INTERP_BUFFER/ buffer_r8, buffer_r4
78			INTEGER ijs
79			#endif /* ndef EXF_INTERP_USE_DYNALLOC */
80			#ifdef ALLOW_USE_MPI
81			INTEGER ierr
82	cnh	1.3	#endif
83	heimbach	1.1
84	jmc	1.11	C-- Check for consistency:
85			#ifdef EXF_INTERP_USE_DYNALLOC
86	cnh	1.3	#ifndef EXF_IREAD_USE_GLOBAL_POINTER
87	jmc	1.11	C The CPP symbol EXF_IREAD_USE_GLOBAL_POINTER must be defined for the
88			C case of nThreads > 1. Stop IF it isnt.
89	cnh	1.3	IF ( nThreads .GT. 1 ) THEN
90	jmc	1.11	STOP
91	cnh	1.3	&'EXF_INTERP_READ: nThreads > 1 needs EXF_IREAD_USE_GLOBAL_POINTER'
92			ENDIF
93			#endif
94	jmc	1.11	#else /* ndef EXF_INTERP_USE_DYNALLOC */
95	dimitri	1.6	#ifdef EXF_IREAD_USE_GLOBAL_POINTER
96	jmc	1.11	STOP
97			&'EXF_INTERP_READ: USE_GLOBAL_POINTER needs INTERP_USE_DYNALLOC'
98	dimitri	1.6	#endif
99	jmc	1.11	IF ( nx_in*ny_in .GT. exf_interp_bufferSize ) THEN
100			STOP 'EXF_INTERP_READ: exf_interp_bufferSize too small'
101			ENDIF
102			#endif /* ndef EXF_INTERP_USE_DYNALLOC */
103
104			C-- before starting to read, wait for everyone to finish
105			_BARRIER
106	heimbach	1.1
107	jmc	1.11	C--- read in input data
108	heimbach	1.1
109	jmc	1.11	IF ( MASTER_CPU_IO(myThid) ) THEN
110			C-- master thread of process 0, only, opens a global file
111	heimbach	1.1
112	mlosch	1.12	IL = ILNBLNK( infile )
113			INQUIRE( file=infile, exist=exst )
114			IF (exst) THEN
115	jmc	1.14	IF ( debugLevel.GE.debLevB ) THEN
116	mlosch	1.12	WRITE(msgBuf,'(A,A)')
117			& ' EXF_INTERP_READ: opening file: ',infile(1:IL)
118			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
119			& SQUEEZE_RIGHT , myThid)
120			ENDIF
121			ELSE
122			WRITE(msgBuf,'(2A)')
123			& ' EXF_INTERP_READ: filename: ', infile(1:IL)
124			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
125			& SQUEEZE_RIGHT , myThid)
126			CALL PRINT_ERROR( msgBuf, myThid )
127			WRITE(msgBuf,'(A)')
128			& ' EXF_INTERP_READ: File does not exist'
129			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
130			& SQUEEZE_RIGHT , myThid)
131			CALL PRINT_ERROR( msgBuf, myThid )
132			STOP 'ABNORMAL END: S/R EXF_INTERP_READ'
133			ENDIF
134
135	jmc	1.11	CALL MDSFINDUNIT( ioUnit, myThid )
136			length_of_rec=MDS_RECLEN( filePrec, nx_in*ny_in, myThid )
137			OPEN( ioUnit, file=infile, status='old', access='direct',
138			& recl=length_of_rec )
139	dimitri	1.9	IF ( filePrec .EQ. 32 ) THEN
140	jmc	1.11	#ifdef EXF_INTERP_USE_DYNALLOC
141			READ(ioUnit,rec=irecord) buffer_r4
142			#else
143			READ(ioUnit,rec=irecord) (buffer_r4(i),i=1,nx_in*ny_in)
144			#endif
145	dimitri	1.9	#ifdef _BYTESWAPIO
146	jmc	1.11	CALL MDS_BYTESWAPR4(nx_in*ny_in,buffer_r4)
147	dimitri	1.9	#endif /* _BYTESWAPIO */
148			ELSE
149	jmc	1.11	#ifdef EXF_INTERP_USE_DYNALLOC
150			READ(ioUnit,rec=irecord) buffer_r8
151			#else
152			READ(ioUnit,rec=irecord) (buffer_r8(i),i=1,nx_in*ny_in)
153			#endif
154	dimitri	1.9	#ifdef _BYTESWAPIO
155	jmc	1.11	CALL MDS_BYTESWAPR8(nx_in*ny_in,buffer_r8)
156	dimitri	1.9	#endif /* _BYTESWAPIO */
157			ENDIF
158	jmc	1.11	CLOSE( ioUnit )
159			C-- end if MASTER_CPU_IO
160			ENDIF
161	heimbach	1.1
162	jmc	1.11	_BEGIN_MASTER( myThid )
163	heimbach	1.1	#ifdef ALLOW_USE_MPI
164	jmc	1.11	C-- broadcast to all processes
165	dimitri	1.15	IF ( useSingleCpuInput ) THEN
166	jmc	1.11	IF ( filePrec .EQ. 32 ) THEN
167			CALL MPI_BCAST(buffer_r4,nx_in*ny_in,MPI_REAL,
168			& 0,MPI_COMM_MODEL,ierr)
169			ELSE
170			CALL MPI_BCAST(buffer_r8,nx_in*ny_in,MPI_DOUBLE_PRECISION,
171			& 0,MPI_COMM_MODEL,ierr)
172			ENDIF
173			ENDIF
174	heimbach	1.1	#endif /* ALLOW_USE_MPI */
175	jmc	1.11
176	cnh	1.3	#ifdef EXF_IREAD_USE_GLOBAL_POINTER
177	dimitri	1.9	IF ( filePrec .EQ. 32 ) THEN
178	jmc	1.11	glPtr4 => buffer_r4
179	dimitri	1.9	ELSE
180	jmc	1.11	glPtr8 => buffer_r8
181	dimitri	1.9	ENDIF
182	cnh	1.3	#endif
183			_END_MASTER( myThid )
184			_BARRIER
185	dimitri	1.9
186	jmc	1.11	C--- Transfer buffer to "arrayin" array:
187			#ifdef EXF_INTERP_USE_DYNALLOC
188	cnh	1.3	#ifdef EXF_IREAD_USE_GLOBAL_POINTER
189	dimitri	1.9	IF ( filePrec .EQ. 32 ) THEN
190	jmc	1.11	DO j=1,ny_in
191			DO i=1,nx_in
192			arrayin(i,j)=glPtr4(i,j)
193			ENDDO
194			ENDDO
195			ELSE
196			DO j=1,ny_in
197			DO i=1,nx_in
198			arrayin(i,j)=glPtr8(i,j)
199			ENDDO
200			ENDDO
201			ENDIF
202			#else /* ndef EXF_IREAD_USE_GLOBAL_POINTER */
203			IF ( filePrec .EQ. 32 ) THEN
204			DO j=1,ny_in
205			DO i=1,nx_in
206			arrayin(i,j)=buffer_r4(i,j)
207			ENDDO
208			ENDDO
209	dimitri	1.9	ELSE
210	jmc	1.11	DO j=1,ny_in
211			DO i=1,nx_in
212			arrayin(i,j)=buffer_r8(i,j)
213			ENDDO
214			ENDDO
215	dimitri	1.9	ENDIF
216	jmc	1.11	#endif /* ndef EXF_IREAD_USE_GLOBAL_POINTER */
217			#else /* ndef EXF_INTERP_USE_DYNALLOC */
218	dimitri	1.9	IF ( filePrec .EQ. 32 ) THEN
219	jmc	1.11	DO j=1,ny_in
220			ijs = (j-1)*nx_in
221			DO i=1,nx_in
222			arrayin(i,j)=buffer_r4(i+ijs)
223			ENDDO
224			ENDDO
225	dimitri	1.9	ELSE
226	jmc	1.11	DO j=1,ny_in
227			ijs = (j-1)*nx_in
228			DO i=1,nx_in
229			arrayin(i,j)=buffer_r8(i+ijs)
230			ENDDO
231			ENDDO
232	dimitri	1.9	ENDIF
233	jmc	1.11	#endif /* ndef EXF_INTERP_USE_DYNALLOC */
234	heimbach	1.1
235	jmc	1.5	RETURN
236	heimbach	1.1	END