eesupp/src/exch_uv_xy_rx.template

C $Header: /u/gcmpack/MITgcm/eesupp/src/exch_uv_xy_rx.template,v 1.10 2009/04/28 15:17:00 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_XY_RX

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

C     !DESCRIPTION:
C     *==========================================================*
C     | SUBROUTINE EXCH_UV_XY_RX
C     | o Handle exchanges for _RX, 2-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,nSx,nSy)
      _RX Vphi(1-OLx:sNx+OLx,1-OLy:sNy+OLy,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, 1, myThid )
#else
      CALL EXCH2_UV_3D_RX(
     U                     Uphi, Vphi,
     I                     withSigns, 1, myThid )
#endif
      RETURN
#else /* ALLOW_EXCH2 */

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