pkg/gmredi/GMREDI.h

C $Header: /u/gcmpack/MITgcm/pkg/gmredi/GMREDI.h,v 1.15 2008/10/07 20:15:27 jmc Exp $
C $Name:  $

#ifdef ALLOW_GMREDI

C---  GM/Redi package parameters

C--   Numerical Constant
      _RL op5
      _RL op25
      PARAMETER( op5  = 0.5 _d 0 )
      PARAMETER( op25 = 0.25 _d 0 )

C--   GM/Redi Logical-type parameters
      LOGICAL GM_AdvForm
      LOGICAL GM_AdvSeparate
      LOGICAL GM_ExtraDiag
      LOGICAL GM_InMomAsStress
      LOGICAL GM_MNC
      LOGICAL GM_MDSIO
      COMMON /GM_PARAMS_L/
     &                   GM_AdvForm, GM_AdvSeparate,
     &                   GM_ExtraDiag, GM_MNC, GM_MDSIO,
     &                   GM_InMomAsStress

C--   GM/Redi Character-type parameters
C     GM_taper_scheme  :: select which tapering/clipping scheme to use
      CHARACTER*(40) GM_taper_scheme
      COMMON /GM_PARAMS_C/
     &                   GM_taper_scheme

C--   GM/Redi real-type parameters
C     GM_isopycK       :: Isopycnal diffusivity [m^2/s] (Redi-tensor)
C     GM_background_K  :: Thickness diffusivity [m^2/s] (GM bolus transport)
C     GM_maxSlope      :: maximum slope (tapering/clipping) [-]
C     GM_Kmin_horiz    :: minimum horizontal diffusivity [m^2/s]
C     GM_Small_Number  :: epsilon used in computing the slope
C     GM_slopeSqCutoff :: slope^2 cut-off value
C-    transition layer thickness definition:
C     GM_facTrL2dz   :: minimum Trans. Layer Thick. as a factor of local dz
C     GM_facTrL2ML   :: maximum Trans. Layer Thick. as a factor of Mix-Layer Depth
C     GM_maxTransLay :: maximum Trans. Layer Thick. [m]
      _RL GM_isopycK
      _RL GM_background_K
      _RL GM_maxSlope
      _RL GM_Kmin_horiz
      _RL GM_Small_Number
      _RL GM_slopeSqCutoff
      _RL GM_Visbeck_alpha
      _RL GM_Visbeck_length
      _RL GM_Visbeck_depth
      _RL GM_Visbeck_minDepth
      _RL GM_Visbeck_maxSlope
      _RL GM_Visbeck_minVal_K
      _RL GM_Visbeck_maxVal_K
      _RL GM_facTrL2dz
      _RL GM_facTrL2ML
      _RL GM_maxTransLay
      _RL GM_Scrit
      _RL GM_Sd
      COMMON /GM_PARAMS_R/
     &                   GM_isopycK, GM_background_K,
     &                   GM_maxSlope,
     &                   GM_Kmin_horiz,
     &                   GM_Small_Number, GM_slopeSqCutoff,
     &                   GM_Visbeck_alpha, GM_Visbeck_length,
     &                   GM_Visbeck_depth,
     &                   GM_Visbeck_minDepth, GM_Visbeck_maxSlope,
     &                   GM_Visbeck_minVal_K, GM_Visbeck_maxVal_K,
     &                   GM_facTrL2dz, GM_facTrL2ML, GM_maxTransLay,
     &                   GM_Scrit, GM_Sd

C--   More GM/Redi parameters derived from previous block
C     (not directly user configured)
      _RL GM_rMaxSlope
      _RL GM_skewflx
      _RL GM_advect
      COMMON /GM_DERIVED_PAR/
     &                   GM_rMaxSlope,
     &                   GM_skewflx, GM_advect

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
C---  GM/Redi tensor elements

