hs94.cs-32x32x5/code/CPP_OPTIONS.h

3e956a7d90 Jean*0001 #ifndef CPP_OPTIONS_H
                0002 #define CPP_OPTIONS_H
                0003
c3490b9dab 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
3e956a7d90 Jean*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 #undef SHORTWAVE_HEATING
                0021
1feb54070b Jean*0022 C o Include/exclude Geothermal Heat Flux at the bottom of the ocean
                0023 #undef ALLOW_GEOTHERMAL_FLUX
                0024
3e956a7d90 Jean*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
c3490b9dab Jean*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
3e956a7d90 Jean*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 #define ALLOW_NONHYDROSTATIC
                0048
c3490b9dab Jean*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
3e956a7d90 Jean*0056 C o Include pressure loading code
                0057 #define ATMOSPHERIC_LOADING
                0058
c3490b9dab Jean*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
3e956a7d90 Jean*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 #define 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 #define NONLIN_FRSURF
                0080
c3490b9dab Jean*0081 C o Include/exclude code for single reduction Conjugate-Gradient solver
                0082 #define ALLOW_SRCG
                0083
                0084 C o Choices for implicit solver routines solve_*diagonal.F
                0085 C   The following has low memory footprint, but not suitable for AD
                0086 #undef SOLVE_DIAGONAL_LOWMEMORY
                0087 C   The following one suitable for AD but does not vectorize
                0088 #undef SOLVE_DIAGONAL_KINNER
                0089
                0090 C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
                0091 C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
                0092 C *only for use on a lat-lon grid*
                0093 C   Setting this flag here affects both momentum and tracer equation unless
                0094 C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
                0095 C   The definition of the flag is commented to avoid interference with
                0096 C   such other header files.
                0097 C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
                0098 C   in data which is then automatically scaled by the grid size;
                0099 C   the old method of specifying viscAh/viscA4 and this flag is provided
                0100 C   for completeness only (and for use with the adjoint).
                0101 C#define ISOTROPIC_COS_SCALING
                0102
                0103 C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
                0104 C *only for use on a lat-lon grid*
                0105 C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
                0106 C   Has no effect on vector invariant momentum equations.
                0107 C   Setting this flag here affects both momentum and tracer equation unless
                0108 C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
                0109 C   The definition of the flag is commented to avoid interference with
                0110 C   such other header files.
                0111 C#define COSINEMETH_III
                0112
3e956a7d90 Jean*0113 C o Use "OLD" UV discretisation near boundaries (*not* recommended)
c3490b9dab Jean*0114 C   Note - only works with pkg/mom_fluxform and "no_slip_sides=.FALSE."
3e956a7d90 Jean*0115 C          because the old code did not have no-slip BCs
c3490b9dab Jean*0116 #undef OLD_ADV_BCS
                0117
                0118 C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
                0119 C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
                0120 C   is still useful with, e.g., single-domain curvilinear configurations.
                0121 #undef OLD_GRID_IO
                0122
                0123 C o Use old EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility)
1feb54070b Jean*0124 #undef USE_OLD_EXTERNAL_FORCING
3e956a7d90 Jean*0125
                0126 C o Execution environment support options
                0127 #include "CPP_EEOPTIONS.h"
                0128
c3490b9dab Jean*0129 C o Include/exclude single header file containing multiple packages options
                0130 C   (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
                0131 C   each of the above pkg get its own options from its specific option file.
                0132 C   Although this method, inherited from ECCO setup, has been traditionally
                0133 C   used for all adjoint built, work is in progress to allow to use the
                0134 C   standard method also for adjoint built.
                0135 c#ifdef PACKAGES_CONFIG_H
                0136 c# include "ECCO_CPPOPTIONS.h"
                0137 c#endif
3e956a7d90 Jean*0138
                0139 #endif /* CPP_OPTIONS_H */