pkg/kpp/KPP_OPTIONS.h

C $Header: /u/u3/gcmpack/MITgcm/pkg/kpp/KPP_OPTIONS.h,v 1.7 2003/10/09 04:19:19 edhill 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 "AD_CONFIG.h"

#ifdef ALLOW_KPP

#include "CPP_OPTIONS.h"

C o Set precision for KPP variables (Real*4 or Real*8)
#define _KPP_RL Real*8

C o When set, use exchange calls rather than recomputation
C   to obtain KPP parameters in overlap region.  This option
C   was added to reduce stack size requirements on the
C   Origin 2000.  It decreases memory and computation
C   requirements at the expense of increased communications.
C   For a 64-processor 360x224x46 MPI configuration on the
C   Exemplar or Origin 2000, wall clock time is about the
C   same whether FRUGAL_KPP is turned on or off.
#undef FRUGAL_KPP

C o When set, smooth zonal shear meridionally and
C   meridional shear zonally 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 Switch on vertical smoothing, the number of sweeps is set in the namelist
#undef ALLOW_KPP_VERTICALLY_SMOOTH

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 various time-averaged diagnostic output
C   for saving storage space
#ifdef  ALLOW_TIMEAVE
#define INCLUDE_DIAGNOSTICS_KPP
#undef  INCLUDE_DIAGNOSTICS_KPPDIFFKZSTAVE
#endif

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

#endif /* ALLOW_KPP */
#endif /* KPP_OPTIONS_H */
1	C $Header: /u/u3/gcmpack/MITgcm/pkg/kpp/KPP_OPTIONS.h,v 1.7 2003/10/09 04:19:19 edhill Exp $
2	C $Name: $
3	C /==========================================================\
4	C \| KPP_OPTIONS.h \|
5	C \| o CPP options file for KPP package. \|
6	C \|==========================================================\|
7	C \| Use this file for selecting options within the KPP \|
8	C \| package. \|
9	C \==========================================================/
10
11	#ifndef KPP_OPTIONS_H
12	#define KPP_OPTIONS_H
13	#include "PACKAGES_CONFIG.h"
14	#include "AD_CONFIG.h"
15
16	#ifdef ALLOW_KPP
17
18	#include "CPP_OPTIONS.h"
19
20	C o Set precision for KPP variables (Real4 or Real8)
21	#define _KPP_RL Real*8
22
23	C o When set, use exchange calls rather than recomputation
24	C to obtain KPP parameters in overlap region. This option
25	C was added to reduce stack size requirements on the
26	C Origin 2000. It decreases memory and computation
27	C requirements at the expense of increased communications.
28	C For a 64-processor 360x224x46 MPI configuration on the
29	C Exemplar or Origin 2000, wall clock time is about the
30	C same whether FRUGAL_KPP is turned on or off.
31	#undef FRUGAL_KPP
32
33	C o When set, smooth zonal shear meridionally and
34	C meridional shear zonally with 121 filters
35	#define KPP_SMOOTH_SHSQ
36	#undef KPP_SMOOTH_DVSQ
37
38	C o When set, smooth dbloc KPP variable horizontally
39	#define KPP_SMOOTH_DBLOC
40
41	C o When set, smooth all KPP density variables horizontally
42	#undef KPP_SMOOTH_DENS
43	#ifdef KPP_SMOOTH_DENS
44	# define KPP_SMOOTH_DBLOC
45	#endif
46
47	C o When set, smooth vertical viscosity horizontally
48	#undef KPP_SMOOTH_VISC
49
50	C o When set, smooth vertical diffusivity horizontally
51	#undef KPP_SMOOTH_DIFF
52
53	C o Switch on vertical smoothing, the number of sweeps is set in the namelist
54	#undef ALLOW_KPP_VERTICALLY_SMOOTH
55
56	C o Get rid of vertical resolution dependence of dVsq term by
57	C estimating a surface velocity that is independent of first
58	C level thickness in the model.
59	#undef KPP_ESTIMATE_UREF
60
61	C o Include/exclude various time-averaged diagnostic output
62	C for saving storage space
63	#ifdef ALLOW_TIMEAVE
64	#define INCLUDE_DIAGNOSTICS_KPP
65	#undef INCLUDE_DIAGNOSTICS_KPPDIFFKZSTAVE
66	#endif
67
68	C o Include/exclude KPP non/local transport terms
69	#define KPP_GHAT
70
71	#endif /* ALLOW_KPP */
72	#endif /* KPP_OPTIONS_H */