model/inc/CPP_OPTIONS.h

417e03a214 Ed H*0001 #ifndef CPP_OPTIONS_H
                0002 #define CPP_OPTIONS_H
                0003
b30dcaee27 Jean*0004 CBOP
                0005 C !ROUTINE: CPP_OPTIONS.h
                0006 C !INTERFACE:
                0007 C #include "CPP_OPTIONS.h"
                0008
                0009 C !DESCRIPTION:
                0010 C *==================================================================*
                0011 C | main CPP options file for the model:
                0012 C | Control which optional features to compile in model/src code.
                0013 C *==================================================================*
                0014 CEOP
                0015
6d54cf9ca1 Ed H*0016 C CPP flags controlling particular source code features
ba5f5f4485 Jean*0017
d4bae8cf47 Jean*0018 C-- Forcing code options:
                0019
6d54cf9ca1 Ed H*0020 C o Shortwave heating as extra term in external_forcing.F
ac0407fdce Jean*0021 C Note: this should be a run-time option
                0022 #undef SHORTWAVE_HEATING
1dbaea09ee Chri*0023
238dcc4694 Jean*0024 C o Include/exclude Geothermal Heat Flux at the bottom of the ocean
                0025 #undef ALLOW_GEOTHERMAL_FLUX
                0026
d4bae8cf47 Jean*0027 C o Allow to account for heating due to friction (and momentum dissipation)
                0028 #undef ALLOW_FRICTION_HEATING
                0029
                0030 C o Allow mass source or sink of Fluid in the interior
                0031 C   (3-D generalisation of oceanic real-fresh water flux)
                0032 #undef ALLOW_ADDFLUID
                0033
                0034 C o Include pressure loading code
                0035 #define ATMOSPHERIC_LOADING
                0036
                0037 C o Include/exclude balancing surface forcing fluxes code
                0038 #undef ALLOW_BALANCE_FLUXES
                0039
                0040 C o Include/exclude balancing surface forcing relaxation code
                0041 #undef ALLOW_BALANCE_RELAX
                0042
                0043 C o Include/exclude checking for negative salinity
                0044 #undef CHECK_SALINITY_FOR_NEGATIVE_VALUES
                0045
                0046 C-- Options to discard parts of the main code:
                0047
                0048 C o Exclude/allow external forcing-fields load
                0049 C   this allows to read & do simple linear time interpolation of oceanic
                0050 C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
                0051 #undef EXCLUDE_FFIELDS_LOAD
3156f625d5 Jean*0052 C   If defined, use same method (with pkg/autodiff compiled or not) for checking
                0053 C   when to load new reccord ; by default, use simpler method with pkg/autodiff.
                0054 #undef STORE_LOADEDREC_TEST
d4bae8cf47 Jean*0055
1dbaea09ee Chri*0056 C o Include/exclude phi_hyd calculation code
                0057 #define INCLUDE_PHIHYD_CALCULATION_CODE
                0058
fb2c52cfd4 aver*0059 C o Include/exclude sound speed calculation code
51575f66de Mart*0060 C o (Note that this is a diagnostic from Del Grasso algorithm, not derived
                0061 C    from EOS)
fb2c52cfd4 aver*0062 #undef INCLUDE_SOUNDSPEED_CALC_CODE
                0063
d4bae8cf47 Jean*0064 C-- Vertical mixing code options:
                0065
51575f66de Mart*0066 C o Include/exclude calling S/R CONVECTIVE_ADJUSTMENT
1dbaea09ee Chri*0067 #define INCLUDE_CONVECT_CALL
                0068
51575f66de Mart*0069 C o Include/exclude calling S/R CONVECTIVE_ADJUSTMENT_INI, turned off by
                0070 C   default because it is an unpopular historical left-over
                0071 #undef INCLUDE_CONVECT_INI_CALL
                0072
1dbaea09ee Chri*0073 C o Include/exclude call to S/R CALC_DIFFUSIVITY
                0074 #define INCLUDE_CALC_DIFFUSIVITY_CALL
ea212a0263 Alis*0075
b30dcaee27 Jean*0076 C o Allow full 3D specification of vertical diffusivity
                0077 #undef ALLOW_3D_DIFFKR
                0078
e40c34e398 Dimi*0079 C o Allow latitudinally varying BryanLewis79 vertical diffusivity
                0080 #undef ALLOW_BL79_LAT_VARY
                0081
d4bae8cf47 Jean*0082 C o Exclude/allow partial-cell effect (physical or enhanced) in vertical mixing
                0083 C   this allows to account for partial-cell in vertical viscosity and diffusion,
                0084 C   either from grid-spacing reduction effect or as artificially enhanced mixing
                0085 C   near surface & bottom for too thin grid-cell
                0086 #undef EXCLUDE_PCELL_MIX_CODE
                0087
2d5bb917cc Jean*0088 C o Exclude/allow to use isotropic 3-D Smagorinsky viscosity as diffusivity
                0089 C   for tracers (after scaling by constant Prandtl number)
                0090 #undef ALLOW_SMAG_3D_DIFFUSIVITY
                0091
d4bae8cf47 Jean*0092 C-- Time-stepping code options:
c0be2284a6 Jean*0093
795d169011 Jean*0094 C o Include/exclude combined Surf.Pressure and Drag Implicit solver code
                0095 #undef ALLOW_SOLVE4_PS_AND_DRAG
                0096
d4bae8cf47 Jean*0097 C o Include/exclude Implicit vertical advection code
                0098 #define INCLUDE_IMPLVERTADV_CODE
                0099
