MOM6
|
Interface to CVMix convection scheme.
Data Types | |
type | cvmix_conv_cs |
Control structure including parameters for CVMix convection. More... | |
character(len=40) | mdl = "MOM_CVMix_conv" |
This module's name. More... | |
logical function, public | cvmix_conv_init (Time, G, GV, US, param_file, diag, CS) |
Initialized the CVMix convection mixing routine. More... | |
subroutine, public | calculate_cvmix_conv (h, tv, G, GV, US, CS, hbl) |
Subroutine for calculating enhanced diffusivity/viscosity due to convection via CVMix. More... | |
logical function, public | cvmix_conv_is_used (param_file) |
Reads the parameter "USE_CVMix_CONVECTION" 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_conv_end (CS) |
Clear pointers and dealocate memory. More... | |
subroutine, public mom_cvmix_conv::calculate_cvmix_conv | ( | real, dimension( g %isd: g %ied, g %jsd: g %jed, g %ke), intent(in) | h, |
type(thermo_var_ptrs), intent(in) | tv, | ||
type(ocean_grid_type), intent(in) | G, | ||
type(verticalgrid_type), intent(in) | GV, | ||
type(unit_scale_type), intent(in) | US, | ||
type(cvmix_conv_cs), pointer | CS, | ||
real, dimension(:,:), optional, pointer | hbl | ||
) |
Subroutine for calculating enhanced diffusivity/viscosity due to convection via CVMix.
[in] | g | Grid structure. |
[in] | gv | Vertical grid structure. |
[in] | us | A dimensional unit scaling type |
[in] | h | Layer thickness [H ~> m or kg m-2]. |
[in] | tv | Thermodynamics structure. |
cs | The control structure returned by a previous call to CVMix_conv_init. | |
hbl | Depth of ocean boundary layer [m] |
Definition at line 151 of file MOM_CVMix_conv.F90.
Referenced by mom_diabatic_driver::diabatic_ale(), mom_diabatic_driver::diabatic_ale_legacy(), and mom_diabatic_driver::layered_diabatic().
subroutine, public mom_cvmix_conv::cvmix_conv_end | ( | type(cvmix_conv_cs), pointer | CS | ) |
Clear pointers and dealocate memory.
cs | Control structure for this module that will be deallocated in this subroutine |
Definition at line 272 of file MOM_CVMix_conv.F90.
Referenced by mom_diabatic_driver::diabatic_driver_end().
logical function, public mom_cvmix_conv::cvmix_conv_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_conv_cs), pointer | CS | ||
) |
Initialized the CVMix convection 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 56 of file MOM_CVMix_conv.F90.
References mdl, and mom_error_handler::mom_error().
logical function, public mom_cvmix_conv::cvmix_conv_is_used | ( | type(param_file_type), intent(in) | param_file | ) |
Reads the parameter "USE_CVMix_CONVECTION" 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 | A structure to parse for run-time parameters |
Definition at line 264 of file MOM_CVMix_conv.F90.
References mdl.
Referenced by mom_set_visc::set_visc_register_restarts().
character(len=40) mom_cvmix_conv::mdl = "MOM_CVMix_conv" |
This module's name.
Definition at line 50 of file MOM_CVMix_conv.F90.
Referenced by cvmix_conv_init(), and cvmix_conv_is_used().