pkg/generic_advdiff/GAD.h

C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/GAD.h,v 1.23 2010/11/16 17:39:13 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:

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 ENUM_OS7MP :: 7th Order One Step method with Monotonicity Preserving Limiter
      INTEGER ENUM_OS7MP
      PARAMETER(ENUM_OS7MP=7)

C ENUM_SOM_PRATHER :: 2nd Order-Moment Advection Scheme, Prather, 1986
      INTEGER ENUM_SOM_PRATHER
      PARAMETER(ENUM_SOM_PRATHER=80)

C ENUM_SOM_LIMITER :: 2nd Order-Moment Advection Scheme, Prather Limiter
      INTEGER ENUM_SOM_LIMITER
      PARAMETER(ENUM_SOM_LIMITER=81)

C GAD_Scheme_MaxNum :: maximum possible number for an advection scheme
      INTEGER GAD_Scheme_MaxNum
      PARAMETER( GAD_Scheme_MaxNum = 100 )

C nSOM :: number of 1rst & 2nd Order-Moments: 1+1 (1D), 2+3 (2D), 3+6 (3D)
      INTEGER nSOM
      PARAMETER( nSOM = 3+6 )

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

C loop range for computing vertical advection tendency
C  iMinAdvR,iMaxAdvR  :: 1rst index (X-dir) loop range for vertical advection
C  jMinAdvR,jMaxAdvR  :: 2nd  index (Y-dir) loop range for vertical advection
      INTEGER iMinAdvR, iMaxAdvR, jMinAdvR, jMaxAdvR
c     PARAMETER ( iMinAdvR = 1-OLx , iMaxAdvR = sNx+OLx )
c     PARAMETER ( jMinAdvR = 1-OLy , jMaxAdvR = sNy+OLy )
C- note: we use to compute vertical advection tracer tendency everywhere
C        (overlap included) as above, but really needs valid tracer tendency
C        in interior only (as below):
      PARAMETER ( iMinAdvR = 1 , iMaxAdvR = sNx )
      PARAMETER ( jMinAdvR = 1 , jMaxAdvR = sNy )

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_C/ Character parameters for GAD pkg routines
C      somSfx       :: 1rst & 2nd Order moment suffix
      CHARACTER*2 somSfx(nSOM)
      COMMON /GAD_PARM_C/
     & somSfx

C--   COMMON /GAD_PARM_I/ Integer parameters for GAD pkg routines
C GAD_OlMinSize     :: overlap minimum size for GAD routines
C           1: min required; 2: to add to current min; 3: factor to apply
      INTEGER GAD_OlMinSize(3)
      COMMON /GAD_PARM_I/
     &        GAD_OlMinSize

