/[MITgcm]/MITgcm/pkg/gmredi/GMREDI.h
ViewVC logotype

Diff of /MITgcm/pkg/gmredi/GMREDI.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.17 by jmc, Tue Jan 11 00:54:45 2011 UTC revision 1.27 by m_bates, Mon Oct 21 18:46:05 2013 UTC
# Line 14  C--   Numerical Constant Line 14  C--   Numerical Constant
14  C--   COMMON /GM_PARAMS_L/ GM/Redi Logical-type parameters  C--   COMMON /GM_PARAMS_L/ GM/Redi Logical-type parameters
15  C     GM_AdvForm       :: use Advective Form (instead of Skew-Flux form)  C     GM_AdvForm       :: use Advective Form (instead of Skew-Flux form)
16  C     GM_AdvSeparate   :: do separately advection by Eulerian and Bolus velocity  C     GM_AdvSeparate   :: do separately advection by Eulerian and Bolus velocity
17    C     GM_useBVP        :: use Boundary-Value-Problem method for Bolus transport
18    C     GM_useSubMeso    :: use parameterization of mixed layer (Sub-Mesoscale) eddies
19  C     GM_ExtraDiag     :: select extra diagnostics  C     GM_ExtraDiag     :: select extra diagnostics
20  C     GM_InMomAsStress :: apply GM as a stress in momentum Eq.  C     GM_InMomAsStress :: apply GM as a stress in momentum Eq.
21  C     GM_MNC           ::  C     GM_MNC           ::
22  C     GM_MDSIO         ::  C     GM_MDSIO         ::
23    C     GM_useK3D        :: use the 3 dimensional calculation for K
24    C     GM_K3D_beta_eq_0 :: Ignores the beta term when calculating grad(q)
25    C     GM_K3D_likeGM    :: Makes the PV closure similar to the GM closure (for debugging only!)
26    C     GM_K3D_ThickSheet:: Use a thick PV sheet (should pretty much always be false)
27    C     GM_K3D_smooth    :: Expand PV closure in terms of baroclinic modes (for debugging only!)
28        LOGICAL GM_AdvForm        LOGICAL GM_AdvForm
29        LOGICAL GM_AdvSeparate        LOGICAL GM_AdvSeparate
30          LOGICAL GM_useBVP
31          LOGICAL GM_useSubMeso
32        LOGICAL GM_ExtraDiag        LOGICAL GM_ExtraDiag
33        LOGICAL GM_InMomAsStress        LOGICAL GM_InMomAsStress
34        LOGICAL GM_MNC        LOGICAL GM_MNC
35        LOGICAL GM_MDSIO        LOGICAL GM_MDSIO
36          LOGICAL GM_useK3D
37          LOGICAL GM_K3D_likeGM
38          LOGICAL GM_K3D_ThickSheet
39          LOGICAL GM_K3D_beta_eq_0
40          LOGICAL GM_K3D_smooth
41        COMMON /GM_PARAMS_L/        COMMON /GM_PARAMS_L/
42       &                   GM_AdvForm, GM_AdvSeparate,       &                   GM_AdvForm, GM_AdvSeparate,
43         &                   GM_useBVP,  GM_useSubMeso,
44       &                   GM_ExtraDiag, GM_MNC, GM_MDSIO,       &                   GM_ExtraDiag, GM_MNC, GM_MDSIO,
45       &                   GM_InMomAsStress       &                   GM_InMomAsStress,
46         &                   GM_useK3D, GM_K3D_likeGM, GM_K3D_smooth,
47         &                   GM_K3D_beta_eq_0, GM_K3D_ThickSheet
48    
49    C--   GM/Redi Integer-type parameters
50    C     GM_BVP_modeNumber :: vertical mode number used for speed "c" in BVP transport
51    C     GM_K3D_NModes :: number of vertical modes used for calculating Xi in K3D
52          INTEGER GM_BVP_modeNumber
53          INTEGER GM_K3D_NModes
54          PARAMETER (GM_K3D_NModes=6)
55          COMMON /GM_PARAMS_I/
56         &                   GM_BVP_modeNumber
57    
58  C--   COMMON /GM_PARAMS_C/ GM/Redi Character-type parameters  C--   COMMON /GM_PARAMS_C/ GM/Redi Character-type parameters
59  C     GM_taper_scheme :: select which tapering/clipping scheme to use  C     GM_taper_scheme :: select which tapering/clipping scheme to use
# Line 52  C     GM_maxSlope      :: maximum slope Line 78  C     GM_maxSlope      :: maximum slope
78  C     GM_Kmin_horiz    :: minimum horizontal diffusivity [m^2/s]  C     GM_Kmin_horiz    :: minimum horizontal diffusivity [m^2/s]
79  C     GM_Small_Number  :: epsilon used in computing the slope  C     GM_Small_Number  :: epsilon used in computing the slope
80  C     GM_slopeSqCutoff :: slope^2 cut-off value  C     GM_slopeSqCutoff :: slope^2 cut-off value
81  C-    transition layer thickness definition:  C-    Transition layer thickness definition:
82  C     GM_facTrL2dz   :: minimum Trans. Layer Thick. as a factor of local dz  C     GM_facTrL2dz   :: minimum Trans. Layer Thick. as a factor of local dz
83  C     GM_facTrL2ML   :: maximum Trans. Layer Thick. as a factor of Mix-Layer Depth  C     GM_facTrL2ML   :: maximum Trans. Layer Thick. as a factor of Mix-Layer Depth
84  C     GM_maxTransLay :: maximum Trans. Layer Thick. [m]  C     GM_maxTransLay :: maximum Trans. Layer Thick. [m]
85    C-    Boundary-Value-Problem method parameters:
86    C     GM_BVP_cMin    :: minimum value for wave speed parameter "c" in BVP [m/s]
87    C-    mixed layer (Sub-Mesoscale) eddies parameterization:
88    C     subMeso_Ceff   :: efficiency coefficient of Mixed-Layer Eddies [-]
89    C     subMeso_invTau :: inverse of mixing time-scale in sub-meso parameteriz. [s^-1]
90    C     subMeso_LfMin  :: minimum value for length-scale "Lf" [m]
91    C     subMeso_Lmax   :: maximum horizontal grid-scale length [m]
92    C     Variable K with PV diffusion parameters:
93    C     GM_K3D_gamma   :: mixing efficiency for 3D eddy diffusivity [-]
94    C     GM_K3D_b1      :: an empirically determined constant of O(1)
95    C     GM_K3D_EadyMinDepth :: upper depth for Eady calculation
96    C     GM_K3D_EadyMaxDepth :: lower depth for Eady calculation
97    C     GM_maxK3D      :: Upper bound on the diffusivity
98    C     GM_K3D_constK  :: Constant diffusivity to use when GM_useK3D=.TRUE. and GM_K3D_likeGM=.TRUE.
99    C     GM_K3D_Rmax    :: Upper bound on the length scale used for calculating urms
100    C     GM_K3D_Rmin    :: Lower bound on the length scale used for calculating the eddy radius
101    C     GM_K3D_minCori :: minimum value for f (to stop things blowing up near the equator)
102    C     GM_K3D_minN2   :: minimum value for the square of the buoyancy frequency
103    C     GM_K3D_surfMinDepth :: minimum value for the depth of the surface layer
104    C     GM_K3D_vecFreq :: Frequency at which to update the baroclinic modes
105    
106        _RL GM_isopycK        _RL GM_isopycK
107        _RL GM_background_K        _RL GM_background_K
108        _RL GM_maxSlope        _RL GM_maxSlope
# Line 69  C     GM_maxTransLay :: maximum Trans. L Line 116  C     GM_maxTransLay :: maximum Trans. L
116        _RL GM_Visbeck_maxSlope        _RL GM_Visbeck_maxSlope
117        _RL GM_Visbeck_minVal_K        _RL GM_Visbeck_minVal_K
118        _RL GM_Visbeck_maxVal_K        _RL GM_Visbeck_maxVal_K
119          _RL GM_K3D_gamma
120          _RL GM_K3D_b1
121          _RL GM_K3D_EadyMinDepth
122          _RL GM_K3D_EadyMaxDepth
123          _RL GM_K3D_Lambda
124          _RL GM_K3D_smallK
125          _RL GM_K3D_maxC
126          _RL GM_maxK3D
127          _RL GM_K3D_constK
128          _RL GM_K3D_Rmax
129          _RL GM_K3D_Rmin
130          _RL GM_K3D_minCori
131          _RL GM_K3D_minN2
132          _RL GM_K3D_surfMinDepth
133          _RL GM_K3D_vecFreq
134        _RL GM_facTrL2dz        _RL GM_facTrL2dz
135        _RL GM_facTrL2ML        _RL GM_facTrL2ML
136        _RL GM_maxTransLay        _RL GM_maxTransLay
137        _RL GM_Scrit        _RL GM_Scrit
138        _RL GM_Sd        _RL GM_Sd
139        COMMON /GM_PARAMS_R/        _RL GM_BVP_cMin
140          _RL subMeso_Ceff
141          _RL subMeso_invTau
142          _RL subMeso_LfMin
143          _RS subMeso_Lmax
144          COMMON /GM_PARAMS_RL/
145       &                   GM_isopycK, GM_background_K,       &                   GM_isopycK, GM_background_K,
146       &                   GM_maxSlope,       &                   GM_maxSlope,
147       &                   GM_Kmin_horiz,       &                   GM_Kmin_horiz,
# Line 83  C     GM_maxTransLay :: maximum Trans. L Line 150  C     GM_maxTransLay :: maximum Trans. L
150       &                   GM_Visbeck_depth,       &                   GM_Visbeck_depth,
151       &                   GM_Visbeck_minDepth, GM_Visbeck_maxSlope,       &                   GM_Visbeck_minDepth, GM_Visbeck_maxSlope,
152       &                   GM_Visbeck_minVal_K, GM_Visbeck_maxVal_K,       &                   GM_Visbeck_minVal_K, GM_Visbeck_maxVal_K,
153         &                   GM_K3D_gamma, GM_K3D_b1, GM_K3D_EadyMinDepth,
154         &                   GM_K3D_EadyMaxDepth, GM_K3D_Lambda,
155         &                   GM_K3D_smallK, GM_K3D_maxC,
156         &                   GM_maxK3D, GM_K3D_minCori, GM_K3D_minN2,
157         &                   GM_K3D_surfMinDepth, GM_K3D_Rmax, GM_K3D_Rmin,
158         &                   GM_K3D_constK, GM_K3D_vecFreq,
159       &                   GM_facTrL2dz, GM_facTrL2ML, GM_maxTransLay,       &                   GM_facTrL2dz, GM_facTrL2ML, GM_maxTransLay,
160       &                   GM_Scrit, GM_Sd       &                   GM_Scrit, GM_Sd, GM_BVP_cMin,
161         &                   subMeso_Ceff, subMeso_invTau, subMeso_LfMin
162          COMMON /GM_PARAMS_RS/
163         &                   subMeso_Lmax
164    
165  C--   COMMON /GM_DERIVED_PAR/ other GM/Redi parameters  C--   COMMON /GM_DERIVED_PAR/ other GM/Redi parameters
166  C     (derived from previous block and not directly user configured)  C     (derived from previous block and not directly user configured)
167        _RL GM_rMaxSlope        _RL GM_rMaxSlope
168        _RL GM_skewflx        _RL GM_skewflx
169        _RL GM_advect        _RL GM_advect
170          _RL GM_BVP_rModeNumber
171          _RL GM_BVP_cHat2Min
172        COMMON /GM_DERIVED_PAR/        COMMON /GM_DERIVED_PAR/
173       &                   GM_rMaxSlope,       &                   GM_rMaxSlope,
174       &                   GM_skewflx, GM_advect       &                   GM_skewflx, GM_advect,
175         &                   GM_BVP_rModeNumber, GM_BVP_cHat2Min
176    
177    
178  C--   COMMON /GM_COEFFICIENTS/ GM/Redi scaling coefficients  C--   COMMON /GM_COEFFICIENTS/ GM/Redi scaling coefficients
179  C     defined at grid-cell center (tracer location)  C     defined at grid-cell center (tracer location)
# Line 159  C     for Visbeck et al. parameterizatio Line 239  C     for Visbeck et al. parameterizatio
239        COMMON /GM_Visbeck/ VisbeckK        COMMON /GM_Visbeck/ VisbeckK
240  #endif  #endif
241    
242    #ifdef GM_K3D
243    C     K3D          :: The three dimensional eddy mixing coeffixint [m**2/s]
244          _RL K3D(1-Olx:sNx+Olx,1-Oly:sNy+Oly,1:Nr,nSx,nSy)
245          _RL modesC(1,1-Olx:sNx+Olx,1-Oly:sNy+Oly,1:Nr,nSx,nSy)
246          _RL modesW(GM_K3D_NModes,1-Olx:sNx+Olx,
247         &     1-Oly:sNy+Oly,1:Nr,nSx,nSy)
248          _RL modesS(GM_K3D_NModes,1-Olx:sNx+Olx,
249         &     1-Oly:sNy+Oly,1:Nr,nSx,nSy)
250          _RL Rdef(1-Olx:sNx+Olx,1-Oly:sNy+Oly,nSx,nSy)
251    
252    
253          COMMON /GM_K3D/ K3D, modesC, modesW, modesS, Rdef
254    #endif
255  #endif /* ALLOW_GMREDI */  #endif /* ALLOW_GMREDI */
256    
257  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
Legend:
Removed from v.1.17  
changed lines
  Added in v.1.27
  ViewVC Help
Powered by ViewVC 1.1.22