MOM6
|
Interface to CVMix interior shear schemes.
Data Types | |
type | cvmix_shear_cs |
Control structure including parameters for CVMix interior shear schemes. More... | |
character(len=40) | mdl = "MOM_CVMix_shear" |
This module's name. More... | |
subroutine, public | calculate_cvmix_shear (u_H, v_H, h, tv, kd, kv, G, GV, US, CS) |
Subroutine for calculating (internal) vertical diffusivities/viscosities. More... | |
logical function, public | cvmix_shear_init (Time, G, GV, US, param_file, diag, CS) |
Initialized the CVMix internal shear mixing routine. More... | |
logical function, public | cvmix_shear_is_used (param_file) |
Reads the parameters "LMD94" and "PP81" and returns state. This function allows other modules to know whether this parameterization will be used without needing to duplicate the log entry. More... | |
subroutine, public | cvmix_shear_end (CS) |
Clear pointers and dealocate memory. More... | |
subroutine, public mom_cvmix_shear::calculate_cvmix_shear | ( | real, dimension(szi_(g),szj_(g),szk_(g)), intent(in) | u_H, |
real, dimension(szi_(g),szj_(g),szk_(g)), intent(in) | v_H, | ||
real, dimension(szi_(g),szj_(g),szk_(g)), intent(in) | h, | ||
type(thermo_var_ptrs), intent(in) | tv, | ||
real, dimension(szi_(g),szj_(g),szk_(g)+1), intent(out) | kd, | ||
real, dimension(szi_(g),szj_(g),szk_(g)+1), intent(out) | kv, | ||
type(ocean_grid_type), intent(in) | G, | ||
type(verticalgrid_type), intent(in) | GV, | ||
type(unit_scale_type), intent(in) | US, | ||
type(cvmix_shear_cs), pointer | CS | ||
) |
Subroutine for calculating (internal) vertical diffusivities/viscosities.
[in] | g | Grid structure. |
[in] | gv | Vertical grid structure. |
[in] | us | A dimensional unit scaling type |
[in] | u_h | Initial zonal velocity on T points [L T-1 ~> m s-1] |
[in] | v_h | Initial meridional velocity on T points [L T-1 ~> m s-1] |
[in] | h | Layer thickness [H ~> m or kg m-2]. |
[in] | tv | Thermodynamics structure. |
[out] | kd | The vertical diffusivity at each interface (not layer!) [Z2 T-1 ~> m2 s-1]. |
[out] | kv | The vertical viscosity at each interface (not layer!) [Z2 T-1 ~> m2 s-1]. |
cs | The control structure returned by a previous call to CVMix_shear_init. |
Definition at line 60 of file MOM_CVMix_shear.F90.
subroutine, public mom_cvmix_shear::cvmix_shear_end | ( | type(cvmix_shear_cs), pointer | CS | ) |
Clear pointers and dealocate memory.
cs | Control structure for this module that will be deallocated in this subroutine |
Definition at line 315 of file MOM_CVMix_shear.F90.
Referenced by mom_set_diffusivity::set_diffusivity_end().
logical function, public mom_cvmix_shear::cvmix_shear_init | ( | type(time_type), intent(in) | Time, |
type(ocean_grid_type), intent(in) | G, | ||
type(verticalgrid_type), intent(in) | GV, | ||
type(unit_scale_type), intent(in) | US, | ||
type(param_file_type), intent(in) | param_file, | ||
type(diag_ctrl), intent(inout), target | diag, | ||
type(cvmix_shear_cs), pointer | CS | ||
) |
Initialized the CVMix internal shear mixing routine.
[in] | time | The current time. |
[in] | g | Grid structure. |
[in] | gv | Vertical grid structure. |
[in] | us | A dimensional unit scaling type |
[in] | param_file | Run-time parameter file handle |
[in,out] | diag | Diagnostics control structure. |
cs | This module's control structure. |
Definition at line 193 of file MOM_CVMix_shear.F90.
References mom_kappa_shear::kappa_shear_is_used(), mdl, and mom_error_handler::mom_error().
logical function, public mom_cvmix_shear::cvmix_shear_is_used | ( | type(param_file_type), intent(in) | param_file | ) |
Reads the parameters "LMD94" and "PP81" and returns state. This function allows other modules to know whether this parameterization will be used without needing to duplicate the log entry.
[in] | param_file | Run-time parameter files handle. |
Definition at line 303 of file MOM_CVMix_shear.F90.
References mdl.
Referenced by mom_diabatic_driver::diabatic_driver_init(), and mom_set_visc::set_visc_register_restarts().
character(len=40) mom_cvmix_shear::mdl = "MOM_CVMix_shear" |
This module's name.
Definition at line 54 of file MOM_CVMix_shear.F90.
Referenced by cvmix_shear_init(), and cvmix_shear_is_used().