87d21912d2 Jean*0100 C o Include/exclude AdamsBashforth-3rd-Order code
                0101 #undef ALLOW_ADAMSBASHFORTH_3
                0102
fdf5fb6af0 Jean*0103 C o Include/exclude Quasi-Hydrostatic Stagger Time-step AdamsBashforth code
                0104 #undef ALLOW_QHYD_STAGGER_TS
                0105
d4bae8cf47 Jean*0106 C-- Model formulation options:
22dbc402ed Jean*0107
d4bae8cf47 Jean*0108 C o Allow/exclude "Exact Convervation" of fluid in Free-Surface formulation
                0109 C   that ensures that d/dt(eta) is exactly equal to - Div.Transport
                0110 #define EXACT_CONSERV
3b540d7094 Jean*0111
d4bae8cf47 Jean*0112 C o Allow the use of Non-Linear Free-Surface formulation
                0113 C   this implies that grid-cell thickness (hFactors) varies with time
                0114 #undef NONLIN_FRSURF
aecc8b0f47 Mart*0115 C o Disable code for rStar coordinate and/or code for Sigma coordinate
                0116 c#define DISABLE_RSTAR_CODE
                0117 c#define DISABLE_SIGMA_CODE
7ef88d9da2 Jean*0118
d4bae8cf47 Jean*0119 C o Include/exclude nonHydrostatic code
                0120 #undef ALLOW_NONHYDROSTATIC
7ef88d9da2 Jean*0121
2b64c85b46 Jean*0122 C o Include/exclude GM-like eddy stress in momentum code
                0123 #undef ALLOW_EDDYPSI
                0124
d4bae8cf47 Jean*0125 C-- Algorithm options:
aea29c8517 Alis*0126
aecc8b0f47 Mart*0127 C o Include/exclude code for Non Self-Adjoint (NSA) conjugate-gradient solver
d4bae8cf47 Jean*0128 #undef ALLOW_CG2D_NSA
aea29c8517 Alis*0129
b30dcaee27 Jean*0130 C o Include/exclude code for single reduction Conjugate-Gradient solver
                0131 #define ALLOW_SRCG
2b64c85b46 Jean*0132
efd9855229 Patr*0133 C o Choices for implicit solver routines solve_*diagonal.F
                0134 C   The following has low memory footprint, but not suitable for AD
f097220636 Jean*0135 #undef SOLVE_DIAGONAL_LOWMEMORY
efd9855229 Patr*0136 C   The following one suitable for AD but does not vectorize
                0137 #undef SOLVE_DIAGONAL_KINNER
                0138
f40bb882f5 Jean*0139 C   Implementation alternative (might be faster on some platforms ?)
                0140 #undef USE_MASK_AND_NO_IF
                0141
d4bae8cf47 Jean*0142 C-- Retired code options:
                0143
73545f9d8b Mart*0144 C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
                0145 C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
                0146 C *only for use on a lat-lon grid*
                0147 C   Setting this flag here affects both momentum and tracer equation unless
                0148 C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
                0149 C   The definition of the flag is commented to avoid interference with
                0150 C   such other header files.
121d850750 Mart*0151 C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
                0152 C   in data which is then automatically scaled by the grid size;
                0153 C   the old method of specifying viscAh/viscA4 and this flag is provided
                0154 C   for completeness only (and for use with the adjoint).
aecc8b0f47 Mart*0155 c#define ISOTROPIC_COS_SCALING
73545f9d8b Mart*0156
                0157 C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
                0158 C *only for use on a lat-lon grid*
                0159 C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
                0160 C   Has no effect on vector invariant momentum equations.
                0161 C   Setting this flag here affects both momentum and tracer equation unless
                0162 C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
                0163 C   The definition of the flag is commented to avoid interference with
                0164 C   such other header files.
aecc8b0f47 Mart*0165 c#define COSINEMETH_III
73545f9d8b Mart*0166
c1701ff971 Alis*0167 C o Use "OLD" UV discretisation near boundaries (*not* recommended)
734746fac8 Jean*0168 C   Note - only works with pkg/mom_fluxform and "no_slip_sides=.FALSE."
c1701ff971 Alis*0169 C          because the old code did not have no-slip BCs
734746fac8 Jean*0170 #undef OLD_ADV_BCS
c1701ff971 Alis*0171
ea0385b2b8 Dimi*0172 C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
                0173 C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
                0174 C   is still useful with, e.g., single-domain curvilinear configurations.
                0175 #undef OLD_GRID_IO
                0176
734746fac8 Jean*0177 C o Use old EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility)
                0178 #undef USE_OLD_EXTERNAL_FORCING
                0179
d4bae8cf47 Jean*0180 C-- Other option files:
                0181
1dbaea09ee Chri*0182 C o Execution environment support options
73470161ee Alis*0183 #include "CPP_EEOPTIONS.h"
e508fdf6c2 Patr*0184
7ef88d9da2 Jean*0185 C o Include/exclude single header file containing multiple packages options
                0186 C   (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
                0187 C   each of the above pkg get its own options from its specific option file.
                0188 C   Although this method, inherited from ECCO setup, has been traditionally
b30dcaee27 Jean*0189 C   used for all adjoint built, work is in progress to allow to use the
                0190 C   standard method also for adjoint built.
                0191 c#ifdef PACKAGES_CONFIG_H
                0192 c# include "ECCO_CPPOPTIONS.h"
                0193 c#endif
2b64c85b46 Jean*0194
417e03a214 Ed H*0195 #endif /* CPP_OPTIONS_H */