namespace mom_cvmix_conv¶

Overview¶

Interface to CVMix convection scheme. More…

namespace mom_cvmix_conv {

// global variables

character(len=40) mdl = "MOM_CVMix_conv";

// global functions

logical function, public cvmix_conv_init(
    Time Time,
    G G,
    GV GV,
    US US,
    param_file param_file,
    diag diag,
    CS CS
    );

subroutine, public calculate_cvmix_conv(h h, tv tv, G G, GV GV, US US, CS CS, hbl hbl);
logical function, public cvmix_conv_is_used(param_file param_file);
subroutine, public cvmix_conv_end(CS CS);

} // namespace mom_cvmix_conv

Detailed Documentation¶

Interface to CVMix convection scheme.

Global Variables¶

character(len=40) mdl = "MOM_CVMix_conv"

This module’s name.

Global Functions¶

logical function, public cvmix_conv_init(
    Time Time,
    G G,
    GV GV,
    US US,
    param_file param_file,
    diag diag,
    CS CS
    )

Initialized the CVMix convection mixing routine.

Parameters:

time	The current time.
g	Grid structure.
gv	Vertical grid structure.
us	A dimensional unit scaling type
param_file	Run-time parameter file handle
diag	Diagnostics control structure.
cs	This module’s control structure.

subroutine, public calculate_cvmix_conv(
    h h,
    tv tv,
    G G,
    GV GV,
    US US,
    CS CS,
    hbl hbl
    )

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

Parameters:

g	Grid structure.
gv	Vertical grid structure.
us	A dimensional unit scaling type
h	Layer thickness [H ~> m or kg m-2].
tv	Thermodynamics structure.
cs	The control structure returned by a previous call to CVMix_conv_init.
hbl	Depth of ocean boundary layer [m]

logical function, public cvmix_conv_is_used(param_file 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

A structure to parse for run-time parameters

subroutine, public cvmix_conv_end(CS CS)

Clear pointers and dealocate memory.

Parameters:

cs	Control structure for this module that will be deallocated in this subroutine