tutorial_tracer_adjsens/code_oad/CPP_OPTIONS.h

76cd8733fa Oliv*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
76cd8733fa Oliv*0020 C o Shortwave heating as extra term in external_forcing.F
                0021 C Note: this should be a run-time option
                0022 #define SHORTWAVE_HEATING
                0023
4da0ef3b9a 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 #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
                0052
76cd8733fa Oliv*0053 C o Include/exclude phi_hyd calculation code
                0054 #define INCLUDE_PHIHYD_CALCULATION_CODE
                0055
51575f66de Mart*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
51575f66de Mart*0063 C o Include/exclude calling S/R CONVECTIVE_ADJUSTMENT
76cd8733fa Oliv*0064 #define INCLUDE_CONVECT_CALL
                0065
51575f66de Mart*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, here we
                0068 C   turn it on to reproduce old results
                0069 #define INCLUDE_CONVECT_INI_CALL
                0070
76cd8733fa Oliv*0071 C o Include/exclude call to S/R CALC_DIFFUSIVITY
                0072 #define INCLUDE_CALC_DIFFUSIVITY_CALL
                0073
                0074 C o Allow full 3D specification of vertical diffusivity
                0075 #define ALLOW_3D_DIFFKR
                0076
                0077 C o Allow latitudinally varying BryanLewis79 vertical diffusivity
                0078 #undef ALLOW_BL79_LAT_VARY
                0079
8c2719e888 Jean*0080 C o Exclude/allow partial-cell effect (physical or enhanced) in vertical mixing
                0081 C   this allows to account for partial-cell in vertical viscosity and diffusion,
                0082 C   either from grid-spacing reduction effect or as artificially enhanced mixing
                0083 C   near surface & bottom for too thin grid-cell
                0084 #define EXCLUDE_PCELL_MIX_CODE
                0085
51575f66de Mart*0086 C o Exclude/allow to use isotropic 3-D Smagorinsky viscosity as diffusivity
                0087 C   for tracers (after scaling by constant Prandtl number)
                0088 #undef ALLOW_SMAG_3D_DIFFUSIVITY
                0089
8c2719e888 Jean*0090 C-- Time-stepping code options:
                0091
                0092 C o Include/exclude combined Surf.Pressure and Drag Implicit solver code
                0093 #undef ALLOW_SOLVE4_PS_AND_DRAG
                0094
76cd8733fa Oliv*0095 C o Include/exclude Implicit vertical advection code
                0096 #undef INCLUDE_IMPLVERTADV_CODE
                0097
                0098 C o Include/exclude AdamsBashforth-3rd-Order code
                0099 #undef ALLOW_ADAMSBASHFORTH_3
                0100
51575f66de Mart*0101 C o Include/exclude Quasi-Hydrostatic Stagger Time-step AdamsBashforth code
                0102 #undef ALLOW_QHYD_STAGGER_TS
                0103
8c2719e888 Jean*0104 C-- Model formulation options:
76cd8733fa Oliv*0105
8c2719e888 Jean*0106 C o Allow/exclude "Exact Convervation" of fluid in Free-Surface formulation
                0107 C   that ensures that d/dt(eta) is exactly equal to - Div.Transport
76cd8733fa Oliv*0108 #define EXACT_CONSERV
                0109
                0110 C o Allow the use of Non-Linear Free-Surface formulation
8c2719e888 Jean*0111 C   this implies that grid-cell thickness (hFactors) varies with time
76cd8733fa Oliv*0112 #define NONLIN_FRSURF
51575f66de Mart*0113 C o Disable code for rStar coordinate and/or code for Sigma coordinate
6a5f34ee03 Jean*0114 #undef  DISABLE_RSTAR_CODE
76cd8733fa Oliv*0115 #define DISABLE_SIGMA_CODE
                0116
8c2719e888 Jean*0117 C o Include/exclude nonHydrostatic code
                0118 #undef ALLOW_NONHYDROSTATIC
                0119
                0120 C o Include/exclude GM-like eddy stress in momentum code
                0121 #undef ALLOW_EDDYPSI
                0122
                0123 C-- Algorithm options:
                0124
51575f66de Mart*0125 C o Include/exclude code for Non Self-Adjoint (NSA) conjugate-gradient solver
76cd8733fa Oliv*0126 #undef ALLOW_CG2D_NSA
                0127
                0128 C o Include/exclude code for single reduction Conjugate-Gradient solver
                0129 #undef ALLOW_SRCG
                0130
                0131 C o Choices for implicit solver routines solve_*diagonal.F
                0132 C   The following has low memory footprint, but not suitable for AD
                0133 #undef SOLVE_DIAGONAL_LOWMEMORY
                0134 C   The following one suitable for AD but does not vectorize
                0135 #undef SOLVE_DIAGONAL_KINNER
                0136
8c2719e888 Jean*0137 C-- Retired code options:
76cd8733fa Oliv*0138
                0139 C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
                0140 C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
                0141 C   is still useful with, e.g., single-domain curvilinear configurations.
                0142 #undef OLD_GRID_IO
                0143
8c2719e888 Jean*0144 C-- Other option files:
                0145
76cd8733fa Oliv*0146 C o Execution environment support options
                0147 #include "CPP_EEOPTIONS.h"
                0148
6a5f34ee03 Jean*0149 C o Include/exclude single header file containing multiple packages options
                0150 C   (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
                0151 C   each of the above pkg get its own options from its specific option file.
                0152 C   Although this method, inherited from ECCO setup, has been traditionally
                0153 C   used for all adjoint built, work is in progress to allow to use the
                0154 C   standard method also for adjoint built.
4da0ef3b9a Jean*0155 c#ifdef PACKAGES_CONFIG_H
                0156 c# include "ECCO_CPPOPTIONS.h"
                0157 c#endif
76cd8733fa Oliv*0158
                0159 #endif /* CPP_OPTIONS_H */