MOM_MEKE_types.F90

module mom_meke_types

! This file is part of MOM6. See LICENSE.md for the license.

implicit none ; private

!> This type is used to exchange information related to the MEKE calculations.
type, public :: meke_type
  ! Variables
  real, dimension(:,:), pointer :: &
    meke => null(), &   !< Vertically averaged eddy kinetic energy [L2 T-2 ~> m2 s-2].
    gm_src => null(), & !< MEKE source due to thickness mixing (GM) [R Z L2 T-3 ~> W m-2].
    mom_src => null(),& !< MEKE source from lateral friction in the momentum equations [R Z L2 T-3 ~> W m-2].
    gme_snk => null(),& !< MEKE sink from GME backscatter in the momentum equations [R Z L2 T-3 ~> W m-2].
    kh => null(), &     !< The MEKE-derived lateral mixing coefficient [L2 T-1 ~> m2 s-1].
    kh_diff => null(), & !< Uses the non-MEKE-derived thickness diffusion coefficient to diffuse
                        !! MEKE [L2 T-1 ~> m2 s-1].
    rd_dx_h => null()   !< The deformation radius compared with the grid spacing [nondim].
                        !! Rd_dx_h is copied from VarMix_CS.
  real, dimension(:,:), pointer :: ku => null() !< The MEKE-derived lateral viscosity coefficient
                        !! [L2 T-1 ~> m2 s-1]. This viscosity can be negative when representing
                        !! backscatter from unresolved eddies (see Jansen and Held, 2014).
  real, dimension(:,:), pointer :: au => null() !< The MEKE-derived lateral biharmonic viscosity
                        !! coefficient [L4 T-1 ~> m4 s-1].
  ! Parameters
  real :: khth_fac = 1.0 !< Multiplier to map Kh(MEKE) to KhTh [nondim]
  real :: khtr_fac = 1.0 !< Multiplier to map Kh(MEKE) to KhTr [nondim].
  real :: backscatter_ro_pow = 0.0 !< Power in Rossby number function for backscatter.
  real :: backscatter_ro_c = 0.0 !< Coefficient in Rossby number function for backscatter.

end type meke_type

end module mom_meke_types