global_oce_biogeo_bling/code_tap/CPP_OPTIONS.h

b4daa24319 Shre*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 o Shortwave heating as extra term in external_forcing.F
                0019 C Note: this should be a run-time option
                0020 #define SHORTWAVE_HEATING
                0021
                0022 C o Include/exclude Geothermal Heat Flux at the bottom of the ocean
                0023 #undef ALLOW_GEOTHERMAL_FLUX
                0024
                0025 C o Include/exclude phi_hyd calculation code
                0026 #define INCLUDE_PHIHYD_CALCULATION_CODE
                0027
                0028 C o Include/exclude call to S/R CONVECT
                0029 #define INCLUDE_CONVECT_CALL
                0030
                0031 C o Include/exclude call to S/R CALC_DIFFUSIVITY
                0032 #define INCLUDE_CALC_DIFFUSIVITY_CALL
                0033
                0034 C o Allow full 3D specification of vertical diffusivity
                0035 #undef ALLOW_3D_DIFFKR
                0036
                0037 C o Allow latitudinally varying BryanLewis79 vertical diffusivity
                0038 #undef ALLOW_BL79_LAT_VARY
                0039
                0040 C o Include/exclude Implicit vertical advection code
                0041 #define INCLUDE_IMPLVERTADV_CODE
                0042
                0043 C o Include/exclude AdamsBashforth-3rd-Order code
                0044 #define ALLOW_ADAMSBASHFORTH_3
                0045
                0046 C o Include/exclude nonHydrostatic code
                0047 #undef ALLOW_NONHYDROSTATIC
                0048
                0049 C o Allow to account for heating due to friction (and momentum dissipation)
                0050 #undef ALLOW_FRICTION_HEATING
                0051
                0052 C o Allow mass source or sink of Fluid in the interior
                0053 C   (3-D generalisation of oceanic real-fresh water flux)
                0054 #undef ALLOW_ADDFLUID
                0055
                0056 C o Include pressure loading code
                0057 #define ATMOSPHERIC_LOADING
                0058
                0059 C o exclude/allow external forcing-fields load
                0060 C   this allows to read & do simple linear time interpolation of oceanic
                0061 C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
                0062 #undef EXCLUDE_FFIELDS_LOAD
                0063
                0064 C o Include/exclude balancing surface forcing fluxes code
                0065 #undef ALLOW_BALANCE_FLUXES
                0066
                0067 C o Include/exclude balancing surface forcing relaxation code
                0068 #undef ALLOW_BALANCE_RELAX
                0069
                0070 C o Include/exclude GM-like eddy stress in momentum code
                0071 #undef ALLOW_EDDYPSI
                0072
                0073 C o Use "Exact Convervation" of fluid in Free-Surface formulation
                0074 C   so that d/dt(eta) is exactly equal to - Div.Transport
                0075 #undef EXACT_CONSERV
                0076
                0077 C o Allow the use of Non-Linear Free-Surface formulation
                0078 C   this implies that surface thickness (hFactors) vary with time
                0079 #undef NONLIN_FRSURF
                0080 #undef DISABLE_RSTAR_CODE
                0081 #define DISABLE_SIGMA_CODE
                0082
                0083 C o Include/exclude code for single reduction Conjugate-Gradient solver
                0084 #undef ALLOW_SRCG
                0085
                0086 C o Choices for implicit solver routines solve_*diagonal.F
                0087 C   The following has low memory footprint, but not suitable for AD
                0088 #undef SOLVE_DIAGONAL_LOWMEMORY
                0089 C   The following one suitable for AD but does not vectorize
                0090 #define SOLVE_DIAGONAL_KINNER
                0091
                0092 C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
                0093 C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
                0094 C *only for use on a lat-lon grid*
                0095 C   Setting this flag here affects both momentum and tracer equation unless
                0096 C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
                0097 C   The definition of the flag is commented to avoid interference with
                0098 C   such other header files.
                0099 C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
                0100 C   in data which is then automatically scaled by the grid size;
                0101 C   the old method of specifying viscAh/viscA4 and this flag is provided
                0102 C   for completeness only (and for use with the adjoint).
                0103 C#define ISOTROPIC_COS_SCALING
                0104
                0105 C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
                0106 C *only for use on a lat-lon grid*
                0107 C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
                0108 C   Has no effect on vector invariant momentum equations.
                0109 C   Setting this flag here affects both momentum and tracer equation unless
                0110 C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
                0111 C   The definition of the flag is commented to avoid interference with
                0112 C   such other header files.
                0113 C#define COSINEMETH_III
                0114
                0115 C o Use "OLD" UV discretisation near boundaries (*not* recommended)
                0116 C   Note - only works with pkg/mom_fluxform and "no_slip_sides=.FALSE."
                0117 C          because the old code did not have no-slip BCs
                0118 #undef OLD_ADV_BCS
                0119
                0120 C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
                0121 C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
                0122 C   is still useful with, e.g., single-domain curvilinear configurations.
                0123 #undef OLD_GRID_IO
                0124
                0125 C o Use old EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility)
                0126 #undef USE_OLD_EXTERNAL_FORCING
                0127
                0128 #define EXCLUDE_PCELL_MIX_CODE
                0129
                0130 C o Execution environment support options
                0131 #include "CPP_EEOPTIONS.h"
                0132
                0133 #endif /* CPP_OPTIONS_H */
                0134