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

Contents of /MITgcm/eesupp/inc/CPP_EEOPTIONS.h

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


Revision 1.17 - (show annotations) (download)
Fri Mar 9 19:36:39 2001 UTC (23 years, 1 month ago) by adcroft
Branch: MAIN
CVS Tags: checkpoint40pre3, checkpoint40pre1, checkpoint40pre7, checkpoint40pre6, checkpoint40pre9, checkpoint40pre8, checkpoint38, checkpoint40pre2, checkpoint40pre4, pre38tag1, c37_adj, pre38-close, checkpoint39, checkpoint37, checkpoint40pre5, checkpoint40
Branch point for: pre38
Changes since 1.16: +10 -2 lines
File MIME type: text/plain
Added un-compilable lines to make sure configuration is done properly.

1 C $Header: /u/gcmpack/models/MITgcmUV/eesupp/inc/CPP_EEOPTIONS.h,v 1.16 2001/02/04 14:38:41 cnh Exp $
2 C $Name: $
3
4 These lines are here to deliberately cause a compile-time error.
5 If you see these lines in your .F files or the compiler shows them
6 as an error then it means you have not placed your configuration
7 files in the appropriate place.
8 You need to place you own copy of CPP_EEOPTIONS.h in the include
9 path for the model.
10
11 C
12 C /==========================================================\
13 C | CPP_EEOPTIONS.h |
14 C |==========================================================|
15 C | C preprocessor "execution environment" supporting |
16 C | flags. Use this file to set flags controlling the |
17 C | execution environment in which a model runs - as opposed |
18 C | to the dynamical problem the model solves. |
19 C | Note: Many options are implemented with both compile time|
20 C | and run-time switches. This allows options to be |
21 C | removed altogether, made optional at run-time or |
22 C | to be permanently enabled. This convention helps |
23 C | with the data-dependence analysis performed by the |
24 C | adjoint model compiler. This data dependency |
25 C | analysis can be upset by runtime switches that it |
26 C | is unable to recoginise as being fixed for the |
27 C | duration of an integration. |
28 C | A reasonable way to use these flags is to |
29 C | set all options as selectable at runtime but then |
30 C | once an experimental configuration has been |
31 C | identified, rebuild the code with the appropriate |
32 C | options set at compile time. |
33 C \==========================================================/
34
35 #ifndef _CPP_EEOPTIONS_H_
36 #define _CPP_EEOPTIONS_H_
37
38 C In general the following convention applies:
39 C ALLOW - indicates an feature will be included but it may
40 C CAN have a run-time flag to allow it to be switched
41 C on and off.
42 C If ALLOW or CAN directives are "undef'd" this generally
43 C means that the feature will not be available i.e. it
44 C will not be included in the compiled code and so no
45 C run-time option to use the feature will be available.
46 C
47 C ALWAYS - indicates the choice will be fixed at compile time
48 C so no run-time option will be present
49
50 C Flag used to indicate whether Fortran formatted write
51 C and read are threadsafe. On SGI the routines can be thread
52 C safe, on Sun it is not possible - if you are unsure then
53 C undef this option.
54 #undef FMTFTN_IO_THREADSAFE
55
56 C-- Control MPI based parallel processing
57 #undef ALLOW_USE_MPI
58 #undef ALWAYS_USE_MPI
59
60 C-- Control use of communication that might overlap computation.
61 C Under MPI selects/deselects "non-blocking" sends and receives.
62 #define ALLOW_ASYNC_COMMUNICATION
63 #undef ALLOW_ASYNC_COMMUNICATION
64 #undef ALWAYS_USE_ASYNC_COMMUNICATION
65 C-- Control use of communication that is atomic to computation.
66 C Under MPI selects/deselects "blocking" sends and receives.
67 #define ALLOW_SYNC_COMMUNICATION
68 #undef ALWAYS_USE_SYNC_COMMUNICATION
69
70 C-- Control use of JAM routines for Artic network
71 C These invoke optimized versions of "exchange" and "sum" that
72 C utilize the programmable aspect of Artic cards.
73 #undef LETS_MAKE_JAM
74 #undef JAM_WITH_TWO_PROCS_PER_NODE
75
76 C-- Control storage of floating point operands
77 C On many systems it improves performance only to use
78 C 8-byte precision for time stepped variables.
79 C Constant in time terms ( geometric factors etc.. )
80 C can use 4-byte precision, reducing memory utilisation and
81 C boosting performance because of a smaller working
82 C set size. However, on vector CRAY systems this degrades
83 C performance.
84 #define REAL4_IS_SLOW
85
86 C-- Control use of "double" precision constants.
87 C Use D0 where it means REAL*8 but not where it means REAL*16
88 #define D0 d0
89
90 C-- Control XY periodicity in processor to grid mappings
91 C Note: Model code does not need to know whether a domain is
92 C periodic because it has overlap regions for every box.
93 C Model assume that these values have been
94 C filled in some way.
95 #undef ALWAYS_PREVENT_X_PERIODICITY
96 #undef ALWAYS_PREVENT_Y_PERIODICITY
97 #define CAN_PREVENT_X_PERIODICITY
98 #define CAN_PREVENT_Y_PERIODICITY
99
100 #endif /* _CPP_EEOPTIONS_H_ */
101
102 #include "CPP_EEMACROS.h"

  ViewVC Help
Powered by ViewVC 1.1.22