C     Bottom row of tensor corresponds to W points
C     Kwx is K_31 element, X direction at W point
C     Kwy is K_32 element, Y direction at W point
C     Kwz is K_33 element, Z direction at W point
      _RL Kwx(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL Kwy(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL Kwz(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      COMMON /GM_Wtensor/ Kwx,Kwy,Kwz

#ifdef GM_NON_UNITY_DIAGONAL
C     Horizontal part of the tensor
C     Kux is K_11 element, X direction at U point
C     Kvy is K_22 element, Y direction at V point
      _RL Kux(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL Kvy(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      COMMON /GM_HorTensor/ Kux,Kvy
#else
      _RL Kux,Kvy
      PARAMETER(Kux=1.,Kvy=1.)
#endif

#ifdef GM_EXTRA_DIAGONAL
C     First/second rows of tensor corresponds to U/V points
C     Kuz is K_13 element, Z direction at U point
C     Kvz is K_23 element, Z direction at V point
      _RL Kuz(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL Kvz(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      COMMON /GM_UVtensor/ Kuz,Kvz
#else
      _RL Kuz,Kvz
      PARAMETER(Kuz=1.,Kvz=1.)
#endif

#ifdef GM_BOLUS_ADVEC
C     GM advection formulation: bolus velocities are derived from 2
C        streamfunctions PsiX and PsiY :
      _RL GM_PsiX(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL GM_PsiY(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      COMMON /GM_BOLUS/ GM_PsiX,GM_PsiY
#endif

#ifdef GM_VISBECK_VARIABLE_K
C     GM mixing/stirring coefficient (spatially variable in horizontal
C     for Visbeck et al. parameterization)
      _RL VisbeckK(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      COMMON /GM_Visbeck/ VisbeckK
#endif

#endif /* ALLOW_GMREDI */

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	jmc	1.16	C $Header: /u/gcmpack/MITgcm/pkg/gmredi/GMREDI.h,v 1.15 2008/10/07 20:15:27 jmc Exp $
2	jmc	1.10	C $Name: $
3	adcroft	1.1
4			#ifdef ALLOW_GMREDI
5	heimbach	1.2
6	jmc	1.15	C--- GM/Redi package parameters
7	adcroft	1.1
8	jmc	1.15	C-- Numerical Constant
9			_RL op5
10			_RL op25
11	jmc	1.16	PARAMETER( op5 = 0.5 _d 0 )
12			PARAMETER( op25 = 0.25 _d 0 )
13	jmc	1.15
14			C-- GM/Redi Logical-type parameters
15			LOGICAL GM_AdvForm
16			LOGICAL GM_AdvSeparate
17			LOGICAL GM_ExtraDiag
18			LOGICAL GM_InMomAsStress
19			LOGICAL GM_MNC
20			LOGICAL GM_MDSIO
21			COMMON /GM_PARAMS_L/
22			& GM_AdvForm, GM_AdvSeparate,
23			& GM_ExtraDiag, GM_MNC, GM_MDSIO,
24			& GM_InMomAsStress
25
26			C-- GM/Redi Character-type parameters
27			C GM_taper_scheme :: select which tapering/clipping scheme to use
28			CHARACTER*(40) GM_taper_scheme
29			COMMON /GM_PARAMS_C/
30			& GM_taper_scheme
31
32			C-- GM/Redi real-type parameters
33			C GM_isopycK :: Isopycnal diffusivity [m^2/s] (Redi-tensor)
34			C GM_background_K :: Thickness diffusivity [m^2/s] (GM bolus transport)
35			C GM_maxSlope :: maximum slope (tapering/clipping) [-]
36			C GM_Kmin_horiz :: minimum horizontal diffusivity [m^2/s]
37			C GM_Small_Number :: epsilon used in computing the slope
38	jmc	1.10	C GM_slopeSqCutoff :: slope^2 cut-off value
39	jmc	1.15	C- transition layer thickness definition:
40			C GM_facTrL2dz :: minimum Trans. Layer Thick. as a factor of local dz
41			C GM_facTrL2ML :: maximum Trans. Layer Thick. as a factor of Mix-Layer Depth
42			C GM_maxTransLay :: maximum Trans. Layer Thick. [m]
43	jmc	1.6	_RL GM_isopycK
44	adcroft	1.1	_RL GM_background_K
45			_RL GM_maxSlope
46	jmc	1.6	_RL GM_Kmin_horiz
47	jmc	1.10	_RL GM_Small_Number
48			_RL GM_slopeSqCutoff
49	adcroft	1.1	_RL GM_Visbeck_alpha
50			_RL GM_Visbeck_length
51			_RL GM_Visbeck_depth
52	jmc	1.16	_RL GM_Visbeck_minDepth
53			_RL GM_Visbeck_maxSlope
54			_RL GM_Visbeck_minVal_K
55			_RL GM_Visbeck_maxVal_K
56	jmc	1.15	_RL GM_facTrL2dz
57			_RL GM_facTrL2ML
58			_RL GM_maxTransLay
59	adcroft	1.1	_RL GM_Scrit
60			_RL GM_Sd
61	jmc	1.15	COMMON /GM_PARAMS_R/
62			& GM_isopycK, GM_background_K,
63	adcroft	1.1	& GM_maxSlope,
64	jmc	1.6	& GM_Kmin_horiz,
65	jmc	1.10	& GM_Small_Number, GM_slopeSqCutoff,
66	jmc	1.16	& GM_Visbeck_alpha, GM_Visbeck_length,
67	adcroft	1.1	& GM_Visbeck_depth,
68	jmc	1.16	& GM_Visbeck_minDepth, GM_Visbeck_maxSlope,
69			& GM_Visbeck_minVal_K, GM_Visbeck_maxVal_K,
70	jmc	1.15	& GM_facTrL2dz, GM_facTrL2ML, GM_maxTransLay,
71			& GM_Scrit, GM_Sd
72	adcroft	1.1
73	jmc	1.15	C-- More GM/Redi parameters derived from previous block
74	adcroft	1.1	C (not directly user configured)
75			_RL GM_rMaxSlope
76	jmc	1.6	_RL GM_skewflx
77			_RL GM_advect
78	jmc	1.15	COMMON /GM_DERIVED_PAR/
79			& GM_rMaxSlope,
80			& GM_skewflx, GM_advect
81	adcroft	1.1
82	jmc	1.15	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
83			C--- GM/Redi tensor elements
84	adcroft	1.1
85			C Bottom row of tensor corresponds to W points
86			C Kwx is K_31 element, X direction at W point
87			C Kwy is K_32 element, Y direction at W point
88			C Kwz is K_33 element, Z direction at W point
89	heimbach	1.3	_RL Kwx(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
90			_RL Kwy(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
91			_RL Kwz(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
92	adcroft	1.1	COMMON /GM_Wtensor/ Kwx,Kwy,Kwz
93
94			#ifdef GM_NON_UNITY_DIAGONAL
95	jmc	1.15	C Horizontal part of the tensor
96	adcroft	1.1	C Kux is K_11 element, X direction at U point
97			C Kvy is K_22 element, Y direction at V point
98	heimbach	1.3	_RL Kux(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
99			_RL Kvy(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
100	jmc	1.6	COMMON /GM_HorTensor/ Kux,Kvy
101	adcroft	1.1	#else
102			_RL Kux,Kvy
103			PARAMETER(Kux=1.,Kvy=1.)
104	jmc	1.6	#endif
105
106			#ifdef GM_EXTRA_DIAGONAL
107			C First/second rows of tensor corresponds to U/V points
108			C Kuz is K_13 element, Z direction at U point
109			C Kvz is K_23 element, Z direction at V point
110			_RL Kuz(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
111			_RL Kvz(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
112			COMMON /GM_UVtensor/ Kuz,Kvz
113			#else
114			_RL Kuz,Kvz
115			PARAMETER(Kuz=1.,Kvz=1.)
116			#endif
117
118			#ifdef GM_BOLUS_ADVEC
119	jmc	1.15	C GM advection formulation: bolus velocities are derived from 2
120			C streamfunctions PsiX and PsiY :
121	jmc	1.6	_RL GM_PsiX(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
122			_RL GM_PsiY(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
123			COMMON /GM_BOLUS/ GM_PsiX,GM_PsiY
124	adcroft	1.1	#endif
125
126			#ifdef GM_VISBECK_VARIABLE_K
127			C GM mixing/stirring coefficient (spatially variable in horizontal
128			C for Visbeck et al. parameterization)
129	heimbach	1.3	_RL VisbeckK(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
130	adcroft	1.1	COMMON /GM_Visbeck/ VisbeckK
131			#endif
132
133			#endif /* ALLOW_GMREDI */
134	edhill	1.12
135			CEH3 ;;; Local Variables: ***
136			CEH3 ;;; mode:fortran ***
137			CEH3 ;;; End: ***