MOM6
mom_meke::meke_cs Type Reference

Detailed Description

Control structure that contains MEKE parameters and diagnostics handles.

Definition at line 29 of file MOM_MEKE.F90.

Collaboration diagram for mom_meke::meke_cs:
[legend]

Public variables and constants

real meke_frcoeff
 Efficiency of conversion of ME into MEKE (non-dim) More...
 
real meke_gmcoeff
 Efficiency of conversion of PE into MEKE (non-dim) More...
 
real meke_damping
 Local depth-independent MEKE dissipation rate in 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 (non-dim) More...
 
real meke_min_gamma
 Minimum value of gamma_b^2 allowed (non-dim) More...
 
real meke_ct
 Coefficient in the \(\gamma_{bt}\) expression (non-dim) More...
 
logical visc_drag
 If true use the vertvisc_type to calculate bottom drag. 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...
 
real cdrag
 The bottom drag coefficient for MEKE (non-dim). More...
 
real meke_bgsrc
 Background energy source for MEKE in W/kg (= m2 s-3). More...
 
real meke_dtscale
 Scale factor to accelerate time-stepping (non-dim.) More...
 
real meke_khcoeff
 Scaling factor to convert MEKE into Kh (non-dim.) More...
 
real meke_uscale
 MEKE velocity scale for bottom drag (m/s) More...
 
real meke_kh
 Background lateral diffusion of MEKE (m^2/s) More...
 
real meke_k4
 Background bi-harmonic diffusivity (of MEKE) (m^4/s) More...
 
real khmeke_fac
 A factor relating MEKEKh to the diffusivity used for MEKE itself (nondimensional). More...
 
real viscosity_coeff
 The scaling coefficient in the expression for viscosity used to parameterize lateral momentum mixing by unresolved eddies represented by MEKE. More...
 
real lfixed
 Fixed mixing length scale, in m. More...
 
real adeform
 Weighting towards deformation scale of mixing length (non-dim.) More...
 
real arhines
 Weighting towards Rhines scale of mixing length (non-dim.) More...
 
real africt
 Weighting towards frictional arrest scale of mixing length (non-dim.) More...
 
real aeady
 Weighting towards Eady scale of mixing length (non-dim.) More...
 
real agrid
 Weighting towards grid scale of mixing length (non-dim.) More...
 
real meke_advection_factor
 A scaling in front of the advection of MEKE (non-dim.) 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...
 
real, dimension(:,:), allocatable del2meke
 
type(diag_ctrl), pointer diag
 A pointer to shared diagnostics data. More...
 
integer id_meke = -1
 
integer id_ue = -1
 
integer id_kh = -1
 
integer id_src = -1
 
integer id_ub = -1
 
integer id_ut = -1
 
integer id_gm_src = -1
 
integer id_mom_src = -1
 
integer id_decay = -1
 
integer id_khmeke_u = -1
 
integer id_khmeke_v = -1
 
integer id_ku = -1
 
integer id_le = -1
 
integer id_gamma_b = -1
 
integer id_gamma_t = -1
 
integer id_lrhines = -1
 
integer id_leady = -1
 
integer id_clock_pass
 Clock for group pass calls. More...
 
type(group_pass_type) pass_meke
 
type(group_pass_type) pass_kh
 
type(group_pass_type) pass_ku
 
type(group_pass_type) pass_del2meke
 Type for group-halo pass calls. More...
 

Variables and constants

◆ adeform

real mom_meke::meke_cs::adeform

Weighting towards deformation scale of mixing length (non-dim.)

Definition at line 57 of file MOM_MEKE.F90.

57  real :: adeform !< Weighting towards deformation scale of mixing length (non-dim.)

◆ aeady

real mom_meke::meke_cs::aeady

Weighting towards Eady scale of mixing length (non-dim.)

Definition at line 60 of file MOM_MEKE.F90.

60  real :: aeady !< Weighting towards Eady scale of mixing length (non-dim.)

◆ africt

real mom_meke::meke_cs::africt

Weighting towards frictional arrest scale of mixing length (non-dim.)

Definition at line 59 of file MOM_MEKE.F90.

59  real :: africt !< Weighting towards frictional arrest scale of mixing length (non-dim.)

◆ agrid

real mom_meke::meke_cs::agrid

Weighting towards grid scale of mixing length (non-dim.)

Definition at line 61 of file MOM_MEKE.F90.

61  real :: agrid !< Weighting towards grid scale of mixing length (non-dim.)

◆ arhines

real mom_meke::meke_cs::arhines

Weighting towards Rhines scale of mixing length (non-dim.)

Definition at line 58 of file MOM_MEKE.F90.

58  real :: arhines !< Weighting towards Rhines scale of mixing length (non-dim.)

◆ cdrag

real mom_meke::meke_cs::cdrag

