pkg/exch2/W2_EXCH2_SIZE.h

C $Header: /u/gcmpack/MITgcm/pkg/exch2/W2_EXCH2_TOPOLOGY.h,v 1.4 2008/07/29 20:25:23 jmc Exp $
C $Name:  $

CBOP
C    !ROUTINE: W2_EXCH2_SIZE.h
C    !INTERFACE:
C    include W2_EXCH2_SIZE.h
C    !DESCRIPTION: \bv
C     *==========================================================*
C     | W2_EXCH2_SIZE.h
C     | Declare size of Wrapper2-Exch2 arrays
C     *==========================================================*
C     | Expected to be modified for unconventional configuration
C     | (e.g., many blank-tiles) or specific topology.
C     *==========================================================*
CEOP

C---   Size of Tiling topology structures
C  W2_maxNbFacets   :: Maximum number of Facets (also and formerly called
C                   :: "domains" or "sub-domains") of this topology.
C  W2_maxNeighbours :: Maximum number of neighbours any tile has.
C  W2_maxNbTiles    :: Maximum number of tiles (active+blank) in this topology
C  W2_ioBufferSize  :: Maximum size of Single-CPU IO buffer.
       INTEGER W2_maxNbFacets
       INTEGER W2_maxNeighbours
       INTEGER W2_maxNbTiles
       INTEGER W2_ioBufferSize

C---   Default values :
C      (suitable for 6-face Cube-Sphere topology, compact global I/O format)
C      W2_maxNbTiles = Nb of active tiles (=nSx*nSy*nPx*nPy) + Max_Nb_BlankTiles
C      default assume a large Max_Nb_BlankTiles equal to Nb of active tiles
C      resulting in doubling the tile number.
       PARAMETER ( W2_maxNbFacets = 10 )
       PARAMETER ( W2_maxNeighbours = 8 )
       PARAMETER ( W2_maxNbTiles = nSx*nSy*nPx*nPy * 2 )
       PARAMETER ( W2_ioBufferSize = W2_maxNbTiles*sNx*sNy )

C- Note: Overestimating W2_maxNbFacets and, to less extent, W2_maxNeighbours
C        have no or very little effects on memory footprint.
C        overestimated W2_maxNbTiles does not have large effect, except
C        through ioBufferSize (if related to, as here).
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
1	C $Header: /u/gcmpack/MITgcm/pkg/exch2/W2_EXCH2_TOPOLOGY.h,v 1.4 2008/07/29 20:25:23 jmc Exp $
2	C $Name: $
3
4	CBOP
5	C !ROUTINE: W2_EXCH2_SIZE.h
6	C !INTERFACE:
7	C include W2_EXCH2_SIZE.h
8	C !DESCRIPTION: \bv
9	C ==========================================================
10	C \| W2_EXCH2_SIZE.h
11	C \| Declare size of Wrapper2-Exch2 arrays
12	C ==========================================================
13	C \| Expected to be modified for unconventional configuration
14	C \| (e.g., many blank-tiles) or specific topology.
15	C ==========================================================
16	CEOP
17
18	C--- Size of Tiling topology structures
19	C W2_maxNbFacets :: Maximum number of Facets (also and formerly called
20	C :: "domains" or "sub-domains") of this topology.
21	C W2_maxNeighbours :: Maximum number of neighbours any tile has.
22	C W2_maxNbTiles :: Maximum number of tiles (active+blank) in this topology
23	C W2_ioBufferSize :: Maximum size of Single-CPU IO buffer.
24	INTEGER W2_maxNbFacets
25	INTEGER W2_maxNeighbours
26	INTEGER W2_maxNbTiles
27	INTEGER W2_ioBufferSize
28
29	C--- Default values :
30	C (suitable for 6-face Cube-Sphere topology, compact global I/O format)
31	C W2_maxNbTiles = Nb of active tiles (=nSxnSynPx*nPy) + Max_Nb_BlankTiles
32	C default assume a large Max_Nb_BlankTiles equal to Nb of active tiles
33	C resulting in doubling the tile number.
34	PARAMETER ( W2_maxNbFacets = 10 )
35	PARAMETER ( W2_maxNeighbours = 8 )
36	PARAMETER ( W2_maxNbTiles = nSxnSynPxnPy 2 )
37	PARAMETER ( W2_ioBufferSize = W2_maxNbTilessNxsNy )
38
39	C- Note: Overestimating W2_maxNbFacets and, to less extent, W2_maxNeighbours
40	C have no or very little effects on memory footprint.
41	C overestimated W2_maxNbTiles does not have large effect, except
42	C through ioBufferSize (if related to, as here).
43	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|