model/inc/CPP_OPTIONS.h

C $Header: /u/gcmpack/models/MITgcmUV/model/inc/CPP_OPTIONS.h,v 1.12 2000/06/21 19:22:24 adcroft Exp $
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 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 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  INCLUDE_DIAGNOSTICS_INTERFACE_CODE

C o Include/exclude latitude circle FFT filter
#undef  INCLUDE_LAT_CIRC_FFT_FILTER_CODE

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 prognostic variable shapiro filter code
C   Note - Shapiro filter of prognostics variables requires the
C          three steps "step forward including edges", filter, 
C          "communicate edges".
C           If the filtering code is included then we do not use the 
C          pipelined "step forward including edges" in S/R DYNAMICS. 
C          Instead the three steps are performed before DYNAMICS one 
C          after another in an un-pipelined fashion.
#undef  INCLUDE_SHAPIRO_FILTER_CODE
#ifdef  INCLUDE_SHAPIRO_FILTER_CODE
#undef  DO_PIPELINED_CORRECTION_STEP
#endif
#ifndef INCLUDE_SHAPIRO_FILTER_CODE
#define DO_PIPELINED_CORRECTION_STEP
#endif

C o Include/exclude call to S/R FIND_RHO
#define INCLUDE_FIND_RHO_CALL

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

