pkg/generic_advdiff/GAD.h

C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/GAD.h,v 1.8 2001/09/28 02:26:57 adcroft Exp $
C $Name:  $

CBOP
C !ROUTINE: GAD.h

C !INTERFACE:
C #include "GAD.h"

C !DESCRIPTION:
C Contains enumerated constants for distinguishing between different
C advection schemes and tracers.
C
C Unfortunately, there is no easy way to make use of the
C tokens in namelist input so for now we have to enter the
C tokens value into "data" (ie. 2 for 2nd order etc.)

C !USES:
#include "GAD_OPTIONS.h"

C !DEFINED PARAMETERS:

C ENUM_CENTERED_2ND :: Centered 2nd order
      INTEGER ENUM_CENTERED_2ND
      PARAMETER(ENUM_CENTERED_2ND=2)

C ENUM_UPWIND_3RD :: 3rd order upwind 
      INTEGER ENUM_UPWIND_3RD
      PARAMETER(ENUM_UPWIND_3RD=3)

C ENUM_CENTERED_4TH :: Centered 4th order
      INTEGER ENUM_CENTERED_4TH
      PARAMETER(ENUM_CENTERED_4TH=4)

C ENUM_FLUX_LIMIT :: Non-linear flux limiter
      INTEGER ENUM_FLUX_LIMIT
      PARAMETER(ENUM_FLUX_LIMIT=77)

C ENUM_DST3 :: 3-DST 
      INTEGER ENUM_DST3
      PARAMETER(ENUM_DST3=30)

C ENUM_DST3_FLUX_LIMIT :: 3-DST flux limited
      INTEGER ENUM_DST3_FLUX_LIMIT
      PARAMETER(ENUM_DST3_FLUX_LIMIT=33)

C oneSixth :: Third/fourth order interpolation factor
      _RL oneSixth
      PARAMETER(oneSixth=1.D0/6.D0)

C Differentiate between tracers (only needed for KPP -  arrgh!!!)
cph                              and for GMRedi arrgh*arrgh!!!)
cph  indices are used for TAF key computations, so need to
cph  running from 1, 2, ...

C GAD_TEMPERATURE :: temperature
      INTEGER GAD_TEMPERATURE
      PARAMETER(GAD_TEMPERATURE=1)
C GAD_TEMPERATURE :: salinity
      INTEGER GAD_SALINITY
      PARAMETER(GAD_SALINITY=2)
C GAD_TR1 :: pssive tracer 1
      INTEGER GAD_TR1
      PARAMETER(GAD_TR1=3)
CEOP
1	heimbach	1.8.4.1	C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/GAD.h,v 1.8 2001/09/28 02:26:57 adcroft Exp $
2	heimbach	1.4	C $Name: $
3	adcroft	1.1
4	adcroft	1.7	CBOP
5			C !ROUTINE: GAD.h
6	adcroft	1.1
7	adcroft	1.7	C !INTERFACE:
8			C #include "GAD.h"
9
10			C !DESCRIPTION:
11			C Contains enumerated constants for distinguishing between different
12			C advection schemes and tracers.
13			C
14			C Unfortunately, there is no easy way to make use of the
15			C tokens in namelist input so for now we have to enter the
16			C tokens value into "data" (ie. 2 for 2nd order etc.)
17	adcroft	1.8
18			C !USES:
19			#include "GAD_OPTIONS.h"
20	adcroft	1.7
21			C !DEFINED PARAMETERS:
22
23			C ENUM_CENTERED_2ND :: Centered 2nd order
24	adcroft	1.1	INTEGER ENUM_CENTERED_2ND
25			PARAMETER(ENUM_CENTERED_2ND=2)
26	jmc	1.2
27	adcroft	1.7	C ENUM_UPWIND_3RD :: 3rd order upwind
28	jmc	1.2	INTEGER ENUM_UPWIND_3RD
29			PARAMETER(ENUM_UPWIND_3RD=3)
30	adcroft	1.1
31	adcroft	1.7	C ENUM_CENTERED_4TH :: Centered 4th order
32	adcroft	1.1	INTEGER ENUM_CENTERED_4TH
33			PARAMETER(ENUM_CENTERED_4TH=4)
34
35	adcroft	1.7	C ENUM_FLUX_LIMIT :: Non-linear flux limiter
36	adcroft	1.1	INTEGER ENUM_FLUX_LIMIT
37			PARAMETER(ENUM_FLUX_LIMIT=77)
38	adcroft	1.6
39	adcroft	1.7	C ENUM_DST3 :: 3-DST
40	adcroft	1.6	INTEGER ENUM_DST3
41			PARAMETER(ENUM_DST3=30)
42
43	adcroft	1.7	C ENUM_DST3_FLUX_LIMIT :: 3-DST flux limited
44	adcroft	1.6	INTEGER ENUM_DST3_FLUX_LIMIT
45			PARAMETER(ENUM_DST3_FLUX_LIMIT=33)
46	adcroft	1.1
47	adcroft	1.7	C oneSixth :: Third/fourth order interpolation factor
48	adcroft	1.1	_RL oneSixth
49	heimbach	1.4	PARAMETER(oneSixth=1.D0/6.D0)
50	adcroft	1.1
51			C Differentiate between tracers (only needed for KPP - arrgh!!!)
52	heimbach	1.8.4.1	cph and for GMRedi arrgh*arrgh!!!)
53			cph indices are used for TAF key computations, so need to
54			cph running from 1, 2, ...
55
56	adcroft	1.7	C GAD_TEMPERATURE :: temperature
57	adcroft	1.1	INTEGER GAD_TEMPERATURE
58	heimbach	1.8.4.1	PARAMETER(GAD_TEMPERATURE=1)
59	adcroft	1.7	C GAD_TEMPERATURE :: salinity
60	adcroft	1.1	INTEGER GAD_SALINITY
61	heimbach	1.8.4.1	PARAMETER(GAD_SALINITY=2)
62	adcroft	1.7	C GAD_TR1 :: pssive tracer 1
63	heimbach	1.3	INTEGER GAD_TR1
64	heimbach	1.8.4.1	PARAMETER(GAD_TR1=3)
65	adcroft	1.7	CEOP