Detailed Description

Control structure that contains MEKE parameters and diagnostics handles.

Definition at line 31 of file MOM_MEKE.F90.

Collaboration diagram for mom_meke::meke_cs:

Public variables and constants
real, dimension(:,:), pointer	equilibrium_value => NULL()
	The equilbrium value of MEKE to be calculated at each time step [L2 T-2 ~> m2 s-2]. More...

real	meke_frcoeff
	Efficiency of conversion of ME into MEKE [nondim]. More...

real	meke_gmcoeff
	Efficiency of conversion of PE into MEKE [nondim]. More...

real	meke_gmecoeff
	Efficiency of conversion of MEKE into ME by GME [nondim]. More...

real	meke_damping
	Local depth-independent MEKE dissipation rate [T-1 ~> s-1]. More...

real	meke_cd_scale
	The ratio of the bottom eddy velocity to the column mean eddy velocity, i.e. sqrt(2*MEKE). This should be less than 1 to account for the surface intensification of MEKE. More...

real	meke_cb
	Coefficient in the $\gamma_{bot}$ expression [nondim]. More...

real	meke_min_gamma
	Minimum value of gamma_b^2 allowed [nondim]. More...

real	meke_ct
	Coefficient in the $\gamma_{bt}$ expression [nondim]. More...

logical	visc_drag
	If true use the vertvisc_type to calculate bottom drag. More...

logical	meke_geometric
	If true, uses the GM coefficient formulation from the GEOMETRIC framework (Marshall et al., 2012) More...

real	meke_geometric_alpha
	The nondimensional coefficient governing the efficiency of the GEOMETRIC thickness diffusion. More...

logical	meke_equilibrium_alt
	If true, use an alternative calculation for the equilibrium value of MEKE. More...

logical	meke_equilibrium_restoring
	If true, restore MEKE back to its equilibrium value, which is calculated at each time step. More...

logical	gm_src_alt
	If true, use the GM energy conversion form S^2N^2kappa rather than the streamfunction for the MEKE GM source term. More...

logical	rd_as_max_scale
	If true the length scale can not exceed the first baroclinic deformation radius. More...

logical	use_old_lscale
	Use the old formula for mixing length scale. More...

logical	use_min_lscale
	Use simple minimum for mixing length scale. More...

real	cdrag
	The bottom drag coefficient for MEKE [nondim]. More...

real	meke_bgsrc
	Background energy source for MEKE [L2 T-3 ~> W kg-1] (= m2 s-3). More...

real	meke_dtscale
	Scale factor to accelerate time-stepping [nondim]. More...

real	meke_khcoeff
	Scaling factor to convert MEKE into Kh [nondim]. More...

real	meke_uscale
	MEKE velocity scale for bottom drag [L T-1 ~> m s-1]. More...

real	meke_kh
	Background lateral diffusion of MEKE [L2 T-1 ~> m2 s-1]. More...

real	meke_k4
	Background bi-harmonic diffusivity (of MEKE) [L4 T-1 ~> m4 s-1]. More...

real	khmeke_fac
	A factor relating MEKEKh to the diffusivity used for MEKE itself [nondim]. More...

real	viscosity_coeff_ku
	The scaling coefficient in the expression for viscosity used to parameterize lateral harmonic momentum mixing by unresolved eddies represented by MEKE. More...

real	viscosity_coeff_au
	The scaling coefficient in the expression for viscosity used to parameterize lateral biharmonic momentum mixing by unresolved eddies represented by MEKE. More...

real	lfixed
	Fixed mixing length scale [L ~> m]. More...

real	adeform
	Weighting towards deformation scale of mixing length [nondim]. More...

real	arhines
	Weighting towards Rhines scale of mixing length [nondim]. More...

real	africt
	Weighting towards frictional arrest scale of mixing length [nondim]. More...

real	aeady
	Weighting towards Eady scale of mixing length [nondim]. More...

real	agrid
	Weighting towards grid scale of mixing length [nondim]. More...

real	meke_advection_factor
	A scaling in front of the advection of MEKE [nondim]. More...

real	meke_topographic_beta
	Weight for how much topographic beta is considered when computing beta in Rhines scale [nondim]. More...

real	meke_restoring_rate
	Inverse of the timescale used to nudge MEKE toward its equilibrium value [s-1]. More...

