pkg/exch2/exch2_get_rx1.template

C $Header: /u/gcmpack/MITgcm/pkg/exch2/exch2_get_rx1.template,v 1.3 2010/04/23 20:21:06 jmc Exp $
C $Name:  $

#include "CPP_EEOPTIONS.h"
#include "W2_OPTIONS.h"

CBOP 0
C !ROUTINE: EXCH2_GET_RX1

C !INTERFACE:
      SUBROUTINE EXCH2_GET_RX1(
     I       tIlo, tIhi, tiStride,
     I       tJlo, tJhi, tjStride,
     I       tKlo, tKhi, tkStride,
     I       thisTile, nN, bi, bj,
     I       e2BufrRecSize, sizeNb, sizeBi, sizeBj,
     I       e2Bufr1_RX,
     U       array,
     I       i1Lo, i1Hi, j1Lo, j1Hi, k1Lo, k1Hi,
     U       e2_msgHandles,
     I       commSetting, myThid )

C !DESCRIPTION:
C     Scalar field (1 component) Exchange:
C     Get from buffer exchanged data to fill in this tile-egde overlap region.

C !USES:
      IMPLICIT NONE

#include "SIZE.h"
#include "EEPARAMS.h"
#include "W2_EXCH2_SIZE.h"
#include "W2_EXCH2_TOPOLOGY.h"

C !INPUT/OUTPUT PARAMETERS:
C     === Routine arguments ===
C     tIlo,tIhi     :: index range in I that will be filled in target "array"
C     tIstride      :: index step  in I that will be filled in target "array"
C     tJlo,tJhi     :: index range in J that will be filled in target "array"
C     tJstride      :: index step  in J that will be filled in target "array"
C     tKlo,tKhi     :: index range in K that will be filled in target "array"
C     tKstride      :: index step  in K that will be filled in target "array"
C     thisTile      :: receiving tile Id. number
C     bi,bj         :: Indices of the receiving tile within this process
C                   ::  (used to select buffer slots that are allowed).
C     nN            :: Neighbour entry that we are processing
C     e2BufrRecSize :: Number of elements in each entry of e2Bufr1_RX
C     sizeNb        :: Second dimension of e2Bufr1_RX
C     sizeBi        :: Third  dimension of e2Bufr1_RX
C     sizeBj        :: Fourth dimension of e2Bufr1_RX
C     e2Bufr1_RX    :: Data transport buffer array. This array is used in one of
C                   :: two ways. For PUT communication the entry in the buffer
C                   :: associated with the source for this receive (determined
C                   :: from the opposing_send index) is read.
C                   :: For MSG communication the entry in the buffer associated
C                   :: with this neighbor of this tile is used as a receive
C                   :: location for loading a linear stream of bytes.
C     array         :: Target array that this receive writes to.
C     i1Lo, i1Hi    :: I coordinate bounds of target array
C     j1Lo, j1Hi    :: J coordinate bounds of target array
C     k1Lo, k1Hi    :: K coordinate bounds of target array
C     e2_msgHandles :: Synchronization and coordination data structure used to
C                   :: coordinate access to e2Bufr1_RX or to regulate message
C                   :: buffering. In PUT communication sender will increment
C                   :: handle entry once data is ready in buffer. Receiver will
C                   :: decrement handle once data is consumed from buffer.
C                   :: For MPI MSG communication MPI_Wait uses handle to check
C                   :: Isend has cleared. This is done in routine after receives.
C     commSetting   :: Mode of communication used to exchange with this neighbor
C     myThid        :: my Thread Id. number

      INTEGER tILo, tIHi, tiStride
      INTEGER tJLo, tJHi, tjStride
      INTEGER tKLo, tKHi, tkStride
      INTEGER i1Lo, i1Hi, j1Lo, j1Hi, k1Lo, k1Hi
      INTEGER thisTile, nN, bi, bj
      INTEGER e2BufrRecSize, sizeNb, sizeBi, sizeBj
      _RX     e2Bufr1_RX( e2BufrRecSize, sizeNb, sizeBi, sizeBj, 2 )
      _RX     array(i1Lo:i1Hi,j1Lo:j1Hi,k1Lo:k1Hi)
      INTEGER e2_msgHandles( 2, sizeNb, sizeBi, sizeBj )
      CHARACTER commSetting
      INTEGER myThid
CEOP

C !LOCAL VARIABLES:
C     == Local variables ==
C     itl,jtl,ktl :: Loop counters (this tile)
C     soT    :: Source tile Id number
C     oNb    :: Opposing send record number
C     iBufr  :: Buffer counter
C     sNb    :: buffer (source) Neighbour index to get data from
C     sBi    :: buffer (source) Tile  index (for this Proc) to get data from
C     sBj    :: buffer (source) Tile  index (for this Proc) to get data from
C     sLv    :: buffer (source) level index to get data from
C     i,j    :: Loop counters
      INTEGER itl, jtl, ktl
      INTEGER soT
      INTEGER oNb
      INTEGER iBufr
      INTEGER sNb, sBi, sBj, sLv
