MOM6
Public variables and constants | List of all members
mom_hor_visc::hor_visc_cs Type Reference

Detailed Description

Definition at line 108 of file MOM_hor_visc.F90.

Collaboration diagram for mom_hor_visc::hor_visc_cs:
[legend]

Public variables and constants

logical laplacian
 
logical biharmonic
 
logical no_slip
 
logical bound_kh
 
logical better_bound_kh
 
logical bound_ah
 
logical better_bound_ah
 
real bound_coef
 
logical smagorinsky_kh
 
logical smagorinsky_ah
 
logical leith_kh
 
logical modified_leith
 
logical leith_ah
 
logical bound_coriolis
 
logical use_kh_bg_2d
 
real kh_bg_min
 
real, dimension(:, :), allocatable kh_bg_xx
 
real, dimension(:, :), allocatable kh_bg_2d
 
real, dimension(:, :), allocatable ah_bg_xx
 
real, dimension(:, :), allocatable kh_max_xx
 
real, dimension(:, :), allocatable ah_max_xx
 
real, dimension(:, :), allocatable biharm_const2_xx
 
real, dimension(:, :), allocatable reduction_xx
 
real, dimension(:, :), allocatable kh_bg_xy
 
real, dimension(:, :), allocatable ah_bg_xy
 
real, dimension(:, :), allocatable kh_max_xy
 
real, dimension(:, :), allocatable ah_max_xy
 
real, dimension(:, :), allocatable biharm_const2_xy
 
real, dimension(:, :), allocatable reduction_xy
 
real, dimension(:, :), allocatable dx2h
 
real, dimension(:, :), allocatable dy2h
 
real, dimension(:, :), allocatable dx_dyt
 
real, dimension(:, :), allocatable dy_dxt
 
real, dimension(:, :), allocatable dx2q
 
real, dimension(:, :), allocatable dy2q
 
real, dimension(:, :), allocatable dx_dybu
 
real, dimension(:, :), allocatable dy_dxbu
 
real, dimension(:, :), allocatable idx2dycu
 
real, dimension(:, :), allocatable idxdy2u
 
real, dimension(:, :), allocatable idx2dycv
 
real, dimension(:, :), allocatable idxdy2v
 
real, dimension(:, :), allocatable laplac_const_xx
 
real, dimension(:, :), allocatable biharm_const_xx
 
real, dimension(:, :), allocatable laplac3_const_xx
 
real, dimension(:, :), allocatable biharm5_const_xx
 
real, dimension(:, :), allocatable laplac_const_xy
 
real, dimension(:, :), allocatable biharm_const_xy
 
real, dimension(:, :), allocatable laplac3_const_xy
 
real, dimension(:, :), allocatable biharm5_const_xy
 
type(diag_ctrl), pointer diag
 
integer id_diffu = -1
 
integer id_diffv = -1
 
integer id_ah_h = -1
 
integer id_ah_q = -1
 
integer id_kh_h = -1
 
integer id_kh_q = -1
 
integer id_frictwork = -1
 
integer id_frictworkintz = -1
 

Variables and constants

◆ ah_bg_xx

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::ah_bg_xx

Definition at line 147 of file MOM_hor_visc.F90.

◆ ah_bg_xy

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::ah_bg_xy

Definition at line 167 of file MOM_hor_visc.F90.

◆ ah_max_xx

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::ah_max_xx

Definition at line 147 of file MOM_hor_visc.F90.

◆ ah_max_xy

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::ah_max_xy

Definition at line 167 of file MOM_hor_visc.F90.

◆ better_bound_ah

logical mom_hor_visc::hor_visc_cs::better_bound_ah

Definition at line 124 of file MOM_hor_visc.F90.

124  logical :: better_bound_ah ! If true, use a more careful bounding of the

◆ better_bound_kh

logical mom_hor_visc::hor_visc_cs::better_bound_kh

Definition at line 120 of file MOM_hor_visc.F90.

120  logical :: better_bound_kh ! If true, use a more careful bounding of the

◆ biharm5_const_xx

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::biharm5_const_xx

Definition at line 197 of file MOM_hor_visc.F90.

◆ biharm5_const_xy

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::biharm5_const_xy

Definition at line 203 of file MOM_hor_visc.F90.

◆ biharm_const2_xx

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::biharm_const2_xx

Definition at line 147 of file MOM_hor_visc.F90.

◆ biharm_const2_xy

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::biharm_const2_xy

Definition at line 167 of file MOM_hor_visc.F90.

◆ biharm_const_xx

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::biharm_const_xx

Definition at line 197 of file MOM_hor_visc.F90.

◆ biharm_const_xy

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::biharm_const_xy

Definition at line 203 of file MOM_hor_visc.F90.

◆ biharmonic

logical mom_hor_visc::hor_visc_cs::biharmonic

Definition at line 110 of file MOM_hor_visc.F90.

110  logical :: biharmonic ! Use a biharmonic horizontal viscosity if true.

◆ bound_ah

logical mom_hor_visc::hor_visc_cs::bound_ah

Definition at line 122 of file MOM_hor_visc.F90.

122  logical :: bound_ah ! If true, the biharmonic coefficient is locally

◆ bound_coef

real mom_hor_visc::hor_visc_cs::bound_coef

Definition at line 126 of file MOM_hor_visc.F90.

126  real :: bound_coef ! The nondimensional coefficient of the ratio of

◆ bound_coriolis

logical mom_hor_visc::hor_visc_cs::bound_coriolis

Definition at line 140 of file MOM_hor_visc.F90.

140  logical :: bound_coriolis ! If true & SMAGORINSKY_AH is used, the biharmonic

◆ bound_kh

logical mom_hor_visc::hor_visc_cs::bound_kh

Definition at line 118 of file MOM_hor_visc.F90.

118  logical :: bound_kh ! If true, the Laplacian coefficient is locally

◆ diag

type(diag_ctrl), pointer mom_hor_visc::hor_visc_cs::diag

Definition at line 209 of file MOM_hor_visc.F90.

209  type(diag_ctrl), pointer :: diag ! structure to regulate diagnostic timing

◆ dx2h

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::dx2h

Definition at line 184 of file MOM_hor_visc.F90.

184  real allocable_, dimension(NIMEM_,NJMEM_) :: &
185  dx2h, dy2h, & ! dx^2 and dy^2 at h points, in m2
186  dx_dyt, dy_dxt ! dx/dy and dy/dx at h points, nondim

◆ dx2q

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::dx2q

Definition at line 187 of file MOM_hor_visc.F90.

187  real allocable_, dimension(NIMEMB_PTR_,NJMEMB_PTR_) :: &
188  dx2q, dy2q, & ! dx^2 and dy^2 at q points, in m2
189  dx_dybu, dy_dxbu ! dx/dy and dy/dx at q points, nondim

◆ dx_dybu

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::dx_dybu

Definition at line 187 of file MOM_hor_visc.F90.

◆ dx_dyt

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::dx_dyt

Definition at line 184 of file MOM_hor_visc.F90.

◆ dy2h

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::dy2h

Definition at line 184 of file MOM_hor_visc.F90.

◆ dy2q

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::dy2q

Definition at line 187 of file MOM_hor_visc.F90.

◆ dy_dxbu

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::dy_dxbu

Definition at line 187 of file MOM_hor_visc.F90.

◆ dy_dxt

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::dy_dxt

Definition at line 184 of file MOM_hor_visc.F90.

◆ id_ah_h

integer mom_hor_visc::hor_visc_cs::id_ah_h = -1

Definition at line 213 of file MOM_hor_visc.F90.

213  integer :: id_ah_h = -1, id_ah_q = -1

◆ id_ah_q

integer mom_hor_visc::hor_visc_cs::id_ah_q = -1

Definition at line 213 of file MOM_hor_visc.F90.

◆ id_diffu

integer mom_hor_visc::hor_visc_cs::id_diffu = -1

Definition at line 212 of file MOM_hor_visc.F90.

212  integer :: id_diffu = -1, id_diffv = -1

◆ id_diffv

integer mom_hor_visc::hor_visc_cs::id_diffv = -1

Definition at line 212 of file MOM_hor_visc.F90.

◆ id_frictwork

integer mom_hor_visc::hor_visc_cs::id_frictwork = -1

Definition at line 215 of file MOM_hor_visc.F90.

215  integer :: id_frictwork = -1, id_frictworkintz = -1

◆ id_frictworkintz

integer mom_hor_visc::hor_visc_cs::id_frictworkintz = -1

Definition at line 215 of file MOM_hor_visc.F90.

◆ id_kh_h

integer mom_hor_visc::hor_visc_cs::id_kh_h = -1

Definition at line 214 of file MOM_hor_visc.F90.

214  integer :: id_kh_h = -1, id_kh_q = -1

◆ id_kh_q

integer mom_hor_visc::hor_visc_cs::id_kh_q = -1

Definition at line 214 of file MOM_hor_visc.F90.

◆ idx2dycu

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::idx2dycu

Definition at line 190 of file MOM_hor_visc.F90.

190  real allocable_, dimension(NIMEMB_PTR_,NJMEM_) :: &
191  idx2dycu, idxdy2u ! 1/(dx^2 dy) and 1/(dx dy^2) at u points, in m-3

◆ idx2dycv

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::idx2dycv

Definition at line 192 of file MOM_hor_visc.F90.

192  real allocable_, dimension(NIMEM_,NJMEMB_PTR_) :: &
193  idx2dycv, idxdy2v ! 1/(dx^2 dy) and 1/(dx dy^2) at v points, in m-3

◆ idxdy2u

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::idxdy2u

Definition at line 190 of file MOM_hor_visc.F90.

◆ idxdy2v

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::idxdy2v

Definition at line 192 of file MOM_hor_visc.F90.

◆ kh_bg_2d

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::kh_bg_2d

Definition at line 147 of file MOM_hor_visc.F90.

◆ kh_bg_min

real mom_hor_visc::hor_visc_cs::kh_bg_min

Definition at line 144 of file MOM_hor_visc.F90.

144  real :: kh_bg_min ! The minimum value allowed for Laplacian horizontal

◆ kh_bg_xx

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::kh_bg_xx

Definition at line 147 of file MOM_hor_visc.F90.

147  real allocable_, dimension(NIMEM_,NJMEM_) :: &
148  kh_bg_xx, &! The background Laplacian viscosity at h points, in units
149  ! of m2 s-1. The actual viscosity may be the larger of this
150  ! viscosity and the Smagorinsky and Leith viscosities.
151  kh_bg_2d, &! The background Laplacian viscosity at h points, in units
152  ! of m2 s-1. The actual viscosity may be the larger of this
153  ! viscosity and the Smagorinsky and Leith viscosities.
154  ah_bg_xx, &! The background biharmonic viscosity at h points, in units
155  ! of m4 s-1. The actual viscosity may be the larger of this
156  ! viscosity and the Smagorinsky and Leith viscosities.
157  kh_max_xx, &! The maximum permitted Laplacian viscosity, m2 s-1.
158  ah_max_xx, &! The maximum permitted biharmonic viscosity, m4 s-1.
159  biharm_const2_xx,&! A constant relating the biharmonic viscosity to the
160  ! square of the velocity shear, in m4 s. This value is
161  ! set to be the magnitude of the Coriolis terms once the
162  ! velocity differences reach a value of order 1/2 MAXVEL.
163 
164  reduction_xx ! The amount by which stresses through h points are reduced

◆ kh_bg_xy

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::kh_bg_xy

Definition at line 167 of file MOM_hor_visc.F90.

167  real allocable_, dimension(NIMEMB_PTR_,NJMEMB_PTR_) :: &
168  kh_bg_xy, &! The background Laplacian viscosity at q points, in units
169  ! of m2 s-1. The actual viscosity may be the larger of this
170  ! viscosity and the Smagorinsky and Leith viscosities.
171  ah_bg_xy, &! The background biharmonic viscosity at q points, in units
172  ! of m4 s-1. The actual viscosity may be the larger of this
173  ! viscosity and the Smagorinsky and Leith viscosities.
174  kh_max_xy, &! The maximum permitted Laplacian viscosity, m2 s-1.
175  ah_max_xy, &! The maximum permitted biharmonic viscosity, m4 s-1.
176  biharm_const2_xy,&! A constant relating the biharmonic viscosity to the
177  ! square of the velocity shear, in m4 s. This value is
178  ! set to be the magnitude of the Coriolis terms once the
179  ! velocity differences reach a value of order 1/2 MAXVEL.
180  reduction_xy ! The amount by which stresses through q points are reduced

