namespace mom_continuity

Overview

Solve the layer continuity equation. More…

namespace mom_continuity {

// global variables

integer, parameter ppm_scheme = 1;

// global functions

subroutine, public continuity(
    u u,
    v v,
    hin hin,
    h h,
    uh uh,
    vh vh,
    dt dt,
    G G,
    GV GV,
    US US,
    CS CS,
    uhbt uhbt,
    vhbt vhbt,
    OBC OBC,
    visc_rem_u visc_rem_u,
    visc_rem_v visc_rem_v,
    u_cor u_cor,
    v_cor v_cor,
    BT_cont BT_cont
    );

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

integer function, public continuity_stencil(CS CS);
subroutine, public continuity_end(CS CS);

} // namespace mom_continuity

Detailed Documentation

Solve the layer continuity equation.

Global Variables

integer, parameter ppm_scheme = 1

Enumerated constant to select PPM.

Global Functions

subroutine, public continuity(
    u u,
    v v,
    hin hin,
    h h,
    uh uh,
    vh vh,
    dt dt,
    G G,
    GV GV,
    US US,
    CS CS,
    uhbt uhbt,
    vhbt vhbt,
    OBC OBC,
    visc_rem_u visc_rem_u,
    visc_rem_v visc_rem_v,
    u_cor u_cor,
    v_cor v_cor,
    BT_cont BT_cont
    )

Time steps the layer thicknesses, using a monotonically limited, directionally split PPM scheme, based on Lin (1994).

Parameters:

g	Ocean grid structure.
gv	Vertical grid structure.
u	Zonal velocity [L T-1 ~> m s-1].
v	Meridional velocity [L T-1 ~> m s-1].
hin	Initial layer thickness [H ~> m or kg m-2].
h	Final layer thickness [H ~> m or kg m-2].
uh	Volume flux through zonal faces =
vh	Volume flux through meridional faces =
dt	Time increment [T ~> s].
us	A dimensional unit scaling type
cs	Control structure for mom_continuity.
uhbt	The vertically summed volume
vhbt	The vertically summed volume
obc	Open boundaries control structure.
visc_rem_u	Both the fraction of
visc_rem_v	Both the fraction of
u_cor	The zonal velocities that
v_cor	The meridional velocities that
bt_cont	A structure with elements

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

Initializes continuity_cs.

Parameters:

time	Current model time.
g	Ocean grid structure.
gv	Vertical grid structure.
us	A dimensional unit scaling type
param_file	Parameter file handles.
diag	Diagnostics control structure.
cs	Control structure for mom_continuity.

integer function, public continuity_stencil(CS CS)

continuity_stencil returns the continuity solver stencil size

Parameters:

cs	Module’s control structure.

Returns:

The continuity solver stencil size with the current settings.

subroutine, public continuity_end(CS CS)

Destructor for continuity_cs.

Parameters:

cs	Control structure for mom_continuity.