OpenAD/code_oad/CPP_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/verification/OpenAD/code_oad/CPP_OPTIONS.h,v 1.3 2014/09/11 19:31:31 jmc Exp $
C $Name:  $

#ifndef CPP_OPTIONS_H
#define CPP_OPTIONS_H

CBOP
C !ROUTINE: CPP_OPTIONS.h
C !INTERFACE:
C #include "CPP_OPTIONS.h"

C !DESCRIPTION:
C *==================================================================*
C | main CPP options file for the model:
C | Control which optional features to compile in model/src code.
C *==================================================================*
CEOP

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 Geothermal Heat Flux at the bottom of the ocean
#undef ALLOW_GEOTHERMAL_FLUX

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 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 nonHydrostatic code
#undef ALLOW_NONHYDROSTATIC

C o Allow to account for heating due to friction (and momentum dissipation)
#undef ALLOW_FRICTION_HEATING

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 Include pressure loading code
#undef 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 balancing surface forcing fluxes code
#undef ALLOW_BALANCE_FLUXES

C o Include/exclude balancing surface forcing relaxation code
#undef ALLOW_BALANCE_RELAX

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
#undef 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 Use Non Self-Adjoint (NSA) conjugate-gradient solver
#undef ALLOW_CG2D_NSA

C o Include/exclude code for single reduction Conjugate-Gradient solver
#undef ALLOW_SRCG

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 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 single header file containing multiple packages options
C   (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
C   each of the above pkg get its own options from its specific option file.
C   Although this method, inherited from ECCO setup, has been traditionally
C   used for all adjoint built, work is in progress to allow to use the
C   standard method also for adjoint built.
c#ifdef PACKAGES_CONFIG_H
c# include "ECCO_CPPOPTIONS.h"
c#endif

#endif /* CPP_OPTIONS_H */
1	heimbach	1.4	C $Header: /u/gcmpack/MITgcm/verification/OpenAD/code_oad/CPP_OPTIONS.h,v 1.3 2014/09/11 19:31:31 jmc Exp $
2	utke	1.1	C $Name: $
3
4			#ifndef CPP_OPTIONS_H
5			#define CPP_OPTIONS_H
6
7	jmc	1.2	CBOP
8			C !ROUTINE: CPP_OPTIONS.h
9			C !INTERFACE:
10			C #include "CPP_OPTIONS.h"
11
12			C !DESCRIPTION:
13			C ==================================================================
14			C \| main CPP options file for the model:
15			C \| Control which optional features to compile in model/src code.
16			C ==================================================================
17			CEOP
18	utke	1.1
19			C CPP flags controlling particular source code features
20
21			C o Shortwave heating as extra term in external_forcing.F
22			C Note: this should be a run-time option
23	heimbach	1.4	#define SHORTWAVE_HEATING
24	utke	1.1
25	jmc	1.3	C o Include/exclude Geothermal Heat Flux at the bottom of the ocean
26			#undef ALLOW_GEOTHERMAL_FLUX
27
28	utke	1.1	C o Include/exclude phi_hyd calculation code
29			#define INCLUDE_PHIHYD_CALCULATION_CODE
30
31			C o Include/exclude call to S/R CONVECT
32			#define INCLUDE_CONVECT_CALL
33
34			C o Include/exclude call to S/R CALC_DIFFUSIVITY
35			#define INCLUDE_CALC_DIFFUSIVITY_CALL
36
37	jmc	1.2	C o Allow full 3D specification of vertical diffusivity
38			#undef ALLOW_3D_DIFFKR
39
40	utke	1.1	C o Allow latitudinally varying BryanLewis79 vertical diffusivity
41			#undef ALLOW_BL79_LAT_VARY
42
43			C o Include/exclude Implicit vertical advection code
44	jmc	1.2	#undef INCLUDE_IMPLVERTADV_CODE
45	utke	1.1
46			C o Include/exclude AdamsBashforth-3rd-Order code
47			#undef ALLOW_ADAMSBASHFORTH_3
48
49			C o Include/exclude nonHydrostatic code
50			#undef ALLOW_NONHYDROSTATIC
51
52	jmc	1.2	C o Allow to account for heating due to friction (and momentum dissipation)
53			#undef ALLOW_FRICTION_HEATING
54
55			C o Allow mass source or sink of Fluid in the interior
56			C (3-D generalisation of oceanic real-fresh water flux)
57			#undef ALLOW_ADDFLUID
58
59	utke	1.1	C o Include pressure loading code
60	jmc	1.2	#undef ATMOSPHERIC_LOADING
61	utke	1.1
62			C o exclude/allow external forcing-fields load
63			C this allows to read & do simple linear time interpolation of oceanic
64			C forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
65			#undef EXCLUDE_FFIELDS_LOAD
66
67	jmc	1.2	C o Include/exclude balancing surface forcing fluxes code
68			#undef ALLOW_BALANCE_FLUXES
69
70			C o Include/exclude balancing surface forcing relaxation code
71			#undef ALLOW_BALANCE_RELAX
72
73	utke	1.1	C o Include/exclude GM-like eddy stress in momentum code
74			#undef ALLOW_EDDYPSI
75
76			C o Use "Exact Convervation" of fluid in Free-Surface formulation
77			C so that d/dt(eta) is exactly equal to - Div.Transport
78			#undef EXACT_CONSERV
79
80			C o Allow the use of Non-Linear Free-Surface formulation
81			C this implies that surface thickness (hFactors) vary with time
82			#undef NONLIN_FRSURF
83
84	jmc	1.3	C o Use Non Self-Adjoint (NSA) conjugate-gradient solver
85			#undef ALLOW_CG2D_NSA
86
87	jmc	1.2	C o Include/exclude code for single reduction Conjugate-Gradient solver
88			#undef ALLOW_SRCG
89
90			C o Choices for implicit solver routines solve_*diagonal.F
91			C The following has low memory footprint, but not suitable for AD
92			#undef SOLVE_DIAGONAL_LOWMEMORY
93			C The following one suitable for AD but does not vectorize
94			#undef SOLVE_DIAGONAL_KINNER
95	utke	1.1
96			C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
97			C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
98			C only for use on a lat-lon grid
99			C Setting this flag here affects both momentum and tracer equation unless
100			C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
101			C The definition of the flag is commented to avoid interference with
102			C such other header files.
103			C The preferred method is specifying a value for viscAhGrid or viscA4Grid
104			C in data which is then automatically scaled by the grid size;
105			C the old method of specifying viscAh/viscA4 and this flag is provided
106			C for completeness only (and for use with the adjoint).
107			C#define ISOTROPIC_COS_SCALING
108
109			C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
110			C only for use on a lat-lon grid
111			C Has no effect if ISOTROPIC_COS_SCALING is undefined.
112			C Has no effect on vector invariant momentum equations.
113			C Setting this flag here affects both momentum and tracer equation unless
114			C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
115			C The definition of the flag is commented to avoid interference with
116			C such other header files.
117			C#define COSINEMETH_III
118
119			C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
120			C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
121			C is still useful with, e.g., single-domain curvilinear configurations.
122	jmc	1.2	#undef OLD_GRID_IO
123	utke	1.1
124			C o Execution environment support options
125			#include "CPP_EEOPTIONS.h"
126
127	jmc	1.2	C o Include/exclude single header file containing multiple packages options
128			C (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
129			C each of the above pkg get its own options from its specific option file.
130			C Although this method, inherited from ECCO setup, has been traditionally
131			C used for all adjoint built, work is in progress to allow to use the
132			C standard method also for adjoint built.
133	jmc	1.3	c#ifdef PACKAGES_CONFIG_H
134			c# include "ECCO_CPPOPTIONS.h"
135			c#endif
136	utke	1.1
137			#endif /* CPP_OPTIONS_H */