/[MITgcm]/MITgcm/verification/cpl_atm2d+ocn/code_ocn/CPP_EEOPTIONS.h
ViewVC logotype

Contents of /MITgcm/verification/cpl_atm2d+ocn/code_ocn/CPP_EEOPTIONS.h

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


Revision 1.4 - (show annotations) (download)
Tue Aug 25 21:11:50 2015 UTC (6 years, 3 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint66g, checkpoint66f, checkpoint66e, checkpoint66d, checkpoint66c, checkpoint66b, checkpoint66a, checkpoint66o, checkpoint66n, checkpoint66m, checkpoint66l, checkpoint66k, checkpoint66j, checkpoint66i, checkpoint66h, checkpoint65z, checkpoint65x, checkpoint65y, checkpoint65r, checkpoint65s, checkpoint65p, checkpoint65q, checkpoint65v, checkpoint65w, checkpoint65t, checkpoint65u, checkpoint65o, HEAD
Changes since 1.3: +17 -4 lines
File MIME type: text/plain
bring up to date with standard version in eesupp/inc

1 C $Header: /u/gcmpack/MITgcm/eesupp/inc/CPP_EEOPTIONS.h,v 1.39 2014/08/27 21:46:17 jmc Exp $
2 C $Name: $
3
4 CBOP
5 C !ROUTINE: CPP_EEOPTIONS.h
6 C !INTERFACE:
7 C include "CPP_EEOPTIONS.h"
8 C
9 C !DESCRIPTION:
10 C *==========================================================*
11 C | CPP\_EEOPTIONS.h |
12 C *==========================================================*
13 C | C preprocessor "execution environment" supporting |
14 C | flags. Use this file to set flags controlling the |
15 C | execution environment in which a model runs - as opposed |
16 C | to the dynamical problem the model solves. |
17 C | Note: Many options are implemented with both compile time|
18 C | and run-time switches. This allows options to be |
19 C | removed altogether, made optional at run-time or |
20 C | to be permanently enabled. This convention helps |
21 C | with the data-dependence analysis performed by the |
22 C | adjoint model compiler. This data dependency |
23 C | analysis can be upset by runtime switches that it |
24 C | is unable to recoginise as being fixed for the |
25 C | duration of an integration. |
26 C | A reasonable way to use these flags is to |
27 C | set all options as selectable at runtime but then |
28 C | once an experimental configuration has been |
29 C | identified, rebuild the code with the appropriate |
30 C | options set at compile time. |
31 C *==========================================================*
32 CEOP
33
34 #ifndef _CPP_EEOPTIONS_H_
35 #define _CPP_EEOPTIONS_H_
36
37 C In general the following convention applies:
38 C ALLOW - indicates an feature will be included but it may
39 C CAN have a run-time flag to allow it to be switched
40 C on and off.
41 C If ALLOW or CAN directives are "undef'd" this generally
42 C means that the feature will not be available i.e. it
43 C will not be included in the compiled code and so no
44 C run-time option to use the feature will be available.
45 C
46 C ALWAYS - indicates the choice will be fixed at compile time
47 C so no run-time option will be present
48
49 C=== Macro related options ===
50 C-- Control storage of floating point operands
51 C On many systems it improves performance only to use
52 C 8-byte precision for time stepped variables.
53 C Constant in time terms ( geometric factors etc.. )
54 C can use 4-byte precision, reducing memory utilisation and
55 C boosting performance because of a smaller working set size.
56 C However, on vector CRAY systems this degrades performance.
57 C Enable to switch REAL4_IS_SLOW from genmake2 (with LET_RS_BE_REAL4):
58 #ifdef LET_RS_BE_REAL4
59 #undef REAL4_IS_SLOW
60 #else /* LET_RS_BE_REAL4 */
61 #define REAL4_IS_SLOW
62 #endif /* LET_RS_BE_REAL4 */
63
64 C-- Control use of "double" precision constants.
65 C Use D0 where it means REAL*8 but not where it means REAL*16
66 #define D0 d0
67
68 C=== IO related options ===
69 C-- Flag used to indicate whether Fortran formatted write
70 C and read are threadsafe. On SGI the routines can be thread
71 C safe, on Sun it is not possible - if you are unsure then
72 C undef this option.
73 #undef FMTFTN_IO_THREAD_SAFE
74
75 C-- Flag used to indicate whether Binary write to Local file (i.e.,
76 C a different file for each tile) and read are thread-safe.
77 #undef LOCBIN_IO_THREAD_SAFE
78
79 C-- Flag to turn off the writing of error message to ioUnit zero
80 #undef DISABLE_WRITE_TO_UNIT_ZERO
81
82 C-- Alternative formulation of BYTESWAP, faster than
83 C compiler flag -byteswapio on the Altix.
84 #undef FAST_BYTESWAP
85
86 C-- Flag defined for eeboot_minimal.F, eeset_parms.F and open_copy_data_file.F
87 C to write STDOUT, STDERR and scratch files from process 0 only.
88 C WARNING: to use only when absolutely confident that the setup is working
89 C since any message (error/warning/print) from any proc <> 0 will be lost.
90 #undef SINGLE_DISK_IO
91
92 C=== MPI, EXCH and GLOBAL_SUM related options ===
93 C-- Flag turns off MPI_SEND ready_to_receive polling in the
94 C gather_* subroutines to speed up integrations.
95 #undef DISABLE_MPI_READY_TO_RECEIVE
96
97 C-- Control use of communication that might overlap computation.
98 C Under MPI selects/deselects "non-blocking" sends and receives.
99 #define ALLOW_ASYNC_COMMUNICATION
100 #undef ALLOW_ASYNC_COMMUNICATION
101 #undef ALWAYS_USE_ASYNC_COMMUNICATION
102 C-- Control use of communication that is atomic to computation.
103 C Under MPI selects/deselects "blocking" sends and receives.
104 #define ALLOW_SYNC_COMMUNICATION
105 #undef ALWAYS_USE_SYNC_COMMUNICATION
106
107 C-- Control XY periodicity in processor to grid mappings
108 C Note: Model code does not need to know whether a domain is
109 C periodic because it has overlap regions for every box.
110 C Model assume that these values have been
111 C filled in some way.
112 #undef ALWAYS_PREVENT_X_PERIODICITY
113 #undef ALWAYS_PREVENT_Y_PERIODICITY
114 #define CAN_PREVENT_X_PERIODICITY
115 #define CAN_PREVENT_Y_PERIODICITY
116
117 C-- disconnect tiles (no exchange between tiles, just fill-in edges
118 C assuming locally periodic subdomain)
119 #undef DISCONNECTED_TILES
120
121 C-- Always cumulate tile local-sum in the same order by applying MPI allreduce
122 C to array of tiles ; can get slower with large number of tiles (big set-up)
123 #undef GLOBAL_SUM_ORDER_TILES
124
125 C-- Alternative way of doing global sum without MPI allreduce call
126 C but instead, explicit MPI send & recv calls. Expected to be slower.
127 #undef GLOBAL_SUM_SEND_RECV
128
129 C-- Alternative way of doing global sum on a single CPU
130 C to eliminate tiling-dependent roundoff errors. Note: This is slow.
131 #undef CG2D_SINGLECPU_SUM
132
133 C=== Other options (to add/remove pieces of code) ===
134 C-- Flag to turn on checking for errors from all threads and procs
135 C (calling S/R STOP_IF_ERROR) before stopping.
136 #define USE_ERROR_STOP
137
138 C-- Control use of communication with other component:
139 C allow to import and export from/to Coupler interface.
140 #define COMPONENT_MODULE
141
142 #endif /* _CPP_EEOPTIONS_H_ */
143
144 #include "CPP_EEMACROS.h"
145

  ViewVC Help
Powered by ViewVC 1.1.22