c     CHARACTER*(MAX_LEN_MBUF) msgBuf

      soT = exch2_neighbourId( nN, thisTile )
      oNb = exch2_opposingSend(nN, thisTile )

C     Handle receive end data transport according to communication mechanism
C     between source and target tile
      IF     ( commSetting .EQ. 'P' ) THEN
C      1 Need to check and spin on data ready assertion for multithreaded mode,
C        for now, ensure global sync using barrier.
C      2 get directly data from 1rst level buffer (sLv=1);

C     find the tile indices (local to this Proc) corresponding to
C      this source tile Id "soT" (note: this is saved in W2_tileIndex array)
       sLv = 1
       sNb = oNb
       sBi = W2_tileIndex(soT)
       sBj = 1 + (sBi-1)/sizeBi
       sBi = 1 + MOD(sBi-1,sizeBi)
#ifdef ALLOW_USE_MPI
      ELSEIF ( commSetting .EQ. 'M' ) THEN
       sLv = 2
       sBi = bi
       sBj = bj
       sNb = nN
#endif /* ALLOW_USE_MPI */
      ELSE
       STOP 'EXCH2_GET_RX1:: commSetting VALUE IS INVALID'
      ENDIF

      iBufr = 0
      DO ktl=tKlo,tKhi,tKStride
       DO jtl=tJLo, tJHi, tjStride
        DO itl=tILo, tIHi, tiStride
