/[MITgcm]/MITgcm_contrib/high_res_cube/code-mods/CPP_EEOPTIONS.h
ViewVC logotype

Annotation of /MITgcm_contrib/high_res_cube/code-mods/CPP_EEOPTIONS.h

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


Revision 1.3 - (hide annotations) (download)
Mon Mar 19 20:31:59 2012 UTC (13 years, 3 months ago) by dimitri
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +49 -20 lines
File MIME type: text/plain
preparing cube94 integration
see MITgcm_contrib/high_res_cube/README.cs510

1 dimitri 1.3 C $Header: /u/gcmpack/MITgcm_contrib/high_res_cube/code-mods/CPP_EEOPTIONS.h,v 1.2 2006/12/05 20:46:48 dimitri Exp $
2 dimitri 1.1 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 dimitri 1.3 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-- Enable some old macro conventions for backward compatibility
69     #undef USE_OLD_MACROS_R4R8toRSRL
70    
71     C=== IO related options ===
72 dimitri 1.1 C-- Flag used to indicate whether Fortran formatted write
73     C and read are threadsafe. On SGI the routines can be thread
74     C safe, on Sun it is not possible - if you are unsure then
75     C undef this option.
76     #undef FMTFTN_IO_THREAD_SAFE
77    
78     C-- Flag used to indicate whether Binary write to Local file (i.e.,
79     C a different file for each tile) and read are thread-safe.
80     #undef LOCBIN_IO_THREAD_SAFE
81    
82     C-- Flag to turn off the writing of error message to ioUnit zero
83     #undef DISABLE_WRITE_TO_UNIT_ZERO
84    
85 dimitri 1.3 C-- Alternative formulation of BYTESWAP, faster than
86     C compiler flag -byteswapio on the Altix.
87     #define FAST_BYTESWAP
88    
89     C=== MPI, EXCH and GLOBAL_SUM related options ===
90 dimitri 1.1 C-- Flag turns off MPI_SEND ready_to_receive polling in the
91     C gather_* subroutines to speed up integrations.
92 dimitri 1.2 #undef DISABLE_MPI_READY_TO_RECEIVE
93 dimitri 1.1
94     C-- Control MPI based parallel processing
95     CXXX We no longer select the use of MPI via this file (CPP_EEOPTIONS.h)
96     CXXX To use MPI, use an appropriate genmake2 options file or use
97     CXXX genmake2 -mpi .
98     CXXX #undef ALLOW_USE_MPI
99     CXXX #undef ALWAYS_USE_MPI
100    
101     C-- Control use of communication that might overlap computation.
102     C Under MPI selects/deselects "non-blocking" sends and receives.
103     #define ALLOW_ASYNC_COMMUNICATION
104     #undef ALLOW_ASYNC_COMMUNICATION
105     #undef ALWAYS_USE_ASYNC_COMMUNICATION
106     C-- Control use of communication that is atomic to computation.
107     C Under MPI selects/deselects "blocking" sends and receives.
108     #define ALLOW_SYNC_COMMUNICATION
109     #undef ALWAYS_USE_SYNC_COMMUNICATION
110    
111     C-- Control use of JAM routines for Artic network
112     C These invoke optimized versions of "exchange" and "sum" that
113     C utilize the programmable aspect of Artic cards.
114 dimitri 1.3 CXXX No longer supported ; started to remove JAM routines.
115     CXXX #undef LETS_MAKE_JAM
116     CXXX #undef JAM_WITH_TWO_PROCS_PER_NODE
117 dimitri 1.1
118     C-- Control XY periodicity in processor to grid mappings
119     C Note: Model code does not need to know whether a domain is
120     C periodic because it has overlap regions for every box.
121     C Model assume that these values have been
122     C filled in some way.
123     #undef ALWAYS_PREVENT_X_PERIODICITY
124     #undef ALWAYS_PREVENT_Y_PERIODICITY
125     #define CAN_PREVENT_X_PERIODICITY
126     #define CAN_PREVENT_Y_PERIODICITY
127    
128 dimitri 1.3 C-- Alternative way of doing global sum without MPI allreduce call
129     C but instead, explicit MPI send & recv calls.
130     #undef GLOBAL_SUM_SEND_RECV
131    
132     C-- Alternative way of doing global sum on a single CPU
133     C to eliminate tiling-dependent roundoff errors.
134     C Note: This is slow.
135     #undef CG2D_SINGLECPU_SUM
136    
137     C=== Other options (to add/remove pieces of code) ===
138     C-- Flag to turn on checking for errors from all threads and procs
139     C (calling S/R STOP_IF_ERROR) before stopping.
140     #define USE_ERROR_STOP
141    
142     C-- Control use of communication with other component:
143     C allow to import and export from/to Coupler interface.
144     #undef COMPONENT_MODULE
145 dimitri 1.2
146 dimitri 1.1 #endif /* _CPP_EEOPTIONS_H_ */
147    
148     #include "CPP_EEMACROS.h"
149    

  ViewVC Help
Powered by ViewVC 1.1.22