lab_sea/code/CPP_EEOPTIONS.MPI.h

C $Header: /usr/local/gcmpack/MITgcm/verification/lab_sea/code/CPP_EEOPTIONS.MPI.h,v 1.2 2002/12/28 10:11:12 dimitri Exp $
C $Name:  $
C
CBOP
C     !ROUTINE: CPP_EEOPTIONS.h
C     !INTERFACE:
C     include "CPP_EEOPTIONS.h"
C
C     !DESCRIPTION:
C     *==========================================================*
C     | CPP_EEOPTIONS.h                                          |
C     *==========================================================*
C     | C preprocessor "execution environment" supporting        |
C     | flags. Use this file to set flags controlling the        |
C     | execution environment in which a model runs - as opposed |
C     | to the dynamical problem the model solves.               |
C     | Note: Many options are implemented with both compile time|
C     |       and run-time switches. This allows options to be   |
C     |       removed altogether, made optional at run-time or   |
C     |       to be permanently enabled. This convention helps   |
C     |       with the data-dependence analysis performed by the |
C     |       adjoint model compiler. This data dependency       |
C     |       analysis can be upset by runtime switches that it  |
C     |       is unable to recoginise as being fixed for the     |
C     |       duration of an integration.                        |
C     |       A reasonable way to use these flags is to          |
C     |       set all options as selectable at runtime but then  |
C     |       once an experimental configuration has been        |
C     |       identified, rebuild the code with the appropriate  |
C     |       options set at compile time.                       |
C     *==========================================================*
CEOP

#ifndef _CPP_EEOPTIONS_H_
#define _CPP_EEOPTIONS_H_

C     In general the following convention applies:
C     ALLOW  - indicates an feature will be included but it may
C     CAN      have a run-time flag to allow it to be switched
C              on and off.
C              If ALLOW or CAN directives are "undef'd" this generally
C              means that the feature will not be available i.e. it
C              will not be included in the compiled code and so no
C              run-time option to use the feature will be available.
C
C     ALWAYS - indicates the choice will be fixed at compile time
C              so no run-time option will be present

C     Flag used to indicate whether Fortran formatted write
C     and read are threadsafe. On SGI the routines can be thread
C     safe, on Sun it is not possible - if you are unsure then
C     undef this option.
#undef  FMTFTN_IO_THREADSAFE

C--   Control MPI based parallel processing
#define ALLOW_USE_MPI
#define ALWAYS_USE_MPI

C--   Control use of communication that might overlap computation.
C     Under MPI selects/deselects "non-blocking" sends and receives.
#define ALLOW_ASYNC_COMMUNICATION
#undef  ALLOW_ASYNC_COMMUNICATION
#undef  ALWAYS_USE_ASYNC_COMMUNICATION
C--   Control use of communication that is atomic to computation.
C     Under MPI selects/deselects "blocking" sends and receives.
#define ALLOW_SYNC_COMMUNICATION
#undef  ALWAYS_USE_SYNC_COMMUNICATION

C--   Control use of JAM routines for Artic network
C     These invoke optimized versions of "exchange" and "sum" that
C     utilize the programmable aspect of Artic cards.
#undef  LETS_MAKE_JAM
#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

C--   Control XY periodicity in processor to grid mappings
C     Note: Model code does not need to know whether a domain is 
C           periodic because it has overlap regions for every box.
C           Model assume that these values have been
C           filled in some way.
#undef  ALWAYS_PREVENT_X_PERIODICITY
#undef  ALWAYS_PREVENT_Y_PERIODICITY
#define CAN_PREVENT_X_PERIODICITY
#define CAN_PREVENT_Y_PERIODICITY

#endif /* _CPP_EEOPTIONS_H_ */

#include "CPP_EEMACROS.h"
1	dimitri	1.3	C $Header: /usr/local/gcmpack/MITgcm/verification/lab_sea/code/CPP_EEOPTIONS.MPI.h,v 1.2 2002/12/28 10:11:12 dimitri Exp $
2	dimitri	1.2	C $Name: $
3			C
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 Flag used to indicate whether Fortran formatted write
50			C and read are threadsafe. On SGI the routines can be thread
51			C safe, on Sun it is not possible - if you are unsure then
52			C undef this option.
53			#undef FMTFTN_IO_THREADSAFE
54
55			C-- Control MPI based parallel processing
56			#define ALLOW_USE_MPI
57			#define ALWAYS_USE_MPI
58
59			C-- Control use of communication that might overlap computation.
60			C Under MPI selects/deselects "non-blocking" sends and receives.
61			#define ALLOW_ASYNC_COMMUNICATION
62			#undef ALLOW_ASYNC_COMMUNICATION
63			#undef ALWAYS_USE_ASYNC_COMMUNICATION
64			C-- Control use of communication that is atomic to computation.
65			C Under MPI selects/deselects "blocking" sends and receives.
66			#define ALLOW_SYNC_COMMUNICATION
67			#undef ALWAYS_USE_SYNC_COMMUNICATION
68
69			C-- Control use of JAM routines for Artic network
70			C These invoke optimized versions of "exchange" and "sum" that
71			C utilize the programmable aspect of Artic cards.
72			#undef LETS_MAKE_JAM
73			#undef JAM_WITH_TWO_PROCS_PER_NODE
74
75			C-- Control storage of floating point operands
76			C On many systems it improves performance only to use
77			C 8-byte precision for time stepped variables.
78			C Constant in time terms ( geometric factors etc.. )
79			C can use 4-byte precision, reducing memory utilisation and
80			C boosting performance because of a smaller working
81			C set size. However, on vector CRAY systems this degrades
82			C performance.
83			#define REAL4_IS_SLOW
84
85			C-- Control use of "double" precision constants.
86			C Use D0 where it means REAL8 but not where it means REAL16
87			#define D0 d0
88
89			C-- Control XY periodicity in processor to grid mappings
90			C Note: Model code does not need to know whether a domain is
91			C periodic because it has overlap regions for every box.
92			C Model assume that these values have been
93			C filled in some way.
94			#undef ALWAYS_PREVENT_X_PERIODICITY
95			#undef ALWAYS_PREVENT_Y_PERIODICITY
96			#define CAN_PREVENT_X_PERIODICITY
97			#define CAN_PREVENT_Y_PERIODICITY
98
99			#endif /* _CPP_EEOPTIONS_H_ */
100
101			#include "CPP_EEMACROS.h"