model/inc/CPP_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/model/inc/CPP_OPTIONS.h,v 1.54 2016/11/28 22:55:00 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
#undef SHORTWAVE_HEATING

C o Include/exclude Geothermal Heat Flux at the bottom of the ocean
#undef 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
#undef ALLOW_BALANCE_FLUXES

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

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
#define 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-- Retired code options:

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 thsice+seaice (old) call sequence: ice-Dyn,ice-Advect,ice-Thermo(thsice)
C              as opposed to new sequence: ice-Thermo(thsice),ice-Dyn,ice-Advect
#undef OLD_THSICE_CALL_SEQUENCE

C o Use old EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility)
#undef USE_OLD_EXTERNAL_FORCING

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.55	C $Header: /u/gcmpack/MITgcm/model/inc/CPP_OPTIONS.h,v 1.54 2016/11/28 22:55:00 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	jmc	1.50	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	edhill	1.23	C CPP flags controlling particular source code features
20	adcroft	1.10
21	jmc	1.55	C-- Forcing code options:
22
23	edhill	1.23	C o Shortwave heating as extra term in external_forcing.F
24	jmc	1.31	C Note: this should be a run-time option
25			#undef SHORTWAVE_HEATING
26	cnh	1.6
27	jmc	1.53	C o Include/exclude Geothermal Heat Flux at the bottom of the ocean
28			#undef ALLOW_GEOTHERMAL_FLUX
29
30	jmc	1.55	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			#undef ALLOW_BALANCE_FLUXES
42
43			C o Include/exclude balancing surface forcing relaxation code
44			#undef 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	cnh	1.6	C o Include/exclude phi_hyd calculation code
57			#define INCLUDE_PHIHYD_CALCULATION_CODE
58
59	jmc	1.55	C-- Vertical mixing code options:
60
61	cnh	1.6	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	jmc	1.30
67	jmc	1.50	C o Allow full 3D specification of vertical diffusivity
68			#undef ALLOW_3D_DIFFKR
69
70	dimitri	1.39	C o Allow latitudinally varying BryanLewis79 vertical diffusivity
71			#undef ALLOW_BL79_LAT_VARY
72
73	jmc	1.55	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			#undef EXCLUDE_PCELL_MIX_CODE
78
79			C-- Time-stepping code options:
80	adcroft	1.8
81	jmc	1.54	C o Include/exclude combined Surf.Pressure and Drag Implicit solver code
82			#undef ALLOW_SOLVE4_PS_AND_DRAG
83
84	jmc	1.55	C o Include/exclude Implicit vertical advection code
85			#define INCLUDE_IMPLVERTADV_CODE
86
87	jmc	1.33	C o Include/exclude AdamsBashforth-3rd-Order code
88			#undef ALLOW_ADAMSBASHFORTH_3
89
90	jmc	1.55	C-- Model formulation options:
91	edhill	1.23
92	jmc	1.55	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	jmc	1.51
96	jmc	1.55	C o Allow the use of Non-Linear Free-Surface formulation
97			C this implies that grid-cell thickness (hFactors) varies with time
98			#undef NONLIN_FRSURF
99	jmc	1.50
100	jmc	1.55	C o Include/exclude nonHydrostatic code
101			#undef ALLOW_NONHYDROSTATIC
102	jmc	1.49
103	jmc	1.43	C o Include/exclude GM-like eddy stress in momentum code
104			#undef ALLOW_EDDYPSI
105
106	jmc	1.55	C-- Algorithm options:
107	adcroft	1.18
108	jmc	1.55	C o Use Non Self-Adjoint (NSA) conjugate-gradient solver
109			#undef ALLOW_CG2D_NSA
110	adcroft	1.7
111	jmc	1.50	C o Include/exclude code for single reduction Conjugate-Gradient solver
112			#define ALLOW_SRCG
113	jmc	1.43
114	heimbach	1.45	C o Choices for implicit solver routines solve_*diagonal.F
115			C The following has low memory footprint, but not suitable for AD
116	jmc	1.47	#undef SOLVE_DIAGONAL_LOWMEMORY
117	heimbach	1.45	C The following one suitable for AD but does not vectorize
118			#undef SOLVE_DIAGONAL_KINNER
119
120	jmc	1.55	C-- Retired code options:
121
122	mlosch	1.35	C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
123			C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
124			C only for use on a lat-lon grid
125			C Setting this flag here affects both momentum and tracer equation unless
126			C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
127			C The definition of the flag is commented to avoid interference with
128			C such other header files.
129	mlosch	1.36	C The preferred method is specifying a value for viscAhGrid or viscA4Grid
130			C in data which is then automatically scaled by the grid size;
131			C the old method of specifying viscAh/viscA4 and this flag is provided
132			C for completeness only (and for use with the adjoint).
133	mlosch	1.35	C#define ISOTROPIC_COS_SCALING
134
135			C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
136			C only for use on a lat-lon grid
137			C Has no effect if ISOTROPIC_COS_SCALING is undefined.
138			C Has no effect on vector invariant momentum equations.
139			C Setting this flag here affects both momentum and tracer equation unless
140			C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
141			C The definition of the flag is commented to avoid interference with
142			C such other header files.
143			C#define COSINEMETH_III
144
145	adcroft	1.7	C o Use "OLD" UV discretisation near boundaries (not recommended)
146	jmc	1.52	C Note - only works with pkg/mom_fluxform and "no_slip_sides=.FALSE."
147	adcroft	1.7	C because the old code did not have no-slip BCs
148	jmc	1.52	#undef OLD_ADV_BCS
149	dimitri	1.22
150	dimitri	1.37	C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
151			C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
152			C is still useful with, e.g., single-domain curvilinear configurations.
153			#undef OLD_GRID_IO
154
155	jmc	1.55	C o Use thsice+seaice (old) call sequence: ice-Dyn,ice-Advect,ice-Thermo(thsice)
156			C as opposed to new sequence: ice-Thermo(thsice),ice-Dyn,ice-Advect
157			#undef OLD_THSICE_CALL_SEQUENCE
158
159	jmc	1.52	C o Use old EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility)
160			#undef USE_OLD_EXTERNAL_FORCING
161
162	jmc	1.55	C-- Other option files:
163
164	cnh	1.6	C o Execution environment support options
165	adcroft	1.3	#include "CPP_EEOPTIONS.h"
166	heimbach	1.13
167	jmc	1.49	C o Include/exclude single header file containing multiple packages options
168			C (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
169			C each of the above pkg get its own options from its specific option file.
170			C Although this method, inherited from ECCO setup, has been traditionally
171	jmc	1.50	C used for all adjoint built, work is in progress to allow to use the
172			C standard method also for adjoint built.
173			c#ifdef PACKAGES_CONFIG_H
174			c# include "ECCO_CPPOPTIONS.h"
175			c#endif
176	jmc	1.43
177	edhill	1.25	#endif /* CPP_OPTIONS_H */