MOM6
|
Control structure with parameters for the tidal mixing module.
Definition at line 71 of file MOM_tidal_mixing.F90.
Public variables and constants | |
logical | debug = .true. |
If true, do more extensive debugging checks. This is hard-coded. More... | |
logical | int_tide_dissipation = .false. |
Internal tide conversion (from barotropic) with the schemes of St Laurent et al (2002) & Simmons et al (2004) More... | |
integer | int_tide_profile |
A coded integer indicating the vertical profile for dissipation of the internal waves. Schemes that are currently encoded are St Laurent et al (2002) and Polzin (2009). More... | |
logical | lee_wave_dissipation = .false. |
Enable lee-wave driven mixing, following Nikurashin (2010), with a vertical energy deposition profile specified by Lee_wave_profile to be St Laurent et al (2002) or Simmons et al (2004) scheme. More... | |
integer | lee_wave_profile |
A coded integer indicating the vertical profile for dissipation of the lee waves. Schemes that are currently encoded are St Laurent et al (2002) and Polzin (2009). More... | |
real | int_tide_decay_scale |
decay scale for internal wave TKE [Z ~> m]. More... | |
real | mu_itides |
efficiency for conversion of dissipation to potential energy [nondim] More... | |
real | gamma_itides |
fraction of local dissipation [nondim] More... | |
real | gamma_lee |
fraction of local dissipation for lee waves (Nikurashin's energy input) [nondim] More... | |
real | decay_scale_factor_lee |
Scaling factor for the decay scale of lee wave energy dissipation [nondim]. More... | |
real | min_zbot_itides |
minimum depth for internal tide conversion [Z ~> m]. More... | |
logical | lowmode_itidal_dissipation = .false. |
If true, consider mixing due to breaking low modes that have been remotely generated using an internal tidal dissipation scheme to specify the vertical profile of the energy input to drive diapycnal mixing, along the lines of St. Laurent et al. (2002) and Simmons et al. (2004). More... | |
real | nu_polzin |
The non-dimensional constant used in Polzin form of the vertical scale of decay of tidal dissipation [nondim]. More... | |
real | nbotref_polzin |
Reference value for the buoyancy frequency at the ocean bottom used in Polzin formulation of the vertical scale of decay of tidal dissipation [T-1 ~> s-1]. More... | |
real | polzin_decay_scale_factor |
Scaling factor for the decay length scale of the tidal dissipation profile in Polzin [nondim]. More... | |
real | polzin_decay_scale_max_factor |
The decay length scale of tidal dissipation profile in Polzin formulation should not exceed Polzin_decay_scale_max_factor * depth of the ocean [nondim]. More... | |
real | polzin_min_decay_scale |
minimum decay scale of the tidal dissipation profile in Polzin formulation [Z ~> m]. More... | |
real | tke_itide_max |
maximum internal tide conversion [R Z3 T-3 ~> W m-2] available to mix above the BBL More... | |
real | utide |
constant tidal amplitude [Z T-1 ~> m s-1] if READ_TIDEAMP is false. More... | |
real | kappa_itides |
topographic wavenumber and non-dimensional scaling [Z-1 ~> m-1]. More... | |
real | kappa_h2_factor |
factor for the product of wavenumber * rms sgs height More... | |
character(len=200) | inputdir |
The directory in which to find input files. More... | |
logical | use_cvmix_tidal = .false. |
true if CVMix is to be used for determining diffusivity due to tidal mixing More... | |
real | min_thickness |
Minimum thickness allowed [m]. More... | |
integer | cvmix_tidal_scheme = -1 |
1 for Simmons, 2 for Schmittner More... | |
type(cvmix_tidal_params_type) | cvmix_tidal_params |
A CVMix-specific type with parameters for tidal mixing. More... | |
type(cvmix_global_params_type) | cvmix_glb_params |
CVMix-specific for Prandtl number only. More... | |
real | tidal_max_coef |
CVMix-specific maximum allowable tidal diffusivity. [m^2/s]. More... | |
real | tidal_diss_lim_tc |
CVMix-specific dissipation limit depth for tidal-energy-constituent data [Z ~> m]. More... | |
type(remapping_cs) | remap_cs |
The control structure for remapping. More... | |
real, dimension(:,:), pointer | tke_niku => NULL() |
Lee wave driven Turbulent Kinetic Energy input [R Z3 T-3 ~> W m-2]. More... | |
real, dimension(:,:), pointer | tke_itidal => NULL() |
The internal Turbulent Kinetic Energy input divided by the bottom stratfication [R Z3 T-2 ~> J m-2]. More... | |
real, dimension(:,:), pointer | nb => NULL() |
The near bottom buoyancy frequency [T-1 ~> s-1]. More... | |
real, dimension(:,:), pointer | mask_itidal => NULL() |
A mask of where internal tide energy is input. More... | |
real, dimension(:,:), pointer | h2 => NULL() |
Squared bottom depth variance [m2]. More... | |
real, dimension(:,:), pointer | tideamp => NULL() |
RMS tidal amplitude [m s-1]. More... | |
real, dimension(:), allocatable | h_src |
tidal constituent input layer thickness [m] More... | |
real, dimension(:,:), allocatable | tidal_qe_2d |
Tidal energy input times the local dissipation fraction, q*E(x,y), with the CVMix implementation of Jayne et al tidal mixing [W m-2]. TODO: make this E(x,y) only. More... | |
real, dimension(:,:,:), allocatable | tidal_qe_3d_in |
q*E(x,y,z) with the Schmittner parameterization [W m-3?] 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... | |
type(diag_ctrl), pointer | diag => NULL() |
structure to regulate diagnostic output timing More... | |
type(tidal_mixing_diags), pointer | dd => NULL() |
A pointer to a structure of diagnostic arrays. More... | |
integer | id_tke_itidal = -1 |
Diagnostic identifiers. More... | |
integer | id_tke_leewave = -1 |
Diagnostic identifiers. More... | |
integer | id_kd_itidal = -1 |
Diagnostic identifiers. More... | |
integer | id_kd_niku = -1 |
Diagnostic identifiers. More... | |
integer | id_kd_lowmode = -1 |
Diagnostic identifiers. More... | |
integer | id_kd_itidal_work = -1 |
Diagnostic identifiers. More... | |
integer | id_kd_niku_work = -1 |
Diagnostic identifiers. More... | |
integer | id_kd_lowmode_work = -1 |
Diagnostic identifiers. More... | |
integer | id_nb = -1 |
Diagnostic identifiers. More... | |
integer | id_n2_bot = -1 |
Diagnostic identifiers. More... | |
integer | id_n2_meanz = -1 |
Diagnostic identifiers. More... | |
integer | id_fl_itidal = -1 |
Diagnostic identifiers. More... | |
integer | id_fl_lowmode = -1 |
Diagnostic identifiers. More... | |
integer | id_polzin_decay_scale = -1 |
Diagnostic identifiers. More... | |
integer | id_polzin_decay_scale_scaled = -1 |
Diagnostic identifiers. More... | |
integer | id_n2_int = -1 |
Diagnostic identifiers. More... | |
integer | id_simmons_coeff = -1 |
Diagnostic identifiers. More... | |
integer | id_schmittner_coeff = -1 |
Diagnostic identifiers. More... | |
integer | id_tidal_qe_md = -1 |
Diagnostic identifiers. More... | |
integer | id_vert_dep = -1 |
Diagnostic identifiers. More... | |
logical mom_tidal_mixing::tidal_mixing_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 162 of file MOM_tidal_mixing.F90.
type(cvmix_global_params_type) mom_tidal_mixing::tidal_mixing_cs::cvmix_glb_params |
CVMix-specific for Prandtl number only.
Definition at line 140 of file MOM_tidal_mixing.F90.
type(cvmix_tidal_params_type) mom_tidal_mixing::tidal_mixing_cs::cvmix_tidal_params |
A CVMix-specific type with parameters for tidal mixing.
Definition at line 139 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::cvmix_tidal_scheme = -1 |
1 for Simmons, 2 for Schmittner
Definition at line 138 of file MOM_tidal_mixing.F90.
type(tidal_mixing_diags), pointer mom_tidal_mixing::tidal_mixing_cs::dd => NULL() |
A pointer to a structure of diagnostic arrays.
Definition at line 168 of file MOM_tidal_mixing.F90.
logical mom_tidal_mixing::tidal_mixing_cs::debug = .true. |
If true, do more extensive debugging checks. This is hard-coded.
Definition at line 73 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::decay_scale_factor_lee |
Scaling factor for the decay scale of lee wave energy dissipation [nondim].
Definition at line 100 of file MOM_tidal_mixing.F90.
type(diag_ctrl), pointer mom_tidal_mixing::tidal_mixing_cs::diag => NULL() |
structure to regulate diagnostic output timing
Definition at line 167 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::gamma_itides |
fraction of local dissipation [nondim]
Definition at line 96 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::gamma_lee |
fraction of local dissipation for lee waves (Nikurashin's energy input) [nondim]
Definition at line 98 of file MOM_tidal_mixing.F90.
real, dimension(:,:), pointer mom_tidal_mixing::tidal_mixing_cs::h2 => NULL() |
Squared bottom depth variance [m2].
Definition at line 153 of file MOM_tidal_mixing.F90.
real, dimension(:), allocatable mom_tidal_mixing::tidal_mixing_cs::h_src |
tidal constituent input layer thickness [m]
Definition at line 155 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_fl_itidal = -1 |
Diagnostic identifiers.
Definition at line 182 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_fl_lowmode = -1 |
Diagnostic identifiers.
Definition at line 183 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_kd_itidal = -1 |
Diagnostic identifiers.
Definition at line 173 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_kd_itidal_work = -1 |
Diagnostic identifiers.
Definition at line 176 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_kd_lowmode = -1 |
Diagnostic identifiers.
Definition at line 175 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_kd_lowmode_work = -1 |
Diagnostic identifiers.
Definition at line 178 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_kd_niku = -1 |
Diagnostic identifiers.
Definition at line 174 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_kd_niku_work = -1 |
Diagnostic identifiers.
Definition at line 177 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_n2_bot = -1 |
Diagnostic identifiers.
Definition at line 180 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_n2_int = -1 |
Diagnostic identifiers.
Definition at line 186 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_n2_meanz = -1 |
Diagnostic identifiers.
Definition at line 181 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_nb = -1 |
Diagnostic identifiers.
Definition at line 179 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_polzin_decay_scale = -1 |
Diagnostic identifiers.
Definition at line 184 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_polzin_decay_scale_scaled = -1 |
Diagnostic identifiers.
Definition at line 185 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_schmittner_coeff = -1 |
Diagnostic identifiers.
Definition at line 188 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_simmons_coeff = -1 |
Diagnostic identifiers.
Definition at line 187 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_tidal_qe_md = -1 |
Diagnostic identifiers.
Definition at line 189 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_tke_itidal = -1 |
Diagnostic identifiers.
Definition at line 171 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_tke_leewave = -1 |
Diagnostic identifiers.
Definition at line 172 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::id_vert_dep = -1 |
Diagnostic identifiers.
Definition at line 190 of file MOM_tidal_mixing.F90.
character(len=200) mom_tidal_mixing::tidal_mixing_cs::inputdir |
The directory in which to find input files.
Definition at line 130 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::int_tide_decay_scale |
decay scale for internal wave TKE [Z ~> m].
Definition at line 91 of file MOM_tidal_mixing.F90.
logical mom_tidal_mixing::tidal_mixing_cs::int_tide_dissipation = .false. |
Internal tide conversion (from barotropic) with the schemes of St Laurent et al (2002) & Simmons et al (2004)
Definition at line 76 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::int_tide_profile |
A coded integer indicating the vertical profile for dissipation of the internal waves. Schemes that are currently encoded are St Laurent et al (2002) and Polzin (2009).
Definition at line 79 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::kappa_h2_factor |
factor for the product of wavenumber * rms sgs height
Definition at line 129 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::kappa_itides |
topographic wavenumber and non-dimensional scaling [Z-1 ~> m-1].
Definition at line 128 of file MOM_tidal_mixing.F90.
logical mom_tidal_mixing::tidal_mixing_cs::lee_wave_dissipation = .false. |
Enable lee-wave driven mixing, following Nikurashin (2010), with a vertical energy deposition profile specified by Lee_wave_profile to be St Laurent et al (2002) or Simmons et al (2004) scheme.
Definition at line 82 of file MOM_tidal_mixing.F90.
integer mom_tidal_mixing::tidal_mixing_cs::lee_wave_profile |
A coded integer indicating the vertical profile for dissipation of the lee waves. Schemes that are currently encoded are St Laurent et al (2002) and Polzin (2009).
Definition at line 87 of file MOM_tidal_mixing.F90.
logical mom_tidal_mixing::tidal_mixing_cs::lowmode_itidal_dissipation = .false. |
If true, consider mixing due to breaking low modes that have been remotely generated using an internal tidal dissipation scheme to specify the vertical profile of the energy input to drive diapycnal mixing, along the lines of St. Laurent et al. (2002) and Simmons et al. (2004).
Definition at line 104 of file MOM_tidal_mixing.F90.
real, dimension(:,:), pointer mom_tidal_mixing::tidal_mixing_cs::mask_itidal => NULL() |
A mask of where internal tide energy is input.
Definition at line 152 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::min_thickness |
Minimum thickness allowed [m].
Definition at line 135 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::min_zbot_itides |
minimum depth for internal tide conversion [Z ~> m].
Definition at line 103 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::mu_itides |
efficiency for conversion of dissipation to potential energy [nondim]
Definition at line 93 of file MOM_tidal_mixing.F90.
real, dimension(:,:), pointer mom_tidal_mixing::tidal_mixing_cs::nb => NULL() |
The near bottom buoyancy frequency [T-1 ~> s-1].
Definition at line 151 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::nbotref_polzin |
Reference value for the buoyancy frequency at the ocean bottom used in Polzin formulation of the vertical scale of decay of tidal dissipation [T-1 ~> s-1].
Definition at line 113 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::nu_polzin |
The non-dimensional constant used in Polzin form of the vertical scale of decay of tidal dissipation [nondim].
Definition at line 110 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::polzin_decay_scale_factor |
Scaling factor for the decay length scale of the tidal dissipation profile in Polzin [nondim].
Definition at line 116 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::polzin_decay_scale_max_factor |
The decay length scale of tidal dissipation profile in Polzin formulation should not exceed Polzin_decay_scale_max_factor * depth of the ocean [nondim].
Definition at line 118 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::polzin_min_decay_scale |
minimum decay scale of the tidal dissipation profile in Polzin formulation [Z ~> m].
Definition at line 121 of file MOM_tidal_mixing.F90.
type(remapping_cs) mom_tidal_mixing::tidal_mixing_cs::remap_cs |
The control structure for remapping.
Definition at line 144 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::tidal_diss_lim_tc |
CVMix-specific dissipation limit depth for tidal-energy-constituent data [Z ~> m].
Definition at line 142 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::tidal_max_coef |
CVMix-specific maximum allowable tidal diffusivity. [m^2/s].
Definition at line 141 of file MOM_tidal_mixing.F90.
real, dimension(:,:), allocatable mom_tidal_mixing::tidal_mixing_cs::tidal_qe_2d |
Tidal energy input times the local dissipation fraction, q*E(x,y), with the CVMix implementation of Jayne et al tidal mixing [W m-2]. TODO: make this E(x,y) only.
Definition at line 156 of file MOM_tidal_mixing.F90.
real, dimension(:,:,:), allocatable mom_tidal_mixing::tidal_mixing_cs::tidal_qe_3d_in |
q*E(x,y,z) with the Schmittner parameterization [W m-3?]
Definition at line 160 of file MOM_tidal_mixing.F90.
real, dimension(:,:), pointer mom_tidal_mixing::tidal_mixing_cs::tideamp => NULL() |
RMS tidal amplitude [m s-1].
Definition at line 154 of file MOM_tidal_mixing.F90.
real, dimension(:,:), pointer mom_tidal_mixing::tidal_mixing_cs::tke_itidal => NULL() |
The internal Turbulent Kinetic Energy input divided by the bottom stratfication [R Z3 T-2 ~> J m-2].
Definition at line 149 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::tke_itide_max |
maximum internal tide conversion [R Z3 T-3 ~> W m-2] available to mix above the BBL
Definition at line 124 of file MOM_tidal_mixing.F90.
real, dimension(:,:), pointer mom_tidal_mixing::tidal_mixing_cs::tke_niku => NULL() |
Lee wave driven Turbulent Kinetic Energy input [R Z3 T-3 ~> W m-2].
Definition at line 147 of file MOM_tidal_mixing.F90.
logical mom_tidal_mixing::tidal_mixing_cs::use_cvmix_tidal = .false. |
true if CVMix is to be used for determining diffusivity due to tidal mixing
Definition at line 132 of file MOM_tidal_mixing.F90.
real mom_tidal_mixing::tidal_mixing_cs::utide |
constant tidal amplitude [Z T-1 ~> m s-1] if READ_TIDEAMP is false.
Definition at line 127 of file MOM_tidal_mixing.F90.