MOM6
mom_bkgnd_mixing::bkgnd_mixing_cs Type Reference

Detailed Description

Control structure including parameters for this module.

Definition at line 38 of file MOM_bkgnd_mixing.F90.

Collaboration diagram for mom_bkgnd_mixing::bkgnd_mixing_cs:
[legend]

Public variables and constants

real bryan_lewis_c1
 The vertical diffusivity values for Bryan-Lewis profile at |z|=D [m2 s-1]. More...
 
real bryan_lewis_c2
 The amplitude of variation in diffusivity for the Bryan-Lewis diffusivity profile [m2 s-1]. More...
 
real bryan_lewis_c3
 The inverse length scale for transition region in the Bryan-Lewis diffusivity profile [m-1]. More...
 
real bryan_lewis_c4
 The depth where diffusivity is Bryan_Lewis_bl1 in the Bryan-Lewis profile [m]. More...
 
real bckgrnd_vdc1
 Background diffusivity (Ledwell) when horiz_varying_background=.true. [Z2 T-1 ~> m2 s-1]. More...
 
real bckgrnd_vdc_eq
 Equatorial diffusivity (Gregg) when horiz_varying_background=.true. [Z2 T-1 ~> m2 s-1]. More...
 
real bckgrnd_vdc_psim
 Max. PSI induced diffusivity (MacKinnon) when horiz_varying_background=.true. [Z2 T-1 ~> m2 s-1]. More...
 
real bckgrnd_vdc_banda
 Banda Sea diffusivity (Gordon) when horiz_varying_background=.true. [Z2 T-1 ~> m2 s-1]. More...
 
real kd_min
 minimum diapycnal diffusivity [Z2 T-1 ~> m2 s-1] More...
 
real kd
 interior diapycnal diffusivity [Z2 T-1 ~> m2 s-1] More...
 
real omega
 The Earth's rotation rate [T-1 ~> s-1]. More...
 
real n0_2omega
 ratio of the typical Buoyancy frequency to twice the Earth's rotation period, used with the Henyey scaling from the mixing More...
 
real prandtl_bkgnd
 Turbulent Prandtl number used to convert vertical background diffusivity into viscosity. More...
 
real kd_tanh_lat_scale
 A nondimensional scaling for the range of diffusivities with Kd_tanh_lat_fn. Valid values are in the range of -2 to 2; 0.4 reproduces CM2M. More...
 
real kdml
 mixed layer diapycnal diffusivity [Z2 T-1 ~> m2 s-1] when bulkmixedlayer==.false. More...
 
real hmix
 mixed layer thickness [Z ~> m] when bulkmixedlayer==.false. More...
 
logical kd_tanh_lat_fn
 If true, use the tanh dependence of Kd_sfc on latitude, like GFDL CM2.1/CM2M. There is no physical justification for this form, and it can not be used with Henyey_IGW_background. More...
 
logical bryan_lewis_diffusivity
 If true, background vertical diffusivity uses Bryan-Lewis (1979) like tanh profile. More...
 
logical horiz_varying_background
 If true, apply vertically uniform, latitude-dependent background diffusivity, as described in Danabasoglu et al., 2012. More...
 
logical henyey_igw_background
 If true, use a simplified variant of the Henyey et al, JGR (1986) latitudinal scaling for the background diapycnal diffusivity, which gives a marked decrease in the diffusivity near the equator. The simplification here is to assume that the in-situ stratification is the same as the reference stratificaiton. More...
 
logical henyey_igw_background_new
 same as Henyey_IGW_background but incorporate the effect of stratification on TKE dissipation, e = f/f_0 * acosh(N/f) / acosh(N_0/f_0) * e_0 where e is the TKE dissipation, and N_0 and f_0 are the reference buoyancy frequency and inertial frequencies respectively. e_0 is the reference dissipation at (N_0,f_0). In the previous version, N=N_0. Additionally, the squared inverse relationship between diapycnal diffusivities and stratification is included: More...
 
logical bulkmixedlayer
 If true, a refined bulk mixed layer scheme is used. More...
 
logical debug
 If true, turn on debugging in this module. More...
 
type(diag_ctrl), pointer diag => NULL()
 A structure that regulates diagnostic output. More...
 
integer id_kd_bkgnd = -1
 Diagnotic IDs. More...
 
