pkg/kpp/KPP_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/pkg/kpp/KPP_OPTIONS.h,v 1.16 2008/09/29 18:35:53 dfer Exp $
C $Name:  $

C     /==========================================================\
C     | KPP_OPTIONS.h                                            |
C     | o CPP options file for KPP package.                      |
C     |==========================================================|
C     | Use this file for selecting options within the KPP       |
C     | package.  KPP is enabled with ALLOW_KPP in CPP_OPTIONS.h |
C     \==========================================================/

#ifndef KPP_OPTIONS_H
#define KPP_OPTIONS_H
#include "PACKAGES_CONFIG.h"

#ifdef ALLOW_KPP

#include "CPP_OPTIONS.h"

C o When set, smooth shear horizontally with 121 filters
#define KPP_SMOOTH_SHSQ
#undef KPP_SMOOTH_DVSQ

C o When set, smooth dbloc KPP variable horizontally
#define KPP_SMOOTH_DBLOC

C o When set, smooth all KPP density variables horizontally
#undef KPP_SMOOTH_DENS
#ifdef KPP_SMOOTH_DENS
#  define KPP_SMOOTH_DBLOC
#endif

C o When set, smooth vertical viscosity horizontally
#undef KPP_SMOOTH_VISC

C o When set, smooth vertical diffusivity horizontally
#undef KPP_SMOOTH_DIFF

C o Get rid of vertical resolution dependence of dVsq term by
C   estimating a surface velocity that is independent of first
C   level thickness in the model.
#undef KPP_ESTIMATE_UREF

C o Include/exclude KPP non/local transport terms
#define KPP_GHAT

C o Exclude Interior shear instability mixing
#undef EXCLUDE_KPP_SHEAR_MIX

C o Exclude double diffusive mixing in the interior
#undef EXCLUDE_KPP_DOUBLEDIFF

C o Avoid as many as possible AD recomputations
C   usually not necessary, but useful for testing
#undef KPP_AUTODIFF_EXCESSIVE_STORE

C o Vertically smooth Ri (for interior shear mixing)
#undef ALLOW_KPP_VERTICALLY_SMOOTH

#endif /* ALLOW_KPP */
#endif /* KPP_OPTIONS_H */


CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	C $Header: /u/gcmpack/MITgcm/pkg/kpp/KPP_OPTIONS.h,v 1.16 2008/09/29 18:35:53 dfer Exp $
2	C $Name: $
3
4	C /==========================================================\
5	C \| KPP_OPTIONS.h \|
6	C \| o CPP options file for KPP package. \|
7	C \|==========================================================\|
8	C \| Use this file for selecting options within the KPP \|
9	C \| package. KPP is enabled with ALLOW_KPP in CPP_OPTIONS.h \|
10	C \==========================================================/
11
12	#ifndef KPP_OPTIONS_H
13	#define KPP_OPTIONS_H
14	#include "PACKAGES_CONFIG.h"
15
16	#ifdef ALLOW_KPP
17
18	#include "CPP_OPTIONS.h"
19
20	C o When set, smooth shear horizontally with 121 filters
21	#define KPP_SMOOTH_SHSQ
22	#undef KPP_SMOOTH_DVSQ
23
24	C o When set, smooth dbloc KPP variable horizontally
25	#define KPP_SMOOTH_DBLOC
26
27	C o When set, smooth all KPP density variables horizontally
28	#undef KPP_SMOOTH_DENS
29	#ifdef KPP_SMOOTH_DENS
30	# define KPP_SMOOTH_DBLOC
31	#endif
32
33	C o When set, smooth vertical viscosity horizontally
34	#undef KPP_SMOOTH_VISC
35
36	C o When set, smooth vertical diffusivity horizontally
37	#undef KPP_SMOOTH_DIFF
38
39	C o Get rid of vertical resolution dependence of dVsq term by
40	C estimating a surface velocity that is independent of first
41	C level thickness in the model.
42	#undef KPP_ESTIMATE_UREF
43
44	C o Include/exclude KPP non/local transport terms
45	#define KPP_GHAT
46
47	C o Exclude Interior shear instability mixing
48	#undef EXCLUDE_KPP_SHEAR_MIX
49
50	C o Exclude double diffusive mixing in the interior
51	#undef EXCLUDE_KPP_DOUBLEDIFF
52
53	C o Avoid as many as possible AD recomputations
54	C usually not necessary, but useful for testing
55	#undef KPP_AUTODIFF_EXCESSIVE_STORE
56
57	C o Vertically smooth Ri (for interior shear mixing)
58	#undef ALLOW_KPP_VERTICALLY_SMOOTH
59
60	#endif /* ALLOW_KPP */
61	#endif /* KPP_OPTIONS_H */
62
63
64	CEH3 ;;; Local Variables: ***
65	CEH3 ;;; mode:fortran ***
66	CEH3 ;;; End: ***