eesupp/src/exch_uv_3d_rx.template

C $Header: /u/gcmpack/MITgcm/eesupp/src/exch_uv_3d_rx.template,v 1.4 2007/08/17 18:34:17 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_3D_RX

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

C     !DESCRIPTION:
C     *==========================================================*
C     | SUBROUTINE EXCH_UV_3D_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     myNz      :: 3rd dimension of array to exchange
C     myThid    :: my Thread Id. number
      INTEGER myNz
      _RX Uphi(1-OLx:sNx+OLx,1-OLy:sNy+OLy,myNz,nSx,nSy)
      _RX Vphi(1-OLx:sNx+OLx,1-OLy:sNy+OLy,myNz,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
#endif
CEOP

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

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