logical	kh_flux_enabled
	If true, lateral diffusive MEKE flux is enabled. More...

logical	initialize
	If True, invokes a steady state solver to calculate MEKE. More...

logical	debug
	If true, write out checksums of data for debugging. More...

type(diag_ctrl), pointer	diag => NULL()
	A type that regulates diagnostics output. More...


integer	id_meke = -1
	Diagnostic handles. More...

integer	id_ue = -1
	Diagnostic handles. More...

integer	id_kh = -1
	Diagnostic handles. More...

integer	id_src = -1
	Diagnostic handles. More...

integer	id_ub = -1
	Diagnostic handles. More...

integer	id_ut = -1
	Diagnostic handles. More...

integer	id_gm_src = -1
	Diagnostic handles. More...

integer	id_mom_src = -1
	Diagnostic handles. More...

integer	id_gme_snk = -1
	Diagnostic handles. More...

integer	id_decay = -1
	Diagnostic handles. More...

integer	id_khmeke_u = -1
	Diagnostic handles. More...

integer	id_khmeke_v = -1
	Diagnostic handles. More...

integer	id_ku = -1
	Diagnostic handles. More...

integer	id_au = -1
	Diagnostic handles. More...

integer	id_le = -1
	Diagnostic handles. More...

integer	id_gamma_b = -1
	Diagnostic handles. More...

integer	id_gamma_t = -1
	Diagnostic handles. More...

integer	id_lrhines = -1
	Diagnostic handles. More...

integer	id_leady = -1
	Diagnostic handles. More...

integer	id_meke_equilibrium = -1
	Diagnostic handles. More...

integer	id_clock_pass
	Clock for group pass calls. More...

type(group_pass_type)	pass_meke
	Group halo pass handle for MEKEMEKE and maybe MEKEKh_diff. More...

type(group_pass_type)	pass_kh
	Group halo pass handle for MEKEKh, MEKEKu, and/or MEKEAu. More...

Variables and constants

◆ adeform

real mom_meke::meke_cs::adeform

Weighting towards deformation scale of mixing length [nondim].

Definition at line 76 of file MOM_MEKE.F90.

76 real :: aDeform !< Weighting towards deformation scale of mixing length [nondim]

◆ aeady

real mom_meke::meke_cs::aeady

Weighting towards Eady scale of mixing length [nondim].

Definition at line 79 of file MOM_MEKE.F90.

79 real :: aEady !< Weighting towards Eady scale of mixing length [nondim]

◆ africt

real mom_meke::meke_cs::africt

Weighting towards frictional arrest scale of mixing length [nondim].

Definition at line 78 of file MOM_MEKE.F90.

78 real :: aFrict !< Weighting towards frictional arrest scale of mixing length [nondim]

◆ agrid

real mom_meke::meke_cs::agrid

Weighting towards grid scale of mixing length [nondim].

Definition at line 80 of file MOM_MEKE.F90.

80 real :: aGrid !< Weighting towards grid scale of mixing length [nondim]

◆ arhines

real mom_meke::meke_cs::arhines

Weighting towards Rhines scale of mixing length [nondim].

Definition at line 77 of file MOM_MEKE.F90.

77 real :: aRhines !< Weighting towards Rhines scale of mixing length [nondim]

◆ cdrag

real mom_meke::meke_cs::cdrag

The bottom drag coefficient for MEKE [nondim].

Definition at line 60 of file MOM_MEKE.F90.

60 real :: cdrag !< The bottom drag coefficient for MEKE [nondim].

◆ debug

logical mom_meke::meke_cs::debug

If true, write out checksums of data for debugging.

Definition at line 88 of file MOM_MEKE.F90.

88 logical :: debug !< If true, write out checksums of data for debugging

◆ diag

type(diag_ctrl), pointer mom_meke::meke_cs::diag => NULL()

A type that regulates diagnostics output.

Definition at line 90 of file MOM_MEKE.F90.

90 type(diag_ctrl), pointer :: diag => null() !< A type that regulates diagnostics output

◆ equilibrium_value

real, dimension(:,:), pointer mom_meke::meke_cs::equilibrium_value => NULL()

The equilbrium value of MEKE to be calculated at each time step [L2 T-2 ~> m2 s-2].

