itd/code/SIZE.h

C $Header: /u/gcmpack/MITgcm_contrib/torge/itd/code/SIZE.h,v 1.2 2012/04/27 22:25:23 dimitri Exp $
C $Name:  $
C
CBOP
C    !ROUTINE: SIZE.h
C    !INTERFACE:
C    include SIZE.h
C    !DESCRIPTION: \bv
C     *==========================================================*
C     | SIZE.h Declare size of underlying computational grid.     
C     *==========================================================*
C     | The design here support a three-dimensional model grid    
C     | with indices I,J and K. The three-dimensional domain      
C     | is comprised of nPx*nSx blocks of size sNx along one axis 
C     | nPy*nSy blocks of size sNy along another axis and one     
C     | block of size Nz along the final axis.                    
C     | Blocks have overlap regions of size OLx and OLy along the 
C     | dimensions that are subdivided.                           
C     *==========================================================*
C     \ev
CEOP
C     Voodoo numbers controlling data layout.
C     sNx :: No. X points in sub-grid.
C     sNy :: No. Y points in sub-grid.
C     OLx :: Overlap extent in X.
C     OLy :: Overlat extent in Y.
C     nSx :: No. sub-grids in X.
C     nSy :: No. sub-grids in Y.
C     nPx :: No. of processes to use in X.
C     nPy :: No. of processes to use in Y.
C     Nx  :: No. points in X for the total domain.
C     Ny  :: No. points in Y for the total domain.
C     Nr  :: No. points in Z for full process domain.
CToM<<<
C     nITD - No. sea ice thickness categories
C     has an effect only when SEAICE_ITD is defined
C     but is needed to declare a bunch of variables in
C     SEAICE.h and SEAICE_PARAMS.h
C>>>ToM
      INTEGER sNx
      INTEGER sNy
      INTEGER OLx
      INTEGER OLy
      INTEGER nSx
      INTEGER nSy
      INTEGER nPx
      INTEGER nPy
      INTEGER Nx
      INTEGER Ny
      INTEGER Nr
      PARAMETER (
     &           sNx =  40,
     &           sNy =  40,
     &           OLx =   5,
     &           OLy =   5,
     &           nSx =   1,
     &           nSy =   1,
     &           nPx =   1,
     &           nPy =   1,
     &           Nx  = sNx*nSx*nPx,
     &           Ny  = sNy*nSy*nPy,
     &           Nr  =  50)

C     MAX_OLX :: Set to the maximum overlap region size of any array
C     MAX_OLY    that will be exchanged. Controls the sizing of exch
C                routine buffers.
      INTEGER MAX_OLX
      INTEGER MAX_OLY
      PARAMETER ( MAX_OLX = OLx,
     &            MAX_OLY = OLy )
CToM<<<
C nITD defines number of ice thickness categories,
C i.e. size of additional dimension to AREA, HEFF, HSNOW, etc.
C Bitz et al. (2001, JGR) suggest a minimum of nITD = 5
C
      INTEGER nITD
      PARAMETER(nITD = 7)
C>>>ToM

1	C $Header: /u/gcmpack/MITgcm_contrib/torge/itd/code/SIZE.h,v 1.2 2012/04/27 22:25:23 dimitri Exp $
2	C $Name: $
3	C
4	CBOP
5	C !ROUTINE: SIZE.h
6	C !INTERFACE:
7	C include SIZE.h
8	C !DESCRIPTION: \bv
9	C ==========================================================
10	C \| SIZE.h Declare size of underlying computational grid.
11	C ==========================================================
12	C \| The design here support a three-dimensional model grid
13	C \| with indices I,J and K. The three-dimensional domain
14	C \| is comprised of nPx*nSx blocks of size sNx along one axis
15	C \| nPy*nSy blocks of size sNy along another axis and one
16	C \| block of size Nz along the final axis.
17	C \| Blocks have overlap regions of size OLx and OLy along the
18	C \| dimensions that are subdivided.
19	C ==========================================================
20	C \ev
21	CEOP
22	C Voodoo numbers controlling data layout.
23	C sNx :: No. X points in sub-grid.
24	C sNy :: No. Y points in sub-grid.
25	C OLx :: Overlap extent in X.
26	C OLy :: Overlat extent in Y.
27	C nSx :: No. sub-grids in X.
28	C nSy :: No. sub-grids in Y.
29	C nPx :: No. of processes to use in X.
30	C nPy :: No. of processes to use in Y.
31	C Nx :: No. points in X for the total domain.
32	C Ny :: No. points in Y for the total domain.
33	C Nr :: No. points in Z for full process domain.
34	CToM<<<
35	C nITD - No. sea ice thickness categories
36	C has an effect only when SEAICE_ITD is defined
37	C but is needed to declare a bunch of variables in
38	C SEAICE.h and SEAICE_PARAMS.h
39	C>>>ToM
40	INTEGER sNx
41	INTEGER sNy
42	INTEGER OLx
43	INTEGER OLy
44	INTEGER nSx
45	INTEGER nSy
46	INTEGER nPx
47	INTEGER nPy
48	INTEGER Nx
49	INTEGER Ny
50	INTEGER Nr
51	PARAMETER (
52	& sNx = 40,
53	& sNy = 40,
54	& OLx = 5,
55	& OLy = 5,
56	& nSx = 1,
57	& nSy = 1,
58	& nPx = 1,
59	& nPy = 1,
60	& Nx = sNxnSxnPx,
61	& Ny = sNynSynPy,
62	& Nr = 50)
63
64	C MAX_OLX :: Set to the maximum overlap region size of any array
65	C MAX_OLY that will be exchanged. Controls the sizing of exch
66	C routine buffers.
67	INTEGER MAX_OLX
68	INTEGER MAX_OLY
69	PARAMETER ( MAX_OLX = OLx,
70	& MAX_OLY = OLy )
71	CToM<<<
72	C nITD defines number of ice thickness categories,
73	C i.e. size of additional dimension to AREA, HEFF, HSNOW, etc.
74	C Bitz et al. (2001, JGR) suggest a minimum of nITD = 5
75	C
76	INTEGER nITD
77	PARAMETER(nITD = 7)
78	C>>>ToM
79