1 |
C $Header: /u/gcmpack/MITgcm/eesupp/src/exch_rx_cube.template,v 1.4 2007/07/28 16:07:35 heimbach Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#include "CPP_EEOPTIONS.h" |
5 |
|
6 |
CBOP |
7 |
C !ROUTINE: EXCH_RX_CUBE |
8 |
|
9 |
C !INTERFACE: |
10 |
SUBROUTINE EXCH_RX_CUBE( |
11 |
U array, |
12 |
I myOLw, myOLe, myOLn, myOLs, myNz, |
13 |
I exchWidthX, exchWidthY, |
14 |
I simulationMode, cornerMode, myThid ) |
15 |
IMPLICIT NONE |
16 |
|
17 |
C !DESCRIPTION: |
18 |
C *==========================================================* |
19 |
C | SUBROUTINE EXCH_RX_CUBE |
20 |
C | o Control edge exchanges for RX array. |
21 |
C *==========================================================* |
22 |
C | |
23 |
C | Controlling routine for exchange of XY edges of an array |
24 |
C | distributed in X and Y. The routine interfaces to |
25 |
C | communication routines that can use messages passing |
26 |
C | exchanges, put type exchanges or get type exchanges. |
27 |
C | This allows anything from MPI to raw memory channel to |
28 |
C | memmap segments to be used as a inter-process and/or |
29 |
C | inter-thread communiation and synchronisation |
30 |
C | mechanism. |
31 |
C | Notes -- |
32 |
C | 1. Some low-level mechanisms such as raw memory-channel |
33 |
C | or SGI/CRAY shmem put do not have direct Fortran bindings |
34 |
C | and are invoked through C stub routines. |
35 |
C | 2. Although this routine is fairly general but it does |
36 |
C | require nSx and nSy are the same for all innvocations. |
37 |
C | There are many common data structures ( myByLo, |
38 |
C | westCommunicationMode, mpiIdW etc... ) tied in with |
39 |
C | (nSx,nSy). To support arbitray nSx and nSy would require |
40 |
C | general forms of these. |
41 |
C | |
42 |
C *==========================================================* |
43 |
|
44 |
C !USES: |
45 |
C == Global data == |
46 |
#include "SIZE.h" |
47 |
#include "EEPARAMS.h" |
48 |
cph-mpi#include "EESUPPORT.h" |
49 |
#include "EXCH.h" |
50 |
|
51 |
C !INPUT/OUTPUT PARAMETERS: |
52 |
C == Routine arguments == |
53 |
C array :: Array with edges to exchange. |
54 |
C myOLw :: West, East, North and South overlap region sizes. |
55 |
C myOLe |
56 |
C myOLn |
57 |
C myOLs |
58 |
C exchWidthX :: Width of data region exchanged in X. |
59 |
C exchWidthY :: Width of data region exchanged in Y. |
60 |
C Note -- |
61 |
C 1. In theory one could have a send width and |
62 |
C a receive width for each face of each tile. The only |
63 |
C restriction woul be that the send width of one |
64 |
C face should equal the receive width of the sent to |
65 |
C tile face. Dont know if this would be useful. I |
66 |
C have left it out for now as it requires additional |
67 |
C bookeeping. |
68 |
C simulationMode :: Forward or reverse mode exchange ( provides |
69 |
C support for adjoint integration of code. ) |
70 |
C cornerMode :: Flag indicating whether corner updates are |
71 |
C needed. |
72 |
C myThid :: Thread number of this instance of S/R EXCH... |
73 |
INTEGER myOLw |
74 |
INTEGER myOLe |
75 |
INTEGER myOLs |
76 |
INTEGER myOLn |
77 |
INTEGER myNz |
78 |
INTEGER exchWidthX |
79 |
INTEGER exchWidthY |
80 |
INTEGER simulationMode |
81 |
INTEGER cornerMode |
82 |
INTEGER myThid |
83 |
_RX array(1-myOLw:sNx+myOLe, |
84 |
& 1-myOLs:sNy+myOLn, |
85 |
& myNZ, nSx, nSy) |
86 |
|
87 |
C !LOCAL VARIABLES: |
88 |
C == Local variables == |
89 |
C theSimulationMode :: Holds working copy of simulation mode |
90 |
C theCornerMode :: Holds working copy of corner mode |
91 |
C I,J,K,bl,bt,bn,bs :: Loop and index counters |
92 |
C be,bw |
93 |
CHARACTER*(MAX_LEN_MBUF) msgBuf |
94 |
INTEGER theSimulationMode |
95 |
INTEGER theCornerMode |
96 |
INTEGER I,J,K |
97 |
INTEGER bl,bt,bn,bs,be,bw |
98 |
C == Statement function == |
99 |
C tilemod - Permutes indices to return neighboring tile index on |
100 |
C six face cube. |
101 |
INTEGER tilemod |
102 |
tilemod(I)=1+mod(I-1+6,6) |
103 |
CEOP |
104 |
|
105 |
IF ( sNx.NE.sNy .OR. |
106 |
& nSx.NE.6 .OR. nSy.NE.1 .OR. |
107 |
& nPx.NE.1 .OR. nPy.NE.1 ) THEN |
108 |
WRITE(msgBuf,'(2A)') 'EXCH_RX_CUBE: Wrong Tiling' |
109 |
CALL PRINT_ERROR( msgBuf, myThid ) |
110 |
WRITE(msgBuf,'(2A)') 'EXCH_RX_CUBE: ', |
111 |
& 'works only with sNx=sNy & nSx=6 & nSy=nPx=nPy=1' |
112 |
CALL PRINT_ERROR( msgBuf, myThid ) |
113 |
STOP 'ABNORMAL END: EXCH_RX_CUBE: Wrong Tiling' |
114 |
ENDIF |
115 |
|
116 |
theSimulationMode = simulationMode |
117 |
theCornerMode = cornerMode |
118 |
|
119 |
C For now tile<->tile exchanges are sequentialised through |
120 |
C thread 1. This is a temporary feature for preliminary testing until |
121 |
C general tile decomposistion is in place (CNH April 11, 2001) |
122 |
CALL BAR2( myThid ) |
123 |
IF ( myThid .EQ. 1 ) THEN |
124 |
|
125 |
DO bl = 1, 5, 2 |
126 |
|
127 |
bt = bl |
128 |
bn=tilemod(bt+2) |
129 |
bs=tilemod(bt-1) |
130 |
be=tilemod(bt+1) |
131 |
bw=tilemod(bt-2) |
132 |
|
133 |
DO K = 1, myNz |
134 |
DO J = 1, sNy |
135 |
DO I = 1, exchWidthX |
136 |
|
137 |
C Tile Odd:Odd+2 [get] [North<-West] |
138 |
array(J,sNy+I,K,bt,1) = array(I,sNy+1-J,K,bn,1) |
139 |
C Tile Odd:Odd-1 [get] [South<-North] |
140 |
array(J,1-I,K,bt,1) = array(J,sNy+1-I,K,bs,1) |
141 |
C Tile Odd:Odd+1 [get] [East<-West] |
142 |
array(sNx+I,J,K,bt,1) = array(I,J,K,be,1) |
143 |
C Tile Odd:Odd-2 [get] [West<-North] |
144 |
array(1-I,J,K,bt,1) = array(sNx+1-J,sNy+1-I,K,bw,1) |
145 |
|
146 |
ENDDO |
147 |
ENDDO |
148 |
ENDDO |
149 |
|
150 |
bt = bl+1 |
151 |
bn=tilemod(bt+1) |
152 |
bs=tilemod(bt-2) |
153 |
be=tilemod(bt+2) |
154 |
bw=tilemod(bt-1) |
155 |
|
156 |
DO K = 1, myNz |
157 |
DO J = 1, sNy |
158 |
DO I = 1, exchWidthX |
159 |
|
160 |
C Tile Even:Even+1 [get] [North<-South] |
161 |
array(J,sNy+I,K,bt,1) = array(J,I,K,bn,1) |
162 |
C Tile Even:Even-2 [get] [South<-East] |
163 |
array(J,1-I,K,bt,1) = array(sNx+1-I,sNy+1-J,K,bs,1) |
164 |
C Tile Even:Even+2 [get] [East<-South] |
165 |
array(sNx+I,J,K,bt,1) = array(sNx+1-J,I,K,be,1) |
166 |
C Tile Even:Even-1 [get] [West<-East] |
167 |
array(1-I,J,K,bt,1) = array(sNx+1-I,J,K,bw,1) |
168 |
|
169 |
ENDDO |
170 |
ENDDO |
171 |
ENDDO |
172 |
|
173 |
ENDDO |
174 |
|
175 |
ENDIF |
176 |
CALL BAR2(myThid) |
177 |
|
178 |
RETURN |
179 |
END |