Definition at line 33 of file MOM_MEKE.F90.

33 real, dimension(:,:), pointer :: equilibrium_value => null() !< The equilbrium value

◆ gm_src_alt

logical mom_meke::meke_cs::gm_src_alt

If true, use the GM energy conversion form S^2*N^2*kappa rather than the streamfunction for the MEKE GM source term.

Definition at line 54 of file MOM_MEKE.F90.

54 logical :: GM_src_alt !< If true, use the GM energy conversion form S^2*N^2*kappa rather

◆ id_au

integer mom_meke::meke_cs::id_au = -1

Diagnostic handles.

Definition at line 95 of file MOM_MEKE.F90.

◆ id_clock_pass

integer mom_meke::meke_cs::id_clock_pass

Clock for group pass calls.

Definition at line 102 of file MOM_MEKE.F90.

102 integer :: id_clock_pass !< Clock for group pass calls

◆ id_decay

integer mom_meke::meke_cs::id_decay = -1

Diagnostic handles.

Definition at line 94 of file MOM_MEKE.F90.

◆ id_gamma_b

integer mom_meke::meke_cs::id_gamma_b = -1

Diagnostic handles.

Definition at line 96 of file MOM_MEKE.F90.

◆ id_gamma_t

integer mom_meke::meke_cs::id_gamma_t = -1

Diagnostic handles.

Definition at line 96 of file MOM_MEKE.F90.

◆ id_gm_src

integer mom_meke::meke_cs::id_gm_src = -1

Diagnostic handles.

Definition at line 94 of file MOM_MEKE.F90.

94 integer :: id_GM_src = -1, id_mom_src = -1, id_gme_snk = -1, id_decay = -1

◆ id_gme_snk

integer mom_meke::meke_cs::id_gme_snk = -1

Diagnostic handles.

Definition at line 94 of file MOM_MEKE.F90.

◆ id_kh

integer mom_meke::meke_cs::id_kh = -1

Diagnostic handles.

Definition at line 92 of file MOM_MEKE.F90.

◆ id_khmeke_u

integer mom_meke::meke_cs::id_khmeke_u = -1

Diagnostic handles.

Definition at line 95 of file MOM_MEKE.F90.

95 integer :: id_KhMEKE_u = -1, id_khmeke_v = -1, id_ku = -1, id_au = -1

◆ id_khmeke_v

integer mom_meke::meke_cs::id_khmeke_v = -1

Diagnostic handles.

Definition at line 95 of file MOM_MEKE.F90.

◆ id_ku

integer mom_meke::meke_cs::id_ku = -1

Diagnostic handles.

Definition at line 95 of file MOM_MEKE.F90.

◆ id_le

integer mom_meke::meke_cs::id_le = -1

Diagnostic handles.

Definition at line 96 of file MOM_MEKE.F90.

96 integer :: id_Le = -1, id_gamma_b = -1, id_gamma_t = -1

◆ id_leady

integer mom_meke::meke_cs::id_leady = -1

Diagnostic handles.

Definition at line 97 of file MOM_MEKE.F90.

◆ id_lrhines

integer mom_meke::meke_cs::id_lrhines = -1

Diagnostic handles.

Definition at line 97 of file MOM_MEKE.F90.

97 integer :: id_Lrhines = -1, id_leady = -1

◆ id_meke

integer mom_meke::meke_cs::id_meke = -1

Diagnostic handles.

Definition at line 92 of file MOM_MEKE.F90.

92 integer :: id_MEKE = -1, id_ue = -1, id_kh = -1, id_src = -1

◆ id_meke_equilibrium

integer mom_meke::meke_cs::id_meke_equilibrium = -1

Diagnostic handles.

Definition at line 98 of file MOM_MEKE.F90.

98 integer :: id_MEKE_equilibrium = -1

◆ id_mom_src

integer mom_meke::meke_cs::id_mom_src = -1

Diagnostic handles.

Definition at line 94 of file MOM_MEKE.F90.

◆ id_src

integer mom_meke::meke_cs::id_src = -1

Diagnostic handles.

Definition at line 92 of file MOM_MEKE.F90.

◆ id_ub

integer mom_meke::meke_cs::id_ub = -1

Diagnostic handles.

