eesupp/src/exch_uv_xyz_rx.template

C $Header: /u/gcmpack/MITgcm/eesupp/src/exch_uv_xyz_rx.template,v 1.11 2009/04/28 15:17:01 jmc Exp $
C $Name:  $

#include "PACKAGES_CONFIG.h"
#include "CPP_EEOPTIONS.h"
#ifdef ALLOW_EXCH2
#include "W2_OPTIONS.h"
#endif

CBOP

C     !ROUTINE: EXCH_UV_XYZ_RX

C     !INTERFACE:
      SUBROUTINE EXCH_UV_XYZ_RX(
     U                          Uphi, Vphi,
     I                          withSigns, myThid )

C     !DESCRIPTION:
C     *==========================================================*
C     | SUBROUTINE EXCH_UV_XYZ_RX
C     | o Handle exchanges for _RX, 3-dimensional vector arrays.
C     *==========================================================*
C     | Vector arrays need to be rotated and interchaged for
C     | exchange operations on some grids. This driver routine
C     | branches to support this.
C     *==========================================================*

C     !USES:
      IMPLICIT NONE

C     === Global data ===
#include "SIZE.h"
#include "EEPARAMS.h"

C     !INPUT/OUTPUT PARAMETERS:
C     === Routine arguments ===
C     Uphi      :: 2 components of a vector field with overlap regions
C     Vphi      :: to be exchanged
C     withSigns :: Flag controlling whether vector is signed.
C     myThid    :: my Thread Id. number
      _RX Uphi(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RX Vphi(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      LOGICAL withSigns
      INTEGER myThid

C     !LOCAL VARIABLES:
#ifndef ALLOW_EXCH2
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
#endif
CEOP

#ifdef ALLOW_EXCH2
#ifdef W2_USE_R1_ONLY
      CALL EXCH2_UV_CGRID_3D_RX(
     U                     Uphi, Vphi,
     I                     withSigns, Nr, myThid )
#else
      CALL EXCH2_UV_3D_RX(
     U                     Uphi, Vphi,
     I                     withSigns, Nr, myThid )
#endif
      RETURN
#else /* ALLOW_EXCH2 */

      OLw        = OLx
      OLe        = OLx
      OLn        = OLy
      OLs        = OLy
      exchWidthX = OLx
      exchWidthY = OLy
      myNz       = Nr
      IF (useCubedSphereExchange) THEN
       CALL EXCH1_UV_RX_CUBE( Uphi, Vphi, withSigns,
     I            OLw, OLe, OLs, OLn, myNz,
     I            exchWidthX, exchWidthY,
     I            EXCH_UPDATE_CORNERS, myThid )
      ELSE
       CALL EXCH1_RX( Uphi,
     I            OLw, OLe, OLs, OLn, myNz,
     I            exchWidthX, exchWidthY,
     I            EXCH_UPDATE_CORNERS, myThid )
       CALL EXCH1_RX( Vphi,
     I            OLw, OLe, OLs, OLn, myNz,
     I            exchWidthX, exchWidthY,
     I            EXCH_UPDATE_CORNERS, myThid )
      ENDIF

      RETURN
#endif /* ALLOW_EXCH2 */
      END

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

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	jmc	1.12	C $Header: /u/gcmpack/MITgcm/eesupp/src/exch_uv_xyz_rx.template,v 1.11 2009/04/28 15:17:01 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.8	#ifdef ALLOW_EXCH2
7			#include "W2_OPTIONS.h"
8			#endif
9	adcroft	1.2
10	cnh	1.3	CBOP
11
12			C !ROUTINE: EXCH_UV_XYZ_RX
13
14			C !INTERFACE:
15	adcroft	1.2	SUBROUTINE EXCH_UV_XYZ_RX(
16	jmc	1.12	U Uphi, Vphi,
17			I withSigns, myThid )
18	jmc	1.6
19	cnh	1.3	C !DESCRIPTION:
20			C ==========================================================
21	jmc	1.6	C \| SUBROUTINE EXCH_UV_XYZ_RX
22			C \| o Handle exchanges for _RX, 3-dimensional vector arrays.
23	cnh	1.3	C ==========================================================
24	jmc	1.6	C \| Vector arrays need to be rotated and interchaged for
25	cnh	1.3	C \| exchange operations on some grids. This driver routine
26			C \| branches to support this.
27			C ==========================================================
28	adcroft	1.2
29	cnh	1.3	C !USES:
30	jmc	1.6	IMPLICIT NONE
31	jmc	1.12
32	adcroft	1.2	C === Global data ===
33			#include "SIZE.h"
34			#include "EEPARAMS.h"
35
36	cnh	1.3	C !INPUT/OUTPUT PARAMETERS:
37	adcroft	1.2	C === Routine arguments ===
38	jmc	1.12	C Uphi :: 2 components of a vector field with overlap regions
39			C Vphi :: to be exchanged
40			C withSigns :: Flag controlling whether vector is signed.
41			C myThid :: my Thread Id. number
42	adcroft	1.2	_RX Uphi(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
43			_RX Vphi(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
44			LOGICAL withSigns
45			INTEGER myThid
46
47	cnh	1.3	C !LOCAL VARIABLES:
48	jmc	1.10	#ifndef ALLOW_EXCH2
49	adcroft	1.2	C == Local variables ==
50	cnh	1.3	C OL[wens] :: Overlap extents in west, east, north, south.
51			C exchWidth[XY] :: Extent of regions that will be exchanged.
52	adcroft	1.2	INTEGER OLw, OLe, OLn, OLs, exchWidthX, exchWidthY, myNz
53	jmc	1.10	#endif
54			CEOP
55	cnh	1.3
56	jmc	1.5	#ifdef ALLOW_EXCH2
57	jmc	1.8	#ifdef W2_USE_R1_ONLY
58			CALL EXCH2_UV_CGRID_3D_RX(
59			U Uphi, Vphi,
60			I withSigns, Nr, myThid )
61			#else
62	jmc	1.6	CALL EXCH2_UV_3D_RX(
63			U Uphi, Vphi,
64			I withSigns, Nr, myThid )
65	jmc	1.8	#endif
66	jmc	1.5	RETURN
67	jmc	1.8	#else /* ALLOW_EXCH2 */
68	adcroft	1.2
69			OLw = OLx
70			OLe = OLx
71			OLn = OLy
72			OLs = OLy
73			exchWidthX = OLx
74			exchWidthY = OLy
75			myNz = Nr
76			IF (useCubedSphereExchange) THEN
77	jmc	1.12	CALL EXCH1_UV_RX_CUBE( Uphi, Vphi, withSigns,
78	adcroft	1.2	I OLw, OLe, OLs, OLn, myNz,
79			I exchWidthX, exchWidthY,
80	jmc	1.12	I EXCH_UPDATE_CORNERS, myThid )
81	adcroft	1.2	ELSE
82	jmc	1.12	CALL EXCH1_RX( Uphi,
83			I OLw, OLe, OLs, OLn, myNz,
84			I exchWidthX, exchWidthY,
85			I EXCH_UPDATE_CORNERS, myThid )
86			CALL EXCH1_RX( Vphi,
87			I OLw, OLe, OLs, OLn, myNz,
88			I exchWidthX, exchWidthY,
89			I EXCH_UPDATE_CORNERS, myThid )
90	adcroft	1.2	ENDIF
91
92			RETURN
93	jmc	1.8	#endif /* ALLOW_EXCH2 */
94	adcroft	1.2	END
95	jmc	1.5
96			C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
97
98			CEH3 ;;; Local Variables: ***
99			CEH3 ;;; mode:fortran ***
100			CEH3 ;;; End: ***