OpenAD/code_ad/KPP_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/verification/OpenAD/code_oad/KPP_OPTIONS.h,v 1.1 2015/07/05 01:54:11 heimbach 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.
C     *==========================================================*

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

#ifdef ALLOW_KPP
C     Package-specific Options & Macros go here

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

C o When set, smooth dbloc KPP variable horizontally
cph#define KPP_SMOOTH_DBLOC
#undef 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
cph#define KPP_GHAT
#undef 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/verification/OpenAD/code_oad/KPP_OPTIONS.h,v 1.1 2015/07/05 01:54:11 heimbach 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.
10	C ==========================================================
11
12	#ifndef KPP_OPTIONS_H
13	#define KPP_OPTIONS_H
14	#include "PACKAGES_CONFIG.h"
15	#include "CPP_OPTIONS.h"
16
17	#ifdef ALLOW_KPP
18	C Package-specific Options & Macros go here
19
20	C o When set, smooth shear horizontally with 121 filters
21	cph#define KPP_SMOOTH_SHSQ
22	#undef KPP_SMOOTH_SHSQ
23	#undef KPP_SMOOTH_DVSQ
24
25	C o When set, smooth dbloc KPP variable horizontally
26	cph#define KPP_SMOOTH_DBLOC
27	#undef KPP_SMOOTH_DBLOC
28
29	C o When set, smooth all KPP density variables horizontally
30	#undef KPP_SMOOTH_DENS
31	#ifdef KPP_SMOOTH_DENS
32	# define KPP_SMOOTH_DBLOC
33	#endif
34
35	C o When set, smooth vertical viscosity horizontally
36	#undef KPP_SMOOTH_VISC
37
38	C o When set, smooth vertical diffusivity horizontally
39	#undef KPP_SMOOTH_DIFF
40
41	C o Get rid of vertical resolution dependence of dVsq term by
42	C estimating a surface velocity that is independent of first
43	C level thickness in the model.
44	#undef KPP_ESTIMATE_UREF
45
46	C o Include/exclude KPP non/local transport terms
47	cph#define KPP_GHAT
48	#undef KPP_GHAT
49
50	C o Exclude Interior shear instability mixing
51	#undef EXCLUDE_KPP_SHEAR_MIX
52
53	C o Exclude double diffusive mixing in the interior
54	#undef EXCLUDE_KPP_DOUBLEDIFF
55
56	C o Avoid as many as possible AD recomputations
57	C usually not necessary, but useful for testing
58	#undef KPP_AUTODIFF_EXCESSIVE_STORE
59
60	C o Vertically smooth Ri (for interior shear mixing)
61	#undef ALLOW_KPP_VERTICALLY_SMOOTH
62
63	#endif /* ALLOW_KPP */
64	#endif /* KPP_OPTIONS_H */
65
66	CEH3 ;;; Local Variables: ***
67	CEH3 ;;; mode:fortran ***
68	CEH3 ;;; End: ***