namespace mom_pointaccel

Overview

Debug accelerations at a given point. More…

namespace mom_pointaccel {

// global functions

subroutine, public write_u_accel(
    I I,
    j j,
    um um,
    hin hin,
    ADp ADp,
    CDp CDp,
    dt dt,
    G G,
    GV GV,
    US US,
    CS CS,
    vel_rpt vel_rpt,
    str str,
    a a,
    hv hv
    );

subroutine, public write_v_accel(
    i i,
    J J,
    vm vm,
    hin hin,
    ADp ADp,
    CDp CDp,
    dt dt,
    G G,
    GV GV,
    US US,
    CS CS,
    vel_rpt vel_rpt,
    str str,
    a a,
    hv hv
    );

subroutine, public pointaccel_init(
    MIS MIS,
    Time Time,
    G G,
    param_file param_file,
    diag diag,
    dirs dirs,
    CS CS
    );

} // namespace mom_pointaccel

Detailed Documentation

Debug accelerations at a given point.

The two subroutines in this file write out all of the terms in the u- or v-momentum balance at a given point. Usually these subroutines are called after the velocities exceed some threshold, in order to determine which term is culpable. often this is done for debugging purposes.

Global Functions

subroutine, public write_u_accel(
    I I,
    j j,
    um um,
    hin hin,
    ADp ADp,
    CDp CDp,
    dt dt,
    G G,
    GV GV,
    US US,
    CS CS,
    vel_rpt vel_rpt,
    str str,
    a a,
    hv hv
    )

This subroutine writes to an output file all of the accelerations that have been applied to a column of zonal velocities over the previous timestep. This subroutine is called from vertvisc.

Parameters:

i	The zonal index of the column to be documented.
j	The meridional index of the column to be documented.
g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
us	A dimensional unit scaling type
um	The new zonal velocity [L T-1 ~> m s-1].
hin	The layer thickness [H ~> m or kg m-2].
adp	A structure pointing to the various accelerations in the momentum equations.
cdp	A structure with pointers to various terms in the continuity equations.
dt	The ocean dynamics time step [s].
cs	The control structure returned by a previous call to PointAccel_init.
vel_rpt	The velocity magnitude that triggers a report [L T-1 ~> m s-1].
str	The surface wind stress integrated over a time step divided by the Boussinesq density [m2 s-1].
a	The layer coupling coefficients from vertvisc [Z s-1 ~> m s-1].
hv	The layer thicknesses at velocity grid points,

subroutine, public write_v_accel(
    i i,
    J J,
    vm vm,
    hin hin,
    ADp ADp,
    CDp CDp,
    dt dt,
    G G,
    GV GV,
    US US,
    CS CS,
    vel_rpt vel_rpt,
    str str,
    a a,
    hv hv
    )

This subroutine writes to an output file all of the accelerations that have been applied to a column of meridional velocities over the previous timestep. This subroutine is called from vertvisc.

Parameters:

i	The zonal index of the column to be documented.
j	The meridional index of the column to be documented.
g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
us	A dimensional unit scaling type
vm	The new meridional velocity [L T-1 ~> m s-1].
hin	The layer thickness [H ~> m or kg m-2].
adp	A structure pointing to the various accelerations in the momentum equations.
cdp	A structure with pointers to various terms in the continuity equations.
dt	The ocean dynamics time step [s].
cs	The control structure returned by a previous call to PointAccel_init.
vel_rpt	The velocity magnitude that triggers a report [L T-1 ~> m s-1].
str	The surface wind stress integrated over a time step divided by the Boussinesq density [m2 s-1].
a	The layer coupling coefficients from vertvisc [Z s-1 ~> m s-1].
hv	The layer thicknesses at velocity grid points,

subroutine, public pointaccel_init(
    MIS MIS,
    Time Time,
    G G,
    param_file param_file,
    diag diag,
    dirs dirs,
    CS CS
    )

This subroutine initializes the parameters regulating how truncations are logged.

Parameters:

mis	For “MOM Internal State” a set of pointers
time	The current model time.
g	The ocean’s grid structure.
param_file	A structure to parse for run-time parameters.
diag	A structure that is used to regulate diagnostic output.
dirs	A structure containing several relevant directory paths.
cs	A pointer that is set to point to the control structure for this module.