The bottom drag coefficient for MEKE (non-dim).

Definition at line 44 of file MOM_MEKE.F90.

44  real :: cdrag !< The bottom drag coefficient for MEKE (non-dim).

◆ debug

logical mom_meke::meke_cs::debug

If true, write out checksums of data for debugging.

Definition at line 64 of file MOM_MEKE.F90.

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

◆ del2meke

real, dimension(:,:), allocatable mom_meke::meke_cs::del2meke

Definition at line 67 of file MOM_MEKE.F90.

67  real, dimension(:,:), allocatable :: del2meke ! Laplacian of MEKE, used for bi-harmonic diffusion.

◆ diag

type(diag_ctrl), pointer mom_meke::meke_cs::diag

A pointer to shared diagnostics data.

Definition at line 70 of file MOM_MEKE.F90.

70  type(diag_ctrl), pointer :: diag !< A pointer to shared diagnostics data

◆ id_clock_pass

integer mom_meke::meke_cs::id_clock_pass

Clock for group pass calls.

Definition at line 79 of file MOM_MEKE.F90.

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

◆ id_decay

integer mom_meke::meke_cs::id_decay = -1

Definition at line 73 of file MOM_MEKE.F90.

◆ id_gamma_b

integer mom_meke::meke_cs::id_gamma_b = -1

Definition at line 75 of file MOM_MEKE.F90.

◆ id_gamma_t

integer mom_meke::meke_cs::id_gamma_t = -1

Definition at line 75 of file MOM_MEKE.F90.

◆ id_gm_src

integer mom_meke::meke_cs::id_gm_src = -1

Definition at line 73 of file MOM_MEKE.F90.

73  integer :: id_gm_src = -1, id_mom_src = -1, id_decay = -1

◆ id_kh

integer mom_meke::meke_cs::id_kh = -1

Definition at line 71 of file MOM_MEKE.F90.

◆ id_khmeke_u

integer mom_meke::meke_cs::id_khmeke_u = -1

Definition at line 74 of file MOM_MEKE.F90.

74  integer :: id_khmeke_u = -1, id_khmeke_v = -1, id_ku = -1

◆ id_khmeke_v

integer mom_meke::meke_cs::id_khmeke_v = -1

Definition at line 74 of file MOM_MEKE.F90.

◆ id_ku

integer mom_meke::meke_cs::id_ku = -1

Definition at line 74 of file MOM_MEKE.F90.

◆ id_le

integer mom_meke::meke_cs::id_le = -1

Definition at line 75 of file MOM_MEKE.F90.

75  integer :: id_le = -1, id_gamma_b = -1, id_gamma_t = -1

◆ id_leady

integer mom_meke::meke_cs::id_leady = -1

Definition at line 76 of file MOM_MEKE.F90.

◆ id_lrhines

integer mom_meke::meke_cs::id_lrhines = -1

Definition at line 76 of file MOM_MEKE.F90.

76  integer :: id_lrhines = -1, id_leady = -1

◆ id_meke

integer mom_meke::meke_cs::id_meke = -1

Definition at line 71 of file MOM_MEKE.F90.

71  integer :: id_meke = -1, id_ue = -1, id_kh = -1, id_src = -1

◆ id_mom_src

integer mom_meke::meke_cs::id_mom_src = -1

Definition at line 73 of file MOM_MEKE.F90.

◆ id_src

integer mom_meke::meke_cs::id_src = -1

Definition at line 71 of file MOM_MEKE.F90.

◆ id_ub

integer mom_meke::meke_cs::id_ub = -1

Definition at line 72 of file MOM_MEKE.F90.

72  integer :: id_ub = -1, id_ut = -1

◆ id_ue

integer mom_meke::meke_cs::id_ue = -1

Definition at line 71 of file MOM_MEKE.F90.

◆ id_ut

integer mom_meke::meke_cs::id_ut = -1

Definition at line 72 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 63 of file MOM_MEKE.F90.

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

◆ khmeke_fac

real mom_meke::meke_cs::khmeke_fac

A factor relating MEKEKh to the diffusivity used for MEKE itself (nondimensional).

Definition at line 51 of file MOM_MEKE.F90.

51  real :: khmeke_fac !< A factor relating MEKE%Kh to the diffusivity used for

◆ lfixed

real mom_meke::meke_cs::lfixed

Fixed mixing length scale, in m.

Definition at line 56 of file MOM_MEKE.F90.

56  real :: lfixed !< Fixed mixing length scale, in m.

◆ meke_advection_factor

real mom_meke::meke_cs::meke_advection_factor

A scaling in front of the advection of MEKE (non-dim.)

Definition at line 62 of file MOM_MEKE.F90.

62  real :: meke_advection_factor !< A scaling in front of the advection of MEKE (non-dim.)

◆ meke_bgsrc

