eesupp/src/exch_xyz_rx.template

C $Header: /u/gcmpack/MITgcm/eesupp/src/exch_xyz_rx.template,v 1.3 2001/09/21 03:55:50 cnh Exp $
C $Name:  $

#include "CPP_EEOPTIONS.h"
CBOP

C     !ROUTINE: EXCH_XYZ_RX

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

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:
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

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