tutorial_global_oce_optim/code_oad/CPP_OPTIONS.h

0e09621e3e Patr*0001 #ifndef CPP_OPTIONS_H
                0002 #define CPP_OPTIONS_H
                0003
                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
                0016 C CPP flags controlling particular source code features
                0017
8c2719e888 Jean*0018 C-- Forcing code options:
                0019
0e09621e3e Patr*0020 C o Shortwave heating as extra term in external_forcing.F
                0021 C Note: this should be a run-time option
                0022 #undef SHORTWAVE_HEATING
                0023
440bcb7748 Jean*0024 C o Include/exclude Geothermal Heat Flux at the bottom of the ocean
                0025 #undef ALLOW_GEOTHERMAL_FLUX
                0026
8c2719e888 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 #undef 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
                0052
0e09621e3e Patr*0053 C o Include/exclude phi_hyd calculation code
                0054 #define INCLUDE_PHIHYD_CALCULATION_CODE
                0055
2e7aec9951 dngo*0056 C o Include/exclude sound speed calculation code
                0057 C o (Note that this is a diagnostic from Del Grasso algorithm, not derived
                0058 C    from EOS)
                0059 #undef INCLUDE_SOUNDSPEED_CALC_CODE
                0060
8c2719e888 Jean*0061 C-- Vertical mixing code options:
                0062
2e7aec9951 dngo*0063 C o Include/exclude calling S/R CONVECTIVE_ADJUSTMENT
0e09621e3e Patr*0064 #define INCLUDE_CONVECT_CALL
                0065
2e7aec9951 dngo*0066 C o Include/exclude calling S/R CONVECTIVE_ADJUSTMENT_INI, turned off by
                0067 C   default because it is an unpopular historical left-over
                0068 #undef INCLUDE_CONVECT_INI_CALL
                0069
0e09621e3e Patr*0070 C o Include/exclude call to S/R CALC_DIFFUSIVITY
                0071 #define INCLUDE_CALC_DIFFUSIVITY_CALL
                0072
                0073 C o Allow full 3D specification of vertical diffusivity
                0074 #undef ALLOW_3D_DIFFKR
                0075
                0076 C o Allow latitudinally varying BryanLewis79 vertical diffusivity
                0077 #undef ALLOW_BL79_LAT_VARY
                0078
8c2719e888 Jean*0079 C o Exclude/allow partial-cell effect (physical or enhanced) in vertical mixing
                0080 C   this allows to account for partial-cell in vertical viscosity and diffusion,
                0081 C   either from grid-spacing reduction effect or as artificially enhanced mixing
                0082 C   near surface & bottom for too thin grid-cell
                0083 #define EXCLUDE_PCELL_MIX_CODE
                0084
2e7aec9951 dngo*0085 C o Exclude/allow to use isotropic 3-D Smagorinsky viscosity as diffusivity
                0086 C   for tracers (after scaling by constant Prandtl number)
                0087 #undef ALLOW_SMAG_3D_DIFFUSIVITY
                0088
8c2719e888 Jean*0089 C-- Time-stepping code options:
                0090
                0091 C o Include/exclude combined Surf.Pressure and Drag Implicit solver code
                0092 #undef ALLOW_SOLVE4_PS_AND_DRAG
                0093
0e09621e3e Patr*0094 C o Include/exclude Implicit vertical advection code
                0095 #undef INCLUDE_IMPLVERTADV_CODE
                0096
                0097 C o Include/exclude AdamsBashforth-3rd-Order code
                0098 #undef ALLOW_ADAMSBASHFORTH_3
                0099
2e7aec9951 dngo*0100 C o Include/exclude Quasi-Hydrostatic Stagger Time-step AdamsBashforth code
                0101 #undef ALLOW_QHYD_STAGGER_TS
                0102