C--   COMMON /GAD_PARM_L/ Logical parameters for GAD pkg routines
C tempSOM_Advection :: set to T if using 2nd-Order Moment advection for Temp
C saltSOM_Advection :: set to T if using 2nd-Order Moment advection for Salt
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
      LOGICAL tempSOM_Advection
      LOGICAL saltSOM_Advection
      LOGICAL tempMultiDimAdvec
      LOGICAL saltMultiDimAdvec
      LOGICAL AdamsBashforthGt
      LOGICAL AdamsBashforthGs
      LOGICAL AdamsBashforth_T
      LOGICAL AdamsBashforth_S
      COMMON /GAD_PARM_L/
     & tempSOM_Advection, saltSOM_Advection,
     & tempMultiDimAdvec, saltMultiDimAdvec,
     & AdamsBashforthGt, AdamsBashforthGs,
     & AdamsBashforth_T, AdamsBashforth_S

      _RL SmolarkiewiczMaxFrac
      COMMON /GAD_SMOL/ SmolarkiewiczMaxFrac

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	jmc	1.24	C $Header: /u/gcmpack/MITgcm/pkg/generic_advdiff/GAD.h,v 1.23 2010/11/16 17:39:13 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	adcroft	1.7
20			C !DEFINED PARAMETERS:
21
22	jmc	1.13	C ENUM_UPWIND_1RST :: 1rst Order Upwind
23			INTEGER ENUM_UPWIND_1RST
24			PARAMETER(ENUM_UPWIND_1RST=1)
25
26	adcroft	1.7	C ENUM_CENTERED_2ND :: Centered 2nd order
27	adcroft	1.1	INTEGER ENUM_CENTERED_2ND
28			PARAMETER(ENUM_CENTERED_2ND=2)
29	jmc	1.2
30	jmc	1.13	C ENUM_UPWIND_3RD :: 3rd order upwind
31	jmc	1.2	INTEGER ENUM_UPWIND_3RD
32			PARAMETER(ENUM_UPWIND_3RD=3)
33	adcroft	1.1
34	adcroft	1.7	C ENUM_CENTERED_4TH :: Centered 4th order
35	adcroft	1.1	INTEGER ENUM_CENTERED_4TH
36			PARAMETER(ENUM_CENTERED_4TH=4)
37
38	jmc	1.13	C ENUM_DST2 :: 2nd Order Direct Space and Time (= Lax-Wendroff)
39			INTEGER ENUM_DST2
40			PARAMETER(ENUM_DST2=20)
41
42	adcroft	1.7	C ENUM_FLUX_LIMIT :: Non-linear flux limiter
43	adcroft	1.1	INTEGER ENUM_FLUX_LIMIT
44			PARAMETER(ENUM_FLUX_LIMIT=77)
45	adcroft	1.6
46	jmc	1.13	C ENUM_DST3 :: 3rd Order Direst Space and Time
47	adcroft	1.6	INTEGER ENUM_DST3
48			PARAMETER(ENUM_DST3=30)
49
50	adcroft	1.7	C ENUM_DST3_FLUX_LIMIT :: 3-DST flux limited
51	adcroft	1.6	INTEGER ENUM_DST3_FLUX_LIMIT
52			PARAMETER(ENUM_DST3_FLUX_LIMIT=33)
53	adcroft	1.1
54	adcroft	1.16	C ENUM_OS7MP :: 7th Order One Step method with Monotonicity Preserving Limiter
55			INTEGER ENUM_OS7MP
56			PARAMETER(ENUM_OS7MP=7)
57
58	jmc	1.15	C ENUM_SOM_PRATHER :: 2nd Order-Moment Advection Scheme, Prather, 1986
59			INTEGER ENUM_SOM_PRATHER
60			PARAMETER(ENUM_SOM_PRATHER=80)
61
62			C ENUM_SOM_LIMITER :: 2nd Order-Moment Advection Scheme, Prather Limiter
63			INTEGER ENUM_SOM_LIMITER
64			PARAMETER(ENUM_SOM_LIMITER=81)
65
66	jmc	1.23	C GAD_Scheme_MaxNum :: maximum possible number for an advection scheme
67			INTEGER GAD_Scheme_MaxNum
68			PARAMETER( GAD_Scheme_MaxNum = 100 )
69
70	jmc	1.15	C nSOM :: number of 1rst & 2nd Order-Moments: 1+1 (1D), 2+3 (2D), 3+6 (3D)
71			INTEGER nSOM
72			PARAMETER( nSOM = 3+6 )
73
74	adcroft	1.7	C oneSixth :: Third/fourth order interpolation factor
75	adcroft	1.1	_RL oneSixth
76	heimbach	1.4	PARAMETER(oneSixth=1.D0/6.D0)
77	adcroft	1.1
78	jmc	1.18	C loop range for computing vertical advection tendency
79			C iMinAdvR,iMaxAdvR :: 1rst index (X-dir) loop range for vertical advection
80			C jMinAdvR,jMaxAdvR :: 2nd index (Y-dir) loop range for vertical advection
81			INTEGER iMinAdvR, iMaxAdvR, jMinAdvR, jMaxAdvR
82			c PARAMETER ( iMinAdvR = 1-OLx , iMaxAdvR = sNx+OLx )
83			c PARAMETER ( jMinAdvR = 1-OLy , jMaxAdvR = sNy+OLy )
84			C- note: we use to compute vertical advection tracer tendency everywhere
85			C (overlap included) as above, but really needs valid tracer tendency
86			C in interior only (as below):
87			PARAMETER ( iMinAdvR = 1 , iMaxAdvR = sNx )
88			PARAMETER ( jMinAdvR = 1 , jMaxAdvR = sNy )
89
90	edhill	1.11	C Differentiate between tracers (needed for KPP - arrgh!!!)
91			cph and GMRedi arrgh*arrgh!!!)
92	heimbach	1.10	cph indices are used for TAF key computations, so need to
93			cph running from 1, 2, ...
94			c
95	adcroft	1.7	C GAD_TEMPERATURE :: temperature
96	adcroft	1.1	INTEGER GAD_TEMPERATURE
97	heimbach	1.10	PARAMETER(GAD_TEMPERATURE=1)
98	jmc	1.9	C GAD_SALINITY :: salinity
99	adcroft	1.1	INTEGER GAD_SALINITY
100	heimbach	1.10	PARAMETER(GAD_SALINITY=2)
101	dimitri	1.12	C GAD_TR1 :: passive tracer 1
102	heimbach	1.3	INTEGER GAD_TR1
103	heimbach	1.10	PARAMETER(GAD_TR1=3)
104	adcroft	1.7	CEOP
105	jmc	1.9
106	jmc	1.20	C-- COMMON /GAD_PARM_C/ Character parameters for GAD pkg routines
107			C somSfx :: 1rst & 2nd Order moment suffix
108			CHARACTER*2 somSfx(nSOM)
109			COMMON /GAD_PARM_C/
110			& somSfx
111
112	jmc	1.23	C-- COMMON /GAD_PARM_I/ Integer parameters for GAD pkg routines
113			C GAD_OlMinSize :: overlap minimum size for GAD routines
114			C 1: min required; 2: to add to current min; 3: factor to apply
115			INTEGER GAD_OlMinSize(3)
116			COMMON /GAD_PARM_I/
117			& GAD_OlMinSize
118
119	jmc	1.9	C-- COMMON /GAD_PARM_L/ Logical parameters for GAD pkg routines
120	jmc	1.15	C tempSOM_Advection :: set to T if using 2nd-Order Moment advection for Temp
121			C saltSOM_Advection :: set to T if using 2nd-Order Moment advection for Salt
122	edhill	1.11	C tempMultiDimAdvec :: set to T if using multi-dim advection for Temp
123			C saltMultiDimAdvec :: set to T if using multi-dim advection for Salt
124	jmc	1.14	C AdamsBashforthGt :: apply Adams-Bashforth extrapolation on T tendency (=Gt)
125			C AdamsBashforthGs :: apply Adams-Bashforth extrapolation on S tendency (=Gs)
126			C AdamsBashforth_T :: apply Adams-Bashforth extrapolation on Pot.Temp.
127			C AdamsBashforth_S :: apply Adams-Bashforth extrapolation on Salinity
128	jmc	1.15	LOGICAL tempSOM_Advection
129			LOGICAL saltSOM_Advection
130	jmc	1.9	LOGICAL tempMultiDimAdvec
131			LOGICAL saltMultiDimAdvec
132	jmc	1.14	LOGICAL AdamsBashforthGt
133			LOGICAL AdamsBashforthGs
134			LOGICAL AdamsBashforth_T
135			LOGICAL AdamsBashforth_S
136	jmc	1.9	COMMON /GAD_PARM_L/
137	jmc	1.15	& tempSOM_Advection, saltSOM_Advection,
138	jmc	1.14	& tempMultiDimAdvec, saltMultiDimAdvec,
139			& AdamsBashforthGt, AdamsBashforthGs,
140	jmc	1.19	& AdamsBashforth_T, AdamsBashforth_S
141	edhill	1.11
142	jahn	1.21	_RL SmolarkiewiczMaxFrac
143			COMMON /GAD_SMOL/ SmolarkiewiczMaxFrac
144
145	edhill	1.11	CEH3 ;;; Local Variables: ***
146			CEH3 ;;; mode:fortran ***
147			CEH3 ;;; End: ***