1 |
jmc |
1.49 |
C $Header: /u/gcmpack/MITgcm/model/inc/CPP_OPTIONS.h,v 1.48 2012/05/11 23:36:56 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 |
jmc |
1.48 |
C o Include/exclude code for single reduction Conjugate-Gradient solver |
32 |
|
|
#define ALLOW_SRCG |
33 |
mlosch |
1.44 |
|
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.49 |
C o Include/exclude balancing surface forcing fluxes code |
46 |
|
|
#undef ALLOW_BALANCE_FLUXES |
47 |
|
|
|
48 |
|
|
C o Include/exclude balancing surface forcing relaxation code |
49 |
|
|
#undef ALLOW_BALANCE_RELAX |
50 |
|
|
|
51 |
jmc |
1.43 |
C o Include/exclude GM-like eddy stress in momentum code |
52 |
|
|
#undef ALLOW_EDDYPSI |
53 |
|
|
|
54 |
adcroft |
1.18 |
C o Use "Exact Convervation" of fluid in Free-Surface formulation |
55 |
|
|
C so that d/dt(eta) is exactly equal to - Div.Transport |
56 |
edhill |
1.23 |
#define EXACT_CONSERV |
57 |
adcroft |
1.18 |
|
58 |
|
|
C o Allow the use of Non-Linear Free-Surface formulation |
59 |
|
|
C this implies that surface thickness (hFactors) vary with time |
60 |
edhill |
1.24 |
#undef NONLIN_FRSURF |
61 |
adcroft |
1.7 |
|
62 |
jmc |
1.43 |
C o Allow mass source or sink of Fluid in the interior |
63 |
|
|
C (3-D generalisation of oceanic real-fresh water flux) |
64 |
|
|
#undef ALLOW_ADDFLUID |
65 |
|
|
|
66 |
heimbach |
1.45 |
C o Choices for implicit solver routines solve_*diagonal.F |
67 |
|
|
C The following has low memory footprint, but not suitable for AD |
68 |
jmc |
1.47 |
#undef SOLVE_DIAGONAL_LOWMEMORY |
69 |
heimbach |
1.45 |
C The following one suitable for AD but does not vectorize |
70 |
|
|
#undef SOLVE_DIAGONAL_KINNER |
71 |
|
|
|
72 |
mlosch |
1.35 |
C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when |
73 |
|
|
C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi)) |
74 |
|
|
C *only for use on a lat-lon grid* |
75 |
|
|
C Setting this flag here affects both momentum and tracer equation unless |
76 |
|
|
C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h). |
77 |
|
|
C The definition of the flag is commented to avoid interference with |
78 |
|
|
C such other header files. |
79 |
mlosch |
1.36 |
C The preferred method is specifying a value for viscAhGrid or viscA4Grid |
80 |
|
|
C in data which is then automatically scaled by the grid size; |
81 |
|
|
C the old method of specifying viscAh/viscA4 and this flag is provided |
82 |
|
|
C for completeness only (and for use with the adjoint). |
83 |
mlosch |
1.35 |
C#define ISOTROPIC_COS_SCALING |
84 |
|
|
|
85 |
|
|
C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term. |
86 |
|
|
C *only for use on a lat-lon grid* |
87 |
|
|
C Has no effect if ISOTROPIC_COS_SCALING is undefined. |
88 |
|
|
C Has no effect on vector invariant momentum equations. |
89 |
|
|
C Setting this flag here affects both momentum and tracer equation unless |
90 |
|
|
C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h). |
91 |
|
|
C The definition of the flag is commented to avoid interference with |
92 |
|
|
C such other header files. |
93 |
|
|
C#define COSINEMETH_III |
94 |
|
|
|
95 |
adcroft |
1.7 |
C o Use "OLD" UV discretisation near boundaries (*not* recommended) |
96 |
|
|
C Note - only works with #undef NO_SLIP_LATERAL in calc_mom_rhs.F |
97 |
|
|
C because the old code did not have no-slip BCs |
98 |
|
|
#undef OLD_ADV_BCS |
99 |
dimitri |
1.22 |
|
100 |
dimitri |
1.37 |
C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F |
101 |
|
|
C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO |
102 |
|
|
C is still useful with, e.g., single-domain curvilinear configurations. |
103 |
|
|
#undef OLD_GRID_IO |
104 |
|
|
|
105 |
cnh |
1.6 |
C o Execution environment support options |
106 |
adcroft |
1.3 |
#include "CPP_EEOPTIONS.h" |
107 |
heimbach |
1.13 |
|
108 |
jmc |
1.49 |
C o Include/exclude single header file containing multiple packages options |
109 |
|
|
C (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where |
110 |
|
|
C each of the above pkg get its own options from its specific option file. |
111 |
|
|
C Although this method, inherited from ECCO setup, has been traditionally |
112 |
|
|
C used for all adjoint built, the alternative standard way is currently |
113 |
|
|
C going through rehabilitation. |
114 |
|
|
c#include "ECCO_CPPOPTIONS.h" |
115 |
edhill |
1.25 |
|
116 |
jmc |
1.43 |
C o Allow full 3D specification of vertical diffusivity |
117 |
|
|
#ifdef ALLOW_DIFFKR_CONTROL |
118 |
|
|
C - Need to be defined if using DIFFKR_CONTROL |
119 |
|
|
C (alternatively, could have put this in ECCO_CPPOPTIONS) |
120 |
|
|
#define ALLOW_3D_DIFFKR |
121 |
|
|
#else |
122 |
|
|
C - otherwise, can be turned on or off hereafter: |
123 |
|
|
#undef ALLOW_3D_DIFFKR |
124 |
|
|
#endif /* ALLOW_DIFFKR_CONTROL */ |
125 |
|
|
|
126 |
edhill |
1.25 |
#endif /* CPP_OPTIONS_H */ |
127 |
|
|
|