8c2719e888 Jean*0103 C-- Model formulation options:
0e09621e3e Patr*0104
8c2719e888 Jean*0105 C o Allow/exclude "Exact Convervation" of fluid in Free-Surface formulation
                0106 C   that ensures that d/dt(eta) is exactly equal to - Div.Transport
                0107 #define EXACT_CONSERV
0e09621e3e Patr*0108
8c2719e888 Jean*0109 C o Allow the use of Non-Linear Free-Surface formulation
                0110 C   this implies that grid-cell thickness (hFactors) varies with time
                0111 #undef NONLIN_FRSURF
2e7aec9951 dngo*0112 C o Disable code for rStar coordinate and/or code for Sigma coordinate
                0113 c#define DISABLE_RSTAR_CODE
                0114 c#define DISABLE_SIGMA_CODE
0e09621e3e Patr*0115
8c2719e888 Jean*0116 C o Include/exclude nonHydrostatic code
                0117 #undef ALLOW_NONHYDROSTATIC
0e09621e3e Patr*0118
                0119 C o Include/exclude GM-like eddy stress in momentum code
                0120 #undef ALLOW_EDDYPSI
                0121
8c2719e888 Jean*0122 C-- Algorithm options:
440bcb7748 Jean*0123
2e7aec9951 dngo*0124 C o Include/exclude code for Non Self-Adjoint (NSA) conjugate-gradient solver
440bcb7748 Jean*0125 #undef ALLOW_CG2D_NSA
0e09621e3e Patr*0126
                0127 C o Include/exclude code for single reduction Conjugate-Gradient solver
                0128 #undef ALLOW_SRCG
                0129
                0130 C o Choices for implicit solver routines solve_*diagonal.F
                0131 C   The following has low memory footprint, but not suitable for AD
                0132 #undef SOLVE_DIAGONAL_LOWMEMORY
                0133 C   The following one suitable for AD but does not vectorize
                0134 #undef SOLVE_DIAGONAL_KINNER
                0135
8c2719e888 Jean*0136 C-- Retired code options:
0e09621e3e Patr*0137
2e7aec9951 dngo*0138 C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
                0139 C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
                0140 C *only for use on a lat-lon grid*
                0141 C   Setting this flag here affects both momentum and tracer equation unless
                0142 C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
                0143 C   The definition of the flag is commented to avoid interference with
                0144 C   such other header files.
                0145 C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
                0146 C   in data which is then automatically scaled by the grid size;
                0147 C   the old method of specifying viscAh/viscA4 and this flag is provided
                0148 C   for completeness only (and for use with the adjoint).
                0149 c#define ISOTROPIC_COS_SCALING
                0150
                0151 C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
                0152 C *only for use on a lat-lon grid*
                0153 C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
                0154 C   Has no effect on vector invariant momentum equations.
                0155 C   Setting this flag here affects both momentum and tracer equation unless
                0156 C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
                0157 C   The definition of the flag is commented to avoid interference with
                0158 C   such other header files.
                0159 c#define COSINEMETH_III
                0160
0e09621e3e Patr*0161 C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
                0162 C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
                0163 C   is still useful with, e.g., single-domain curvilinear configurations.
                0164 #undef OLD_GRID_IO
                0165
8c2719e888 Jean*0166 C-- Other option files:
                0167
0e09621e3e Patr*0168 C o Execution environment support options
                0169 #include "CPP_EEOPTIONS.h"
                0170
                0171 C o Include/exclude single header file containing multiple packages options
                0172 C   (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
                0173 C   each of the above pkg get its own options from its specific option file.
                0174 C   Although this method, inherited from ECCO setup, has been traditionally
                0175 C   used for all adjoint built, work is in progress to allow to use the
                0176 C   standard method also for adjoint built.
440bcb7748 Jean*0177 c#ifdef PACKAGES_CONFIG_H
                0178 c# include "ECCO_CPPOPTIONS.h"
                0179 c#endif
0e09621e3e Patr*0180
                0181 #endif /* CPP_OPTIONS_H */