namespace mom_checksum_packages

Overview

Provides routines that do checksums of groups of MOM variables. More…

namespace mom_checksum_packages {

// interfaces

interface mom_state_chksum;

// global functions

subroutine, public mom_thermo_chksum(mesg mesg, tv tv, G G, haloshift haloshift);

subroutine, public mom_surface_chksum(
    mesg mesg,
    sfc sfc,
    G G,
    haloshift haloshift,
    symmetric symmetric
    );

subroutine, public mom_accel_chksum(
    mesg mesg,
    CAu CAu,
    CAv CAv,
    PFu PFu,
    PFv PFv,
    diffu diffu,
    diffv diffv,
    G G,
    GV GV,
    US US,
    pbce pbce,
    u_accel_bt u_accel_bt,
    v_accel_bt v_accel_bt,
    symmetric symmetric
    );

subroutine, public mom_state_stats(
    mesg mesg,
    u u,
    v v,
    h h,
    Temp Temp,
    Salt Salt,
    G G,
    GV GV,
    US US,
    allowChange allowChange,
    permitDiminishing permitDiminishing
    );

} // namespace mom_checksum_packages

Detailed Documentation

Provides routines that do checksums of groups of MOM variables.

Global Functions

subroutine, public mom_thermo_chksum(mesg mesg, tv tv, G G, haloshift haloshift)

Write out chksums for the model’s thermodynamic state variables.

Parameters:

mesg	A message that appears on the chksum lines.
tv	A structure pointing to various thermodynamic variables.
g	The ocean’s grid structure.
haloshift	The width of halos to check (default 0).

subroutine, public mom_surface_chksum(
    mesg mesg,
    sfc sfc,
    G G,
    haloshift haloshift,
    symmetric symmetric
    )

Write out chksums for the ocean surface variables.

Parameters:

mesg	A message that appears on the chksum lines.
sfc	transparent ocean surface state structure shared with the calling routine data in this structure is intent out.
g	The ocean’s grid structure.
haloshift	The width of halos to check (default 0).
symmetric	If true, do checksums on the fully symmetric computational domain.

subroutine, public mom_accel_chksum(
    mesg mesg,
    CAu CAu,
    CAv CAv,
    PFu PFu,
    PFv PFv,
    diffu diffu,
    diffv diffv,
    G G,
    GV GV,
    US US,
    pbce pbce,
    u_accel_bt u_accel_bt,
    v_accel_bt v_accel_bt,
    symmetric symmetric
    )

Write out chksums for the model’s accelerations.

Parameters:

mesg	A message that appears on the chksum lines.
g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
cau	Zonal acceleration due to Coriolis
cav	Meridional acceleration due to Coriolis
pfu	Zonal acceleration due to pressure gradients
pfv	Meridional acceleration due to pressure gradients
diffu	Zonal acceleration due to convergence of the
diffv	Meridional acceleration due to convergence of
us	A dimensional unit scaling type
pbce	The baroclinic pressure anomaly in each layer
u_accel_bt	The zonal acceleration from terms in the
v_accel_bt	The meridional acceleration from terms in
symmetric	If true, do checksums on the fully symmetric computational domain.

subroutine, public mom_state_stats(
    mesg mesg,
    u u,
    v v,
    h h,
    Temp Temp,
    Salt Salt,
    G G,
    GV GV,
    US US,
    allowChange allowChange,
    permitDiminishing permitDiminishing
    )

Monitor and write out statistics for the model’s state variables.

Parameters:

g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
mesg	A message that appears on the chksum lines.
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].
temp	Temperature [degC].
salt	Salinity [ppt].
us	A dimensional unit scaling type
allowchange	do not flag an error if the statistics change.
permitdiminishing	do not flag error if the extrema are diminishing.