integer id_kv_bkgnd = -1
 Diagnostic IDs. More...
 
real, dimension(:,:), allocatable kd_sfc
 surface value of the diffusivity [Z2 T-1 ~> m2 s-1] More...
 
real, dimension(:,:,:), allocatable kd_bkgnd
 Background diffusivity [Z2 T-1 ~> m2 s-1]. More...
 
real, dimension(:,:,:), allocatable kv_bkgnd
 Background viscosity [Z2 s-1 ~> m2 s-1]. More...
 
character(len=40) bkgnd_scheme_str = "none"
 Background scheme identifier. More...
 

Variables and constants

◆ bckgrnd_vdc1

real mom_bkgnd_mixing::bkgnd_mixing_cs::bckgrnd_vdc1

Background diffusivity (Ledwell) when horiz_varying_background=.true. [Z2 T-1 ~> m2 s-1].

Definition at line 49 of file MOM_bkgnd_mixing.F90.

49  real :: bckgrnd_vdc1 !< Background diffusivity (Ledwell) when

◆ bckgrnd_vdc_banda

real mom_bkgnd_mixing::bkgnd_mixing_cs::bckgrnd_vdc_banda

Banda Sea diffusivity (Gordon) when horiz_varying_background=.true. [Z2 T-1 ~> m2 s-1].

Definition at line 55 of file MOM_bkgnd_mixing.F90.

55  real :: bckgrnd_vdc_Banda !< Banda Sea diffusivity (Gordon) when

◆ bckgrnd_vdc_eq

real mom_bkgnd_mixing::bkgnd_mixing_cs::bckgrnd_vdc_eq

Equatorial diffusivity (Gregg) when horiz_varying_background=.true. [Z2 T-1 ~> m2 s-1].

Definition at line 51 of file MOM_bkgnd_mixing.F90.

51  real :: bckgrnd_vdc_eq !< Equatorial diffusivity (Gregg) when

◆ bckgrnd_vdc_psim

real mom_bkgnd_mixing::bkgnd_mixing_cs::bckgrnd_vdc_psim

Max. PSI induced diffusivity (MacKinnon) when horiz_varying_background=.true. [Z2 T-1 ~> m2 s-1].

Definition at line 53 of file MOM_bkgnd_mixing.F90.

53  real :: bckgrnd_vdc_psim !< Max. PSI induced diffusivity (MacKinnon) when

◆ bkgnd_scheme_str

character(len=40) mom_bkgnd_mixing::bkgnd_mixing_cs::bkgnd_scheme_str = "none"

Background scheme identifier.

Definition at line 109 of file MOM_bkgnd_mixing.F90.

109  character(len=40) :: bkgnd_scheme_str = "none" !< Background scheme identifier

◆ bryan_lewis_c1

real mom_bkgnd_mixing::bkgnd_mixing_cs::bryan_lewis_c1

The vertical diffusivity values for Bryan-Lewis profile at |z|=D [m2 s-1].

Definition at line 41 of file MOM_bkgnd_mixing.F90.

41  real :: Bryan_Lewis_c1 !< The vertical diffusivity values for Bryan-Lewis profile

◆ bryan_lewis_c2

real mom_bkgnd_mixing::bkgnd_mixing_cs::bryan_lewis_c2

The amplitude of variation in diffusivity for the Bryan-Lewis diffusivity profile [m2 s-1].

Definition at line 43 of file MOM_bkgnd_mixing.F90.

43  real :: Bryan_Lewis_c2 !< The amplitude of variation in diffusivity for the

◆ bryan_lewis_c3

real mom_bkgnd_mixing::bkgnd_mixing_cs::bryan_lewis_c3

The inverse length scale for transition region in the Bryan-Lewis diffusivity profile [m-1].

Definition at line 45 of file MOM_bkgnd_mixing.F90.

45  real :: Bryan_Lewis_c3 !< The inverse length scale for transition region in the

◆ bryan_lewis_c4

real mom_bkgnd_mixing::bkgnd_mixing_cs::bryan_lewis_c4

The depth where diffusivity is Bryan_Lewis_bl1 in the Bryan-Lewis profile [m].

Definition at line 47 of file MOM_bkgnd_mixing.F90.

47  real :: Bryan_Lewis_c4 !< The depth where diffusivity is Bryan_Lewis_bl1 in the

◆ bryan_lewis_diffusivity

