mom_cvmix_conv module reference

Interface to CVMix convection scheme.

Data Types

cvmix_conv_cs

Control structure including parameters for CVMix convection.

Functions/Subroutines

`cvmix_conv_init()`	Initialized the CVMix convection mixing routine.
`calculate_cvmix_conv()`	Subroutine for calculating enhanced diffusivity/viscosity due to convection via CVMix.
`cvmix_conv_is_used()`	Reads the parameter "USE_CVMix_CONVECTION" and returns state.

Detailed Description

Interface to CVMix convection scheme.

Type Documentation

type mom_cvmix_conv/cvmix_conv_cs

Control structure including parameters for CVMix convection.

Type fields:

% id_n2 :: integer Diagnostics handles.
% id_kd_conv :: integer Diagnostics handles.
% id_kv_conv :: integer Diagnostics handles.
% kd_conv_const :: real diffusivity constant used in convective regime [Z2 T-1 ~> m2 s-1]
% kv_conv_const :: real viscosity constant used in convective regime [Z2 T-1 ~> m2 s-1]
% bv_sqr_conv :: real Threshold for squared buoyancy frequency needed to trigger Brunt-Vaisala parameterization [T-2 ~> s-2].
% min_thickness :: real Minimum thickness allowed [Z ~> m].
% debug :: logical If true, turn on debugging.
% diag :: type(diag_ctrl), pointer Pointer to diagnostics control structure.

[source]

Function/Subroutine Documentation

function mom_cvmix_conv/cvmix_conv_init(Time, G, GV, US, param_file, diag, CS)

Initialized the CVMix convection mixing routine.

Parameters:

time :: [in] The current time.
g :: [in] Grid structure.
gv :: [in] Vertical grid structure.
us :: [in] A dimensional unit scaling type
param_file :: param_file [in] Run-time parameter file handle
diag :: diag [inout] Diagnostics control structure.
cs :: [inout] CVMix convection control structure

Call to:

mdl mom_error_handler::mom_error

[source]

subroutine mom_cvmix_conv/calculate_cvmix_conv(h, tv, G, GV, US, CS, hbl, Kd, Kv, Kd_aux)

Subroutine for calculating enhanced diffusivity/viscosity due to convection via CVMix.

Parameters:

g :: [in] Grid structure.
gv :: [in] Vertical grid structure.
us :: [in] A dimensional unit scaling type
h :: h [in] Layer thickness [H ~> m or kg m-2].
tv :: tv [in] Thermodynamics structure.
cs :: [in] CVMix convection control structure
hbl :: hbl [in] Depth of ocean boundary layer [Z ~> m]
kd :: [inout] Diapycnal diffusivity at each interface
kv :: [inout] Viscosity at each interface that will be
kd_aux :: [inout] A second diapycnal diffusivity at each

Called from:

mom_diabatic_driver::diabatic_ale mom_diabatic_driver::diabatic_ale_legacy mom_diabatic_driver::layered_diabatic

[source]

function mom_cvmix_conv/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.

Parameters:: param_file :: param_file [in] A structure to parse for run-time parameters
Call to:: mdl
Called from:: mom_set_visc::set_visc_register_restarts

[source]