1 |
jmc |
1.10 |
C $Header: /u/gcmpack/MITgcm/pkg/exch2/W2_EXCH2_PARAMS.h,v 1.9 2009/05/12 19:40:32 jmc Exp $ |
2 |
jmc |
1.7 |
C $Name: $ |
3 |
|
|
|
4 |
jmc |
1.8 |
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 |
jmc |
1.9 |
C | o Header file defining WRAPPER2-EXCH2 topology parameters |
13 |
jmc |
1.8 |
C *==========================================================* |
14 |
|
|
CEOP |
15 |
|
|
|
16 |
jmc |
1.9 |
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 |
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 minimun, 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 nTiles |
45 |
|
|
INTEGER nBlankTiles |
46 |
|
|
INTEGER blankList(W2_maxNbTiles) |
47 |
|
|
INTEGER W2_mapIO |
48 |
|
|
INTEGER W2_oUnit, W2_printMsg |
49 |
|
|
COMMON /W2_EXCH2_PARM_I/ |
50 |
|
|
& preDefTopol, |
51 |
|
|
& nFacets, facet_dims, |
52 |
|
|
& nTiles, nBlankTiles, |
53 |
|
|
& blankList, |
54 |
|
|
& W2_mapIO, |
55 |
|
|
& W2_oUnit, W2_printMsg |
56 |
afe |
1.1 |
|
57 |
jmc |
1.10 |
C-- COMMON /W2_EXCH2_PARM_L/ Logical valued parameters used by W2-EXCH2 |
58 |
|
|
C W2_useE2ioLayOut :: =T: use Exch2 global-IO Layout; =F: use model default |
59 |
|
|
LOGICAL W2_useE2ioLayOut |
60 |
|
|
COMMON /W2_EXCH2_PARM_L/ |
61 |
|
|
& W2_useE2ioLayOut |
62 |
|
|
|
63 |
jmc |
1.9 |
C-- COMMON /W2_EXCH2_BUILD_I/ Integer variables used to build topology |
64 |
|
|
C facet_owns :: Range of tiles this facet "owns" |
65 |
|
|
C facet_pij \ :: |
66 |
|
|
C facet_oi } :: indices correspondence matrix (facet_pij) & offsets: |
67 |
|
|
C facet_oj / :: |
68 |
|
|
C-with: suffix "so" for indices of source facet j ; |
69 |
|
|
C suffix "tg" for indices of target facet jj= INT(facet_link(i,j)) |
70 |
|
|
C pij(:,i,j) : matrix which gives so indices when applied to tg indices |
71 |
|
|
C iso = pij(1)*itg + pij(2)*jtg + oi |
72 |
|
|
C jso = pij(3)*itg + pij(4)*jtg + oj |
73 |
|
|
C----- |
74 |
|
|
INTEGER facet_owns(2,W2_maxNbFacets) |
75 |
|
|
INTEGER facet_pij(4,4,W2_maxNbFacets) |
76 |
|
|
INTEGER facet_oi(4,W2_maxNbFacets) |
77 |
|
|
INTEGER facet_oj(4,W2_maxNbFacets) |
78 |
|
|
COMMON /W2_EXCH2_BUILD_I/ |
79 |
|
|
& facet_owns, |
80 |
|
|
& facet_pij, facet_oi, facet_oj |
81 |
afe |
1.1 |
|
82 |
jmc |
1.9 |
C-- COMMON /W2_EXCH2_PARM_R/ Real*4 valued parameters used by W2-EXCH2 |
83 |
|
|
C-- topology defined from processing "data.exch2" (preDefTopol=0): |
84 |
|
|
C facet_link :: Face-Edge connectivity map: |
85 |
|
|
C facet_link(i,j)=XX.1 : face(j)-edge(i) (i=1,2,3,4 <==> N,S,E,W) |
86 |
|
|
C is connected to Northern edge of face "XX" ; similarly, |
87 |
|
|
C = XX.2 : to Southern.E, XX.3 = Eastern.E, XX.4 = Western.E of face "XX". |
88 |
|
|
Real*4 facet_link( 4, W2_maxNbFacets ) |
89 |
|
|
COMMON /W2_EXCH2_PARM_R/ facet_link |
90 |
afe |
1.1 |
|
91 |
jmc |
1.9 |
C-- COMMON /EXCH2_FILLVAL_RX/ real type filling vallue used by EXCH2 |
92 |
|
|
C e2FillValue_RX :: filling value for null regions (facet-corner |
93 |
|
|
C :: halo regions) |
94 |
jmc |
1.6 |
_RL e2FillValue_RL |
95 |
|
|
_RS e2FillValue_RS |
96 |
|
|
_R4 e2FillValue_R4 |
97 |
|
|
_R8 e2FillValue_R8 |
98 |
jmc |
1.9 |
COMMON /EXCH2_FILLVAL_RL/ e2FillValue_RL |
99 |
|
|
COMMON /EXCH2_FILLVAL_RS/ e2FillValue_RS |
100 |
|
|
COMMON /EXCH2_FILLVAL_R4/ e2FillValue_R4 |
101 |
|
|
COMMON /EXCH2_FILLVAL_R8/ e2FillValue_R8 |
102 |
jmc |
1.6 |
|
103 |
jmc |
1.9 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |