/[MITgcm]/MITgcm/eesupp/inc/EEPARAMS.h
ViewVC logotype

Annotation of /MITgcm/eesupp/inc/EEPARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.11 - (hide annotations) (download)
Mon Sep 16 18:11:58 2002 UTC (21 years, 6 months ago) by heimbach
Branch: MAIN
CVS Tags: checkpoint46n_post, checkpoint46l_post, checkpoint46g_pre, checkpoint46f_post, checkpoint46l_pre, checkpoint46j_pre, checkpoint46j_post, checkpoint46k_post, checkpoint46h_pre, checkpoint46m_post, checkpoint46g_post, checkpoint46i_post, checkpoint46h_post
Changes since 1.10: +5 -2 lines
File MIME type: text/plain
Enable tangent linear (forward mode) gradient checks:
o extended active file handling to g_... files
o added TANGENT_SIMULATION to theSimulationMode
o extended grdchk package accordingly

1 heimbach 1.11 C $Header: /u/gcmpack/MITgcm/eesupp/inc/EEPARAMS.h,v 1.10 2001/09/21 03:54:35 cnh Exp $
2 adcroft 1.9 C $Name: $
3 cnh 1.10 CBOP
4     C !ROUTINE: EEPARAMS.h
5     C !INTERFACE:
6     C include "EEPARAMS.h"
7 cnh 1.1 C
8 cnh 1.10 C !DESCRIPTION:
9     C *==========================================================*
10 cnh 1.1 C | EEPARAMS.h |
11 cnh 1.10 C *==========================================================*
12 cnh 1.1 C | Parameters for "execution environemnt". These are used |
13     C | by both the particular numerical model and the "execution|
14     C | environment" support routines. |
15 cnh 1.10 C *==========================================================*
16     CEOP
17 cnh 1.1
18     C MAX_LEN_MBUF - Default message buffer max. size
19     C MAX_LEN_FNAM - Default file name max. size
20     C MAX_LEN_PREC - Default record length for reading "parameter" files
21     INTEGER MAX_LEN_MBUF
22     PARAMETER ( MAX_LEN_MBUF = 512 )
23     INTEGER MAX_LEN_FNAM
24     PARAMETER ( MAX_LEN_FNAM = 512 )
25     INTEGER MAX_LEN_PREC
26     PARAMETER ( MAX_LEN_PREC = 200 )
27    
28     C SQUEEZE_RIGHT - Flag indicating right blank space removal
29     C from text field.
30     C SQUEEZE_LEFT - Flag indicating left blank space removal
31     C from text field.
32     C SQUEEZE_BOTH - Flag indicating left and right blank
33     C space removal from text field.
34     C PRINT_MAP_XY - Flag indicating to plot map as XY slices
35     C PRINT_MAP_XZ - Flag indicating to plot map as XZ slices
36     C PRINT_MAP_YZ - Flag indicating to plot map as YZ slices
37     C commentCharacter - Variable used in column 1 of parameter files to
38     C indicate comments.
39 cnh 1.3 C INDEX_I - Variable used to select an index label
40     C INDEX_J for formatted input parameters.
41     C INDEX_K
42     C INDEX_NONE
43 cnh 1.1 CHARACTER*(*) SQUEEZE_RIGHT
44     PARAMETER ( SQUEEZE_RIGHT = 'R' )
45     CHARACTER*(*) SQUEEZE_LEFT
46     PARAMETER ( SQUEEZE_LEFT = 'L' )
47     CHARACTER*(*) SQUEEZE_BOTH
48     PARAMETER ( SQUEEZE_BOTH = 'B' )
49     CHARACTER*(*) PRINT_MAP_XY
50     PARAMETER ( PRINT_MAP_XY = 'XY' )
51     CHARACTER*(*) PRINT_MAP_XZ
52     PARAMETER ( PRINT_MAP_XZ = 'XZ' )
53     CHARACTER*(*) PRINT_MAP_YZ
54     PARAMETER ( PRINT_MAP_YZ = 'YZ' )
55     CHARACTER*(*) commentCharacter
56     PARAMETER ( commentCharacter = '#' )
57 cnh 1.3 INTEGER INDEX_I
58     INTEGER INDEX_J
59     INTEGER INDEX_K
60     INTEGER INDEX_NONE
61     PARAMETER ( INDEX_I = 1,
62     & INDEX_J = 2,
63     & INDEX_K = 3,
64     & INDEX_NONE = 4 )
65 cnh 1.1
66 cnh 1.5
67     C EXCH_IGNORE_CORNERS - Flag to select ignoring or
68     C EXCH_UPDATE_CORNERS updating of corners during
69     C an edge exchange.
70     INTEGER EXCH_IGNORE_CORNERS
71     INTEGER EXCH_UPDATE_CORNERS
72     PARAMETER ( EXCH_IGNORE_CORNERS = 0,
73     & EXCH_UPDATE_CORNERS = 1 )
74    
75     C FORWARD_SIMULATION
76     C REVERSE_SIMULATION
77 heimbach 1.11 C TANGENT_SIMULATION
78 cnh 1.5 INTEGER FORWARD_SIMULATION
79     INTEGER REVERSE_SIMULATION
80 heimbach 1.11 INTEGER TANGENT_SIMULATION
81 cnh 1.5 PARAMETER ( FORWARD_SIMULATION = 0,
82 heimbach 1.11 & REVERSE_SIMULATION = 1,
83     & TANGENT_SIMULATION = 2 )
84 cnh 1.5
85    
86 cnh 1.1 C Particularly weird and obscure voodoo numbers
87     C lShare - This wants to be the length in
88     C [148]-byte words of the size of
89     C the address "window" that is snooped
90     C on an SMP bus. By separating elements in
91     C the global sum buffer we can avoid generating
92     C extraneous invalidate traffic between
93     C processors. The length of this window is usually
94     C a cache line i.e. small O(64 bytes).
95     C The buffer arrays are usually short arrays
96     C and are declared REAL ARRA(lShare[148],LBUFF).
97     C Setting lShare[148] to 1 is like making these arrays
98     C one dimensional.
99 cnh 1.5 INTEGER cacheLineSize
100 cnh 1.1 INTEGER lShare1
101     INTEGER lShare4
102     INTEGER lShare8
103 cnh 1.5 PARAMETER ( cacheLineSize = 256 )
104     PARAMETER ( lShare1 = cacheLineSize )
105     PARAMETER ( lShare4 = cacheLineSize/4 )
106     PARAMETER ( lShare8 = cacheLineSize/8 )
107 cnh 1.1
108     C MAX_NO_THREADS - Maximum number of threads allowed.
109     C MAX_NO_PROCS - Maximum number of processes allowed.
110     C MAX_NO_BARRIERS - Maximum number of distinct thread "barriers"
111     INTEGER MAX_NO_THREADS
112 heimbach 1.7 PARAMETER ( MAX_NO_THREADS = 32 )
113 cnh 1.1 INTEGER MAX_NO_PROCS
114     PARAMETER ( MAX_NO_PROCS = 128 )
115     INTEGER MAX_NO_BARRIERS
116     PARAMETER ( MAX_NO_BARRIERS = 1 )
117    
118     C-- COMMON /EEPARAMS_L/ Execution environment public logical variables.
119     C eeBootError - Flag indicating error during multi-processing
120     C eeEndError initialisation/termination.
121     C fatalError - Flag used to indicate that the model is ended with
122     C an error
123 adcroft 1.9 COMMON /EEPARAMS_L/ eeBootError, fatalError, eeEndError,
124     & useCubedSphereExchange
125 cnh 1.1 LOGICAL eeBootError
126     LOGICAL eeEndError
127     LOGICAL fatalError
128 adcroft 1.9 LOGICAL useCubedSphereExchange
129 cnh 1.1
130     C-- COMMON /EPARAMS_I/ Execution environment public integer variables.
131     C errorMessageUnit - Fortran IO unit for error messages
132     C standardMessageUnit - Fortran IO unit for informational messages
133     C scrUnit1 - Scratch file 1 unit number
134     C scrUnit2 - Scratch file 2 unit number
135     C eeDataUnit - Unit number used for reading "execution environment" parameter file.
136     C modelDataUnit - Unit number for reading "model" parameter file.
137     C numberOfProcs - Number of processes computing in parallel
138     C pidIO - Id of process to use for I/O.
139     C myBxLo, myBxHi - Extents of domain in blocks in X and Y
140     C myByLo, myByHi that each threads is responsble for.
141     C myProcId - My own "process" id.
142     C myPx - My X coord on the proc. grid.
143     C myPy - My Y coord on the proc. grid.
144     C myXGlobalLo - My bottom-left (south-west) x-index
145     C global domain. The x-coordinate of this
146     C point in for example m or degrees is *not*
147     C specified here. A model needs to provide a
148     C mechanism for deducing that information if it
149     C is needed.
150     C myYGlobalLo - My bottom-left (south-west) y-index in
151     C global domain. The y-coordinate of this
152     C point in for example m or degrees is *not*
153     C specified here. A model needs to provide a
154     C mechanism for deducing that information if it
155     C is needed.
156     C nThreads - No. of threads
157     C nTx - No. of threads in X
158     C nTy - No. of threads in Y
159     C This assumes a simple cartesian
160     C gridding of the threads which is not required elsewhere
161     C but that makes it easier.
162 cnh 1.4 C ioErrorCount - IO Error Counter. Set to zero initially and increased
163     C by one every time an IO error occurs.
164 cnh 1.1 COMMON /EEPARAMS_I/ errorMessageUnit, standardMessageUnit,
165     & scrUnit1, scrUnit2, eeDataUnit, modelDataUnit,
166     & numberOfProcs, pidIO, myProcId,
167     & myPx, myPy, myXGlobalLo, myYGlobalLo, nThreads,
168     & myBxLo, myBxHi, myByLo, myByHi,
169 cnh 1.4 & nTx, nTy, ioErrorCount
170 cnh 1.1 INTEGER eeDataUnit
171     INTEGER errorMessageUnit
172 cnh 1.4 INTEGER ioErrorCount(MAX_NO_THREADS)
173 cnh 1.1 INTEGER modelDataUnit
174     INTEGER myBxLo(MAX_NO_THREADS)
175     INTEGER myBxHi(MAX_NO_THREADS)
176     INTEGER myByLo(MAX_NO_THREADS)
177     INTEGER myByHi(MAX_NO_THREADS)
178     INTEGER myProcId
179     INTEGER myPx
180     INTEGER myPy
181     INTEGER myXGlobalLo
182     INTEGER myYGlobalLo
183     INTEGER nThreads
184     INTEGER nTx
185     INTEGER nTy
186     INTEGER numberOfProcs
187     INTEGER pidIO
188     INTEGER scrUnit1
189     INTEGER scrUnit2
190     INTEGER standardMessageUnit

  ViewVC Help
Powered by ViewVC 1.1.22