namespace mom_internal_tides

Overview

Subroutines that use the ray-tracing equations to propagate the internal tide energy density. More…

namespace mom_internal_tides {

// global functions

subroutine, public propagate_int_tide(
    h h,
    tv tv,
    cn cn,
    TKE_itidal_input TKE_itidal_input,
    vel_btTide vel_btTide,
    Nb Nb,
    dt dt,
    G G,
    GV GV,
    US US,
    CS CS
    );

subroutine, public get_lowmode_loss(
    i i,
    j j,
    G G,
    CS CS,
    mechanism mechanism,
    TKE_loss_sum TKE_loss_sum
    );

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

subroutine, public internal_tides_end(CS CS);

} // namespace mom_internal_tides

Detailed Documentation

Subroutines that use the ray-tracing equations to propagate the internal tide energy density.

Benjamin Mater & Robert Hallberg, 2015

Global Functions

subroutine, public propagate_int_tide(
    h h,
    tv tv,
    cn cn,
    TKE_itidal_input TKE_itidal_input,
    vel_btTide vel_btTide,
    Nb Nb,
    dt dt,
    G G,
    GV GV,
    US US,
    CS CS
    )

Calls subroutines in this file that are needed to refract, propagate, and dissipate energy density of the internal tide.

Parameters:

g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
us	A dimensional unit scaling type
h	Layer thicknesses [H ~> m or kg m-2]
tv	Pointer to thermodynamic variables (needed for wave structure).
tke_itidal_input	The energy input to the internal waves [W m-2].
vel_bttide	Barotropic velocity read from file [m s-1].
nb	Near-bottom buoyancy frequency [s-1].
dt	Length of time over which these fluxes will be applied [s].
cs	The control structure returned by a previous call to int_tide_init.
cn	The internal wave speeds of each

subroutine, public get_lowmode_loss(
    i i,
    j j,
    G G,
    CS CS,
    mechanism mechanism,
    TKE_loss_sum TKE_loss_sum
    )

This subroutine extracts the energy lost from the propagating internal which has been summed across all angles, frequencies, and modes for a given mechanism and location.

It can be called from another module to get values from this module’s (private) CS.

Parameters:

i	The i-index of the value to be reported.
j	The j-index of the value to be reported.
g	The ocean’s grid structure
cs	The control structure returned by a previous call to int_tide_init.
mechanism	The named mechanism of loss to return
tke_loss_sum	Total energy loss rate due to specified mechanism [W m-2].

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

This subroutine initializes the internal tides module.

Parameters:

time	The current model time.
g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
us	A dimensional unit scaling type
param_file	A structure to parse for run-time parameters.
diag	A structure that is used to regulate diagnostic output.
cs	A pointer that is set to point to the control structure for this module.

subroutine, public internal_tides_end(CS CS)

This subroutine deallocates the memory associated with the internal tides control structure.

Parameters:

cs	A pointer to the control structure returned by a previous call to internal_tides_init, it will be deallocated here.