submesoscale/code/GMREDI.h

C $Header: /u/gcmpack/MITgcm/pkg/gmredi/GMREDI.h,v 1.16 2008/10/27 22:03:46 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
C SM (4)
      _RL GM_SM_Ce
      _RL GM_SM_Lf
      _RL GM_SM_Lmax
      _RL GM_SM_tau
                        
      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 SM (4)
     &                   ,GM_SM_Ce,
     &                   GM_SM_Lf,
     &                   GM_SM_Lmax,
     &                   GM_SM_tau
                    

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	zhc	1.4	C $Header: /u/gcmpack/MITgcm/pkg/gmredi/GMREDI.h,v 1.16 2008/10/27 22:03:46 jmc Exp $
2	dimitri	1.1	C $Name: $
3
4			#ifdef ALLOW_GMREDI
5
6	zhc	1.4	C--- GM/Redi package parameters
7	dimitri	1.1
8	zhc	1.4	C-- Numerical Constant
9			_RL op5
10			_RL op25
11			PARAMETER( op5 = 0.5 _d 0 )
12			PARAMETER( op25 = 0.25 _d 0 )
13
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	dimitri	1.1	C GM_slopeSqCutoff :: slope^2 cut-off value
39	zhc	1.4	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	dimitri	1.1	_RL GM_isopycK
44			_RL GM_background_K
45			_RL GM_maxSlope
46			_RL GM_Kmin_horiz
47			_RL GM_Small_Number
48			_RL GM_slopeSqCutoff
49			_RL GM_Visbeck_alpha
50			_RL GM_Visbeck_length
51			_RL GM_Visbeck_depth
52	zhc	1.4	_RL GM_Visbeck_minDepth
53			_RL GM_Visbeck_maxSlope
54			_RL GM_Visbeck_minVal_K
55			_RL GM_Visbeck_maxVal_K
56			_RL GM_facTrL2dz
57			_RL GM_facTrL2ML
58			_RL GM_maxTransLay
59	dimitri	1.1	_RL GM_Scrit
60			_RL GM_Sd
61	zhc	1.4	C SM (4)
62	dimitri	1.2	_RL GM_SM_Ce
63			_RL GM_SM_Lf
64			_RL GM_SM_Lmax
65			_RL GM_SM_tau
66	zhc	1.4
67			COMMON /GM_PARAMS_R/
68			& GM_isopycK, GM_background_K,
69	dimitri	1.1	& GM_maxSlope,
70			& GM_Kmin_horiz,
71			& GM_Small_Number, GM_slopeSqCutoff,
72	zhc	1.4	& GM_Visbeck_alpha, GM_Visbeck_length,
73	dimitri	1.1	& GM_Visbeck_depth,
74	zhc	1.4	& GM_Visbeck_minDepth, GM_Visbeck_maxSlope,
75			& GM_Visbeck_minVal_K, GM_Visbeck_maxVal_K,
76			& GM_facTrL2dz, GM_facTrL2ML, GM_maxTransLay,
77			& GM_Scrit, GM_Sd
78			C SM (4)
79			& ,GM_SM_Ce,
80			& GM_SM_Lf,
81			& GM_SM_Lmax,
82			& GM_SM_tau
83
84	dimitri	1.1
85	zhc	1.4	C-- More GM/Redi parameters derived from previous block
86	dimitri	1.1	C (not directly user configured)
87			_RL GM_rMaxSlope
88			_RL GM_skewflx
89			_RL GM_advect
90	zhc	1.4	COMMON /GM_DERIVED_PAR/
91			& GM_rMaxSlope,
92			& GM_skewflx, GM_advect
93	dimitri	1.1
94	zhc	1.4	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
95			C--- GM/Redi tensor elements
96	dimitri	1.1
97			C Bottom row of tensor corresponds to W points
98			C Kwx is K_31 element, X direction at W point
99			C Kwy is K_32 element, Y direction at W point
100			C Kwz is K_33 element, Z direction at W point
101			_RL Kwx(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
102			_RL Kwy(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
103			_RL Kwz(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
104			COMMON /GM_Wtensor/ Kwx,Kwy,Kwz
105
106			#ifdef GM_NON_UNITY_DIAGONAL
107	zhc	1.4	C Horizontal part of the tensor
108	dimitri	1.1	C Kux is K_11 element, X direction at U point
109			C Kvy is K_22 element, Y direction at V point
110			_RL Kux(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
111			_RL Kvy(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
112			COMMON /GM_HorTensor/ Kux,Kvy
113			#else
114			_RL Kux,Kvy
115			PARAMETER(Kux=1.,Kvy=1.)
116			#endif
117
118			#ifdef GM_EXTRA_DIAGONAL
119			C First/second rows of tensor corresponds to U/V points
120			C Kuz is K_13 element, Z direction at U point
121			C Kvz is K_23 element, Z direction at V point
122			_RL Kuz(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
123			_RL Kvz(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
124			COMMON /GM_UVtensor/ Kuz,Kvz
125			#else
126			_RL Kuz,Kvz
127			PARAMETER(Kuz=1.,Kvz=1.)
128			#endif
129
130			#ifdef GM_BOLUS_ADVEC
131	zhc	1.4	C GM advection formulation: bolus velocities are derived from 2
132			C streamfunctions PsiX and PsiY :
133	dimitri	1.1	_RL GM_PsiX(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
134			_RL GM_PsiY(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
135			COMMON /GM_BOLUS/ GM_PsiX,GM_PsiY
136			#endif
137
138			#ifdef GM_VISBECK_VARIABLE_K
139			C GM mixing/stirring coefficient (spatially variable in horizontal
140			C for Visbeck et al. parameterization)
141			_RL VisbeckK(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
142			COMMON /GM_Visbeck/ VisbeckK
143			#endif
144
145			#endif /* ALLOW_GMREDI */
146
147			CEH3 ;;; Local Variables: ***
148			CEH3 ;;; mode:fortran ***
149			CEH3 ;;; End: ***