Definition at line 93 of file MOM_MEKE.F90.

93 integer :: id_Ub = -1, id_ut = -1

◆ id_ue

integer mom_meke::meke_cs::id_ue = -1

Diagnostic handles.

Definition at line 92 of file MOM_MEKE.F90.

◆ id_ut

integer mom_meke::meke_cs::id_ut = -1

Diagnostic handles.

Definition at line 93 of file MOM_MEKE.F90.

◆ initialize

logical mom_meke::meke_cs::initialize

If True, invokes a steady state solver to calculate MEKE.

Definition at line 87 of file MOM_MEKE.F90.

87 logical :: initialize !< If True, invokes a steady state solver to calculate MEKE.

◆ kh_flux_enabled

logical mom_meke::meke_cs::kh_flux_enabled

If true, lateral diffusive MEKE flux is enabled.

Definition at line 86 of file MOM_MEKE.F90.

86 logical :: kh_flux_enabled !< If true, lateral diffusive MEKE flux is enabled.

◆ khmeke_fac

real mom_meke::meke_cs::khmeke_fac

A factor relating MEKEKh to the diffusivity used for MEKE itself [nondim].

Definition at line 67 of file MOM_MEKE.F90.

67 real :: KhMEKE_Fac !< A factor relating MEKE%Kh to the diffusivity used for

◆ lfixed

real mom_meke::meke_cs::lfixed

Fixed mixing length scale [L ~> m].

Definition at line 75 of file MOM_MEKE.F90.

75 real :: Lfixed !< Fixed mixing length scale [L ~> m].

◆ meke_advection_factor

real mom_meke::meke_cs::meke_advection_factor

A scaling in front of the advection of MEKE [nondim].

Definition at line 81 of file MOM_MEKE.F90.

81 real :: MEKE_advection_factor !< A scaling in front of the advection of MEKE [nondim]

◆ meke_bgsrc

real mom_meke::meke_cs::meke_bgsrc

Background energy source for MEKE [L2 T-3 ~> W kg-1] (= m2 s-3).

Definition at line 61 of file MOM_MEKE.F90.

61 real :: MEKE_BGsrc !< Background energy source for MEKE [L2 T-3 ~> W kg-1] (= m2 s-3).

◆ meke_cb

real mom_meke::meke_cs::meke_cb

Coefficient in the $\gamma_{bot}$ expression [nondim].

Definition at line 42 of file MOM_MEKE.F90.

42 real :: MEKE_Cb !< Coefficient in the \f$\gamma_{bot}\f$ expression [nondim]

◆ meke_cd_scale

real mom_meke::meke_cs::meke_cd_scale

The ratio of the bottom eddy velocity to the column mean eddy velocity, i.e. sqrt(2*MEKE). This should be less than 1 to account for the surface intensification of MEKE.

Definition at line 39 of file MOM_MEKE.F90.

39 real :: MEKE_Cd_scale !< The ratio of the bottom eddy velocity to the column mean

◆ meke_ct

real mom_meke::meke_cs::meke_ct

Coefficient in the $\gamma_{bt}$ expression [nondim].

Definition at line 44 of file MOM_MEKE.F90.

44 real :: MEKE_Ct !< Coefficient in the \f$\gamma_{bt}\f$ expression [nondim]

◆ meke_damping

real mom_meke::meke_cs::meke_damping

Local depth-independent MEKE dissipation rate [T-1 ~> s-1].

Definition at line 38 of file MOM_MEKE.F90.

38 real :: MEKE_damping !< Local depth-independent MEKE dissipation rate [T-1 ~> s-1].

◆ meke_dtscale

real mom_meke::meke_cs::meke_dtscale

Scale factor to accelerate time-stepping [nondim].

Definition at line 62 of file MOM_MEKE.F90.

62 real :: MEKE_dtScale !< Scale factor to accelerate time-stepping [nondim]

◆ meke_equilibrium_alt

logical mom_meke::meke_cs::meke_equilibrium_alt

If true, use an alternative calculation for the equilibrium value of MEKE.

Definition at line 50 of file MOM_MEKE.F90.

50 logical :: MEKE_equilibrium_alt !< If true, use an alternative calculation for the

◆ meke_equilibrium_restoring

logical mom_meke::meke_cs::meke_equilibrium_restoring

