1 |
jmc |
1.6 |
C $Header: /u/gcmpack/MITgcm/model/inc/CPP_OPTIONS.h,v 1.54 2016/11/28 22:55:00 jmc Exp $ |
2 |
jmc |
1.2 |
C $Name: $ |
3 |
|
|
|
4 |
heimbach |
1.1 |
#ifndef CPP_OPTIONS_H |
5 |
|
|
#define CPP_OPTIONS_H |
6 |
|
|
|
7 |
jmc |
1.5 |
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 |
heimbach |
1.1 |
|
19 |
jmc |
1.5 |
C CPP flags controlling particular source code features |
20 |
heimbach |
1.1 |
|
21 |
jmc |
1.6 |
C-- Forcing code options: |
22 |
|
|
|
23 |
heimbach |
1.1 |
C o Shortwave heating as extra term in external_forcing.F |
24 |
jmc |
1.5 |
C Note: this should be a run-time option |
25 |
|
|
#define SHORTWAVE_HEATING |
26 |
heimbach |
1.1 |
|
27 |
jmc |
1.6 |
C o Include/exclude Geothermal Heat Flux at the bottom of the ocean |
28 |
|
|
#undef ALLOW_GEOTHERMAL_FLUX |
29 |
|
|
|
30 |
|
|
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 |
heimbach |
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 |
heimbach |
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 |
jmc |
1.5 |
C o Allow full 3D specification of vertical diffusivity |
68 |
|
|
#undef ALLOW_3D_DIFFKR |
69 |
|
|
|
70 |
|
|
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 |
jmc |
1.5 |
C o Include/exclude Implicit vertical advection code |
85 |
|
|
#undef INCLUDE_IMPLVERTADV_CODE |
86 |
|
|
|
87 |
|
|
C o Include/exclude AdamsBashforth-3rd-Order code |
88 |
|
|
#undef ALLOW_ADAMSBASHFORTH_3 |
89 |
|
|
|
90 |
jmc |
1.6 |
C-- Model formulation options: |
91 |
jmc |
1.5 |
|
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 |
jmc |
1.5 |
|
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 |
|
|
#undef NONLIN_FRSURF |
99 |
|
|
#define DISABLE_RSTAR_CODE |
100 |
|
|
#define DISABLE_SIGMA_CODE |
101 |
heimbach |
1.1 |
|
102 |
jmc |
1.6 |
C o Include/exclude nonHydrostatic code |
103 |
|
|
#undef ALLOW_NONHYDROSTATIC |
104 |
jmc |
1.5 |
|
105 |
|
|
C o Include/exclude GM-like eddy stress in momentum code |
106 |
|
|
#undef ALLOW_EDDYPSI |
107 |
|
|
|
108 |
jmc |
1.6 |
C-- Algorithm options: |
109 |
jmc |
1.5 |
|
110 |
jmc |
1.6 |
C o Use Non Self-Adjoint (NSA) conjugate-gradient solver |
111 |
|
|
#define ALLOW_CG2D_NSA |
112 |
heimbach |
1.1 |
|
113 |
jmc |
1.5 |
C o Include/exclude code for single reduction Conjugate-Gradient solver |
114 |
|
|
#undef ALLOW_SRCG |
115 |
heimbach |
1.1 |
|
116 |
jmc |
1.5 |
C o Choices for implicit solver routines solve_*diagonal.F |
117 |
|
|
C The following has low memory footprint, but not suitable for AD |
118 |
|
|
#undef SOLVE_DIAGONAL_LOWMEMORY |
119 |
|
|
C The following one suitable for AD but does not vectorize |
120 |
|
|
#undef SOLVE_DIAGONAL_KINNER |
121 |
|
|
|
122 |
jmc |
1.6 |
C-- Retired code options: |
123 |
jmc |
1.5 |
|
124 |
|
|
C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F |
125 |
|
|
C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO |
126 |
|
|
C is still useful with, e.g., single-domain curvilinear configurations. |
127 |
|
|
#undef OLD_GRID_IO |
128 |
heimbach |
1.1 |
|
129 |
jmc |
1.6 |
C-- Other option files: |
130 |
|
|
|
131 |
heimbach |
1.1 |
C o Execution environment support options |
132 |
|
|
#include "CPP_EEOPTIONS.h" |
133 |
|
|
|
134 |
jmc |
1.5 |
C o Include/exclude single header file containing multiple packages options |
135 |
|
|
C (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where |
136 |
|
|
C each of the above pkg get its own options from its specific option file. |
137 |
|
|
C Although this method, inherited from ECCO setup, has been traditionally |
138 |
|
|
C used for all adjoint built, work is in progress to allow to use the |
139 |
|
|
C standard method also for adjoint built. |
140 |
|
|
#ifdef PACKAGES_CONFIG_H |
141 |
heimbach |
1.1 |
# include "ECCO_CPPOPTIONS.h" |
142 |
|
|
#endif |
143 |
|
|
|
144 |
|
|
#endif /* CPP_OPTIONS_H */ |