pkg/obcs/OBCS_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/pkg/obcs/OBCS_OPTIONS.h,v 1.9 2010/11/11 09:42:54 mlosch Exp $
C $Name:  $

C CPP options file for OBCS package
C
C Use this file for selecting options within the OBCS package
C
C OBCS is enabled with ALLOW_OBCS in CPP_OPTIONS.h

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

#ifdef ALLOW_OBCS

C Enable individual open boundaries
#define ALLOW_OBCS_NORTH
#define ALLOW_OBCS_SOUTH
#define ALLOW_OBCS_EAST
#define ALLOW_OBCS_WEST

C This include hooks to the Orlanski Open Boundary Radiation code
#define ALLOW_ORLANSKI

C Enable OB values to be prescribed via external fields that are read
C from a file
#define ALLOW_OBCS_PRESCRIBE

C Enable OB conditions following Stevens (1990)
#undef ALLOW_OBCS_STEVENS

C This includes hooks to sponge layer treatment of uvel, vvel
#undef ALLOW_OBCS_SPONGE

C balance barotropic velocity
#define ALLOW_OBCS_BALANCE

C     The following five CPP options are experimental and aim to deal
C     with artifacts due to the low-frequency specification of sea-ice
C     boundary conditions compared to the model forcing frequency.
C     Ice convergence at edges can cause model to blow up.  The
C     following CPP option fixes this problem at the expense of less
C     accurate boundary conditions.
#undef OBCS_SEAICE_AVOID_CONVERGENCE

C     Smooth the component of sea-ice velocity perpendicular to the edge.
#undef OBCS_SEAICE_SMOOTH_UVICE_PERP

C     Smooth the component of sea ice velocity parallel to the edge.
#undef OBCS_SEAICE_SMOOTH_UVICE_PAR

C     Smooth the tracer sea-ice variables near the edges.
#undef OBCS_SEAICE_SMOOTH_EDGE

C     Compute rather than specify seaice velocities at the edges.
#undef OBCS_SEAICE_COMPUTE_UVICE

#endif /* ALLOW_OBCS */
#endif /* OBCS_OPTIONS_H */
1	C $Header: /u/gcmpack/MITgcm/pkg/obcs/OBCS_OPTIONS.h,v 1.9 2010/11/11 09:42:54 mlosch Exp $
2	C $Name: $
3
4	C CPP options file for OBCS package
5	C
6	C Use this file for selecting options within the OBCS package
7	C
8	C OBCS is enabled with ALLOW_OBCS in CPP_OPTIONS.h
9
10	#ifndef OBCS_OPTIONS_H
11	#define OBCS_OPTIONS_H
12	#include "PACKAGES_CONFIG.h"
13	#include "CPP_OPTIONS.h"
14
15	#ifdef ALLOW_OBCS
16
17	C Enable individual open boundaries
18	#define ALLOW_OBCS_NORTH
19	#define ALLOW_OBCS_SOUTH
20	#define ALLOW_OBCS_EAST
21	#define ALLOW_OBCS_WEST
22
23	C This include hooks to the Orlanski Open Boundary Radiation code
24	#define ALLOW_ORLANSKI
25
26	C Enable OB values to be prescribed via external fields that are read
27	C from a file
28	#define ALLOW_OBCS_PRESCRIBE
29
30	C Enable OB conditions following Stevens (1990)
31	#undef ALLOW_OBCS_STEVENS
32
33	C This includes hooks to sponge layer treatment of uvel, vvel
34	#undef ALLOW_OBCS_SPONGE
35
36	C balance barotropic velocity
37	#define ALLOW_OBCS_BALANCE
38
39	C The following five CPP options are experimental and aim to deal
40	C with artifacts due to the low-frequency specification of sea-ice
41	C boundary conditions compared to the model forcing frequency.
42	C Ice convergence at edges can cause model to blow up. The
43	C following CPP option fixes this problem at the expense of less
44	C accurate boundary conditions.
45	#undef OBCS_SEAICE_AVOID_CONVERGENCE
46
47	C Smooth the component of sea-ice velocity perpendicular to the edge.
48	#undef OBCS_SEAICE_SMOOTH_UVICE_PERP
49
50	C Smooth the component of sea ice velocity parallel to the edge.
51	#undef OBCS_SEAICE_SMOOTH_UVICE_PAR
52
53	C Smooth the tracer sea-ice variables near the edges.
54	#undef OBCS_SEAICE_SMOOTH_EDGE
55
56	C Compute rather than specify seaice velocities at the edges.
57	#undef OBCS_SEAICE_COMPUTE_UVICE
58
59	#endif /* ALLOW_OBCS */
60	#endif /* OBCS_OPTIONS_H */