model/inc/CPP_OPTIONS.h

C $Header: /u/gcmpack/models/MITgcmUV/model/inc/CPP_OPTIONS.h,v 1.17.2.1 2001/03/30 22:18:17 jmc 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

C 
C CPP flags controlling which code in included in the files that
C will be compiled.
C

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