model/inc/CPP_OPTIONS.h

C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/inc/CPP_OPTIONS.h,v 1.19.4.4 2003/05/01 06:10:19 dimitri Exp $
C $Name:  $

  These lines are here to deliberately cause a compile-time error.
  If you see these lines in your .F files or the compiler shows them
  as an error then it means you have not placed your configuration
  files in the appropriate place.
  You need to place you own copy of CPP_OPTIONS.h in the include
  path for the model.

C

CBOP
C !ROUTINE: CPP_OPTIONS.h
C !INTERFACE: 
C include "CPP_OPTIONS.h"
C !DESCRIPTION:
C CPP flags controlling which code in included in the files that
C will be compiled.
CEOP

C o Include/exclude code for direct surface pressure solver
#undef  ALLOW_DIRECT_SOLVER

C o Include/exclude code for AIM package
#undef  ALLOW_AIM

C o Include/exclude code for GM/Redi parameterization
#undef  ALLOW_GMREDI

C o Include/exclude code for KPP mixing scheme
#define  ALLOW_KPP

C o Shortwave heating as extra term in external_forcing.F
#ifdef ALLOW_KPP
#define  SHORTWAVE_HEATING
#endif

C o Include/exclude code for Shapiro filters
#define ALLOW_SHAP_FILT

C o Include/exclude code for C-D grid method of integrating the 
C   coriolis terms
#define  INCLUDE_CD_CODE

C o Include/exclude code for open-boundary conditions
#undef  ALLOW_OBCS

C o Include/exclude diagnostics package interface code
#define  ALLOW_TIMEAVE

C o Include/exclude zonal FFT filter code
#undef  ALLOW_ZONAL_FILT

C o Include/exclude temperature advection code
#define  INCLUDE_T_ADVECTION_CODE
#ifdef   INCLUDE_T_ADVECTION_CODE
#define  _ADT(a)a
#endif
#ifndef  INCLUDE_T_ADVECTION_CODE
#define  _ADT(a)
#endif

C o Include/exclude temperature diffusion code
#define  INCLUDE_T_DIFFUSION_CODE
#ifdef   INCLUDE_T_DIFFUSION_CODE
#define  _LPT(a)a
#define  _BHT(a)a
#endif
#ifndef  INCLUDE_T_DIFFUSION_CODE
#define  _LPT(a)
#define  _BHT(a)
#endif

C o Include/exclude temperature forcing code
#define  INCLUDE_T_FORCING_CODE

C o Include/exclude momentum advection code
#define  INCLUDE_MOMENTUM_ADVECTION_CODE
#ifdef   INCLUDE_MOMENTUM_ADVECTION_CODE
#define  _ADM(a)a
#endif
#ifndef  INCLUDE_MOMENTUM_ADVECTION_CODE
#define  _ADM(a)
#endif

C o Include/exclude laplacian viscosity code
#define  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
#ifdef   INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
#define  _LPM(a)a
#endif
#ifndef  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
#define  _LPM(a)
#endif

C o Include/exclude biharmonic viscosity code
#define  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
#ifdef   INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
#define  _BHM(a)a
#endif
#ifndef  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
#define  _BHM(a)
#endif

C o Include/exclude gradient of phy_hyd code
#define INCLUDE_GRADPH_CODE
#ifdef  INCLUDE_GRADPH_CODE
#define _PHM(a)a
#endif
#ifndef INCLUDE_GRADPH_CODE
#define _PHM(a)
#endif

C o Include/exclude momentum forcing code
#define INCLUDE_MOMENTUM_FORCING_CODE

C o Include/exclude momentum eqn metric terms code
#define INCLUDE_MOMENTUM_METRIC_TERM_CODE

C o Include/exclude phi_hyd calculation code
#define INCLUDE_PHIHYD_CALCULATION_CODE

C o Include/exclude call to S/R CONVECT
#define INCLUDE_CONVECT_CALL

C o Include/exclude call to S/R CALC_DIFFUSIVITY
#define INCLUDE_CALC_DIFFUSIVITY_CALL

C o Allow nonHydrostatic code
#undef  ALLOW_NONHYDROSTATIC

C o Use "natural" boundary conditions for salinity
C   instead of the "virtual salt flux"
#undef  USE_NATURAL_BCS

