high_res_cube/code-mods/CPP_OPTIONS.h

C $Header: /u/gcmpack/MITgcm_contrib/high_res_cube/code-mods/CPP_OPTIONS.h,v 1.8 2007/06/22 20:16:51 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
#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 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 code for single reduction cg-solver
#undef ALLOW_SRCG

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 Include/exclude GM-like eddy stress in momentum code
#undef ALLOW_EDDYPSI

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 mass source or sink of Fluid in the interior
C   (3-D generalisation of oceanic real-fresh water flux)
#undef ALLOW_ADDFLUID

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

C o Allow full 3D specification of vertical diffusivity
#ifdef ALLOW_DIFFKR_CONTROL
C - Need to be defined if using DIFFKR_CONTROL
C   (alternatively, could have put this in ECCO_CPPOPTIONS)
#define ALLOW_3D_DIFFKR
#else
C - otherwise, can be turned on or off hereafter:
#define ALLOW_3D_DIFFKR
#endif /* ALLOW_DIFFKR_CONTROL */

#endif /* CPP_OPTIONS_H */

1	dimitri	1.9	C $Header: /u/gcmpack/MITgcm_contrib/high_res_cube/code-mods/CPP_OPTIONS.h,v 1.8 2007/06/22 20:16:51 dimitri Exp $
2	dimitri	1.2	C $Name: $
3	dimitri	1.1
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	dimitri	1.6	C Note: this should be a run-time option
11	dimitri	1.8	#define SHORTWAVE_HEATING
12	dimitri	1.1
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	dimitri	1.6	C o Allow latitudinally varying BryanLewis79 vertical diffusivity
23	dimitri	1.7	#undef ALLOW_BL79_LAT_VARY
24	dimitri	1.6
25			C o Include/exclude Implicit vertical advection code
26			#undef INCLUDE_IMPLVERTADV_CODE
27
28			C o Include/exclude AdamsBashforth-3rd-Order code
29			#undef ALLOW_ADAMSBASHFORTH_3
30
31	dimitri	1.9	C o Include/exclude code for single reduction cg-solver
32			#undef ALLOW_SRCG
33
34	dimitri	1.1	C o Include/exclude nonHydrostatic code
35			#undef ALLOW_NONHYDROSTATIC
36
37			C o Include pressure loading code
38			#define ATMOSPHERIC_LOADING
39
40	dimitri	1.9	C o exclude/allow external forcing-fields load
41	dimitri	1.8	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	dimitri	1.9	C o Include/exclude GM-like eddy stress in momentum code
46			#undef ALLOW_EDDYPSI
47
48	dimitri	1.1	C o Use "Exact Convervation" of fluid in Free-Surface formulation
49			C so that d/dt(eta) is exactly equal to - Div.Transport
50			#define EXACT_CONSERV
51
52			C o Allow the use of Non-Linear Free-Surface formulation
53			C this implies that surface thickness (hFactors) vary with time
54			#define NONLIN_FRSURF
55
56	dimitri	1.9	C o Allow mass source or sink of Fluid in the interior
57			C (3-D generalisation of oceanic real-fresh water flux)
58			#undef ALLOW_ADDFLUID
59
60	dimitri	1.6	C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
61			C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
62			C only for use on a lat-lon grid
63			C Setting this flag here affects both momentum and tracer equation unless
64			C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
65			C The definition of the flag is commented to avoid interference with
66			C such other header files.
67			C The preferred method is specifying a value for viscAhGrid or viscA4Grid
68			C in data which is then automatically scaled by the grid size;
69			C the old method of specifying viscAh/viscA4 and this flag is provided
70			C for completeness only (and for use with the adjoint).
71	dimitri	1.8	C#define ISOTROPIC_COS_SCALING
72	dimitri	1.6
73			C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
74			C only for use on a lat-lon grid
75			C Has no effect if ISOTROPIC_COS_SCALING is undefined.
76			C Has no effect on vector invariant momentum equations.
77			C Setting this flag here affects both momentum and tracer equation unless
78			C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
79			C The definition of the flag is commented to avoid interference with
80			C such other header files.
81	dimitri	1.8	C#define COSINEMETH_III
82	dimitri	1.6
83	dimitri	1.1	C o Use "OLD" UV discretisation near boundaries (not recommended)
84			C Note - only works with #undef NO_SLIP_LATERAL in calc_mom_rhs.F
85			C because the old code did not have no-slip BCs
86			#undef OLD_ADV_BCS
87
88	dimitri	1.6	C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
89			C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
90			C is still useful with, e.g., single-domain curvilinear configurations.
91			#undef OLD_GRID_IO
92
93	dimitri	1.1	C o Execution environment support options
94			#include "CPP_EEOPTIONS.h"
95
96			C o Include/exclude code specific to the ECCO/SEALION version.
97	dimitri	1.2	C AUTODIFF or EXF package.
98			C Currently controled by a single header file
99			C For this to work, PACKAGES_CONFIG.h needs to be included!
100	dimitri	1.8	cph#if (defined (ALLOW_AUTODIFF) \|\| \
101			cph defined (ALLOW_ECCO) \|\| \
102			cph defined (ALLOW_EXF))
103			cph# include "ECCO_CPPOPTIONS.h"
104			cph#endif
105	dimitri	1.1
106	dimitri	1.9	C o Allow full 3D specification of vertical diffusivity
107			#ifdef ALLOW_DIFFKR_CONTROL
108			C - Need to be defined if using DIFFKR_CONTROL
109			C (alternatively, could have put this in ECCO_CPPOPTIONS)
110			#define ALLOW_3D_DIFFKR
111			#else
112			C - otherwise, can be turned on or off hereafter:
113			#define ALLOW_3D_DIFFKR
114			#endif /* ALLOW_DIFFKR_CONTROL */
115
116	dimitri	1.1	#endif /* CPP_OPTIONS_H */
117	dimitri	1.6