model/inc/CPP_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/model/inc/CPP_OPTIONS.h,v 1.46 2012/03/15 00:41:29 jmc 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 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 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
#undef 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 Choices for implicit solver routines solve_*diagonal.F
C   The following has low memory footprint, but not suitable for AD
#undef SOLVE_DIAGONAL_LOWMEMORY
C   The following one suitable for AD but does not vectorize
#undef SOLVE_DIAGONAL_KINNER

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:
#undef  ALLOW_3D_DIFFKR
#endif /* ALLOW_DIFFKR_CONTROL */

#endif /* CPP_OPTIONS_H */

1	jmc	1.47	C $Header: /u/gcmpack/MITgcm/model/inc/CPP_OPTIONS.h,v 1.46 2012/03/15 00:41:29 jmc 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.39	C o Allow latitudinally varying BryanLewis79 vertical diffusivity
23			#undef ALLOW_BL79_LAT_VARY
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	mlosch	1.44	C o Include/exclude code for single reduction cg-solver
32			#undef ALLOW_SRCG
33
34	edhill	1.24	C o Include/exclude nonHydrostatic code
35			#undef ALLOW_NONHYDROSTATIC
36	edhill	1.23
37			C o Include pressure loading code
38			#define ATMOSPHERIC_LOADING
39	adcroft	1.11
40	jmc	1.43	C o exclude/allow external forcing-fields load
41	jmc	1.40	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	jmc	1.43	C o Include/exclude GM-like eddy stress in momentum code
46			#undef ALLOW_EDDYPSI
47
48	adcroft	1.18	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	edhill	1.23	#define EXACT_CONSERV
51	adcroft	1.18
52			C o Allow the use of Non-Linear Free-Surface formulation
53			C this implies that surface thickness (hFactors) vary with time
54	edhill	1.24	#undef NONLIN_FRSURF
55	adcroft	1.7
56	jmc	1.43	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	heimbach	1.45	C o Choices for implicit solver routines solve_*diagonal.F
61			C The following has low memory footprint, but not suitable for AD
62	jmc	1.47	#undef SOLVE_DIAGONAL_LOWMEMORY
63	heimbach	1.45	C The following one suitable for AD but does not vectorize
64			#undef SOLVE_DIAGONAL_KINNER
65
66	mlosch	1.35	C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
67			C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
68			C only for use on a lat-lon grid
69			C Setting this flag here affects both momentum and tracer equation unless
70			C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
71			C The definition of the flag is commented to avoid interference with
72			C such other header files.
73	mlosch	1.36	C The preferred method is specifying a value for viscAhGrid or viscA4Grid
74			C in data which is then automatically scaled by the grid size;
75			C the old method of specifying viscAh/viscA4 and this flag is provided
76			C for completeness only (and for use with the adjoint).
77	mlosch	1.35	C#define ISOTROPIC_COS_SCALING
78
79			C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
80			C only for use on a lat-lon grid
81			C Has no effect if ISOTROPIC_COS_SCALING is undefined.
82			C Has no effect on vector invariant momentum equations.
83			C Setting this flag here affects both momentum and tracer equation unless
84			C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
85			C The definition of the flag is commented to avoid interference with
86			C such other header files.
87			C#define COSINEMETH_III
88
89	adcroft	1.7	C o Use "OLD" UV discretisation near boundaries (not recommended)
90			C Note - only works with #undef NO_SLIP_LATERAL in calc_mom_rhs.F
91			C because the old code did not have no-slip BCs
92			#undef OLD_ADV_BCS
93	dimitri	1.22
94	dimitri	1.37	C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
95			C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
96			C is still useful with, e.g., single-domain curvilinear configurations.
97			#undef OLD_GRID_IO
98
99	cnh	1.6	C o Execution environment support options
100	adcroft	1.3	#include "CPP_EEOPTIONS.h"
101	heimbach	1.13
102			C o Include/exclude code specific to the ECCO/SEALION version.
103	heimbach	1.29	C AUTODIFF or EXF package.
104			C Currently controled by a single header file
105			C For this to work, PACKAGES_CONFIG.h needs to be included!
106			cph#if (defined (ALLOW_AUTODIFF) \|\| \
107			cph defined (ALLOW_ECCO) \|\| \
108			cph defined (ALLOW_EXF))
109			cph# include "ECCO_CPPOPTIONS.h"
110			cph#endif
111	edhill	1.25
112	jmc	1.43	C o Allow full 3D specification of vertical diffusivity
113			#ifdef ALLOW_DIFFKR_CONTROL
114			C - Need to be defined if using DIFFKR_CONTROL
115			C (alternatively, could have put this in ECCO_CPPOPTIONS)
116			#define ALLOW_3D_DIFFKR
117			#else
118			C - otherwise, can be turned on or off hereafter:
119			#undef ALLOW_3D_DIFFKR
120			#endif /* ALLOW_DIFFKR_CONTROL */
121
122	edhill	1.25	#endif /* CPP_OPTIONS_H */
123