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

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

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

revision 1.17 by adcroft, Fri Mar 9 19:36:39 2001 UTC revision 1.34 by jmc, Mon May 14 13:13:40 2012 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4    These lines are here to deliberately cause a compile-time error.  CBOP
5    If you see these lines in your .F files or the compiler shows them  C     !ROUTINE: CPP_EEOPTIONS.h
6    as an error then it means you have not placed your configuration  C     !INTERFACE:
7    files in the appropriate place.  C     include "CPP_EEOPTIONS.h"
   You need to place you own copy of CPP_EEOPTIONS.h in the include  
   path for the model.  
   
8  C  C
9  C     /==========================================================\  C     !DESCRIPTION:
10  C     | CPP_EEOPTIONS.h                                          |  C     *==========================================================*
11  C     |==========================================================|  C     | CPP\_EEOPTIONS.h                                         |
12    C     *==========================================================*
13  C     | C preprocessor "execution environment" supporting        |  C     | C preprocessor "execution environment" supporting        |
14  C     | flags. Use this file to set flags controlling the        |  C     | flags. Use this file to set flags controlling the        |
15  C     | execution environment in which a model runs - as opposed |  C     | execution environment in which a model runs - as opposed |
# Line 30  C     |       set all options as selecta Line 28  C     |       set all options as selecta
28  C     |       once an experimental configuration has been        |  C     |       once an experimental configuration has been        |
29  C     |       identified, rebuild the code with the appropriate  |  C     |       identified, rebuild the code with the appropriate  |
30  C     |       options set at compile time.                       |  C     |       options set at compile time.                       |
31  C     \==========================================================/  C     *==========================================================*
32    CEOP
33    
34  #ifndef _CPP_EEOPTIONS_H_  #ifndef _CPP_EEOPTIONS_H_
35  #define _CPP_EEOPTIONS_H_  #define _CPP_EEOPTIONS_H_
# Line 47  C Line 46  C
46  C     ALWAYS - indicates the choice will be fixed at compile time  C     ALWAYS - indicates the choice will be fixed at compile time
47  C              so no run-time option will be present  C              so no run-time option will be present
48    
49  C     Flag used to indicate whether Fortran formatted write  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    C--   Flag used to indicate whether Fortran formatted write
73  C     and read are threadsafe. On SGI the routines can be thread  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  C     safe, on Sun it is not possible - if you are unsure then
75  C     undef this option.  C     undef this option.
76  #undef  FMTFTN_IO_THREADSAFE  #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    C--   Alternative formulation of BYTESWAP, faster than
86    C     compiler flag -byteswapio on the Altix.
87    #undef FAST_BYTESWAP
88    
89    C=== MPI, EXCH and GLOBAL_SUM related options ===
90    C--   Flag turns off MPI_SEND ready_to_receive polling in the
91    C     gather_* subroutines to speed up integrations.
92    #undef DISABLE_MPI_READY_TO_RECEIVE
93    
94  C--   Control MPI based parallel processing  C--   Control MPI based parallel processing
95  #undef  ALLOW_USE_MPI  CXXX We no longer select the use of MPI via this file (CPP_EEOPTIONS.h)
96  #undef  ALWAYS_USE_MPI  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.  C--   Control use of communication that might overlap computation.
102  C     Under MPI selects/deselects "non-blocking" sends and receives.  C     Under MPI selects/deselects "non-blocking" sends and receives.
103  #define ALLOW_ASYNC_COMMUNICATION  #define ALLOW_ASYNC_COMMUNICATION
# Line 70  C     Under MPI selects/deselects "block Line 111  C     Under MPI selects/deselects "block
111  C--   Control use of JAM routines for Artic network  C--   Control use of JAM routines for Artic network
112  C     These invoke optimized versions of "exchange" and "sum" that  C     These invoke optimized versions of "exchange" and "sum" that
113  C     utilize the programmable aspect of Artic cards.  C     utilize the programmable aspect of Artic cards.
114  #undef  LETS_MAKE_JAM  CXXX No longer supported ; started to remove JAM routines.
115  #undef  JAM_WITH_TWO_PROCS_PER_NODE  CXXX #undef  LETS_MAKE_JAM
116    CXXX #undef  JAM_WITH_TWO_PROCS_PER_NODE
 C--   Control storage of floating point operands  
 C     On many systems it improves performance only to use  
 C     8-byte precision for time stepped variables.  
 C     Constant in time terms ( geometric factors etc.. )  
 C     can use 4-byte precision, reducing memory utilisation and  
 C     boosting performance because of a smaller working  
 C     set size. However, on vector CRAY systems this degrades  
 C     performance.  
 #define REAL4_IS_SLOW  
   
 C--   Control use of "double" precision constants.  
 C     Use D0 where it means REAL*8 but not where it means REAL*16  
 #define D0 d0  
117    
118  C--   Control XY periodicity in processor to grid mappings  C--   Control XY periodicity in processor to grid mappings
119  C     Note: Model code does not need to know whether a domain is  C     Note: Model code does not need to know whether a domain is
120  C           periodic because it has overlap regions for every box.  C           periodic because it has overlap regions for every box.
121  C           Model assume that these values have been  C           Model assume that these values have been
122  C           filled in some way.  C           filled in some way.
# Line 97  C           filled in some way. Line 125  C           filled in some way.
125  #define CAN_PREVENT_X_PERIODICITY  #define CAN_PREVENT_X_PERIODICITY
126  #define CAN_PREVENT_Y_PERIODICITY  #define CAN_PREVENT_Y_PERIODICITY
127    
128    C--   disconnect tiles (no exchange between tiles, just fill-in edges
129    C     assuming locally periodic subdomain)
130    #undef DISCONNECTED_TILES
131    
132    C--   Alternative way of doing global sum without MPI allreduce call
133    C     but instead, explicit MPI send & recv calls.
134    #undef GLOBAL_SUM_SEND_RECV
135    
136    C--   Alternative way of doing global sum on a single CPU
137    C     to eliminate tiling-dependent roundoff errors.
138    C     Note: This is slow.
139    #undef  CG2D_SINGLECPU_SUM
140    
141    C=== Other options (to add/remove pieces of code) ===
142    C--   Flag to turn on checking for errors from all threads and procs
143    C     (calling S/R STOP_IF_ERROR) before stopping.
144    #define USE_ERROR_STOP
145    
146    C--   Control use of communication with other component:
147    C     allow to import and export from/to Coupler interface.
148    #undef COMPONENT_MODULE
149    
150  #endif /* _CPP_EEOPTIONS_H_ */  #endif /* _CPP_EEOPTIONS_H_ */
151    
152  #include "CPP_EEMACROS.h"  #include "CPP_EEMACROS.h"
153    
Legend:
Removed from v.1.17  
changed lines
  Added in v.1.34
  ViewVC Help
Powered by ViewVC 1.1.22