high_res_cube/code-mods/CPP_OPTIONS.h

C $Header: /u/gcmpack/MITgcm_contrib/high_res_cube/code-mods/CPP_OPTIONS.h,v 1.6 2007/04/14 18:40:49 dimitri Exp $
C $Name:  $

#ifndef CPP_OPTIONS_H
#define CPP_OPTIONS_H

#include "PACKAGES_CONFIG.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
#define  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
#define ALLOW_3D_DIFFKR

C o Include/exclude Implicit vertical advection code
#undef 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
#define 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#undef 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#undef 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!
#if (defined (ALLOW_AUTODIFF) || \
     defined (ALLOW_ECCO) || \
     defined (ALLOW_EXF))
# include "ECCO_CPPOPTIONS.h"
#endif

C o Configuration details specific to high-resolution cube-sphere
#define HRCUBE

#endif /* CPP_OPTIONS_H */

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