C o Include/exclude call to S/R CALC_ISOSLOPES
#define INCLUDE_CALC_ISOSLOPES_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 "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	heimbach	1.13	C $Header: /u/gcmpack/models/MITgcmUV/model/inc/CPP_OPTIONS.h,v 1.12 2000/06/21 19:22:24 adcroft Exp $
2	cnh	1.1	C
3	adcroft	1.3
4	cnh	1.6	C
5			C CPP flags controlling which code in included in the files that
6			C will be compiled.
7			C
8	adcroft	1.12
9			C o Include/exclude code for GM/Redi parameterization
10			#undef ALLOW_GMREDI
11	cnh	1.6
12	adcroft	1.11	C o Include/exclude code for KPP mixing scheme
13	heimbach	1.13	#define ALLOW_KPP
14
15			C o Shortwave heating as extra term in external_forcing.F
16			#ifdef ALLOW_KPP
17			#define SHORTWAVE_HEATING
18			#endif
19	adcroft	1.11
20	cnh	1.6	C o Include/exclude code for C-D grid method of integrating the
21			C coriolis terms
22	heimbach	1.13	#define INCLUDE_CD_CODE
23	adcroft	1.10
24			C o Include/exclude code for open-boundary conditions
25	adcroft	1.11	#undef ALLOW_OBCS
26	cnh	1.6
27			C o Include/exclude diagnostics package interface code
28			#define INCLUDE_DIAGNOSTICS_INTERFACE_CODE
29
30			C o Include/exclude latitude circle FFT filter
31			#undef INCLUDE_LAT_CIRC_FFT_FILTER_CODE
32
33			C o Include/exclude temperature advection code
34			#define INCLUDE_T_ADVECTION_CODE
35			#ifdef INCLUDE_T_ADVECTION_CODE
36	adcroft	1.9	#define _ADT(a)a
37	cnh	1.6	#endif
38			#ifndef INCLUDE_T_ADVECTION_CODE
39			#define _ADT(a)
40			#endif
41
42			C o Include/exclude temperature diffusion code
43			#define INCLUDE_T_DIFFUSION_CODE
44			#ifdef INCLUDE_T_DIFFUSION_CODE
45	adcroft	1.9	#define _LPT(a)a
46			#define _BHT(a)a
47	cnh	1.6	#endif
48			#ifndef INCLUDE_T_DIFFUSION_CODE
49			#define _LPT(a)
50			#define _BHT(a)
51			#endif
52
53			C o Include/exclude temperature forcing code
54			#define INCLUDE_T_FORCING_CODE
55
56			C o Include/exclude momentum advection code
57			#define INCLUDE_MOMENTUM_ADVECTION_CODE
58			#ifdef INCLUDE_MOMENTUM_ADVECTION_CODE
59	adcroft	1.9	#define _ADM(a)a
60	cnh	1.6	#endif
61			#ifndef INCLUDE_MOMENTUM_ADVECTION_CODE
62			#define _ADM(a)
63			#endif
64
65			C o Include/exclude laplacian viscosity code
66			#define INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
67			#ifdef INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
68	adcroft	1.9	#define _LPM(a)a
69	cnh	1.6	#endif
70			#ifndef INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
71			#define _LPM(a)
72			#endif
73
74			C o Include/exclude biharmonic viscosity code
75	adcroft	1.7	#define INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
76	cnh	1.6	#ifdef INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
77	adcroft	1.9	#define _BHM(a)a
78	cnh	1.6	#endif
79			#ifndef INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
80			#define _BHM(a)
81			#endif
82
83			C o Include/exclude gradient of phy_hyd code
84			#define INCLUDE_GRADPH_CODE
85			#ifdef INCLUDE_GRADPH_CODE
86	adcroft	1.9	#define _PHM(a)a
87	cnh	1.6	#endif
88			#ifndef INCLUDE_GRADPH_CODE
89			#define _PHM(a)
90			#endif
91
92			C o Include/exclude momentum forcing code
93			#define INCLUDE_MOMENTUM_FORCING_CODE
94
95			C o Include/exclude momentum eqn metric terms code
96			#define INCLUDE_MOMENTUM_METRIC_TERM_CODE
97
98			C o Include/exclude phi_hyd calculation code
99			#define INCLUDE_PHIHYD_CALCULATION_CODE
100
101			C o Include/exclude prognostic variable shapiro filter code
102			C Note - Shapiro filter of prognostics variables requires the
103			C three steps "step forward including edges", filter,
104			C "communicate edges".
105			C If the filtering code is included then we do not use the
106			C pipelined "step forward including edges" in S/R DYNAMICS.
107			C Instead the three steps are performed before DYNAMICS one
108			C after another in an un-pipelined fashion.
109			#undef INCLUDE_SHAPIRO_FILTER_CODE
110			#ifdef INCLUDE_SHAPIRO_FILTER_CODE
111			#undef DO_PIPELINED_CORRECTION_STEP
112			#endif
113			#ifndef INCLUDE_SHAPIRO_FILTER_CODE
114			#define DO_PIPELINED_CORRECTION_STEP
115			#endif
116
117			C o Include/exclude call to S/R FIND_RHO
118			#define INCLUDE_FIND_RHO_CALL
119
120			C o Include/exclude call to S/R CONVECT
121			#define INCLUDE_CONVECT_CALL
122
123			C o Include/exclude call to S/R CALC_ISOSLOPES
124			#define INCLUDE_CALC_ISOSLOPES_CALL
125	adcroft	1.5
126	cnh	1.6	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.7
136			C o Use "OLD" UV discretisation near boundaries (not recommended)
137			C Note - only works with #undef NO_SLIP_LATERAL in calc_mom_rhs.F
138			C because the old code did not have no-slip BCs
139			#undef OLD_ADV_BCS
140
141			C o Use "OLD" UV geometry on sphere (definately NOT recommended)
142			C Note - only works with #undef NO_SLIP_LATERAL in calc_mom_rhs.F
143			C because the old code did not have no-slip BCs
144			#undef OLD_UV_GEOMETRY
145	adcroft	1.3
146	cnh	1.6	C o Execution environment support options
147	adcroft	1.3	#include "CPP_EEOPTIONS.h"
148	heimbach	1.13
149			C o Include/exclude code specific to the ECCO/SEALION version.
150			#undef INCLUDE_ECCO_PACKAGE
151			#ifdef INCLUDE_ECCO_PACKAGE
152			#include "ECCO_CPPOPTIONS.h"
153			#endif
154
155
156