pkg/generic_advdiff/GAD.h

C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/GAD.h,v 1.13 2005/10/22 19:56:33 jmc 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 AdamsBashforthGt  :: apply Adams-Bashforth extrapolation on T tendency (=Gt)
C AdamsBashforthGs  :: apply Adams-Bashforth extrapolation on S tendency (=Gs)
C AdamsBashforth_T  :: apply Adams-Bashforth extrapolation on Pot.Temp.
C AdamsBashforth_S  :: apply Adams-Bashforth extrapolation on Salinity
C tempStartAB       :: start this run (or restart) without previous gT/Temp
C saltStartAB       :: start this run (or restart) without previous gS/Salt
      LOGICAL tempMultiDimAdvec
      LOGICAL saltMultiDimAdvec
      LOGICAL AdamsBashforthGt
      LOGICAL AdamsBashforthGs
      LOGICAL AdamsBashforth_T
      LOGICAL AdamsBashforth_S
      LOGICAL tempStartAB
      LOGICAL saltStartAB
      COMMON /GAD_PARM_L/
     & tempMultiDimAdvec, saltMultiDimAdvec,
     & AdamsBashforthGt, AdamsBashforthGs,
     & AdamsBashforth_T, AdamsBashforth_S,
     & tempStartAB, saltStartAB

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	jmc	1.14	C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/GAD.h,v 1.13 2005/10/22 19:56:33 jmc 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	jmc	1.13	C ENUM_UPWIND_1RST :: 1rst Order Upwind
24			INTEGER ENUM_UPWIND_1RST
25			PARAMETER(ENUM_UPWIND_1RST=1)
26
27	adcroft	1.7	C ENUM_CENTERED_2ND :: Centered 2nd order
28	adcroft	1.1	INTEGER ENUM_CENTERED_2ND
29			PARAMETER(ENUM_CENTERED_2ND=2)
30	jmc	1.2
31	jmc	1.13	C ENUM_UPWIND_3RD :: 3rd order upwind
32	jmc	1.2	INTEGER ENUM_UPWIND_3RD
33			PARAMETER(ENUM_UPWIND_3RD=3)
34	adcroft	1.1
35	adcroft	1.7	C ENUM_CENTERED_4TH :: Centered 4th order
36	adcroft	1.1	INTEGER ENUM_CENTERED_4TH
37			PARAMETER(ENUM_CENTERED_4TH=4)
38
39	jmc	1.13	C ENUM_DST2 :: 2nd Order Direct Space and Time (= Lax-Wendroff)
40			INTEGER ENUM_DST2
41			PARAMETER(ENUM_DST2=20)
42
43	adcroft	1.7	C ENUM_FLUX_LIMIT :: Non-linear flux limiter
44	adcroft	1.1	INTEGER ENUM_FLUX_LIMIT
45			PARAMETER(ENUM_FLUX_LIMIT=77)
46	adcroft	1.6
47	jmc	1.13	C ENUM_DST3 :: 3rd Order Direst Space and Time
48	adcroft	1.6	INTEGER ENUM_DST3
49			PARAMETER(ENUM_DST3=30)
50
51	adcroft	1.7	C ENUM_DST3_FLUX_LIMIT :: 3-DST flux limited
52	adcroft	1.6	INTEGER ENUM_DST3_FLUX_LIMIT
53			PARAMETER(ENUM_DST3_FLUX_LIMIT=33)
54	adcroft	1.1
55	adcroft	1.7	C oneSixth :: Third/fourth order interpolation factor
56	adcroft	1.1	_RL oneSixth
57	heimbach	1.4	PARAMETER(oneSixth=1.D0/6.D0)
58	adcroft	1.1
59	edhill	1.11	C Differentiate between tracers (needed for KPP - arrgh!!!)
60			cph and GMRedi arrgh*arrgh!!!)
61	heimbach	1.10	cph indices are used for TAF key computations, so need to
62			cph running from 1, 2, ...
63			c
64	adcroft	1.7	C GAD_TEMPERATURE :: temperature
65	adcroft	1.1	INTEGER GAD_TEMPERATURE
66	heimbach	1.10	PARAMETER(GAD_TEMPERATURE=1)
67	jmc	1.9	C GAD_SALINITY :: salinity
68	adcroft	1.1	INTEGER GAD_SALINITY
69	heimbach	1.10	PARAMETER(GAD_SALINITY=2)
70	dimitri	1.12	C GAD_TR1 :: passive tracer 1
71	heimbach	1.3	INTEGER GAD_TR1
72	heimbach	1.10	PARAMETER(GAD_TR1=3)
73	adcroft	1.7	CEOP
74	jmc	1.9
75			C-- COMMON /GAD_PARM_L/ Logical parameters for GAD pkg routines
76	edhill	1.11	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	jmc	1.14	C AdamsBashforthGt :: apply Adams-Bashforth extrapolation on T tendency (=Gt)
79			C AdamsBashforthGs :: apply Adams-Bashforth extrapolation on S tendency (=Gs)
80			C AdamsBashforth_T :: apply Adams-Bashforth extrapolation on Pot.Temp.
81			C AdamsBashforth_S :: apply Adams-Bashforth extrapolation on Salinity
82			C tempStartAB :: start this run (or restart) without previous gT/Temp
83			C saltStartAB :: start this run (or restart) without previous gS/Salt
84	jmc	1.9	LOGICAL tempMultiDimAdvec
85			LOGICAL saltMultiDimAdvec
86	jmc	1.14	LOGICAL AdamsBashforthGt
87			LOGICAL AdamsBashforthGs
88			LOGICAL AdamsBashforth_T
89			LOGICAL AdamsBashforth_S
90			LOGICAL tempStartAB
91			LOGICAL saltStartAB
92	jmc	1.9	COMMON /GAD_PARM_L/
93	jmc	1.14	& tempMultiDimAdvec, saltMultiDimAdvec,
94			& AdamsBashforthGt, AdamsBashforthGs,
95			& AdamsBashforth_T, AdamsBashforth_S,
96			& tempStartAB, saltStartAB
97	edhill	1.11
98			CEH3 ;;; Local Variables: ***
99			CEH3 ;;; mode:fortran ***
100			CEH3 ;;; End: ***