C     Read from e2Bufr1_RX(iBufr,sNb,sBi,sBj,sLv)
         iBufr = iBufr+1
         array(itl,jtl,ktl) = e2Bufr1_RX(iBufr,sNb,sBi,sBj,sLv)
        ENDDO
       ENDDO
      ENDDO

      RETURN
      END

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	jmc	1.4	C $Header: /u/gcmpack/MITgcm/pkg/exch2/exch2_get_rx1.template,v 1.3 2010/04/23 20:21:06 jmc Exp $
2	jmc	1.1	C $Name: $
3
4			#include "CPP_EEOPTIONS.h"
5			#include "W2_OPTIONS.h"
6
7			CBOP 0
8			C !ROUTINE: EXCH2_GET_RX1
9
10			C !INTERFACE:
11			SUBROUTINE EXCH2_GET_RX1(
12			I tIlo, tIhi, tiStride,
13			I tJlo, tJhi, tjStride,
14			I tKlo, tKhi, tkStride,
15			I thisTile, nN, bi, bj,
16			I e2BufrRecSize, sizeNb, sizeBi, sizeBj,
17			I e2Bufr1_RX,
18			U array,
19			I i1Lo, i1Hi, j1Lo, j1Hi, k1Lo, k1Hi,
20			U e2_msgHandles,
21			I commSetting, myThid )
22
23			C !DESCRIPTION:
24			C Scalar field (1 component) Exchange:
25			C Get from buffer exchanged data to fill in this tile-egde overlap region.
26
27			C !USES:
28			IMPLICIT NONE
29
30			#include "SIZE.h"
31			#include "EEPARAMS.h"
32			#include "W2_EXCH2_SIZE.h"
33			#include "W2_EXCH2_TOPOLOGY.h"
34
35			C !INPUT/OUTPUT PARAMETERS:
36			C === Routine arguments ===
37			C tIlo,tIhi :: index range in I that will be filled in target "array"
38			C tIstride :: index step in I that will be filled in target "array"
39			C tJlo,tJhi :: index range in J that will be filled in target "array"
40			C tJstride :: index step in J that will be filled in target "array"
41			C tKlo,tKhi :: index range in K that will be filled in target "array"
42			C tKstride :: index step in K that will be filled in target "array"
43	jmc	1.3	C thisTile :: receiving tile Id. number
44	jmc	1.1	C bi,bj :: Indices of the receiving tile within this process
45			C :: (used to select buffer slots that are allowed).
46			C nN :: Neighbour entry that we are processing
47			C e2BufrRecSize :: Number of elements in each entry of e2Bufr1_RX
48			C sizeNb :: Second dimension of e2Bufr1_RX
49			C sizeBi :: Third dimension of e2Bufr1_RX
50			C sizeBj :: Fourth dimension of e2Bufr1_RX
51			C e2Bufr1_RX :: Data transport buffer array. This array is used in one of
52			C :: two ways. For PUT communication the entry in the buffer
53			C :: associated with the source for this receive (determined
54			C :: from the opposing_send index) is read.
55			C :: For MSG communication the entry in the buffer associated
56			C :: with this neighbor of this tile is used as a receive
57			C :: location for loading a linear stream of bytes.
58			C array :: Target array that this receive writes to.
59			C i1Lo, i1Hi :: I coordinate bounds of target array
60			C j1Lo, j1Hi :: J coordinate bounds of target array
61			C k1Lo, k1Hi :: K coordinate bounds of target array
62			C e2_msgHandles :: Synchronization and coordination data structure used to
63			C :: coordinate access to e2Bufr1_RX or to regulate message
64			C :: buffering. In PUT communication sender will increment
65			C :: handle entry once data is ready in buffer. Receiver will
66			C :: decrement handle once data is consumed from buffer.
67	jmc	1.3	C :: For MPI MSG communication MPI_Wait uses handle to check
68	jmc	1.1	C :: Isend has cleared. This is done in routine after receives.
69			C commSetting :: Mode of communication used to exchange with this neighbor
70			C myThid :: my Thread Id. number
71
72			INTEGER tILo, tIHi, tiStride
73			INTEGER tJLo, tJHi, tjStride
74			INTEGER tKLo, tKHi, tkStride
75			INTEGER i1Lo, i1Hi, j1Lo, j1Hi, k1Lo, k1Hi
76			INTEGER thisTile, nN, bi, bj
77			INTEGER e2BufrRecSize, sizeNb, sizeBi, sizeBj
78			_RX e2Bufr1_RX( e2BufrRecSize, sizeNb, sizeBi, sizeBj, 2 )
79			_RX array(i1Lo:i1Hi,j1Lo:j1Hi,k1Lo:k1Hi)
80			INTEGER e2_msgHandles( 2, sizeNb, sizeBi, sizeBj )
81			CHARACTER commSetting
82			INTEGER myThid
83			CEOP
84
85			C !LOCAL VARIABLES:
86			C == Local variables ==
87			C itl,jtl,ktl :: Loop counters (this tile)
88			C soT :: Source tile Id number
89			C oNb :: Opposing send record number
90			C iBufr :: Buffer counter
91	jmc	1.3	C sNb :: buffer (source) Neighbour index to get data from
92	jmc	1.1	C sBi :: buffer (source) Tile index (for this Proc) to get data from
93			C sBj :: buffer (source) Tile index (for this Proc) to get data from
94			C sLv :: buffer (source) level index to get data from
95			C i,j :: Loop counters
96			INTEGER itl, jtl, ktl
97			INTEGER soT
98			INTEGER oNb
99			INTEGER iBufr
100			INTEGER sNb, sBi, sBj, sLv
101			c CHARACTER*(MAX_LEN_MBUF) msgBuf
102
103			soT = exch2_neighbourId( nN, thisTile )
104			oNb = exch2_opposingSend(nN, thisTile )
105
106			C Handle receive end data transport according to communication mechanism
107			C between source and target tile
108			IF ( commSetting .EQ. 'P' ) THEN
109			C 1 Need to check and spin on data ready assertion for multithreaded mode,
110			C for now, ensure global sync using barrier.
111			C 2 get directly data from 1rst level buffer (sLv=1);
112
113			C find the tile indices (local to this Proc) corresponding to
114	jmc	1.4	C this source tile Id "soT" (note: this is saved in W2_tileIndex array)
115	jmc	1.1	sLv = 1
116			sNb = oNb
117	jmc	1.4	sBi = W2_tileIndex(soT)
118			sBj = 1 + (sBi-1)/sizeBi
119			sBi = 1 + MOD(sBi-1,sizeBi)
120	jmc	1.1	#ifdef ALLOW_USE_MPI
121			ELSEIF ( commSetting .EQ. 'M' ) THEN
122			sLv = 2
123			sBi = bi
124			sBj = bj
125			sNb = nN
126			#endif /* ALLOW_USE_MPI */
127			ELSE
128			STOP 'EXCH2_GET_RX1:: commSetting VALUE IS INVALID'
129			ENDIF
130
131			iBufr = 0
132			DO ktl=tKlo,tKhi,tKStride
133			DO jtl=tJLo, tJHi, tjStride
134			DO itl=tILo, tIHi, tiStride
135			C Read from e2Bufr1_RX(iBufr,sNb,sBi,sBj,sLv)
136			iBufr = iBufr+1
137			array(itl,jtl,ktl) = e2Bufr1_RX(iBufr,sNb,sBi,sBj,sLv)
138			ENDDO
139			ENDDO
140			ENDDO
141
142			RETURN
143			END
144
145			C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
146
147			CEH3 ;;; Local Variables: ***
148			CEH3 ;;; mode:fortran ***
149			CEH3 ;;; End: ***