namespace mom_int_tide_input

Overview

Calculates energy input to the internal tides. More…

namespace mom_int_tide_input {

// global functions

subroutine, public set_int_tide_input(
    u u,
    v v,
    h h,
    tv tv,
    fluxes fluxes,
    itide itide,
    dt dt,
    G G,
    GV GV,
    US US,
    CS CS
    );

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

subroutine, public int_tide_input_end(CS CS);

} // namespace mom_int_tide_input

Detailed Documentation

Calculates energy input to the internal tides.

Global Functions

subroutine, public set_int_tide_input(
    u u,
    v v,
    h h,
    tv tv,
    fluxes fluxes,
    itide itide,
    dt dt,
    G G,
    GV GV,
    US US,
    CS CS
    )

Sets the model-state dependent internal tide energy sources.

Parameters:

g	The ocean’s grid structure
gv	The ocean’s vertical grid structure
us	A dimensional unit scaling type
u	The zonal velocity [L T-1 ~> m s-1]
v	The meridional velocity [L T-1 ~> m s-1]
h	Layer thicknesses [H ~> m or kg m-2]
tv	A structure containing pointers to the thermodynamic fields
fluxes	A structure of thermodynamic surface fluxes
itide	A structure containing fields related to the internal tide sources.
dt	The time increment [s].
cs	This module’s control structure.

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

Initializes the data related to the internal tide input 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	structure used to regulate diagnostic output.
cs	This module’s control structure, which is initialized here.
itide	A structure containing fields related to the internal tide sources.

subroutine, public int_tide_input_end(CS CS)

Deallocates any memory related to the internal tide input module.

Parameters:

cs	This module’s control structure, which is deallocated here.