global_oce_llc90/code/CPP_OPTIONS.h

C $Header: /u/gcmpack/MITgcm_contrib/gael/verification/global_oce_llc90/code/CPP_OPTIONS.h,v 1.1 2012/10/03 20:27:37 gforget 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

#include "PACKAGES_CONFIG.h"
#include "AD_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 Geothermal Heat Flux at the bottom of the ocean
#define 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
c#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
#define INCLUDE_IMPLVERTADV_CODE

C o Include/exclude AdamsBashforth-3rd-Order code
#define 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
#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 balancing surface forcing fluxes code
#define ALLOW_BALANCE_FLUXES

C o Include/exclude balancing surface forcing relaxation code
#define 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
#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
# undef DISABLE_RSTAR_CODE
#define DISABLE_SIGMA_CODE

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
#define 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 pkg/mom_fluxform and "no_slip_sides=.FALSE."
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 Use old EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility)
#undef USE_OLD_EXTERNAL_FORCING

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 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	gforget	1.2	C $Header: /u/gcmpack/MITgcm_contrib/gael/verification/global_oce_llc90/code/CPP_OPTIONS.h,v 1.1 2012/10/03 20:27:37 gforget Exp $
2	gforget	1.1	C $Name: $
3
4			#ifndef CPP_OPTIONS_H
5			#define CPP_OPTIONS_H
6
7	gforget	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
19	gforget	1.1	#include "PACKAGES_CONFIG.h"
20			#include "AD_CONFIG.h"
21
22			C CPP flags controlling particular source code features
23
24			C o Shortwave heating as extra term in external_forcing.F
25			C Note: this should be a run-time option
26			#define SHORTWAVE_HEATING
27
28	gforget	1.2	C o Include/exclude Geothermal Heat Flux at the bottom of the ocean
29			#define ALLOW_GEOTHERMAL_FLUX
30
31	gforget	1.1	C o Include/exclude phi_hyd calculation code
32			#define INCLUDE_PHIHYD_CALCULATION_CODE
33
34			C o Include/exclude call to S/R CONVECT
35			#define INCLUDE_CONVECT_CALL
36
37			C o Include/exclude call to S/R CALC_DIFFUSIVITY
38			#define INCLUDE_CALC_DIFFUSIVITY_CALL
39
40	gforget	1.2	C o Allow full 3D specification of vertical diffusivity
41			c#undef ALLOW_3D_DIFFKR
42
43	gforget	1.1	C o Allow latitudinally varying BryanLewis79 vertical diffusivity
44			#undef ALLOW_BL79_LAT_VARY
45
46			C o Include/exclude Implicit vertical advection code
47			#define INCLUDE_IMPLVERTADV_CODE
48
49			C o Include/exclude AdamsBashforth-3rd-Order code
50			#define ALLOW_ADAMSBASHFORTH_3
51
52			C o Include/exclude nonHydrostatic code
53			#undef ALLOW_NONHYDROSTATIC
54
55	gforget	1.2	C o Allow to account for heating due to friction (and momentum dissipation)
56			#undef ALLOW_FRICTION_HEATING
57
58			C o Allow mass source or sink of Fluid in the interior
59			C (3-D generalisation of oceanic real-fresh water flux)
60			#undef ALLOW_ADDFLUID
61
62	gforget	1.1	C o Include pressure loading code
63			#define ATMOSPHERIC_LOADING
64
65			C o exclude/allow external forcing-fields load
66			C this allows to read & do simple linear time interpolation of oceanic
67			C forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
68			#undef EXCLUDE_FFIELDS_LOAD
69
70			C o Include/exclude balancing surface forcing fluxes code
71			#define ALLOW_BALANCE_FLUXES
72
73			C o Include/exclude balancing surface forcing relaxation code
74			#define ALLOW_BALANCE_RELAX
75
76			C o Include/exclude GM-like eddy stress in momentum code
77			#undef ALLOW_EDDYPSI
78
79			C o Use "Exact Convervation" of fluid in Free-Surface formulation
80			C so that d/dt(eta) is exactly equal to - Div.Transport
81			#define EXACT_CONSERV
82
83			C o Allow the use of Non-Linear Free-Surface formulation
84			C this implies that surface thickness (hFactors) vary with time
85			#define NONLIN_FRSURF
86			# undef DISABLE_RSTAR_CODE
87			#define DISABLE_SIGMA_CODE
88
89	gforget	1.2	C o Include/exclude code for single reduction Conjugate-Gradient solver
90			#undef ALLOW_SRCG
91	gforget	1.1
92			C o Choices for implicit solver routines solve_*diagonal.F
93			C The following has low memory footprint, but not suitable for AD
94			#undef SOLVE_DIAGONAL_LOWMEMORY
95			C The following one suitable for AD but does not vectorize
96			#define SOLVE_DIAGONAL_KINNER
97
98			C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
99			C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
100			C only for use on a lat-lon grid
101			C Setting this flag here affects both momentum and tracer equation unless
102			C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
103			C The definition of the flag is commented to avoid interference with
104			C such other header files.
105			C The preferred method is specifying a value for viscAhGrid or viscA4Grid
106			C in data which is then automatically scaled by the grid size;
107			C the old method of specifying viscAh/viscA4 and this flag is provided
108			C for completeness only (and for use with the adjoint).
109			C#define ISOTROPIC_COS_SCALING
110
111			C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
112			C only for use on a lat-lon grid
113			C Has no effect if ISOTROPIC_COS_SCALING is undefined.
114			C Has no effect on vector invariant momentum equations.
115			C Setting this flag here affects both momentum and tracer equation unless
116			C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
117			C The definition of the flag is commented to avoid interference with
118			C such other header files.
119			C#define COSINEMETH_III
120
121			C o Use "OLD" UV discretisation near boundaries (not recommended)
122	gforget	1.2	C Note - only works with pkg/mom_fluxform and "no_slip_sides=.FALSE."
123	gforget	1.1	C because the old code did not have no-slip BCs
124	gforget	1.2	#undef OLD_ADV_BCS
125	gforget	1.1
126			C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
127			C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
128			C is still useful with, e.g., single-domain curvilinear configurations.
129			#undef OLD_GRID_IO
130
131	gforget	1.2	C o Use old EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility)
132			#undef USE_OLD_EXTERNAL_FORCING
133
134	gforget	1.1	C o Execution environment support options
135			#include "CPP_EEOPTIONS.h"
136
137			C o Include/exclude code specific to the ECCO/SEALION version.
138			C AUTODIFF or EXF package.
139			C Currently controled by a single header file
140			C For this to work, PACKAGES_CONFIG.h needs to be included!
141			#if (defined (ALLOW_AUTODIFF) \|\| \
142			defined (ALLOW_ECCO) \|\| \
143			defined (ALLOW_EXF))
144			# include "ECCO_CPPOPTIONS.h"
145			#endif
146
147			C o Allow full 3D specification of vertical diffusivity
148			#ifdef ALLOW_DIFFKR_CONTROL
149			C - Need to be defined if using DIFFKR_CONTROL
150			C (alternatively, could have put this in ECCO_CPPOPTIONS)
151			#define ALLOW_3D_DIFFKR
152			#else
153			C - otherwise, can be turned on or off hereafter:
154			#undef ALLOW_3D_DIFFKR
155			#endif /* ALLOW_DIFFKR_CONTROL */
156
157			#endif /* CPP_OPTIONS_H */
158