real mom_meke::meke_cs::meke_bgsrc

Background energy source for MEKE in W/kg (= m2 s-3).

Definition at line 45 of file MOM_MEKE.F90.

45  real :: meke_bgsrc !< Background energy source for MEKE in W/kg (= m2 s-3).

◆ meke_cb

real mom_meke::meke_cs::meke_cb

Coefficient in the \(\gamma_{bot}\) expression (non-dim)

Definition at line 37 of file MOM_MEKE.F90.

37  real :: meke_cb !< Coefficient in the \f$\gamma_{bot}\f$ expression (non-dim)

◆ 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 34 of file MOM_MEKE.F90.

34  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 (non-dim)

Definition at line 39 of file MOM_MEKE.F90.

39  real :: meke_ct !< Coefficient in the \f$\gamma_{bt}\f$ expression (non-dim)

◆ meke_damping

real mom_meke::meke_cs::meke_damping

Local depth-independent MEKE dissipation rate in s-1.

Definition at line 33 of file MOM_MEKE.F90.

33  real :: meke_damping !< Local depth-independent MEKE dissipation rate in s-1.

◆ meke_dtscale

real mom_meke::meke_cs::meke_dtscale

Scale factor to accelerate time-stepping (non-dim.)

Definition at line 46 of file MOM_MEKE.F90.

46  real :: meke_dtscale !< Scale factor to accelerate time-stepping (non-dim.)

◆ meke_frcoeff

real mom_meke::meke_cs::meke_frcoeff

Efficiency of conversion of ME into MEKE (non-dim)

Definition at line 31 of file MOM_MEKE.F90.

31  real :: meke_frcoeff !< Efficiency of conversion of ME into MEKE (non-dim)

◆ meke_gmcoeff

real mom_meke::meke_cs::meke_gmcoeff

Efficiency of conversion of PE into MEKE (non-dim)

Definition at line 32 of file MOM_MEKE.F90.

32  real :: meke_gmcoeff !< Efficiency of conversion of PE into MEKE (non-dim)

◆ meke_k4

real mom_meke::meke_cs::meke_k4

Background bi-harmonic diffusivity (of MEKE) (m^4/s)

Definition at line 50 of file MOM_MEKE.F90.

50  real :: meke_k4 !< Background bi-harmonic diffusivity (of MEKE) (m^4/s)

◆ meke_kh

real mom_meke::meke_cs::meke_kh

Background lateral diffusion of MEKE (m^2/s)

Definition at line 49 of file MOM_MEKE.F90.

49  real :: meke_kh !< Background lateral diffusion of MEKE (m^2/s)

◆ meke_khcoeff

real mom_meke::meke_cs::meke_khcoeff

Scaling factor to convert MEKE into Kh (non-dim.)

Definition at line 47 of file MOM_MEKE.F90.

47  real :: meke_khcoeff !< Scaling factor to convert MEKE into Kh (non-dim.)

◆ meke_min_gamma

real mom_meke::meke_cs::meke_min_gamma

Minimum value of gamma_b^2 allowed (non-dim)

Definition at line 38 of file MOM_MEKE.F90.

38  real :: meke_min_gamma!< Minimum value of gamma_b^2 allowed (non-dim)

◆ meke_uscale

real mom_meke::meke_cs::meke_uscale

MEKE velocity scale for bottom drag (m/s)

Definition at line 48 of file MOM_MEKE.F90.

48  real :: meke_uscale !< MEKE velocity scale for bottom drag (m/s)

◆ pass_del2meke

type(group_pass_type) mom_meke::meke_cs::pass_del2meke

Type for group-halo pass calls.

Definition at line 80 of file MOM_MEKE.F90.

◆ pass_kh

type(group_pass_type) mom_meke::meke_cs::pass_kh

Definition at line 80 of file MOM_MEKE.F90.

◆ pass_ku

type(group_pass_type) mom_meke::meke_cs::pass_ku

Definition at line 80 of file MOM_MEKE.F90.

◆ pass_meke

type(group_pass_type) mom_meke::meke_cs::pass_meke

Definition at line 80 of file MOM_MEKE.F90.

80  type(group_pass_type) :: pass_meke, pass_kh, pass_ku, pass_del2meke !< Type for group-halo pass calls

◆ 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 41 of file MOM_MEKE.F90.

41  logical :: rd_as_max_scale !< If true the length scale can not exceed the

◆ use_old_lscale

logical mom_meke::meke_cs::use_old_lscale

Use the old formula for mixing length scale.

Definition at line 43 of file MOM_MEKE.F90.

43  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 40 of file MOM_MEKE.F90.

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

◆ viscosity_coeff

real mom_meke::meke_cs::viscosity_coeff

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

Definition at line 53 of file MOM_MEKE.F90.

53  real :: viscosity_coeff !< The scaling coefficient in the expression for

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