logical mom_bkgnd_mixing::bkgnd_mixing_cs::bryan_lewis_diffusivity

If true, background vertical diffusivity uses Bryan-Lewis (1979) like tanh profile.

Definition at line 75 of file MOM_bkgnd_mixing.F90.

75  logical :: Bryan_Lewis_diffusivity!< If true, background vertical diffusivity

◆ bulkmixedlayer

logical mom_bkgnd_mixing::bkgnd_mixing_cs::bulkmixedlayer

If true, a refined bulk mixed layer scheme is used.

Definition at line 97 of file MOM_bkgnd_mixing.F90.

97  logical :: bulkmixedlayer !< If true, a refined bulk mixed layer scheme is used

◆ debug

logical mom_bkgnd_mixing::bkgnd_mixing_cs::debug

If true, turn on debugging in this module.

Definition at line 98 of file MOM_bkgnd_mixing.F90.

98  logical :: debug !< If true, turn on debugging in this module

◆ diag

type(diag_ctrl), pointer mom_bkgnd_mixing::bkgnd_mixing_cs::diag => NULL()

A structure that regulates diagnostic output.

Definition at line 100 of file MOM_bkgnd_mixing.F90.

100  type(diag_ctrl), pointer :: diag => null() !< A structure that regulates diagnostic output

◆ henyey_igw_background

logical mom_bkgnd_mixing::bkgnd_mixing_cs::henyey_igw_background

If true, use a simplified variant of the Henyey et al, JGR (1986) latitudinal scaling for the background diapycnal diffusivity, which gives a marked decrease in the diffusivity near the equator. The simplification here is to assume that the in-situ stratification is the same as the reference stratificaiton.

Definition at line 79 of file MOM_bkgnd_mixing.F90.

79  logical :: Henyey_IGW_background !< If true, use a simplified variant of the

◆ henyey_igw_background_new

logical mom_bkgnd_mixing::bkgnd_mixing_cs::henyey_igw_background_new

same as Henyey_IGW_background but incorporate the effect of stratification on TKE dissipation, e = f/f_0 * acosh(N/f) / acosh(N_0/f_0) * e_0 where e is the TKE dissipation, and N_0 and f_0 are the reference buoyancy frequency and inertial frequencies respectively. e_0 is the reference dissipation at (N_0,f_0). In the previous version, N=N_0. Additionally, the squared inverse relationship between diapycnal diffusivities and stratification is included:

kd = e/N^2

where kd is the diapycnal diffusivity. This approach assumes that work done against gravity is uniformly distributed throughout the column. Whereas, kd=kd_0*e, as in the original version, concentrates buoyancy work in regions of strong stratification.

Definition at line 83 of file MOM_bkgnd_mixing.F90.

83  logical :: Henyey_IGW_background_new !< same as Henyey_IGW_background

◆ hmix

real mom_bkgnd_mixing::bkgnd_mixing_cs::hmix

mixed layer thickness [Z ~> m] when bulkmixedlayer==.false.

Definition at line 70 of file MOM_bkgnd_mixing.F90.

70  real :: Hmix !< mixed layer thickness [Z ~> m] when bulkmixedlayer==.false.

◆ horiz_varying_background

logical mom_bkgnd_mixing::bkgnd_mixing_cs::horiz_varying_background

If true, apply vertically uniform, latitude-dependent background diffusivity, as described in Danabasoglu et al., 2012.

Definition at line 77 of file MOM_bkgnd_mixing.F90.

77  logical :: horiz_varying_background !< If true, apply vertically uniform, latitude-dependent

◆ id_kd_bkgnd

integer mom_bkgnd_mixing::bkgnd_mixing_cs::id_kd_bkgnd = -1

Diagnotic IDs.

Definition at line 101 of file MOM_bkgnd_mixing.F90.

101  integer :: id_kd_bkgnd = -1 !< Diagnotic IDs

◆ id_kv_bkgnd

integer mom_bkgnd_mixing::bkgnd_mixing_cs::id_kv_bkgnd = -1

Diagnostic IDs.

Definition at line 102 of file MOM_bkgnd_mixing.F90.

102  integer :: id_kv_bkgnd = -1 !< Diagnostic IDs

◆ kd

real mom_bkgnd_mixing::bkgnd_mixing_cs::kd

