atm_gray/code/CPP_OPTIONS.h

4287557481 Jean*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
                0018 C-- Forcing code options:
                0019
7bb5a8a109 Jean*0020 C o Shortwave heating as extra term in APPLY_FORCING_T (apply_forcing.F)
4287557481 Jean*0021 #undef SHORTWAVE_HEATING
                0022
                0023 C o Include/exclude Geothermal Heat Flux at the bottom of the ocean
                0024 #undef ALLOW_GEOTHERMAL_FLUX
                0025
                0026 C o Allow to account for heating due to friction (and momentum dissipation)
                0027 #define ALLOW_FRICTION_HEATING
                0028
                0029 C o Allow mass source or sink of Fluid in the interior
                0030 C   (3-D generalisation of oceanic real-fresh water flux)
                0031 #undef ALLOW_ADDFLUID
                0032
                0033 C o Include pressure loading code
                0034 #define ATMOSPHERIC_LOADING
                0035
                0036 C o Include/exclude balancing surface forcing fluxes code
                0037 #undef ALLOW_BALANCE_FLUXES
                0038
                0039 C o Include/exclude balancing surface forcing relaxation code
                0040 #undef ALLOW_BALANCE_RELAX
                0041
                0042 C o Include/exclude checking for negative salinity
                0043 #undef CHECK_SALINITY_FOR_NEGATIVE_VALUES
                0044
                0045 C-- Options to discard parts of the main code:
                0046
                0047 C o Exclude/allow external forcing-fields load
                0048 C   this allows to read & do simple linear time interpolation of oceanic
                0049 C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
                0050 #undef EXCLUDE_FFIELDS_LOAD
                0051 C   If defined, use same method (with pkg/autodiff compiled or not) for checking
                0052 C   when to load new reccord ; by default, use simpler method with pkg/autodiff.
                0053 #undef STORE_LOADEDREC_TEST
                0054
                0055 C o Include/exclude phi_hyd calculation code
                0056 #define INCLUDE_PHIHYD_CALCULATION_CODE
                0057
                0058 C o Include/exclude sound speed calculation code
                0059 C o (Note that this is a diagnostic from Del Grasso algorithm, not derived
                0060 C    from EOS)
                0061 #undef INCLUDE_SOUNDSPEED_CALC_CODE
                0062
                0063 C-- Vertical mixing code options:
                0064
                0065 C o Include/exclude calling S/R CONVECTIVE_ADJUSTMENT
                0066 #define INCLUDE_CONVECT_CALL
                0067
                0068 C o Include/exclude calling S/R CONVECTIVE_ADJUSTMENT_INI, turned off by
                0069 C   default because it is an unpopular historical left-over
                0070 #undef INCLUDE_CONVECT_INI_CALL
                0071
                0072 C o Include/exclude call to S/R CALC_DIFFUSIVITY
                0073 #define INCLUDE_CALC_DIFFUSIVITY_CALL
                0074
                0075 C o Allow full 3D specification of vertical diffusivity
                0076 #undef ALLOW_3D_DIFFKR
                0077
                0078 C o Allow latitudinally varying BryanLewis79 vertical diffusivity
                0079 #undef ALLOW_BL79_LAT_VARY
                0080
                0081 C o Exclude/allow partial-cell effect (physical or enhanced) in vertical mixing
                0082 C   this allows to account for partial-cell in vertical viscosity and diffusion,
                0083 C   either from grid-spacing reduction effect or as artificially enhanced mixing
                0084 C   near surface & bottom for too thin grid-cell
                0085 #undef EXCLUDE_PCELL_MIX_CODE
                0086
                0087 C o Exclude/allow to use isotropic 3-D Smagorinsky viscosity as diffusivity
                0088 C   for tracers (after scaling by constant Prandtl number)
                0089 #undef ALLOW_SMAG_3D_DIFFUSIVITY
                0090
                0091 C-- Time-stepping code options:
                0092
                0093 C o Include/exclude combined Surf.Pressure and Drag Implicit solver code
                0094 #undef ALLOW_SOLVE4_PS_AND_DRAG
                0095
                0096 C o Include/exclude Implicit vertical advection code
                0097 #define INCLUDE_IMPLVERTADV_CODE
                0098
                0099 C o Include/exclude AdamsBashforth-3rd-Order code
                0100 #undef ALLOW_ADAMSBASHFORTH_3
                0101
                0102 C o Include/exclude Quasi-Hydrostatic Stagger Time-step AdamsBashforth code
                0103 #undef ALLOW_QHYD_STAGGER_TS
                0104
                0105 C-- Model formulation options:
                0106
                0107 C o Allow/exclude "Exact Convervation" of fluid in Free-Surface formulation
                0108 C   that ensures that d/dt(eta) is exactly equal to - Div.Transport
                0109 #define EXACT_CONSERV
                0110
                0111 C o Allow the use of Non-Linear Free-Surface formulation
                0112 C   this implies that grid-cell thickness (hFactors) varies with time
                0113 #define NONLIN_FRSURF
                0114 C o Disable code for rStar coordinate and/or code for Sigma coordinate
                0115 c#define DISABLE_RSTAR_CODE
                0116 c#define DISABLE_SIGMA_CODE
                0117
                0118 C o Include/exclude nonHydrostatic code
                0119 #undef ALLOW_NONHYDROSTATIC
                0120
                0121 C o Include/exclude GM-like eddy stress in momentum code
                0122 #undef ALLOW_EDDYPSI
                0123
                0124 C-- Algorithm options:
                0125
                0126 C o Include/exclude code for Non Self-Adjoint (NSA) conjugate-gradient solver
                0127 #undef ALLOW_CG2D_NSA
                0128
                0129 C o Include/exclude code for single reduction Conjugate-Gradient solver
                0130 #define ALLOW_SRCG
                0131
                0132 C o Choices for implicit solver routines solve_*diagonal.F
                0133 C   The following has low memory footprint, but not suitable for AD
                0134 #undef SOLVE_DIAGONAL_LOWMEMORY
                0135 C   The following one suitable for AD but does not vectorize
                0136 #undef SOLVE_DIAGONAL_KINNER
                0137
                0138 C   Implementation alternative (might be faster on some platforms ?)
                0139 #undef USE_MASK_AND_NO_IF
                0140
                0141 C-- Retired code options:
                0142
                0143 C-  These 2 flags: ISOTROPIC_COS_SCALING & COSINEMETH_III have no effect
                0144 C   here as they are reset in GAD_OPTIONS.h and in MOM_COMMON_OPTIONS.h
                0145 C   for tracer diffusivity and momentum viscosity respectively
                0146
                0147 C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
                0148 C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
                0149 C   is still useful with, e.g., single-domain curvilinear configurations.
                0150 #undef OLD_GRID_IO
                0151
                0152 C-- Other option files:
                0153
                0154 C o Execution environment support options
                0155 #include "CPP_EEOPTIONS.h"
                0156
7bb5a8a109 Jean*0157 C-  Place where multi-pkg header file ECCO_CPPOPTIONS.h used to be included
4287557481 Jean*0158
                0159 #endif /* CPP_OPTIONS_H */