model/inc/CPP_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/model/inc/CPP_OPTIONS.h,v 1.41 2007/07/22 23:51:15 dimitri Exp $
C $Name:  $

#ifndef CPP_OPTIONS_H
#define CPP_OPTIONS_H

C CPP flags controlling particular source code features

C o Shortwave heating as extra term in external_forcing.F
C Note: this should be a run-time option
#undef SHORTWAVE_HEATING

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 latitudinally varying BryanLewis79 vertical diffusivity
#undef ALLOW_BL79_LAT_VARY

C o Allow full 3D specification of vertical diffusivity
#undef ALLOW_3D_DIFFKR

C o Include/exclude Implicit vertical advection code
#define INCLUDE_IMPLVERTADV_CODE

C o Include/exclude AdamsBashforth-3rd-Order code
#undef ALLOW_ADAMSBASHFORTH_3

C o Include/exclude nonHydrostatic code
#undef ALLOW_NONHYDROSTATIC

C o Include pressure loading code
#define ATMOSPHERIC_LOADING

C o exclude/allow external forcing-fields load 
C   this allows to read & do simple linear time interpolation of oceanic
C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
#undef EXCLUDE_FFIELDS_LOAD

C o Use "Exact Convervation" of fluid in Free-Surface formulation
C   so that d/dt(eta) is exactly equal to - Div.Transport
#define 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 ALLOW isotropic scaling of harmonic and bi-harmonic terms when
C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
C *only for use on a lat-lon grid*
C   Setting this flag here affects both momentum and tracer equation unless
C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
C   The definition of the flag is commented to avoid interference with
C   such other header files.
C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
C   in data which is then automatically scaled by the grid size;
C   the old method of specifying viscAh/viscA4 and this flag is provided
C   for completeness only (and for use with the adjoint).
C#define ISOTROPIC_COS_SCALING

C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
C *only for use on a lat-lon grid*
C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
C   Has no effect on vector invariant momentum equations.
C   Setting this flag here affects both momentum and tracer equation unless
C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
C   The definition of the flag is commented to avoid interference with
C   such other header files.
C#define COSINEMETH_III

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 LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
C   is still useful with, e.g., single-domain curvilinear configurations.
#undef OLD_GRID_IO

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

C o Include/exclude code specific to the ECCO/SEALION version.
C   AUTODIFF or EXF package.
C   Currently controled by a single header file
C   For this to work, PACKAGES_CONFIG.h needs to be included!
cph#if (defined (ALLOW_AUTODIFF) || \
cph     defined (ALLOW_ECCO) || \
cph     defined (ALLOW_EXF))
cph# include "ECCO_CPPOPTIONS.h"
cph#endif

#endif /* CPP_OPTIONS_H */

1	C $Header: /u/gcmpack/MITgcm/model/inc/CPP_OPTIONS.h,v 1.41 2007/07/22 23:51:15 dimitri Exp $
2	C $Name: $
3
4	#ifndef CPP_OPTIONS_H
5	#define CPP_OPTIONS_H
6
7	C CPP flags controlling particular source code features
8
9	C o Shortwave heating as extra term in external_forcing.F
10	C Note: this should be a run-time option
11	#undef SHORTWAVE_HEATING
12
13	C o Include/exclude phi_hyd calculation code
14	#define INCLUDE_PHIHYD_CALCULATION_CODE
15
16	C o Include/exclude call to S/R CONVECT
17	#define INCLUDE_CONVECT_CALL
18
19	C o Include/exclude call to S/R CALC_DIFFUSIVITY
20	#define INCLUDE_CALC_DIFFUSIVITY_CALL
21
22	C o Allow latitudinally varying BryanLewis79 vertical diffusivity
23	#undef ALLOW_BL79_LAT_VARY
24
25	C o Allow full 3D specification of vertical diffusivity
26	#undef ALLOW_3D_DIFFKR
27
28	C o Include/exclude Implicit vertical advection code
29	#define INCLUDE_IMPLVERTADV_CODE
30
31	C o Include/exclude AdamsBashforth-3rd-Order code
32	#undef ALLOW_ADAMSBASHFORTH_3
33
34	C o Include/exclude nonHydrostatic code
35	#undef ALLOW_NONHYDROSTATIC
36
37	C o Include pressure loading code
38	#define ATMOSPHERIC_LOADING
39
40	C o exclude/allow external forcing-fields load
41	C this allows to read & do simple linear time interpolation of oceanic
42	C forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
43	#undef EXCLUDE_FFIELDS_LOAD
44
45	C o Use "Exact Convervation" of fluid in Free-Surface formulation
46	C so that d/dt(eta) is exactly equal to - Div.Transport
47	#define EXACT_CONSERV
48
49	C o Allow the use of Non-Linear Free-Surface formulation
50	C this implies that surface thickness (hFactors) vary with time
51	#undef NONLIN_FRSURF
52
53	C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
54	C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
55	C only for use on a lat-lon grid
56	C Setting this flag here affects both momentum and tracer equation unless
57	C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
58	C The definition of the flag is commented to avoid interference with
59	C such other header files.
60	C The preferred method is specifying a value for viscAhGrid or viscA4Grid
61	C in data which is then automatically scaled by the grid size;
62	C the old method of specifying viscAh/viscA4 and this flag is provided
63	C for completeness only (and for use with the adjoint).
64	C#define ISOTROPIC_COS_SCALING
65
66	C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
67	C only for use on a lat-lon grid
68	C Has no effect if ISOTROPIC_COS_SCALING is undefined.
69	C Has no effect on vector invariant momentum equations.
70	C Setting this flag here affects both momentum and tracer equation unless
71	C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
72	C The definition of the flag is commented to avoid interference with
73	C such other header files.
74	C#define COSINEMETH_III
75
76	C o Use "OLD" UV discretisation near boundaries (not recommended)
77	C Note - only works with #undef NO_SLIP_LATERAL in calc_mom_rhs.F
78	C because the old code did not have no-slip BCs
79	#undef OLD_ADV_BCS
80
81	C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
82	C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
83	C is still useful with, e.g., single-domain curvilinear configurations.
84	#undef OLD_GRID_IO
85
86	C o Execution environment support options
87	#include "CPP_EEOPTIONS.h"
88
89	C o Include/exclude code specific to the ECCO/SEALION version.
90	C AUTODIFF or EXF package.
91	C Currently controled by a single header file
92	C For this to work, PACKAGES_CONFIG.h needs to be included!
93	cph#if (defined (ALLOW_AUTODIFF) \|\| \
94	cph defined (ALLOW_ECCO) \|\| \
95	cph defined (ALLOW_EXF))
96	cph# include "ECCO_CPPOPTIONS.h"
97	cph#endif
98
99	#endif /* CPP_OPTIONS_H */
100