namespace mom_bkgnd_mixing

Overview

Interface to background mixing schemes, including the Bryan and Lewis (1979) which is applied via CVMix. More…

namespace mom_bkgnd_mixing {

// global variables

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

// global functions

subroutine, public bkgnd_mixing_init(
    Time Time,
    G G,
    GV GV,
    US US,
    param_file param_file,
    diag diag,
    CS CS
    );

subroutine, public sfc_bkgnd_mixing(G G, US US, CS CS);

subroutine, public calculate_bkgnd_mixing(
    h h,
    tv tv,
    N2_lay N2_lay,
    Kd_lay Kd_lay,
    Kv Kv,
    j j,
    G G,
    GV GV,
    US US,
    CS CS
    );

subroutine, public bkgnd_mixing_end(CS CS);

} // namespace mom_bkgnd_mixing

Detailed Documentation

Interface to background mixing schemes, including the Bryan and Lewis (1979) which is applied via CVMix.

Global Variables

character(len=40) mdl = "MOM_bkgnd_mixing"

This module’s name.

Global Functions

subroutine, public bkgnd_mixing_init(
    Time Time,
    G G,
    GV GV,
    US US,
    param_file param_file,
    diag diag,
    CS CS
    )

Initialize the background 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 sfc_bkgnd_mixing(G G, US US, CS CS)

Get surface vertical background diffusivities/viscosities.

Parameters:

g	Grid structure.
us	A dimensional unit scaling type
cs	The control structure returned by a previous call to bkgnd_mixing_init.

subroutine, public calculate_bkgnd_mixing(
    h h,
    tv tv,
    N2_lay N2_lay,
    Kd_lay Kd_lay,
    Kv Kv,
    j j,
    G G,
    GV GV,
    US US,
    CS CS
    )

Calculates the vertical background diffusivities/viscosities.

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.
n2_lay	squared buoyancy frequency associated with layers [T-2 ~> s-2]
kd_lay	Diapycnal diffusivity of each layer [Z2 T-1 ~> m2 s-1].
kv	The “slow” vertical viscosity at each interface (not layer!) [Z2 T-1 ~> m2 s-1]
j	Meridional grid index
cs	The control structure returned by a previous call to bkgnd_mixing_init.

subroutine, public bkgnd_mixing_end(CS CS)

Clear pointers and dealocate memory.

Parameters:

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