model/inc/CPP_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/model/inc/CPP_OPTIONS.h,v 1.36 2006/04/05 21:25:53 mlosch 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 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 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	dimitri	1.37	C $Header: /u/gcmpack/MITgcm/model/inc/CPP_OPTIONS.h,v 1.36 2006/04/05 21:25:53 mlosch Exp $
2	jmc	1.15	C $Name: $
3	adcroft	1.17
4	edhill	1.25	#ifndef CPP_OPTIONS_H
5			#define CPP_OPTIONS_H
6
7	edhill	1.23	C CPP flags controlling particular source code features
8	adcroft	1.10
9	edhill	1.23	C o Shortwave heating as extra term in external_forcing.F
10	jmc	1.31	C Note: this should be a run-time option
11			#undef SHORTWAVE_HEATING
12	cnh	1.6
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	jmc	1.30
22			C o Include/exclude Implicit vertical advection code
23			#define INCLUDE_IMPLVERTADV_CODE
24	adcroft	1.8
25	jmc	1.33	C o Include/exclude AdamsBashforth-3rd-Order code
26			#undef ALLOW_ADAMSBASHFORTH_3
27
28	edhill	1.24	C o Include/exclude nonHydrostatic code
29			#undef ALLOW_NONHYDROSTATIC
30	edhill	1.23
31			C o Include pressure loading code
32			#define ATMOSPHERIC_LOADING
33	adcroft	1.11
34	adcroft	1.18	C o Use "Exact Convervation" of fluid in Free-Surface formulation
35			C so that d/dt(eta) is exactly equal to - Div.Transport
36	edhill	1.23	#define EXACT_CONSERV
37	adcroft	1.18
38			C o Allow the use of Non-Linear Free-Surface formulation
39			C this implies that surface thickness (hFactors) vary with time
40	edhill	1.24	#undef NONLIN_FRSURF
41	adcroft	1.7
42	mlosch	1.35	C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
43			C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
44			C only for use on a lat-lon grid
45			C Setting this flag here affects both momentum and tracer equation unless
46			C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
47			C The definition of the flag is commented to avoid interference with
48			C such other header files.
49	mlosch	1.36	C The preferred method is specifying a value for viscAhGrid or viscA4Grid
50			C in data which is then automatically scaled by the grid size;
51			C the old method of specifying viscAh/viscA4 and this flag is provided
52			C for completeness only (and for use with the adjoint).
53	mlosch	1.35	C#define ISOTROPIC_COS_SCALING
54
55			C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
56			C only for use on a lat-lon grid
57			C Has no effect if ISOTROPIC_COS_SCALING is undefined.
58			C Has no effect on vector invariant momentum equations.
59			C Setting this flag here affects both momentum and tracer equation unless
60			C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
61			C The definition of the flag is commented to avoid interference with
62			C such other header files.
63			C#define COSINEMETH_III
64
65	adcroft	1.7	C o Use "OLD" UV discretisation near boundaries (not recommended)
66			C Note - only works with #undef NO_SLIP_LATERAL in calc_mom_rhs.F
67			C because the old code did not have no-slip BCs
68			#undef OLD_ADV_BCS
69	dimitri	1.22
70	dimitri	1.37	C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
71			C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
72			C is still useful with, e.g., single-domain curvilinear configurations.
73			#undef OLD_GRID_IO
74
75	cnh	1.6	C o Execution environment support options
76	adcroft	1.3	#include "CPP_EEOPTIONS.h"
77	heimbach	1.13
78			C o Include/exclude code specific to the ECCO/SEALION version.
79	heimbach	1.29	C AUTODIFF or EXF package.
80			C Currently controled by a single header file
81			C For this to work, PACKAGES_CONFIG.h needs to be included!
82			cph#if (defined (ALLOW_AUTODIFF) \|\| \
83			cph defined (ALLOW_ECCO) \|\| \
84			cph defined (ALLOW_EXF))
85			cph# include "ECCO_CPPOPTIONS.h"
86			cph#endif
87	edhill	1.25
88			#endif /* CPP_OPTIONS_H */
89