pkg/generic_advdiff/GAD.h

C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/GAD.h,v 1.12 2004/05/05 07:15:41 dimitri 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_UPWIND_1RST :: 1rst Order Upwind
      INTEGER ENUM_UPWIND_1RST
      PARAMETER(ENUM_UPWIND_1RST=1)

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_DST2 :: 2nd Order Direct Space and Time (= Lax-Wendroff)
      INTEGER ENUM_DST2
      PARAMETER(ENUM_DST2=20)

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

C ENUM_DST3 :: 3rd Order Direst Space and Time
      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 (needed for KPP - arrgh!!!)
cph                              and GMRedi arrgh*arrgh!!!)
cph  indices are used for TAF key computations, so need to
cph  running from 1, 2, ...
c
C GAD_TEMPERATURE :: temperature
      INTEGER GAD_TEMPERATURE
      PARAMETER(GAD_TEMPERATURE=1)
C GAD_SALINITY :: salinity
      INTEGER GAD_SALINITY
      PARAMETER(GAD_SALINITY=2)
C GAD_TR1 :: passive tracer 1
      INTEGER GAD_TR1
      PARAMETER(GAD_TR1=3)
CEOP

C--   COMMON /GAD_PARM_L/ Logical parameters for GAD pkg routines
C tempMultiDimAdvec :: set to T if using multi-dim advection for Temp
C saltMultiDimAdvec :: set to T if using multi-dim advection for Salt
C tempAdamsBashforth :: set to T if using Adams-Bashforth stepping for Temp
C saltAdamsBashforth :: set to T if using Adams-Bashforth stepping for Salt
      LOGICAL tempMultiDimAdvec
      LOGICAL saltMultiDimAdvec
      LOGICAL tempAdamsBashforth
      LOGICAL saltAdamsBashforth
      COMMON /GAD_PARM_L/
     & tempMultiDimAdvec , saltMultiDimAdvec ,
     & tempAdamsBashforth, saltAdamsBashforth

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/GAD.h,v 1.12 2004/05/05 07:15:41 dimitri Exp $
2	C $Name: $
3
4	CBOP
5	C !ROUTINE: GAD.h
6
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
18	C !USES:
19	#include "GAD_OPTIONS.h"
20
21	C !DEFINED PARAMETERS:
22
23	C ENUM_UPWIND_1RST :: 1rst Order Upwind
24	INTEGER ENUM_UPWIND_1RST
25	PARAMETER(ENUM_UPWIND_1RST=1)
26
27	C ENUM_CENTERED_2ND :: Centered 2nd order
28	INTEGER ENUM_CENTERED_2ND
29	PARAMETER(ENUM_CENTERED_2ND=2)
30
31	C ENUM_UPWIND_3RD :: 3rd order upwind
32	INTEGER ENUM_UPWIND_3RD
33	PARAMETER(ENUM_UPWIND_3RD=3)
34
35	C ENUM_CENTERED_4TH :: Centered 4th order
36	INTEGER ENUM_CENTERED_4TH
37	PARAMETER(ENUM_CENTERED_4TH=4)
38
39	C ENUM_DST2 :: 2nd Order Direct Space and Time (= Lax-Wendroff)
40	INTEGER ENUM_DST2
41	PARAMETER(ENUM_DST2=20)
42
43	C ENUM_FLUX_LIMIT :: Non-linear flux limiter
44	INTEGER ENUM_FLUX_LIMIT
45	PARAMETER(ENUM_FLUX_LIMIT=77)
46
47	C ENUM_DST3 :: 3rd Order Direst Space and Time
48	INTEGER ENUM_DST3
49	PARAMETER(ENUM_DST3=30)
50
51	C ENUM_DST3_FLUX_LIMIT :: 3-DST flux limited
52	INTEGER ENUM_DST3_FLUX_LIMIT
53	PARAMETER(ENUM_DST3_FLUX_LIMIT=33)
54
55	C oneSixth :: Third/fourth order interpolation factor
56	_RL oneSixth
57	PARAMETER(oneSixth=1.D0/6.D0)
58
59	C Differentiate between tracers (needed for KPP - arrgh!!!)
60	cph and GMRedi arrgh*arrgh!!!)
61	cph indices are used for TAF key computations, so need to
62	cph running from 1, 2, ...
63	c
64	C GAD_TEMPERATURE :: temperature
65	INTEGER GAD_TEMPERATURE
66	PARAMETER(GAD_TEMPERATURE=1)
67	C GAD_SALINITY :: salinity
68	INTEGER GAD_SALINITY
69	PARAMETER(GAD_SALINITY=2)
70	C GAD_TR1 :: passive tracer 1
71	INTEGER GAD_TR1
72	PARAMETER(GAD_TR1=3)
73	CEOP
74
75	C-- COMMON /GAD_PARM_L/ Logical parameters for GAD pkg routines
76	C tempMultiDimAdvec :: set to T if using multi-dim advection for Temp
77	C saltMultiDimAdvec :: set to T if using multi-dim advection for Salt
78	C tempAdamsBashforth :: set to T if using Adams-Bashforth stepping for Temp
79	C saltAdamsBashforth :: set to T if using Adams-Bashforth stepping for Salt
80	LOGICAL tempMultiDimAdvec
81	LOGICAL saltMultiDimAdvec
82	LOGICAL tempAdamsBashforth
83	LOGICAL saltAdamsBashforth
84	COMMON /GAD_PARM_L/
85	& tempMultiDimAdvec , saltMultiDimAdvec ,
86	& tempAdamsBashforth, saltAdamsBashforth
87
88	CEH3 ;;; Local Variables: ***
89	CEH3 ;;; mode:fortran ***
90	CEH3 ;;; End: ***