eesupp/src/exch_xy_rx.template

C $Header: /u/gcmpack/MITgcm/eesupp/src/exch_xy_rx.template,v 1.5 2004/11/16 17:21:40 jmc Exp $
C $Name:  $

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

CBOP

C     !ROUTINE: EXCH_XY_RX

C     !INTERFACE:
      SUBROUTINE EXCH_XY_RX( 
     U                       phi, 
     I                       myThid )
      IMPLICIT NONE
C     !DESCRIPTION:
C     *==========================================================*
C     | SUBROUTINE EXCH_XY_RX                                     
C     | o Handle exchanges for _RX two-dimensional scalar arrays.
C     *==========================================================*
C     | Invoke appropriate exchange for a scalar array for either
C     | global grid, or cube sphere grid.                         
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,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_XY_RX( phi, myThid )
      RETURN
#else

      OLw        = OLx
      OLe        = OLx
      OLn        = OLy
      OLs        = OLy
      exchWidthX = OLx
      exchWidthY = OLy
      myNz       = 1
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

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

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	C $Header: /u/gcmpack/MITgcm/eesupp/src/exch_xy_rx.template,v 1.5 2004/11/16 17:21:40 jmc Exp $
2	C $Name: $
3
4	#include "PACKAGES_CONFIG.h"
5	#include "CPP_EEOPTIONS.h"
6
7	CBOP
8
9	C !ROUTINE: EXCH_XY_RX
10
11	C !INTERFACE:
12	SUBROUTINE EXCH_XY_RX(
13	U phi,
14	I myThid )
15	IMPLICIT NONE
16	C !DESCRIPTION:
17	C ==========================================================
18	C \| SUBROUTINE EXCH_XY_RX
19	C \| o Handle exchanges for _RX two-dimensional scalar arrays.
20	C ==========================================================
21	C \| Invoke appropriate exchange for a scalar array for either
22	C \| global grid, or cube sphere grid.
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,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	CEOP
45
46	#ifdef ALLOW_EXCH2
47	CALL EXCH2_XY_RX( phi, myThid )
48	RETURN
49	#else
50
51	OLw = OLx
52	OLe = OLx
53	OLn = OLy
54	OLs = OLy
55	exchWidthX = OLx
56	exchWidthY = OLy
57	myNz = 1
58	C NOTE The exchange routine we use here does not
59	C require the preceeding and following barriers.
60	C However, the slow, simple exchange interface
61	C that is calling it here is meant to ensure
62	C that threads are synchronised before exchanges
63	C begine.
64	IF (useCubedSphereExchange) THEN
65	CALL EXCH_RX_CUBE( phi,
66	I OLw, OLe, OLs, OLn, myNz,
67	I exchWidthX, exchWidthY,
68	I FORWARD_SIMULATION, EXCH_UPDATE_CORNERS, myThid )
69	ELSE
70	CALL EXCH_RX( phi,
71	I OLw, OLe, OLs, OLn, myNz,
72	I exchWidthX, exchWidthY,
73	I FORWARD_SIMULATION, EXCH_UPDATE_CORNERS, myThid )
74	ENDIF
75
76	RETURN
77	#endif
78	END
79
80	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
81
82	CEH3 ;;; Local Variables: ***
83	CEH3 ;;; mode:fortran ***
84	CEH3 ;;; End: ***