4 |
#ifndef CPP_OPTIONS_H |
#ifndef CPP_OPTIONS_H |
5 |
#define CPP_OPTIONS_H |
#define CPP_OPTIONS_H |
6 |
|
|
7 |
|
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 |
C CPP flags controlling particular source code features |
C CPP flags controlling particular source code features |
20 |
|
|
21 |
C o Shortwave heating as extra term in external_forcing.F |
C o Shortwave heating as extra term in external_forcing.F |
22 |
C Note: this should be a run-time option |
C Note: this should be a run-time option |
23 |
#define SHORTWAVE_HEATING |
#define SHORTWAVE_HEATING |
24 |
|
|
25 |
|
C o Include/exclude Geothermal Heat Flux at the bottom of the ocean |
26 |
|
#define ALLOW_GEOTHERMAL_FLUX |
27 |
|
|
28 |
C o Include/exclude phi_hyd calculation code |
C o Include/exclude phi_hyd calculation code |
29 |
#define INCLUDE_PHIHYD_CALCULATION_CODE |
#define INCLUDE_PHIHYD_CALCULATION_CODE |
30 |
|
|
34 |
C o Include/exclude call to S/R CALC_DIFFUSIVITY |
C o Include/exclude call to S/R CALC_DIFFUSIVITY |
35 |
#define INCLUDE_CALC_DIFFUSIVITY_CALL |
#define INCLUDE_CALC_DIFFUSIVITY_CALL |
36 |
|
|
37 |
|
C o Allow full 3D specification of vertical diffusivity |
38 |
|
#undef ALLOW_3D_DIFFKR |
39 |
|
|
40 |
C o Allow latitudinally varying BryanLewis79 vertical diffusivity |
C o Allow latitudinally varying BryanLewis79 vertical diffusivity |
41 |
#undef ALLOW_BL79_LAT_VARY |
#undef ALLOW_BL79_LAT_VARY |
42 |
|
|
49 |
C o Include/exclude nonHydrostatic code |
C o Include/exclude nonHydrostatic code |
50 |
#undef ALLOW_NONHYDROSTATIC |
#undef ALLOW_NONHYDROSTATIC |
51 |
|
|
52 |
|
C o Allow to account for heating due to friction (and momentum dissipation) |
53 |
|
#undef ALLOW_FRICTION_HEATING |
54 |
|
|
55 |
|
C o Allow mass source or sink of Fluid in the interior |
56 |
|
C (3-D generalisation of oceanic real-fresh water flux) |
57 |
|
#undef ALLOW_ADDFLUID |
58 |
|
|
59 |
C o Include pressure loading code |
C o Include pressure loading code |
60 |
#define ATMOSPHERIC_LOADING |
#define ATMOSPHERIC_LOADING |
61 |
|
|
64 |
C forcing fields, if no specific pkg (e.g., EXF) is used to compute them. |
C forcing fields, if no specific pkg (e.g., EXF) is used to compute them. |
65 |
#undef EXCLUDE_FFIELDS_LOAD |
#undef EXCLUDE_FFIELDS_LOAD |
66 |
|
|
67 |
|
C o Include/exclude balancing surface forcing fluxes code |
68 |
|
#undef ALLOW_BALANCE_FLUXES |
69 |
|
|
70 |
|
C o Include/exclude balancing surface forcing relaxation code |
71 |
|
#undef ALLOW_BALANCE_RELAX |
72 |
|
|
73 |
C o Include/exclude GM-like eddy stress in momentum code |
C o Include/exclude GM-like eddy stress in momentum code |
74 |
#undef ALLOW_EDDYPSI |
#undef ALLOW_EDDYPSI |
75 |
|
|
81 |
C this implies that surface thickness (hFactors) vary with time |
C this implies that surface thickness (hFactors) vary with time |
82 |
#undef NONLIN_FRSURF |
#undef NONLIN_FRSURF |
83 |
|
|
84 |
C o Allow mass source or sink of Fluid in the interior |
C o Include/exclude code for single reduction Conjugate-Gradient solver |
85 |
C (3-D generalisation of oceanic real-fresh water flux) |
#define ALLOW_SRCG |
86 |
#undef ALLOW_ADDFLUID |
|
87 |
|
C o Choices for implicit solver routines solve_*diagonal.F |
88 |
|
C The following has low memory footprint, but not suitable for AD |
89 |
|
#undef SOLVE_DIAGONAL_LOWMEMORY |
90 |
|
C The following one suitable for AD but does not vectorize |
91 |
|
#undef SOLVE_DIAGONAL_KINNER |
92 |
|
|
93 |
C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when |
C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when |
94 |
C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi)) |
C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi)) |
114 |
C#define COSINEMETH_III |
C#define COSINEMETH_III |
115 |
|
|
116 |
C o Use "OLD" UV discretisation near boundaries (*not* recommended) |
C o Use "OLD" UV discretisation near boundaries (*not* recommended) |
117 |
C Note - only works with #undef NO_SLIP_LATERAL in calc_mom_rhs.F |
C Note - only works with pkg/mom_fluxform and "no_slip_sides=.FALSE." |
118 |
C because the old code did not have no-slip BCs |
C because the old code did not have no-slip BCs |
119 |
#undef OLD_ADV_BCS |
#undef OLD_ADV_BCS |
120 |
|
|
121 |
C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F |
C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F |
122 |
C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO |
C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO |
123 |
C is still useful with, e.g., single-domain curvilinear configurations. |
C is still useful with, e.g., single-domain curvilinear configurations. |
124 |
#undef OLD_GRID_IO |
#undef OLD_GRID_IO |
125 |
|
|
126 |
|
C o Use old EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility) |
127 |
|
#undef USE_OLD_EXTERNAL_FORCING |
128 |
|
|
129 |
C o Execution environment support options |
C o Execution environment support options |
130 |
#include "CPP_EEOPTIONS.h" |
#include "CPP_EEOPTIONS.h" |
131 |
|
|
132 |
C o Include/exclude code specific to the ECCO/SEALION version. |
C o Include/exclude single header file containing multiple packages options |
133 |
C AUTODIFF or EXF package. |
C (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where |
134 |
C Currently controled by a single header file |
C each of the above pkg get its own options from its specific option file. |
135 |
C For this to work, PACKAGES_CONFIG.h needs to be included! |
C Although this method, inherited from ECCO setup, has been traditionally |
136 |
cph#if (defined (ALLOW_AUTODIFF) || \ |
C used for all adjoint built, work is in progress to allow to use the |
137 |
cph defined (ALLOW_ECCO) || \ |
C standard method also for adjoint built. |
138 |
cph defined (ALLOW_EXF)) |
c#ifdef PACKAGES_CONFIG_H |
139 |
cph# include "ECCO_CPPOPTIONS.h" |
c# include "ECCO_CPPOPTIONS.h" |
140 |
cph#endif |
c#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 */ |
|
141 |
|
|
142 |
#endif /* CPP_OPTIONS_H */ |
#endif /* CPP_OPTIONS_H */ |
|
|
|