eesupp/src/exch_xyz_rx.template

C $Header: /u/gcmpack/MITgcm/eesupp/src/exch_xyz_rx.template,v 1.6 2006/08/23 15:20:37 jmc Exp $
C $Name:  $

#include "PACKAGES_CONFIG.h"
#include "CPP_EEOPTIONS.h"

CBOP
C     !ROUTINE: EXCH_XYZ_RX

C     !INTERFACE:
      SUBROUTINE EXCH_XYZ_RX(
     U                       phi,
     I                       myThid )

C     !DESCRIPTION:
C     *==========================================================*
C     | SUBROUTINE EXCH_XYZ_RX
C     | o Handle exchanges for _RX, three-dim scalar arrays.
C     *==========================================================*
C     | Invoke appropriate exchange routine depending on type
C     | of grid (cube or globally indexed) to be operated on.
C     *==========================================================*

C     !USES:
      IMPLICIT NONE
C     === Global data ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "EESUPPORT.h"
#include "EXCH.h"

C     !INPUT/OUTPUT PARAMETERS:
C     === Routine arguments ===
C     phi    :: Array with overlap regions are to be exchanged
C     myThid :: My thread id.
      _RX phi(1-OLx:sNx+OLx,1-OLy:sNy+OLy,1:Nr,nSx,nSy)
      INTEGER myThid

C     !LOCAL VARIABLES:
C     == Local variables ==
C     OL[wens]       :: Overlap extents in west, east, north, south.
C     exchWidth[XY]  :: Extent of regions that will be exchanged.
      INTEGER OLw, OLe, OLn, OLs, exchWidthX, exchWidthY, myNz

CEOP

#ifdef ALLOW_EXCH2
      CALL EXCH2_3D_RX( phi, Nr, myThid )
      RETURN
#else

      OLw        = OLx
      OLe        = OLx
      OLn        = OLy
      OLs        = OLy
      exchWidthX = OLx
      exchWidthY = OLy
      myNz       = Nr
C     ** NOTE ** The exchange routine we use here does not
C                require the preceeding and following barriers.
C                However, the slow, simple exchange interface
C                that is calling it here is meant to ensure
C                that threads are synchronised before exchanges
C                begine.
      IF (useCubedSphereExchange) THEN
       CALL EXCH_RX_CUBE( phi,
     I            OLw, OLe, OLs, OLn, myNz,
     I            exchWidthX, exchWidthY,
     I            FORWARD_SIMULATION, EXCH_UPDATE_CORNERS, myThid )
      ELSE
       CALL EXCH_RX( phi,
     I            OLw, OLe, OLs, OLn, myNz,
     I            exchWidthX, exchWidthY,
     I            FORWARD_SIMULATION, EXCH_UPDATE_CORNERS, myThid )
      ENDIF

      RETURN
#endif
      END
1	heimbach	1.7	C $Header: /u/gcmpack/MITgcm/eesupp/src/exch_xyz_rx.template,v 1.6 2006/08/23 15:20:37 jmc Exp $
2	cnh	1.3	C $Name: $
3	adcroft	1.2
4	jmc	1.5	#include "PACKAGES_CONFIG.h"
5	adcroft	1.2	#include "CPP_EEOPTIONS.h"
6	jmc	1.6
7	cnh	1.3	CBOP
8			C !ROUTINE: EXCH_XYZ_RX
9
10			C !INTERFACE:
11	jmc	1.6	SUBROUTINE EXCH_XYZ_RX(
12			U phi,
13	adcroft	1.2	I myThid )
14
15	cnh	1.3	C !DESCRIPTION:
16			C ==========================================================
17	jmc	1.6	C \| SUBROUTINE EXCH_XYZ_RX
18			C \| o Handle exchanges for _RX, three-dim scalar arrays.
19	cnh	1.3	C ==========================================================
20			C \| Invoke appropriate exchange routine depending on type
21			C \| of grid (cube or globally indexed) to be operated on.
22			C ==========================================================
23
24			C !USES:
25	jmc	1.6	IMPLICIT NONE
26	adcroft	1.2	C === Global data ===
27			#include "SIZE.h"
28			#include "EEPARAMS.h"
29			#include "EESUPPORT.h"
30	edhill	1.4	#include "EXCH.h"
31	adcroft	1.2
32	cnh	1.3	C !INPUT/OUTPUT PARAMETERS:
33	adcroft	1.2	C === Routine arguments ===
34	cnh	1.3	C phi :: Array with overlap regions are to be exchanged
35			C myThid :: My thread id.
36	adcroft	1.2	_RX phi(1-OLx:sNx+OLx,1-OLy:sNy+OLy,1:Nr,nSx,nSy)
37			INTEGER myThid
38
39	cnh	1.3	C !LOCAL VARIABLES:
40	adcroft	1.2	C == Local variables ==
41	cnh	1.3	C OL[wens] :: Overlap extents in west, east, north, south.
42			C exchWidth[XY] :: Extent of regions that will be exchanged.
43	adcroft	1.2	INTEGER OLw, OLe, OLn, OLs, exchWidthX, exchWidthY, myNz
44	cnh	1.3
45			CEOP
46	adcroft	1.2
47	jmc	1.5	#ifdef ALLOW_EXCH2
48	jmc	1.6	CALL EXCH2_3D_RX( phi, Nr, myThid )
49	jmc	1.5	RETURN
50	heimbach	1.7	#else
51	jmc	1.5
52	adcroft	1.2	OLw = OLx
53			OLe = OLx
54			OLn = OLy
55			OLs = OLy
56			exchWidthX = OLx
57			exchWidthY = OLy
58			myNz = Nr
59	jmc	1.6	C NOTE The exchange routine we use here does not
60	adcroft	1.2	C require the preceeding and following barriers.
61	jmc	1.6	C However, the slow, simple exchange interface
62			C that is calling it here is meant to ensure
63	adcroft	1.2	C that threads are synchronised before exchanges
64			C begine.
65			IF (useCubedSphereExchange) THEN
66			CALL EXCH_RX_CUBE( phi,
67			I OLw, OLe, OLs, OLn, myNz,
68			I exchWidthX, exchWidthY,
69			I FORWARD_SIMULATION, EXCH_UPDATE_CORNERS, myThid )
70			ELSE
71			CALL EXCH_RX( phi,
72			I OLw, OLe, OLs, OLn, myNz,
73			I exchWidthX, exchWidthY,
74			I FORWARD_SIMULATION, EXCH_UPDATE_CORNERS, myThid )
75			ENDIF
76
77			RETURN
78	heimbach	1.7	#endif
79	adcroft	1.2	END