If true, restore MEKE back to its equilibrium value, which is calculated at each time step.

Definition at line 52 of file MOM_MEKE.F90.

52 logical :: MEKE_equilibrium_restoring !< If true, restore MEKE back to its equilibrium value,

◆ meke_frcoeff

real mom_meke::meke_cs::meke_frcoeff

Efficiency of conversion of ME into MEKE [nondim].

Definition at line 35 of file MOM_MEKE.F90.

35 real :: MEKE_FrCoeff !< Efficiency of conversion of ME into MEKE [nondim]

◆ meke_geometric

logical mom_meke::meke_cs::meke_geometric

If true, uses the GM coefficient formulation from the GEOMETRIC framework (Marshall et al., 2012)

Definition at line 46 of file MOM_MEKE.F90.

46 logical :: MEKE_GEOMETRIC !< If true, uses the GM coefficient formulation from the GEOMETRIC

◆ meke_geometric_alpha

real mom_meke::meke_cs::meke_geometric_alpha

The nondimensional coefficient governing the efficiency of the GEOMETRIC thickness diffusion.

Definition at line 48 of file MOM_MEKE.F90.

48 real :: MEKE_GEOMETRIC_alpha !< The nondimensional coefficient governing the efficiency of the

◆ meke_gmcoeff

real mom_meke::meke_cs::meke_gmcoeff

Efficiency of conversion of PE into MEKE [nondim].

Definition at line 36 of file MOM_MEKE.F90.

36 real :: MEKE_GMcoeff !< Efficiency of conversion of PE into MEKE [nondim]

◆ meke_gmecoeff

real mom_meke::meke_cs::meke_gmecoeff

Efficiency of conversion of MEKE into ME by GME [nondim].

Definition at line 37 of file MOM_MEKE.F90.

37 real :: MEKE_GMECoeff !< Efficiency of conversion of MEKE into ME by GME [nondim]

◆ meke_k4

real mom_meke::meke_cs::meke_k4

Background bi-harmonic diffusivity (of MEKE) [L4 T-1 ~> m4 s-1].

Definition at line 66 of file MOM_MEKE.F90.

66 real :: MEKE_K4 !< Background bi-harmonic diffusivity (of MEKE) [L4 T-1 ~> m4 s-1]

◆ meke_kh

real mom_meke::meke_cs::meke_kh

Background lateral diffusion of MEKE [L2 T-1 ~> m2 s-1].

Definition at line 65 of file MOM_MEKE.F90.

65 real :: MEKE_KH !< Background lateral diffusion of MEKE [L2 T-1 ~> m2 s-1]

◆ meke_khcoeff

real mom_meke::meke_cs::meke_khcoeff

Scaling factor to convert MEKE into Kh [nondim].

Definition at line 63 of file MOM_MEKE.F90.

63 real :: MEKE_KhCoeff !< Scaling factor to convert MEKE into Kh [nondim]

◆ meke_min_gamma

real mom_meke::meke_cs::meke_min_gamma

Minimum value of gamma_b^2 allowed [nondim].

Definition at line 43 of file MOM_MEKE.F90.

43 real :: MEKE_min_gamma!< Minimum value of gamma_b^2 allowed [nondim]

◆ meke_restoring_rate

real mom_meke::meke_cs::meke_restoring_rate

Inverse of the timescale used to nudge MEKE toward its equilibrium value [s-1].

Definition at line 84 of file MOM_MEKE.F90.

84 real :: MEKE_restoring_rate !< Inverse of the timescale used to nudge MEKE toward its equilibrium value [s-1].

◆ meke_topographic_beta

real mom_meke::meke_cs::meke_topographic_beta

Weight for how much topographic beta is considered when computing beta in Rhines scale [nondim].

Definition at line 82 of file MOM_MEKE.F90.

82 real :: MEKE_topographic_beta !< Weight for how much topographic beta is considered

◆ meke_uscale

real mom_meke::meke_cs::meke_uscale

MEKE velocity scale for bottom drag [L T-1 ~> m s-1].

Definition at line 64 of file MOM_MEKE.F90.

64 real :: MEKE_Uscale !< MEKE velocity scale for bottom drag [L T-1 ~> m s-1]

◆ pass_kh