C o Use "Exact Convervation" of fluid in Free-Surface formulation
C   so that d/dt(eta) is exactly equal to - Div.Transport
#undef EXACT_CONSERV

C o Allow the use of Non-Linear Free-Surface formulation
C   this implies that surface thickness (hFactors) vary with time
#undef NONLIN_FRSURF

C o Use "OLD" UV discretisation near boundaries (*not* recommended)
C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F
C          because the old code did not have no-slip BCs
#undef  OLD_ADV_BCS

C o Use "OLD" UV geometry on sphere (definately *NOT* recommended)
C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F
C          because the old code did not have no-slip BCs
#undef  OLD_UV_GEOMETRY

C o Include/exclude IERS Special Bureau for the Oceans diagnostics
#undef  ALLOW_SBO

C o Include/exclude code for sea-ice model
#undef  ALLOW_SEAICE

C o Execution environment support options
#include "CPP_EEOPTIONS.h"

C o Include/exclude code specific to the ECCO/SEALION version.
#undef INCLUDE_ECCO_PACKAGE
#ifdef INCLUDE_ECCO_PACKAGE
#include "ECCO_CPPOPTIONS.h"
#endif
1	dimitri	1.19.4.4	C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/inc/CPP_OPTIONS.h,v 1.19.4.4 2003/05/01 06:10:19 dimitri Exp $
2	jmc	1.15	C $Name: $
3	adcroft	1.17
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_OPTIONS.h in the include
9			path for the model.
10
11	cnh	1.1	C
12	adcroft	1.3
13	cnh	1.19	CBOP
14			C !ROUTINE: CPP_OPTIONS.h
15			C !INTERFACE:
16			C include "CPP_OPTIONS.h"
17			C !DESCRIPTION:
18	cnh	1.6	C CPP flags controlling which code in included in the files that
19			C will be compiled.
20	cnh	1.19	CEOP
21	dimitri	1.19.4.4
22			C o Include/exclude code for direct surface pressure solver
23			#undef ALLOW_DIRECT_SOLVER
24	adcroft	1.12
25	jmc	1.15	C o Include/exclude code for AIM package
26			#undef ALLOW_AIM
27
28	adcroft	1.12	C o Include/exclude code for GM/Redi parameterization
29			#undef ALLOW_GMREDI
30	cnh	1.6
31	adcroft	1.11	C o Include/exclude code for KPP mixing scheme
32	heimbach	1.13	#define ALLOW_KPP
33
34			C o Shortwave heating as extra term in external_forcing.F
35			#ifdef ALLOW_KPP
36			#define SHORTWAVE_HEATING
37			#endif
38	adcroft	1.11
39	jmc	1.15	C o Include/exclude code for Shapiro filters
40			#define ALLOW_SHAP_FILT
41
42	cnh	1.6	C o Include/exclude code for C-D grid method of integrating the
43			C coriolis terms
44	heimbach	1.13	#define INCLUDE_CD_CODE
45	adcroft	1.10
46			C o Include/exclude code for open-boundary conditions
47	adcroft	1.11	#undef ALLOW_OBCS
48	cnh	1.6
49			C o Include/exclude diagnostics package interface code
50	jmc	1.16	#define ALLOW_TIMEAVE
51	cnh	1.6
52	jmc	1.15	C o Include/exclude zonal FFT filter code
53			#undef ALLOW_ZONAL_FILT
54	cnh	1.6
55			C o Include/exclude temperature advection code
56			#define INCLUDE_T_ADVECTION_CODE
57			#ifdef INCLUDE_T_ADVECTION_CODE
58	adcroft	1.9	#define _ADT(a)a
59	cnh	1.6	#endif
60			#ifndef INCLUDE_T_ADVECTION_CODE
61			#define _ADT(a)
62			#endif
63
64			C o Include/exclude temperature diffusion code
65			#define INCLUDE_T_DIFFUSION_CODE
66			#ifdef INCLUDE_T_DIFFUSION_CODE
67	adcroft	1.9	#define _LPT(a)a
68			#define _BHT(a)a
69	cnh	1.6	#endif
70			#ifndef INCLUDE_T_DIFFUSION_CODE
71			#define _LPT(a)
72			#define _BHT(a)
73			#endif
74
75			C o Include/exclude temperature forcing code
76			#define INCLUDE_T_FORCING_CODE
77
78			C o Include/exclude momentum advection code
79			#define INCLUDE_MOMENTUM_ADVECTION_CODE
80			#ifdef INCLUDE_MOMENTUM_ADVECTION_CODE
81	adcroft	1.9	#define _ADM(a)a
82	cnh	1.6	#endif
83			#ifndef INCLUDE_MOMENTUM_ADVECTION_CODE
84			#define _ADM(a)
85			#endif
86
87			C o Include/exclude laplacian viscosity code
88			#define INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
89			#ifdef INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
90	adcroft	1.9	#define _LPM(a)a
91	cnh	1.6	#endif
92			#ifndef INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
93			#define _LPM(a)
94			#endif
95
96			C o Include/exclude biharmonic viscosity code
97	adcroft	1.7	#define INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
98	cnh	1.6	#ifdef INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
99	adcroft	1.9	#define _BHM(a)a
100	cnh	1.6	#endif
101			#ifndef INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
102			#define _BHM(a)
103			#endif
104
105			C o Include/exclude gradient of phy_hyd code
106			#define INCLUDE_GRADPH_CODE
107			#ifdef INCLUDE_GRADPH_CODE
108	adcroft	1.9	#define _PHM(a)a
109	cnh	1.6	#endif
110			#ifndef INCLUDE_GRADPH_CODE
111			#define _PHM(a)
112			#endif
113
114			C o Include/exclude momentum forcing code
115			#define INCLUDE_MOMENTUM_FORCING_CODE
116
117			C o Include/exclude momentum eqn metric terms code
118			#define INCLUDE_MOMENTUM_METRIC_TERM_CODE
119
120			C o Include/exclude phi_hyd calculation code
121			#define INCLUDE_PHIHYD_CALCULATION_CODE
122
123			C o Include/exclude call to S/R CONVECT
124			#define INCLUDE_CONVECT_CALL
125
126			C o Include/exclude call to S/R CALC_DIFFUSIVITY
127			#define INCLUDE_CALC_DIFFUSIVITY_CALL
128	adcroft	1.8
129	adcroft	1.11	C o Allow nonHydrostatic code
130			#undef ALLOW_NONHYDROSTATIC
131
132	adcroft	1.8	C o Use "natural" boundary conditions for salinity
133			C instead of the "virtual salt flux"
134	adcroft	1.11	#undef USE_NATURAL_BCS
135	adcroft	1.18
136			C o Use "Exact Convervation" of fluid in Free-Surface formulation
137			C so that d/dt(eta) is exactly equal to - Div.Transport
138			#undef EXACT_CONSERV
139
140			C o Allow the use of Non-Linear Free-Surface formulation
141			C this implies that surface thickness (hFactors) vary with time
142			#undef NONLIN_FRSURF
143	adcroft	1.7
144			C o Use "OLD" UV discretisation near boundaries (not recommended)
145			C Note - only works with #undef NO_SLIP_LATERAL in calc_mom_rhs.F
146			C because the old code did not have no-slip BCs
147			#undef OLD_ADV_BCS
148
149			C o Use "OLD" UV geometry on sphere (definately NOT recommended)
150			C Note - only works with #undef NO_SLIP_LATERAL in calc_mom_rhs.F
151			C because the old code did not have no-slip BCs
152			#undef OLD_UV_GEOMETRY
153	dimitri	1.19.4.3
154			C o Include/exclude IERS Special Bureau for the Oceans diagnostics
155			#undef ALLOW_SBO
156	heimbach	1.19.4.1
157			C o Include/exclude code for sea-ice model
158			#undef ALLOW_SEAICE
159	adcroft	1.3
160	cnh	1.6	C o Execution environment support options
161	adcroft	1.3	#include "CPP_EEOPTIONS.h"
162	heimbach	1.13
163			C o Include/exclude code specific to the ECCO/SEALION version.
164			#undef INCLUDE_ECCO_PACKAGE
165			#ifdef INCLUDE_ECCO_PACKAGE
166			#include "ECCO_CPPOPTIONS.h"
167			#endif