global_oce_llc90/code/CPP_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/model/inc/CPP_OPTIONS.h,v 1.55 2017/11/02 17:43:26 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-- Forcing code options:

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 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 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 checking for negative salinity
#undef CHECK_SALINITY_FOR_NEGATIVE_VALUES

C-- Options to discard parts of the main code:

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 phi_hyd calculation code
#define INCLUDE_PHIHYD_CALCULATION_CODE

C-- Vertical mixing code options:

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
#define ALLOW_3D_DIFFKR

C o Allow latitudinally varying BryanLewis79 vertical diffusivity
#undef ALLOW_BL79_LAT_VARY

C o Exclude/allow partial-cell effect (physical or enhanced) in vertical mixing
C   this allows to account for partial-cell in vertical viscosity and diffusion,
C   either from grid-spacing reduction effect or as artificially enhanced mixing
C   near surface & bottom for too thin grid-cell
#define EXCLUDE_PCELL_MIX_CODE

C-- Time-stepping code options:

C o Include/exclude combined Surf.Pressure and Drag Implicit solver code
#undef ALLOW_SOLVE4_PS_AND_DRAG

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-- Model formulation options:

C o Allow/exclude "Exact Convervation" of fluid in Free-Surface formulation
C   that ensures 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 grid-cell thickness (hFactors) varies with time
#define NONLIN_FRSURF
#define DISABLE_SIGMA_CODE

C o Include/exclude nonHydrostatic code
#undef ALLOW_NONHYDROSTATIC

C o Include/exclude GM-like eddy stress in momentum code
#undef ALLOW_EDDYPSI

C-- Algorithm options:

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
#define SOLVE_DIAGONAL_KINNER

C-- Retired code options:

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-- Other option files:

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	jmc	1.6	C $Header: /u/gcmpack/MITgcm/model/inc/CPP_OPTIONS.h,v 1.55 2017/11/02 17:43:26 jmc 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	C CPP flags controlling particular source code features
20
21	jmc	1.6	C-- Forcing code options:
22
23	gforget	1.1	C o Shortwave heating as extra term in external_forcing.F
24			C Note: this should be a run-time option
25			#define SHORTWAVE_HEATING
26
27	gforget	1.2	C o Include/exclude Geothermal Heat Flux at the bottom of the ocean
28			#define ALLOW_GEOTHERMAL_FLUX
29
30	jmc	1.6	C o Allow to account for heating due to friction (and momentum dissipation)
31			#undef ALLOW_FRICTION_HEATING
32
33			C o Allow mass source or sink of Fluid in the interior
34			C (3-D generalisation of oceanic real-fresh water flux)
35			#undef ALLOW_ADDFLUID
36
37			C o Include pressure loading code
38			#define ATMOSPHERIC_LOADING
39
40			C o Include/exclude balancing surface forcing fluxes code
41			#define ALLOW_BALANCE_FLUXES
42
43			C o Include/exclude balancing surface forcing relaxation code
44			#define ALLOW_BALANCE_RELAX
45
46			C o Include/exclude checking for negative salinity
47			#undef CHECK_SALINITY_FOR_NEGATIVE_VALUES
48
49			C-- Options to discard parts of the main code:
50
51			C o Exclude/allow external forcing-fields load
52			C this allows to read & do simple linear time interpolation of oceanic
53			C forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
54			#undef EXCLUDE_FFIELDS_LOAD
55
56	gforget	1.1	C o Include/exclude phi_hyd calculation code
57			#define INCLUDE_PHIHYD_CALCULATION_CODE
58
59	jmc	1.6	C-- Vertical mixing code options:
60
61	gforget	1.1	C o Include/exclude call to S/R CONVECT
62			#define INCLUDE_CONVECT_CALL
63
64			C o Include/exclude call to S/R CALC_DIFFUSIVITY
65			#define INCLUDE_CALC_DIFFUSIVITY_CALL
66
67	gforget	1.2	C o Allow full 3D specification of vertical diffusivity
68	gforget	1.4	#define ALLOW_3D_DIFFKR
69	gforget	1.2
70	gforget	1.1	C o Allow latitudinally varying BryanLewis79 vertical diffusivity
71			#undef ALLOW_BL79_LAT_VARY
72
73	jmc	1.6	C o Exclude/allow partial-cell effect (physical or enhanced) in vertical mixing
74			C this allows to account for partial-cell in vertical viscosity and diffusion,
75			C either from grid-spacing reduction effect or as artificially enhanced mixing
76			C near surface & bottom for too thin grid-cell
77			#define EXCLUDE_PCELL_MIX_CODE
78
79			C-- Time-stepping code options:
80
81			C o Include/exclude combined Surf.Pressure and Drag Implicit solver code
82			#undef ALLOW_SOLVE4_PS_AND_DRAG
83
84	gforget	1.1	C o Include/exclude Implicit vertical advection code
85			#define INCLUDE_IMPLVERTADV_CODE
86
87			C o Include/exclude AdamsBashforth-3rd-Order code
88			#define ALLOW_ADAMSBASHFORTH_3
89
90	jmc	1.6	C-- Model formulation options:
91	gforget	1.2
92	jmc	1.6	C o Allow/exclude "Exact Convervation" of fluid in Free-Surface formulation
93			C that ensures that d/dt(eta) is exactly equal to - Div.Transport
94			#define EXACT_CONSERV
95	gforget	1.2
96	jmc	1.6	C o Allow the use of Non-Linear Free-Surface formulation
97			C this implies that grid-cell thickness (hFactors) varies with time
98			#define NONLIN_FRSURF
99			#define DISABLE_SIGMA_CODE
100	gforget	1.1
101	jmc	1.6	C o Include/exclude nonHydrostatic code
102			#undef ALLOW_NONHYDROSTATIC
103	gforget	1.1
104			C o Include/exclude GM-like eddy stress in momentum code
105			#undef ALLOW_EDDYPSI
106
107	jmc	1.6	C-- Algorithm options:
108	gforget	1.1
109	jmc	1.6	C o Use Non Self-Adjoint (NSA) conjugate-gradient solver
110			#undef ALLOW_CG2D_NSA
111	gforget	1.1
112	gforget	1.2	C o Include/exclude code for single reduction Conjugate-Gradient solver
113			#undef ALLOW_SRCG
114	gforget	1.1
115			C o Choices for implicit solver routines solve_*diagonal.F
116			C The following has low memory footprint, but not suitable for AD
117			#undef SOLVE_DIAGONAL_LOWMEMORY
118			C The following one suitable for AD but does not vectorize
119			#define SOLVE_DIAGONAL_KINNER
120
121	jmc	1.6	C-- Retired code options:
122	gforget	1.1
123			C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
124			C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
125			C is still useful with, e.g., single-domain curvilinear configurations.
126			#undef OLD_GRID_IO
127
128	jmc	1.6	C-- Other option files:
129	gforget	1.2
130	gforget	1.1	C o Execution environment support options
131			#include "CPP_EEOPTIONS.h"
132
133	jmc	1.6	C o Include/exclude single header file containing multiple packages options
134			C (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
135			C each of the above pkg get its own options from its specific option file.
136			C Although this method, inherited from ECCO setup, has been traditionally
137			C used for all adjoint built, work is in progress to allow to use the
138			C standard method also for adjoint built.
139			c#ifdef PACKAGES_CONFIG_H
140			c# include "ECCO_CPPOPTIONS.h"
141			c#endif
142
143	gforget	1.1	#endif /* CPP_OPTIONS_H */