eesupp/src/exch_xyz_rx.template

C $Header: /u/gcmpack/MITgcm/eesupp/src/exch_xyz_rx.template,v 1.4 2004/04/03 04:46:34 edhill 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 )
      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

#ifdef ALLOW_EXCH2
      CALL EXCH2_XYZ_RX( phi, myThid )
      RETURN
#endif

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