type(group_pass_type) mom_meke::meke_cs::pass_kh

Group halo pass handle for MEKEKh, MEKEKu, and/or MEKEAu.

Definition at line 104 of file MOM_MEKE.F90.

104 type(group_pass_type) :: pass_Kh !< Group halo pass handle for MEKE%Kh, MEKE%Ku, and/or MEKE%Au

◆ pass_meke

type(group_pass_type) mom_meke::meke_cs::pass_meke

Group halo pass handle for MEKEMEKE and maybe MEKEKh_diff.

Definition at line 103 of file MOM_MEKE.F90.

103 type(group_pass_type) :: pass_MEKE !< Group halo pass handle for MEKE%MEKE and maybe MEKE%Kh_diff

◆ rd_as_max_scale

logical mom_meke::meke_cs::rd_as_max_scale

If true the length scale can not exceed the first baroclinic deformation radius.

Definition at line 56 of file MOM_MEKE.F90.

56 logical :: Rd_as_max_scale !< If true the length scale can not exceed the

◆ use_min_lscale

logical mom_meke::meke_cs::use_min_lscale

Use simple minimum for mixing length scale.

Definition at line 59 of file MOM_MEKE.F90.

59 logical :: use_min_lscale !< Use simple minimum for mixing length scale.

◆ use_old_lscale

logical mom_meke::meke_cs::use_old_lscale

Use the old formula for mixing length scale.

Definition at line 58 of file MOM_MEKE.F90.

58 logical :: use_old_lscale !< Use the old formula for mixing length scale.

◆ visc_drag

logical mom_meke::meke_cs::visc_drag

If true use the vertvisc_type to calculate bottom drag.

Definition at line 45 of file MOM_MEKE.F90.

45 logical :: visc_drag !< If true use the vertvisc_type to calculate bottom drag.

◆ viscosity_coeff_au

real mom_meke::meke_cs::viscosity_coeff_au

The scaling coefficient in the expression for viscosity used to parameterize lateral biharmonic momentum mixing by unresolved eddies represented by MEKE.

Definition at line 72 of file MOM_MEKE.F90.

72 real :: viscosity_coeff_Au !< The scaling coefficient in the expression for

◆ viscosity_coeff_ku

real mom_meke::meke_cs::viscosity_coeff_ku

The scaling coefficient in the expression for viscosity used to parameterize lateral harmonic momentum mixing by unresolved eddies represented by MEKE.

Definition at line 69 of file MOM_MEKE.F90.

69 real :: viscosity_coeff_Ku !< The scaling coefficient in the expression for

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_MEKE.F90

Detailed Description

Public variables and constants

Variables and constants

◆ adeform

◆ aeady

◆ africt

◆ agrid

◆ arhines

◆ cdrag

◆ debug

◆ diag

◆ equilibrium_value

◆ gm_src_alt

◆ id_au

◆ id_clock_pass

◆ id_decay

◆ id_gamma_b

◆ id_gamma_t

◆ id_gm_src

◆ id_gme_snk

◆ id_kh

◆ id_khmeke_u

◆ id_khmeke_v

◆ id_ku

◆ id_le

◆ id_leady

◆ id_lrhines

◆ id_meke

◆ id_meke_equilibrium

◆ id_mom_src

◆ id_src

◆ id_ub

◆ id_ue

◆ id_ut

◆ initialize

◆ kh_flux_enabled

◆ khmeke_fac

◆ lfixed

◆ meke_advection_factor

◆ meke_bgsrc

◆ meke_cb

◆ meke_cd_scale

◆ meke_ct

◆ meke_damping

◆ meke_dtscale

◆ meke_equilibrium_alt

◆ meke_equilibrium_restoring

◆ meke_frcoeff

◆ meke_geometric

◆ meke_geometric_alpha

◆ meke_gmcoeff

◆ meke_gmecoeff

◆ meke_k4

◆ meke_kh

◆ meke_khcoeff

◆ meke_min_gamma

◆ meke_restoring_rate

◆ meke_topographic_beta

◆ meke_uscale

◆ pass_kh

◆ pass_meke

◆ rd_as_max_scale

◆ use_min_lscale

◆ use_old_lscale

◆ visc_drag

◆ viscosity_coeff_au

◆ viscosity_coeff_ku