model/inc/CPP_OPTIONS.h

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