1 |
C $Header: /u/gcmpack/MITgcm/pkg/exch2/W2_EXCH2_PARAMS.h,v 1.12 2011/07/09 22:09:07 jmc Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
CBOP |
5 |
C !ROUTINE: W2_EXCH2_PARAMS.h |
6 |
C !INTERFACE: |
7 |
C #include W2_EXCH2_PARAMS.h |
8 |
|
9 |
C !DESCRIPTION: |
10 |
C *==========================================================* |
11 |
C | W2_EXCH2_PARAMS.h |
12 |
C | o Header file defining WRAPPER2-EXCH2 topology parameters |
13 |
C *==========================================================* |
14 |
CEOP |
15 |
|
16 |
C-- COMMON /W2_EXCH2_PARM_I/ Integer valued parameters used by W2-EXCH2 |
17 |
C preDefTopol :: pre-defined Topology selector: |
18 |
C :: = 0 : topology defined from processing "data.exch2"; |
19 |
C :: = 1 : simple, single facet topology; |
20 |
C :: = 2 : customized topology (w2_set_myown_facets) |
21 |
C :: = 3 : 6-face Cube (3 face-dims: nRed, nGreen, nBlue). |
22 |
C nFacets :: Number of facets (or domains) in this topology |
23 |
C facet_dims :: facet pair of dimensions (n1x,n1y, n2x,n2y, ...) |
24 |
C nTiles :: Number of tiles in this topology <- moved to W2_EXCH2_TOPOLOGY.h |
25 |
C nBlankTiles :: Number of "Blank-Tiles" |
26 |
C blankList :: List of "Blank-Tiles" (non active) |
27 |
C-- |
28 |
C W2_mapIO :: select option for global-IO mapping: |
29 |
C =-1 :: old format, put facets 1 after the other in the X dir.; |
30 |
C :: this is not necessary "compact". |
31 |
C = 1 :: compact format, 1 facet after the other (mostly in Y dir.) |
32 |
C :: but needs to fold some facet (domain) if too large |
33 |
C = 0 :: compact format (= 1 long line), one facet after the other. |
34 |
C-- |
35 |
C W2_oUnit :: output fortran Unit for printing Std messages |
36 |
C W2_printMsg :: select option for information messages printing |
37 |
C < 0 :: open and print to "w2_tile_topology" log file |
38 |
C = 0 :: print the minimum, to StdOut |
39 |
C = 1 :: no duplicated print from different processes (only Master) |
40 |
C = 2 :: all processes do print (used to check). |
41 |
INTEGER preDefTopol |
42 |
INTEGER nFacets |
43 |
INTEGER facet_dims(2*W2_maxNbFacets) |
44 |
INTEGER nBlankTiles |
45 |
INTEGER blankList(W2_maxNbTiles) |
46 |
INTEGER W2_mapIO |
47 |
INTEGER W2_oUnit, W2_printMsg |
48 |
COMMON /W2_EXCH2_PARM_I/ |
49 |
& preDefTopol, |
50 |
& nFacets, facet_dims, |
51 |
& nBlankTiles, blankList, |
52 |
& W2_mapIO, |
53 |
& W2_oUnit, W2_printMsg |
54 |
|
55 |
C-- COMMON /W2_EXCH2_PARM_L/ Logical valued parameters used by W2-EXCH2 |
56 |
C W2_useE2ioLayOut :: =T: use Exch2 global-IO Layout; =F: use model default |
57 |
LOGICAL W2_useE2ioLayOut |
58 |
COMMON /W2_EXCH2_PARM_L/ |
59 |
& W2_useE2ioLayOut |
60 |
|
61 |
C-- COMMON /W2_EXCH2_BUILD_I/ Integer variables used to build topology |
62 |
C facet_owns :: Range of tiles this facet "owns" |
63 |
C facet_pij \ :: |
64 |
C facet_oi } :: indices correspondence matrix (facet_pij) & offsets: |
65 |
C facet_oj / :: |
66 |
C-with: suffix "so" for indices of source facet j ; |
67 |
C suffix "tg" for indices of target facet jj= INT(facet_link(i,j)) |
68 |
C pij(:,i,j) : matrix which gives so indices when applied to tg indices |
69 |
C iso = pij(1)*itg + pij(2)*jtg + oi |
70 |
C jso = pij(3)*itg + pij(4)*jtg + oj |
71 |
C----- |
72 |
INTEGER facet_owns(2,W2_maxNbFacets) |
73 |
INTEGER facet_pij(4,4,W2_maxNbFacets) |
74 |
INTEGER facet_oi(4,W2_maxNbFacets) |
75 |
INTEGER facet_oj(4,W2_maxNbFacets) |
76 |
COMMON /W2_EXCH2_BUILD_I/ |
77 |
& facet_owns, |
78 |
& facet_pij, facet_oi, facet_oj |
79 |
|
80 |
C-- COMMON /W2_EXCH2_PARM_R/ Real*4 valued parameters used by W2-EXCH2 |
81 |
C-- topology defined from processing "data.exch2" (preDefTopol=0): |
82 |
C facet_link :: Face-Edge connectivity map: |
83 |
C facet_link(i,j)=XX.1 : face(j)-edge(i) (i=1,2,3,4 <==> N,S,E,W) |
84 |
C is connected to Northern edge of face "XX" ; similarly, |
85 |
C = XX.2 : to Southern.E, XX.3 = Eastern.E, XX.4 = Western.E of face "XX". |
86 |
Real*4 facet_link( 4, W2_maxNbFacets ) |
87 |
COMMON /W2_EXCH2_PARM_R/ facet_link |
88 |
|
89 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |