Detailed Description

Control structure for horizontal viscosity.

Definition at line 30 of file MOM_hor_visc.F90.

Collaboration diagram for mom_hor_visc::hor_visc_cs:

Public variables and constants
logical	laplacian
	Use a Laplacian horizontal viscosity if true. More...

logical	biharmonic
	Use a biharmonic horizontal viscosity if true. More...

logical	debug
	If true, write verbose checksums for debugging purposes. More...

logical	no_slip
	If true, no slip boundary conditions are used. Otherwise free slip boundary conditions are assumed. The implementation of the free slip boundary conditions on a C-grid is much cleaner than the no slip boundary conditions. The use of free slip b.c.s is strongly encouraged. The no slip b.c.s are not implemented with the biharmonic viscosity. More...

logical	bound_kh
	If true, the Laplacian coefficient is locally limited to guarantee stability. More...

logical	better_bound_kh
	If true, use a more careful bounding of the Laplacian viscosity to guarantee stability. More...

logical	bound_ah
	If true, the biharmonic coefficient is locally limited to guarantee stability. More...

logical	better_bound_ah
	If true, use a more careful bounding of the biharmonic viscosity to guarantee stability. More...

real	bound_coef
	The nondimensional coefficient of the ratio of the viscosity bounds to the theoretical maximum for stability without considering other terms [nondim]. The default is 0.8. More...

logical	smagorinsky_kh
	If true, use Smagorinsky nonlinear eddy viscosity. KH is the background value. More...

logical	smagorinsky_ah
	If true, use a biharmonic form of Smagorinsky nonlinear eddy viscosity. AH is the background. More...

logical	leith_kh
	If true, use 2D Leith nonlinear eddy viscosity. KH is the background value. More...

logical	modified_leith
	If true, use extra component of Leith viscosity to damp divergent flow. To use, still set Leith_Kh=.TRUE. More...

logical	use_beta_in_leith
	If true, includes the beta term in the Leith viscosity. More...

logical	leith_ah
	If true, use a biharmonic form of 2D Leith nonlinear eddy viscosity. AH is the background. More...

logical	use_qg_leith_visc
	If true, use QG Leith nonlinear eddy viscosity. KH is the background value. More...

logical	bound_coriolis
	If true & SMAGORINSKY_AH is used, the biharmonic viscosity is modified to include a term that scales quadratically with the velocity shears. More...

logical	use_kh_bg_2d
	Read 2d background viscosity from a file. More...

real	kh_bg_min
	The minimum value allowed for Laplacian horizontal viscosity [L2 T-1 ~> m2 s-1]. The default is 0.0. More...

logical	use_land_mask
	Use the land mask for the computation of thicknesses at velocity locations. This eliminates the dependence on arbitrary values over land or outside of the domain. Default is False to maintain answers with legacy experiments but should be changed to True for new experiments. More...

logical	anisotropic
	If true, allow anisotropic component to the viscosity. More...

logical	add_les_viscosity
	If true, adds the viscosity from Smagorinsky and Leith to the background viscosity instead of taking the maximum. More...

real	kh_aniso
	The anisotropic viscosity [L2 T-1 ~> m2 s-1]. More...

logical	dynamic_aniso
	If true, the anisotropic viscosity is recomputed as a function of state. This is set depending on ANISOTROPIC_MODE. More...

logical	res_scale_meke
	If true, the viscosity contribution from MEKE is scaled by the resolution function. More...

logical	use_gme
	If true, use GME backscatter scheme. More...

logical	answers_2018
	If true, use the order of arithmetic and expressions that recover the answers from the end of 2018. Otherwise, use updated and more robust forms of the same expressions. More...

real	gme_h0
	The strength of GME tapers quadratically to zero when the bathymetric depth is shallower than GME_H0 [Z ~> m]. More...

real	gme_efficiency
	The nondimensional prefactor multiplying the GME coefficient [nondim]. More...

real	gme_limiter
	The absolute maximum value the GME coefficient is allowed to take [L2 T-1 ~> m2 s-1]. More...

real, dimension(:, :), allocatable	kh_bg_xx
	The background Laplacian viscosity at h points [L2 T-1 ~> m2 s-1]. The actual viscosity may be the larger of this viscosity and the Smagorinsky and Leith viscosities. More...

real, dimension(:, :), allocatable	kh_bg_2d
	The background Laplacian viscosity at h points [L2 T-1 ~> m2 s-1]. The actual viscosity may be the larger of this viscosity and the Smagorinsky and Leith viscosities. More...

real, dimension(:, :), allocatable	ah_bg_xx
	The background biharmonic viscosity at h points [L4 T-1 ~> m4 s-1]. The actual viscosity may be the larger of this viscosity and the Smagorinsky and Leith viscosities. More...

real, dimension(:, :), allocatable	reduction_xx
	The amount by which stresses through h points are reduced due to partial barriers [nondim]. More...

real, dimension(:, :), allocatable	kh_max_xx
	The maximum permitted Laplacian viscosity [L2 T-1 ~> m2 s-1]. More...

real, dimension(:, :), allocatable	ah_max_xx
	The maximum permitted biharmonic viscosity [L4 T-1 ~> m4 s-1]. More...

real, dimension(:, :), allocatable	n1n2_h
	Factor n1*n2 in the anisotropic direction tensor at h-points. More...

real, dimension(:, :), allocatable	n1n1_m_n2n2_h
	Factor n12-n22 in the anisotropic direction tensor at h-points. More...

real, dimension(:, :), allocatable	kh_bg_xy
	The background Laplacian viscosity at q points [L2 T-1 ~> m2 s-1]. The actual viscosity may be the larger of this viscosity and the Smagorinsky and Leith viscosities. More...

real, dimension(:, :), allocatable	ah_bg_xy
	The background biharmonic viscosity at q points [L4 T-1 ~> m4 s-1]. The actual viscosity may be the larger of this viscosity and the Smagorinsky and Leith viscosities. More...

real, dimension(:, :), allocatable	reduction_xy
	The amount by which stresses through q points are reduced due to partial barriers [nondim]. More...

real, dimension(:, :), allocatable	kh_max_xy
	The maximum permitted Laplacian viscosity [L2 T-1 ~> m2 s-1]. More...

real, dimension(:, :), allocatable	ah_max_xy
	The maximum permitted biharmonic viscosity [L4 T-1 ~> m4 s-1]. More...

real, dimension(:, :), allocatable	n1n2_q
	Factor n1*n2 in the anisotropic direction tensor at q-points. More...

real, dimension(:, :), allocatable	n1n1_m_n2n2_q
	Factor n12-n22 in the anisotropic direction tensor at q-points. More...

real, dimension(:, :), allocatable	dx2h
	Pre-calculated dx^2 at h points [L2 ~> m2]. More...

real, dimension(:, :), allocatable	dy2h
	Pre-calculated dy^2 at h points [L2 ~> m2]. More...

real, dimension(:, :), allocatable	dx_dyt
	Pre-calculated dx/dy at h points [nondim]. More...

real, dimension(:, :), allocatable	dy_dxt
	Pre-calculated dy/dx at h points [nondim]. More...

real, dimension(:, :), allocatable	dx2q
	Pre-calculated dx^2 at q points [L2 ~> m2]. More...

real, dimension(:, :), allocatable	dy2q
	Pre-calculated dy^2 at q points [L2 ~> m2]. More...

real, dimension(:, :), allocatable	dx_dybu
	Pre-calculated dx/dy at q points [nondim]. More...

real, dimension(:, :), allocatable	dy_dxbu
	Pre-calculated dy/dx at q points [nondim]. More...

real, dimension(:, :), allocatable	idx2dycu
	1/(dx^2 dy) at u points [L-3 ~> m-3] More...

real, dimension(:, :), allocatable	idxdy2u
	1/(dx dy^2) at u points [L-3 ~> m-3] More...

real, dimension(:, :), allocatable	idx2dycv
	1/(dx^2 dy) at v points [L-3 ~> m-3] More...

real, dimension(:, :), allocatable	idxdy2v
	1/(dx dy^2) at v points [L-3 ~> m-3] More...

real, dimension(:, :), allocatable	laplac2_const_xx
	Laplacian metric-dependent constants [L2 ~> m2]. More...

real, dimension(:, :), allocatable	biharm5_const_xx
	Biharmonic metric-dependent constants [L5 ~> m5]. More...

real, dimension(:, :), allocatable	laplac3_const_xx
	Laplacian metric-dependent constants [L3 ~> m3]. More...

real, dimension(:, :), allocatable	biharm_const_xx
	Biharmonic metric-dependent constants [L4 ~> m4]. More...

real, dimension(:, :), allocatable	biharm_const2_xx
	Biharmonic metric-dependent constants [T L4 ~> s m4]. More...

real, dimension(:, :), allocatable	laplac2_const_xy
	Laplacian metric-dependent constants [L2 ~> m2]. More...

real, dimension(:, :), allocatable	biharm5_const_xy
	Biharmonic metric-dependent constants [L5 ~> m5]. More...

real, dimension(:, :), allocatable	laplac3_const_xy
	Laplacian metric-dependent constants [L3 ~> m3]. More...

real, dimension(:, :), allocatable	biharm_const_xy
	Biharmonic metric-dependent constants [L4 ~> m4]. More...

real, dimension(:, :), allocatable	biharm_const2_xy
	Biharmonic metric-dependent constants [T L4 ~> s m4]. More...

type(diag_ctrl), pointer	diag => NULL()
	structure to regulate diagnostics More...


integer	id_diffu = -1
	Diagnostic id. More...

integer	id_diffv = -1
	Diagnostic id. More...

integer	id_ah_h = -1
	Diagnostic id. More...

integer	id_ah_q = -1
	Diagnostic id. More...

integer	id_kh_h = -1
	Diagnostic id. More...

integer	id_kh_q = -1
	Diagnostic id. More...

integer	id_gme_coeff_h = -1
	Diagnostic id. More...

integer	id_gme_coeff_q = -1
	Diagnostic id. More...

integer	id_vort_xy_q = -1
	Diagnostic id. More...

integer	id_div_xx_h = -1
	Diagnostic id. More...

integer	id_frictwork = -1
	Diagnostic id. More...

integer	id_frictworkintz = -1
	Diagnostic id. More...

integer	id_frictwork_gme = -1
	Diagnostic id. More...

Variables and constants

◆ add_les_viscosity

logical mom_hor_visc::hor_visc_cs::add_les_viscosity

If true, adds the viscosity from Smagorinsky and Leith to the background viscosity instead of taking the maximum.

Definition at line 78 of file MOM_hor_visc.F90.

78 logical :: add_LES_viscosity!< If true, adds the viscosity from Smagorinsky and Leith to

◆ ah_bg_xx

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

The background biharmonic viscosity at h points [L4 T-1 ~> m4 s-1]. The actual viscosity may be the larger of this viscosity and the Smagorinsky and Leith viscosities.

A constant relating the biharmonic viscosity to the square of the velocity shear [L4 T ~> m4 s]. This value is set to be the magnitude of the Coriolis terms once the velocity differences reach a value of order 1/2 MAXVEL.

Definition at line 102 of file MOM_hor_visc.F90.

102 real ALLOCABLE_, dimension(NIMEM_,NJMEM_) :: Ah_bg_xx

◆ ah_bg_xy

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

The background biharmonic viscosity at q points [L4 T-1 ~> m4 s-1]. The actual viscosity may be the larger of this viscosity and the Smagorinsky and Leith viscosities.

A constant relating the biharmonic viscosity to the square of the velocity shear [L4 T ~> m4 s]. This value is set to be the magnitude of the Coriolis terms once the velocity differences reach a value of order 1/2 MAXVEL.

Definition at line 124 of file MOM_hor_visc.F90.

124 real ALLOCABLE_, dimension(NIMEMB_PTR_,NJMEMB_PTR_) :: Ah_bg_xy

◆ ah_max_xx

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

The maximum permitted biharmonic viscosity [L4 T-1 ~> m4 s-1].

Definition at line 114 of file MOM_hor_visc.F90.

◆ ah_max_xy

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

The maximum permitted biharmonic viscosity [L4 T-1 ~> m4 s-1].

Definition at line 136 of file MOM_hor_visc.F90.

◆ anisotropic

logical mom_hor_visc::hor_visc_cs::anisotropic

If true, allow anisotropic component to the viscosity.

Definition at line 77 of file MOM_hor_visc.F90.

77 logical :: anisotropic !< If true, allow anisotropic component to the viscosity.

◆ answers_2018

logical mom_hor_visc::hor_visc_cs::answers_2018

If true, use the order of arithmetic and expressions that recover the answers from the end of 2018. Otherwise, use updated and more robust forms of the same expressions.

Definition at line 86 of file MOM_hor_visc.F90.

86 logical :: answers_2018 !< If true, use the order of arithmetic and expressions that recover the

◆ better_bound_ah

logical mom_hor_visc::hor_visc_cs::better_bound_ah

If true, use a more careful bounding of the biharmonic viscosity to guarantee stability.

Definition at line 47 of file MOM_hor_visc.F90.

47 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

If true, use a more careful bounding of the Laplacian viscosity to guarantee stability.

Definition at line 43 of file MOM_hor_visc.F90.

43 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

Biharmonic metric-dependent constants [L5 ~> m5].

Definition at line 161 of file MOM_hor_visc.F90.

◆ biharm5_const_xy

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

Biharmonic metric-dependent constants [L5 ~> m5].

Definition at line 168 of file MOM_hor_visc.F90.

◆ biharm_const2_xx

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

Biharmonic metric-dependent constants [T L4 ~> s m4].

Definition at line 161 of file MOM_hor_visc.F90.

◆ biharm_const2_xy

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

Biharmonic metric-dependent constants [T L4 ~> s m4].

Definition at line 168 of file MOM_hor_visc.F90.

◆ biharm_const_xx

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

Biharmonic metric-dependent constants [L4 ~> m4].

Definition at line 161 of file MOM_hor_visc.F90.

◆ biharm_const_xy

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

Biharmonic metric-dependent constants [L4 ~> m4].

Definition at line 168 of file MOM_hor_visc.F90.

◆ biharmonic

logical mom_hor_visc::hor_visc_cs::biharmonic

Use a biharmonic horizontal viscosity if true.

Definition at line 32 of file MOM_hor_visc.F90.

32 logical :: biharmonic !< Use a biharmonic horizontal viscosity if true.

◆ bound_ah

logical mom_hor_visc::hor_visc_cs::bound_ah

If true, the biharmonic coefficient is locally limited to guarantee stability.

Definition at line 45 of file MOM_hor_visc.F90.

45 logical :: bound_Ah !< If true, the biharmonic coefficient is locally

◆ bound_coef

real mom_hor_visc::hor_visc_cs::bound_coef

The nondimensional coefficient of the ratio of the viscosity bounds to the theoretical maximum for stability without considering other terms [nondim]. The default is 0.8.

Definition at line 49 of file MOM_hor_visc.F90.

49 real :: bound_coef !< The nondimensional coefficient of the ratio of

◆ bound_coriolis

logical mom_hor_visc::hor_visc_cs::bound_coriolis

If true & SMAGORINSKY_AH is used, the biharmonic viscosity is modified to include a term that scales quadratically with the velocity shears.

Definition at line 66 of file MOM_hor_visc.F90.

66 logical :: bound_Coriolis !< If true & SMAGORINSKY_AH is used, the biharmonic

◆ bound_kh

logical mom_hor_visc::hor_visc_cs::bound_kh

If true, the Laplacian coefficient is locally limited to guarantee stability.

Definition at line 41 of file MOM_hor_visc.F90.

41 logical :: bound_Kh !< If true, the Laplacian coefficient is locally

◆ debug

logical mom_hor_visc::hor_visc_cs::debug

If true, write verbose checksums for debugging purposes.

Definition at line 33 of file MOM_hor_visc.F90.

33 logical :: debug !< If true, write verbose checksums for debugging purposes.

◆ diag

type(diag_ctrl), pointer mom_hor_visc::hor_visc_cs::diag => NULL()

structure to regulate diagnostics

Definition at line 175 of file MOM_hor_visc.F90.

175 type(diag_ctrl), pointer :: diag => null() !< structure to regulate diagnostics

◆ dx2h

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

Pre-calculated dx^2 at h points [L2 ~> m2].

Definition at line 142 of file MOM_hor_visc.F90.

   real ALLOCABLE_, dimension(NIMEM_,NJMEM_) :: &
     dx2h,   & !< Pre-calculated dx^2 at h points [L2 ~> m2]
     dy2h,   & !< Pre-calculated dy^2 at h points [L2 ~> m2]
     dx_dyT, & !< Pre-calculated dx/dy at h points [nondim]
     dy_dxT    !< Pre-calculated dy/dx at h points [nondim]

◆ dx2q

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

Pre-calculated dx^2 at q points [L2 ~> m2].

Definition at line 147 of file MOM_hor_visc.F90.

   real ALLOCABLE_, dimension(NIMEMB_PTR_,NJMEMB_PTR_) :: &
     dx2q,    & !< Pre-calculated dx^2 at q points [L2 ~> m2]
     dy2q,    & !< Pre-calculated dy^2 at q points [L2 ~> m2]
     dx_dyBu, & !< Pre-calculated dx/dy at q points [nondim]
     dy_dxBu    !< Pre-calculated dy/dx at q points [nondim]

◆ dx_dybu

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

Pre-calculated dx/dy at q points [nondim].

Definition at line 147 of file MOM_hor_visc.F90.

◆ dx_dyt

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

Pre-calculated dx/dy at h points [nondim].

Definition at line 142 of file MOM_hor_visc.F90.

◆ dy2h

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

Pre-calculated dy^2 at h points [L2 ~> m2].

Definition at line 142 of file MOM_hor_visc.F90.

◆ dy2q

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

Pre-calculated dy^2 at q points [L2 ~> m2].

Definition at line 147 of file MOM_hor_visc.F90.

◆ dy_dxbu

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

Pre-calculated dy/dx at q points [nondim].

Definition at line 147 of file MOM_hor_visc.F90.

◆ dy_dxt

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

Pre-calculated dy/dx at h points [nondim].

Definition at line 142 of file MOM_hor_visc.F90.

◆ dynamic_aniso

logical mom_hor_visc::hor_visc_cs::dynamic_aniso

If true, the anisotropic viscosity is recomputed as a function of state. This is set depending on ANISOTROPIC_MODE.

Definition at line 81 of file MOM_hor_visc.F90.

81 logical :: dynamic_aniso !< If true, the anisotropic viscosity is recomputed as a function

◆ gme_efficiency

real mom_hor_visc::hor_visc_cs::gme_efficiency

The nondimensional prefactor multiplying the GME coefficient [nondim].

Definition at line 91 of file MOM_hor_visc.F90.

91 real :: GME_efficiency !< The nondimensional prefactor multiplying the GME coefficient [nondim]

◆ gme_h0

real mom_hor_visc::hor_visc_cs::gme_h0

The strength of GME tapers quadratically to zero when the bathymetric depth is shallower than GME_H0 [Z ~> m].

Definition at line 89 of file MOM_hor_visc.F90.

89 real :: GME_h0 !< The strength of GME tapers quadratically to zero when the bathymetric

◆ gme_limiter

real mom_hor_visc::hor_visc_cs::gme_limiter

The absolute maximum value the GME coefficient is allowed to take [L2 T-1 ~> m2 s-1].

Definition at line 92 of file MOM_hor_visc.F90.

92 real :: GME_limiter !< The absolute maximum value the GME coefficient is allowed to take [L2 T-1 ~> m2 s-1].

◆ id_ah_h

integer mom_hor_visc::hor_visc_cs::id_ah_h = -1

Diagnostic id.

Definition at line 180 of file MOM_hor_visc.F90.

180 integer :: id_Ah_h = -1, id_ah_q = -1

◆ id_ah_q

integer mom_hor_visc::hor_visc_cs::id_ah_q = -1

Diagnostic id.

Definition at line 180 of file MOM_hor_visc.F90.

◆ id_diffu

integer mom_hor_visc::hor_visc_cs::id_diffu = -1

Diagnostic id.

Definition at line 179 of file MOM_hor_visc.F90.

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

◆ id_diffv

integer mom_hor_visc::hor_visc_cs::id_diffv = -1

Diagnostic id.

Definition at line 179 of file MOM_hor_visc.F90.

◆ id_div_xx_h

integer mom_hor_visc::hor_visc_cs::id_div_xx_h = -1

Diagnostic id.

Definition at line 183 of file MOM_hor_visc.F90.

◆ id_frictwork

integer mom_hor_visc::hor_visc_cs::id_frictwork = -1

Diagnostic id.

Definition at line 184 of file MOM_hor_visc.F90.

184 integer :: id_FrictWork = -1, id_frictworkintz = -1

◆ id_frictwork_gme

integer mom_hor_visc::hor_visc_cs::id_frictwork_gme = -1

Diagnostic id.

Definition at line 185 of file MOM_hor_visc.F90.

185 integer :: id_FrictWork_GME = -1

◆ id_frictworkintz

integer mom_hor_visc::hor_visc_cs::id_frictworkintz = -1

Diagnostic id.

Definition at line 184 of file MOM_hor_visc.F90.

◆ id_gme_coeff_h

integer mom_hor_visc::hor_visc_cs::id_gme_coeff_h = -1

Diagnostic id.

Definition at line 182 of file MOM_hor_visc.F90.

182 integer :: id_GME_coeff_h = -1, id_gme_coeff_q = -1

◆ id_gme_coeff_q

integer mom_hor_visc::hor_visc_cs::id_gme_coeff_q = -1

Diagnostic id.

Definition at line 182 of file MOM_hor_visc.F90.

◆ id_kh_h

integer mom_hor_visc::hor_visc_cs::id_kh_h = -1

Diagnostic id.

Definition at line 181 of file MOM_hor_visc.F90.

181 integer :: id_Kh_h = -1, id_kh_q = -1

◆ id_kh_q

integer mom_hor_visc::hor_visc_cs::id_kh_q = -1

Diagnostic id.

Definition at line 181 of file MOM_hor_visc.F90.

◆ id_vort_xy_q

integer mom_hor_visc::hor_visc_cs::id_vort_xy_q = -1

Diagnostic id.

Definition at line 183 of file MOM_hor_visc.F90.

183 integer :: id_vort_xy_q = -1, id_div_xx_h = -1

◆ idx2dycu

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

1/(dx^2 dy) at u points [L-3 ~> m-3]

Definition at line 152 of file MOM_hor_visc.F90.

   real ALLOCABLE_, dimension(NIMEMB_PTR_,NJMEM_) :: &
     Idx2dyCu, & !< 1/(dx^2 dy) at u points [L-3 ~> m-3]
     Idxdy2u     !< 1/(dx dy^2) at u points [L-3 ~> m-3]

◆ idx2dycv

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

1/(dx^2 dy) at v points [L-3 ~> m-3]

Definition at line 155 of file MOM_hor_visc.F90.

   real ALLOCABLE_, dimension(NIMEM_,NJMEMB_PTR_) :: &
     Idx2dyCv, & !< 1/(dx^2 dy) at v points [L-3 ~> m-3]
     Idxdy2v     !< 1/(dx dy^2) at v points [L-3 ~> m-3]

◆ idxdy2u

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

1/(dx dy^2) at u points [L-3 ~> m-3]

Definition at line 152 of file MOM_hor_visc.F90.

◆ idxdy2v

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

1/(dx dy^2) at v points [L-3 ~> m-3]

Definition at line 155 of file MOM_hor_visc.F90.

◆ kh_aniso

real mom_hor_visc::hor_visc_cs::kh_aniso

The anisotropic viscosity [L2 T-1 ~> m2 s-1].

Definition at line 80 of file MOM_hor_visc.F90.

80 real :: Kh_aniso !< The anisotropic viscosity [L2 T-1 ~> m2 s-1].

◆ kh_bg_2d

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

The background Laplacian viscosity at h points [L2 T-1 ~> m2 s-1]. The actual viscosity may be the larger of this viscosity and the Smagorinsky and Leith viscosities.

Definition at line 98 of file MOM_hor_visc.F90.

98 real ALLOCABLE_, dimension(NIMEM_,NJMEM_) :: Kh_bg_2d

◆ kh_bg_min

real mom_hor_visc::hor_visc_cs::kh_bg_min

The minimum value allowed for Laplacian horizontal viscosity [L2 T-1 ~> m2 s-1]. The default is 0.0.

Definition at line 70 of file MOM_hor_visc.F90.

70 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

The background Laplacian viscosity at h points [L2 T-1 ~> m2 s-1]. The actual viscosity may be the larger of this viscosity and the Smagorinsky and Leith viscosities.

Definition at line 94 of file MOM_hor_visc.F90.

94 real ALLOCABLE_, dimension(NIMEM_,NJMEM_) :: Kh_bg_xx

◆ kh_bg_xy

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

The background Laplacian viscosity at q points [L2 T-1 ~> m2 s-1]. The actual viscosity may be the larger of this viscosity and the Smagorinsky and Leith viscosities.

Definition at line 120 of file MOM_hor_visc.F90.

120 real ALLOCABLE_, dimension(NIMEMB_PTR_,NJMEMB_PTR_) :: Kh_bg_xy

◆ kh_max_xx

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

The maximum permitted Laplacian viscosity [L2 T-1 ~> m2 s-1].

Definition at line 114 of file MOM_hor_visc.F90.

   real ALLOCABLE_, dimension(NIMEM_,NJMEM_) :: &
     Kh_Max_xx,      & !< The maximum permitted Laplacian viscosity [L2 T-1 ~> m2 s-1].
     Ah_Max_xx,      & !< The maximum permitted biharmonic viscosity [L4 T-1 ~> m4 s-1].
     n1n2_h,         & !< Factor n1*n2 in the anisotropic direction tensor at h-points
     n1n1_m_n2n2_h     !< Factor n1**2-n2**2 in the anisotropic direction tensor at h-points

◆ kh_max_xy

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

The maximum permitted Laplacian viscosity [L2 T-1 ~> m2 s-1].

Definition at line 136 of file MOM_hor_visc.F90.

   real ALLOCABLE_, dimension(NIMEMB_PTR_,NJMEMB_PTR_) :: &
     Kh_Max_xy,      & !< The maximum permitted Laplacian viscosity [L2 T-1 ~> m2 s-1].
     Ah_Max_xy,      & !< The maximum permitted biharmonic viscosity [L4 T-1 ~> m4 s-1].
     n1n2_q,         & !< Factor n1*n2 in the anisotropic direction tensor at q-points
     n1n1_m_n2n2_q     !< Factor n1**2-n2**2 in the anisotropic direction tensor at q-points

◆ laplac2_const_xx

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

Laplacian metric-dependent constants [L2 ~> m2].

Definition at line 161 of file MOM_hor_visc.F90.

   real ALLOCABLE_, dimension(NIMEM_,NJMEM_) :: &
     Laplac2_const_xx, & !< Laplacian  metric-dependent constants [L2 ~> m2]
     Biharm5_const_xx, & !< Biharmonic metric-dependent constants [L5 ~> m5]
     Laplac3_const_xx, & !< Laplacian  metric-dependent constants [L3 ~> m3]
     Biharm_const_xx,  & !< Biharmonic metric-dependent constants [L4 ~> m4]
     Biharm_const2_xx    !< Biharmonic metric-dependent constants [T L4 ~> s m4]

◆ laplac2_const_xy

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

Laplacian metric-dependent constants [L2 ~> m2].

Definition at line 168 of file MOM_hor_visc.F90.

   real ALLOCABLE_, dimension(NIMEMB_PTR_,NJMEMB_PTR_) :: &
     Laplac2_const_xy, & !< Laplacian  metric-dependent constants [L2 ~> m2]
     Biharm5_const_xy, & !< Biharmonic metric-dependent constants [L5 ~> m5]
     Laplac3_const_xy, & !< Laplacian  metric-dependent constants [L3 ~> m3]
     Biharm_const_xy,  & !< Biharmonic metric-dependent constants [L4 ~> m4]
     Biharm_const2_xy    !< Biharmonic metric-dependent constants [T L4 ~> s m4]

◆ laplac3_const_xx

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

Laplacian metric-dependent constants [L3 ~> m3].

Definition at line 161 of file MOM_hor_visc.F90.

◆ laplac3_const_xy

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

Laplacian metric-dependent constants [L3 ~> m3].

Definition at line 168 of file MOM_hor_visc.F90.

◆ laplacian

logical mom_hor_visc::hor_visc_cs::laplacian

Use a Laplacian horizontal viscosity if true.

Definition at line 31 of file MOM_hor_visc.F90.

31 logical :: Laplacian !< Use a Laplacian horizontal viscosity if true.

◆ leith_ah

logical mom_hor_visc::hor_visc_cs::leith_ah

If true, use a biharmonic form of 2D Leith nonlinear eddy viscosity. AH is the background.

Definition at line 62 of file MOM_hor_visc.F90.

62 logical :: Leith_Ah !< If true, use a biharmonic form of 2D Leith

◆ leith_kh

logical mom_hor_visc::hor_visc_cs::leith_kh

If true, use 2D Leith nonlinear eddy viscosity. KH is the background value.

Definition at line 57 of file MOM_hor_visc.F90.

57 logical :: Leith_Kh !< If true, use 2D Leith nonlinear eddy

◆ modified_leith

logical mom_hor_visc::hor_visc_cs::modified_leith

If true, use extra component of Leith viscosity to damp divergent flow. To use, still set Leith_Kh=.TRUE.

Definition at line 59 of file MOM_hor_visc.F90.

59 logical :: Modified_Leith !< If true, use extra component of Leith viscosity

◆ n1n1_m_n2n2_h

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

Factor n1**2-n2**2 in the anisotropic direction tensor at h-points.

Definition at line 114 of file MOM_hor_visc.F90.

◆ n1n1_m_n2n2_q

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

Factor n1**2-n2**2 in the anisotropic direction tensor at q-points.

Definition at line 136 of file MOM_hor_visc.F90.

◆ n1n2_h

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

Factor n1*n2 in the anisotropic direction tensor at h-points.

Definition at line 114 of file MOM_hor_visc.F90.

◆ n1n2_q

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

Factor n1*n2 in the anisotropic direction tensor at q-points.

Definition at line 136 of file MOM_hor_visc.F90.

◆ no_slip

logical mom_hor_visc::hor_visc_cs::no_slip

If true, no slip boundary conditions are used. Otherwise free slip boundary conditions are assumed. The implementation of the free slip boundary conditions on a C-grid is much cleaner than the no slip boundary conditions. The use of free slip b.c.s is strongly encouraged. The no slip b.c.s are not implemented with the biharmonic viscosity.

Definition at line 34 of file MOM_hor_visc.F90.

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

◆ reduction_xx

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

The amount by which stresses through h points are reduced due to partial barriers [nondim].

Definition at line 111 of file MOM_hor_visc.F90.

111 real ALLOCABLE_, dimension(NIMEM_,NJMEM_) :: reduction_xx

◆ reduction_xy

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

The amount by which stresses through q points are reduced due to partial barriers [nondim].

Definition at line 133 of file MOM_hor_visc.F90.

133 real ALLOCABLE_, dimension(NIMEMB_PTR_,NJMEMB_PTR_) :: reduction_xy

◆ res_scale_meke

logical mom_hor_visc::hor_visc_cs::res_scale_meke

If true, the viscosity contribution from MEKE is scaled by the resolution function.

Definition at line 83 of file MOM_hor_visc.F90.

83 logical :: res_scale_MEKE !< If true, the viscosity contribution from MEKE is scaled by

◆ smagorinsky_ah

logical mom_hor_visc::hor_visc_cs::smagorinsky_ah

If true, use a biharmonic form of Smagorinsky nonlinear eddy viscosity. AH is the background.

Definition at line 55 of file MOM_hor_visc.F90.

55 logical :: Smagorinsky_Ah !< If true, use a biharmonic form of Smagorinsky

◆ smagorinsky_kh

logical mom_hor_visc::hor_visc_cs::smagorinsky_kh

If true, use Smagorinsky nonlinear eddy viscosity. KH is the background value.

Definition at line 53 of file MOM_hor_visc.F90.

53 logical :: Smagorinsky_Kh !< If true, use Smagorinsky nonlinear eddy

◆ use_beta_in_leith

logical mom_hor_visc::hor_visc_cs::use_beta_in_leith

If true, includes the beta term in the Leith viscosity.

Definition at line 61 of file MOM_hor_visc.F90.

61 logical :: use_beta_in_Leith !< If true, includes the beta term in the Leith viscosity

◆ use_gme

logical mom_hor_visc::hor_visc_cs::use_gme

If true, use GME backscatter scheme.

Definition at line 85 of file MOM_hor_visc.F90.

85 logical :: use_GME !< If true, use GME backscatter scheme.

◆ use_kh_bg_2d

logical mom_hor_visc::hor_visc_cs::use_kh_bg_2d

Read 2d background viscosity from a file.

Definition at line 69 of file MOM_hor_visc.F90.

69 logical :: use_Kh_bg_2d !< Read 2d background viscosity from a file.

◆ use_land_mask

logical mom_hor_visc::hor_visc_cs::use_land_mask

Use the land mask for the computation of thicknesses at velocity locations. This eliminates the dependence on arbitrary values over land or outside of the domain. Default is False to maintain answers with legacy experiments but should be changed to True for new experiments.

Definition at line 72 of file MOM_hor_visc.F90.

72 logical :: use_land_mask !< Use the land mask for the computation of thicknesses

◆ use_qg_leith_visc

logical mom_hor_visc::hor_visc_cs::use_qg_leith_visc

If true, use QG Leith nonlinear eddy viscosity. KH is the background value.

Definition at line 64 of file MOM_hor_visc.F90.

64 logical :: use_QG_Leith_visc !< If true, use QG Leith nonlinear eddy viscosity.

The documentation for this type was generated from the following file:

/glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/src/parameterizations/lateral/MOM_hor_visc.F90

Detailed Description

Public variables and constants

Variables and constants

◆ add_les_viscosity

◆ ah_bg_xx

◆ ah_bg_xy

◆ ah_max_xx

◆ ah_max_xy

◆ anisotropic

◆ answers_2018

◆ better_bound_ah

◆ better_bound_kh

◆ biharm5_const_xx

◆ biharm5_const_xy

◆ biharm_const2_xx

◆ biharm_const2_xy

◆ biharm_const_xx

◆ biharm_const_xy

◆ biharmonic

◆ bound_ah

◆ bound_coef

◆ bound_coriolis

◆ bound_kh

◆ debug

◆ diag

◆ dx2h

◆ dx2q

◆ dx_dybu

◆ dx_dyt

◆ dy2h

◆ dy2q

◆ dy_dxbu

◆ dy_dxt

◆ dynamic_aniso

◆ gme_efficiency

◆ gme_h0

◆ gme_limiter

◆ id_ah_h

◆ id_ah_q

◆ id_diffu

◆ id_diffv

◆ id_div_xx_h

◆ id_frictwork

◆ id_frictwork_gme

◆ id_frictworkintz

◆ id_gme_coeff_h

◆ id_gme_coeff_q

◆ id_kh_h

◆ id_kh_q

◆ id_vort_xy_q

◆ idx2dycu

◆ idx2dycv

◆ idxdy2u

◆ idxdy2v

◆ kh_aniso

◆ kh_bg_2d

◆ kh_bg_min

◆ kh_bg_xx

◆ kh_bg_xy

◆ kh_max_xx

◆ kh_max_xy

◆ laplac2_const_xx

◆ laplac2_const_xy

◆ laplac3_const_xx

◆ laplac3_const_xy

◆ laplacian

◆ leith_ah

◆ leith_kh

◆ modified_leith

◆ n1n1_m_n2n2_h

◆ n1n1_m_n2n2_q

◆ n1n2_h

◆ n1n2_q

◆ no_slip

◆ reduction_xx

◆ reduction_xy

◆ res_scale_meke

◆ smagorinsky_ah

◆ smagorinsky_kh

◆ use_beta_in_leith