global_ocean.cs32x15/code_ad/SIZE.h

C $Header: /u/gcmpack/MITgcm/verification/global_ocean.cs32x15/code/SIZE.h,v 1.6 2009/05/28 23:19:29 jmc Exp $
C $Name:  $


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.
      INTEGER sNx
      INTEGER sNy
      INTEGER OLx
      INTEGER OLy
      INTEGER nSx
      INTEGER nSy
      INTEGER nPx
      INTEGER nPy
      INTEGER Nx
      INTEGER Ny
      INTEGER Nr
C-- Note: the 4 test-experiments (input, input.thsice, input.viscA4 and
C         input.icedyn ) have different minimum Overlap-size requirement:
C    input & input.thsice : work with Olx=Oly=2 (= absolute minimum size) ;
C    input.viscA4 : needs at least Olx=Oly=3 (for biharmonic viscosity) ;
C    input.icedyn : needs at least Olx=Oly=4 (CS-grid multidimensional Advect.)
      PARAMETER (
     &           sNx =  32,
     &           sNy =  16,
     &           OLx =   4,
     &           OLy =   4,
     &           nSx =  12,
     &           nSy =   1,
     &           nPx =   1,
     &           nPy =   1,
     &           Nx  = sNx*nSx*nPx,
     &           Ny  = sNy*nSy*nPy,
     &           Nr  =  15)

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 )

      INTEGER nobcs
      PARAMETER ( nobcs = 4 )

1	jmc	1.2	C $Header: /u/gcmpack/MITgcm/verification/global_ocean.cs32x15/code/SIZE.h,v 1.6 2009/05/28 23:19:29 jmc Exp $
2	heimbach	1.1	C $Name: $
3
4	jmc	1.2
5			CBOP
6			C !ROUTINE: SIZE.h
7			C !INTERFACE:
8			C include SIZE.h
9			C !DESCRIPTION: \bv
10			C ==========================================================
11			C \| SIZE.h Declare size of underlying computational grid.
12			C ==========================================================
13			C \| The design here support a three-dimensional model grid
14			C \| with indices I,J and K. The three-dimensional domain
15			C \| is comprised of nPx*nSx blocks of size sNx along one axis
16			C \| nPy*nSy blocks of size sNy along another axis and one
17			C \| block of size Nz along the final axis.
18			C \| Blocks have overlap regions of size OLx and OLy along the
19			C \| dimensions that are subdivided.
20			C ==========================================================
21			C \ev
22			CEOP
23	heimbach	1.1	C Voodoo numbers controlling data layout.
24	jmc	1.2	C sNx :: No. X points in sub-grid.
25			C sNy :: No. Y points in sub-grid.
26			C OLx :: Overlap extent in X.
27			C OLy :: Overlat extent in Y.
28			C nSx :: No. sub-grids in X.
29			C nSy :: No. sub-grids in Y.
30			C nPx :: No. of processes to use in X.
31			C nPy :: No. of processes to use in Y.
32			C Nx :: No. points in X for the total domain.
33			C Ny :: No. points in Y for the total domain.
34			C Nr :: No. points in Z for full process domain.
35	heimbach	1.1	INTEGER sNx
36			INTEGER sNy
37			INTEGER OLx
38			INTEGER OLy
39			INTEGER nSx
40			INTEGER nSy
41			INTEGER nPx
42			INTEGER nPy
43			INTEGER Nx
44			INTEGER Ny
45			INTEGER Nr
46	jmc	1.2	C-- Note: the 4 test-experiments (input, input.thsice, input.viscA4 and
47			C input.icedyn ) have different minimum Overlap-size requirement:
48			C input & input.thsice : work with Olx=Oly=2 (= absolute minimum size) ;
49			C input.viscA4 : needs at least Olx=Oly=3 (for biharmonic viscosity) ;
50			C input.icedyn : needs at least Olx=Oly=4 (CS-grid multidimensional Advect.)
51	heimbach	1.1	PARAMETER (
52			& sNx = 32,
53	jmc	1.2	& sNy = 16,
54	heimbach	1.1	& OLx = 4,
55			& OLy = 4,
56	jmc	1.2	& nSx = 12,
57	heimbach	1.1	& nSy = 1,
58			& nPx = 1,
59			& nPy = 1,
60			& Nx = sNxnSxnPx,
61			& Ny = sNynSynPy,
62			& Nr = 15)
63
64	jmc	1.2	C MAX_OLX :: Set to the maximum overlap region size of any array
65	heimbach	1.1	C MAX_OLY that will be exchanged. Controls the sizing of exch
66	jmc	1.2	C routine buffers.
67	heimbach	1.1	INTEGER MAX_OLX
68			INTEGER MAX_OLY
69			PARAMETER ( MAX_OLX = OLx,
70			& MAX_OLY = OLy )
71
72			INTEGER nobcs
73			PARAMETER ( nobcs = 4 )
74