interior diapycnal diffusivity [Z2 T-1 ~> m2 s-1]

Definition at line 58 of file MOM_bkgnd_mixing.F90.

58  real :: Kd !< interior diapycnal diffusivity [Z2 T-1 ~> m2 s-1]

◆ kd_bkgnd

real, dimension(:,:,:), allocatable mom_bkgnd_mixing::bkgnd_mixing_cs::kd_bkgnd

Background diffusivity [Z2 T-1 ~> m2 s-1].

Definition at line 106 of file MOM_bkgnd_mixing.F90.

106  real, allocatable, dimension(:,:,:) :: kd_bkgnd !< Background diffusivity [Z2 T-1 ~> m2 s-1]

◆ kd_min

real mom_bkgnd_mixing::bkgnd_mixing_cs::kd_min

minimum diapycnal diffusivity [Z2 T-1 ~> m2 s-1]

Definition at line 57 of file MOM_bkgnd_mixing.F90.

57  real :: Kd_min !< minimum diapycnal diffusivity [Z2 T-1 ~> m2 s-1]

◆ kd_sfc

real, dimension(:,:), allocatable mom_bkgnd_mixing::bkgnd_mixing_cs::kd_sfc

surface value of the diffusivity [Z2 T-1 ~> m2 s-1]

Definition at line 104 of file MOM_bkgnd_mixing.F90.

104  real, allocatable, dimension(:,:) :: Kd_sfc !< surface value of the diffusivity [Z2 T-1 ~> m2 s-1]

◆ kd_tanh_lat_fn

logical mom_bkgnd_mixing::bkgnd_mixing_cs::kd_tanh_lat_fn

If true, use the tanh dependence of Kd_sfc on latitude, like GFDL CM2.1/CM2M. There is no physical justification for this form, and it can not be used with Henyey_IGW_background.

Definition at line 71 of file MOM_bkgnd_mixing.F90.

71  logical :: Kd_tanh_lat_fn !< If true, use the tanh dependence of Kd_sfc on

◆ kd_tanh_lat_scale

real mom_bkgnd_mixing::bkgnd_mixing_cs::kd_tanh_lat_scale

A nondimensional scaling for the range of diffusivities with Kd_tanh_lat_fn. Valid values are in the range of -2 to 2; 0.4 reproduces CM2M.

Definition at line 65 of file MOM_bkgnd_mixing.F90.

65  real :: Kd_tanh_lat_scale !< A nondimensional scaling for the range of

◆ kdml

real mom_bkgnd_mixing::bkgnd_mixing_cs::kdml

mixed layer diapycnal diffusivity [Z2 T-1 ~> m2 s-1] when bulkmixedlayer==.false.

Definition at line 68 of file MOM_bkgnd_mixing.F90.

68  real :: Kdml !< mixed layer diapycnal diffusivity [Z2 T-1 ~> m2 s-1]

◆ kv_bkgnd

real, dimension(:,:,:), allocatable mom_bkgnd_mixing::bkgnd_mixing_cs::kv_bkgnd

Background viscosity [Z2 s-1 ~> m2 s-1].

Definition at line 107 of file MOM_bkgnd_mixing.F90.

107  real, allocatable, dimension(:,:,:) :: kv_bkgnd !< Background viscosity [Z2 s-1 ~> m2 s-1]

◆ n0_2omega

real mom_bkgnd_mixing::bkgnd_mixing_cs::n0_2omega

ratio of the typical Buoyancy frequency to twice the Earth's rotation period, used with the Henyey scaling from the mixing

Definition at line 60 of file MOM_bkgnd_mixing.F90.

60  real :: N0_2Omega !< ratio of the typical Buoyancy frequency to

◆ omega

real mom_bkgnd_mixing::bkgnd_mixing_cs::omega

The Earth's rotation rate [T-1 ~> s-1].

Definition at line 59 of file MOM_bkgnd_mixing.F90.

59  real :: omega !< The Earth's rotation rate [T-1 ~> s-1].

◆ prandtl_bkgnd

real mom_bkgnd_mixing::bkgnd_mixing_cs::prandtl_bkgnd

Turbulent Prandtl number used to convert vertical background diffusivity into viscosity.

Definition at line 63 of file MOM_bkgnd_mixing.F90.

63  real :: prandtl_bkgnd !< Turbulent Prandtl number used to convert

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