pkg/kpp/KPP_OPTIONS.h

d6c8672c92 Jean*0001 C     *==========================================================*
                0002 C     | KPP_OPTIONS.h
                0003 C     | o CPP options file for KPP package.
                0004 C     *==========================================================*
                0005 C     | Use this file for selecting options within the KPP
                0006 C     | package.
                0007 C     *==========================================================*
2fa42a6013 Alis*0008
6d54cf9ca1 Ed H*0009 #ifndef KPP_OPTIONS_H
                0010 #define KPP_OPTIONS_H
                0011 #include "PACKAGES_CONFIG.h"
d6c8672c92 Jean*0012 #include "CPP_OPTIONS.h"
577a31280a Ed H*0013
6d54cf9ca1 Ed H*0014 #ifdef ALLOW_KPP
d6c8672c92 Jean*0015 C     Package-specific Options & Macros go here
2fa42a6013 Alis*0016
379a51a1bb Dimi*0017 C o When set, smooth shear horizontally with 121 filters
2fa42a6013 Alis*0018 #define KPP_SMOOTH_SHSQ
                0019 #undef KPP_SMOOTH_DVSQ
                0020
                0021 C o When set, smooth dbloc KPP variable horizontally
                0022 #define KPP_SMOOTH_DBLOC
                0023
                0024 C o When set, smooth all KPP density variables horizontally
                0025 #undef KPP_SMOOTH_DENS
                0026 #ifdef KPP_SMOOTH_DENS
                0027 #  define KPP_SMOOTH_DBLOC
                0028 #endif
                0029
                0030 C o When set, smooth vertical viscosity horizontally
                0031 #undef KPP_SMOOTH_VISC
                0032
                0033 C o When set, smooth vertical diffusivity horizontally
                0034 #undef KPP_SMOOTH_DIFF
                0035
956c0a5824 Patr*0036 C o Get rid of vertical resolution dependence of dVsq term by
                0037 C   estimating a surface velocity that is independent of first
                0038 C   level thickness in the model.
                0039 #undef KPP_ESTIMATE_UREF
2fa42a6013 Alis*0040
2b4c90c108 Mart*0041 C o The default matching of diffusivity as described in Large et al. (1994)
                0042 C can be turned off here, which sometimes helps to remove a noise problem
                0043 C at the bottom of the mixing layer when interior mixing is noisy. This
                0044 C is documented somehow in van Roekel et al. (2018), 10.1029/2018MS001336
                0045 C For better backward compatibility, the flags are defined as negative
                0046 #undef KPP_DO_NOT_MATCH_DIFFUSIVITIES
                0047 #ifndef KPP_DO_NOT_MATCH_DIFFUSIVITIES
                0048 C only makes sense if the diffusitivies are matched
                0049 # undef KPP_DO_NOT_MATCH_DERIVATIVES
                0050 #endif /*  KPP_DO_NOT_MATCH_DIFFUSIVITIES */
                0051
                0052 C o Include/exclude smooth regularization at the cost of changed results.
                0053 C   With this flag defined, some MAX(var,phepsi) are replaced by var+phepsi
                0054 #undef KPP_SMOOTH_REGULARISATION
                0055
                0056 C o reduce shear mxing by shsq**2/(shsq**2+1e-16) according to
                0057 C   Polzin (1996), JPO, 1409-1425), so that there will be no shear mixing
                0058 C   with very small shear
                0059 #undef KPP_SCALE_SHEARMIXING
                0060
1d478690dc Patr*0061 C o Include/exclude KPP non/local transport terms
                0062 #define KPP_GHAT
2fa42a6013 Alis*0063
3067745c9b Patr*0064 C o Exclude Interior shear instability mixing
                0065 #undef EXCLUDE_KPP_SHEAR_MIX
                0066
e750a5e49e Mart*0067 C o Exclude double diffusive mixing in the interior
                0068 #undef EXCLUDE_KPP_DOUBLEDIFF
                0069
3067745c9b Patr*0070 C o Avoid as many as possible AD recomputations
                0071 C   usually not necessary, but useful for testing
                0072 #undef KPP_AUTODIFF_EXCESSIVE_STORE
                0073
ae2c264443 Davi*0074 C o Vertically smooth Ri (for interior shear mixing)
                0075 #undef ALLOW_KPP_VERTICALLY_SMOOTH
                0076
2fa42a6013 Alis*0077 #endif /* ALLOW_KPP */
6d54cf9ca1 Ed H*0078 #endif /* KPP_OPTIONS_H */
3067745c9b Patr*0079
c9c3d7103f Ed H*0080 CEH3 ;;; Local Variables: ***
                0081 CEH3 ;;; mode:fortran ***
                0082 CEH3 ;;; End: ***