◆ kh_max_xx

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::kh_max_xx

Definition at line 147 of file MOM_hor_visc.F90.

◆ kh_max_xy

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::kh_max_xy

Definition at line 167 of file MOM_hor_visc.F90.

◆ laplac3_const_xx

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::laplac3_const_xx

Definition at line 197 of file MOM_hor_visc.F90.

◆ laplac3_const_xy

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::laplac3_const_xy

Definition at line 203 of file MOM_hor_visc.F90.

◆ laplac_const_xx

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::laplac_const_xx

Definition at line 197 of file MOM_hor_visc.F90.

197  real allocable_, dimension(NIMEM_,NJMEM_) :: &
198  laplac_const_xx, & ! Laplacian metric-dependent constants (nondim)
199  biharm_const_xx, & ! Biharmonic metric-dependent constants (nondim)
200  laplac3_const_xx, & ! Laplacian metric-dependent constants (nondim)
201  biharm5_const_xx ! Biharmonic metric-dependent constants (nondim)

◆ laplac_const_xy

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::laplac_const_xy

Definition at line 203 of file MOM_hor_visc.F90.

203  real allocable_, dimension(NIMEMB_PTR_,NJMEMB_PTR_) :: &
204  laplac_const_xy, & ! Laplacian metric-dependent constants (nondim)
205  biharm_const_xy, & ! Biharmonic metric-dependent constants (nondim)
206  laplac3_const_xy, & ! Laplacian metric-dependent constants (nondim)
207  biharm5_const_xy ! Biharmonic metric-dependent constants (nondim)

◆ laplacian

logical mom_hor_visc::hor_visc_cs::laplacian

Definition at line 109 of file MOM_hor_visc.F90.

109  logical :: laplacian ! Use a Laplacian horizontal viscosity if true.

◆ leith_ah

logical mom_hor_visc::hor_visc_cs::leith_ah

Definition at line 138 of file MOM_hor_visc.F90.

138  logical :: leith_ah ! If true, use a biharmonic form of 2D Leith

◆ leith_kh

logical mom_hor_visc::hor_visc_cs::leith_kh

Definition at line 134 of file MOM_hor_visc.F90.

134  logical :: leith_kh ! If true, use 2D Leith nonlinear eddy

◆ modified_leith

logical mom_hor_visc::hor_visc_cs::modified_leith

Definition at line 136 of file MOM_hor_visc.F90.

136  logical :: modified_leith ! If true, use extra component of Leith viscosity

◆ no_slip

logical mom_hor_visc::hor_visc_cs::no_slip

Definition at line 111 of file MOM_hor_visc.F90.

111  logical :: no_slip ! If true, no slip boundary conditions are used.

◆ reduction_xx

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::reduction_xx

Definition at line 147 of file MOM_hor_visc.F90.

◆ reduction_xy

real, dimension( : , : ), allocatable mom_hor_visc::hor_visc_cs::reduction_xy

Definition at line 167 of file MOM_hor_visc.F90.

◆ smagorinsky_ah

logical mom_hor_visc::hor_visc_cs::smagorinsky_ah

Definition at line 132 of file MOM_hor_visc.F90.

132  logical :: smagorinsky_ah ! If true, use a biharmonic form of Smagorinsky

◆ smagorinsky_kh

logical mom_hor_visc::hor_visc_cs::smagorinsky_kh

Definition at line 130 of file MOM_hor_visc.F90.

130  logical :: smagorinsky_kh ! If true, use Smagorinsky nonlinear eddy

◆ use_kh_bg_2d

logical mom_hor_visc::hor_visc_cs::use_kh_bg_2d

Definition at line 143 of file MOM_hor_visc.F90.

143  logical :: use_kh_bg_2d ! Read 2d background viscosity from a file.
The documentation for this type was generated from the following file: