namespace mom_checksums

Overview

Routines to calculate checksums of various array and vector types. More…

namespace mom_checksums {

// interfaces

interface bchksum;
interface bchksum_pair;
interface chk_sum_msg;
interface chksum;
interface hchksum;
interface hchksum_pair;
interface is_nan;
interface qchksum;
interface uchksum;
interface uvchksum;
interface vchksum;

// global functions

subroutine, public chksum0(scalar scalar, mesg mesg, scale scale, logunit logunit);
subroutine, public zchksum(array array, mesg mesg, scale scale, logunit logunit);
subroutine, public mom_checksums_init(param_file param_file);

} // namespace mom_checksums

Detailed Documentation

Routines to calculate checksums of various array and vector types.

Global Functions

subroutine, public chksum0(
    scalar scalar,
    mesg mesg,
    scale scale,
    logunit logunit
    )

Checksum a scalar field (consistent with array checksums)

Parameters:

scalar	The array to be checksummed
mesg	An identifying message
scale	A scaling factor for this array.
logunit	IO unit for checksum logging

subroutine, public zchksum(array array, mesg mesg, scale scale, logunit logunit)

Checksum a 1d array (typically a column).

Parameters:

array	The array to be checksummed
mesg	An identifying message
scale	A scaling factor for this array.
logunit	IO unit for checksum logging

subroutine, public mom_checksums_init(param_file param_file)

MOM_checksums_init initializes the MOM_checksums module. As it happens, the only thing that it does is to log the version of this module.

Parameters:

param_file

A structure to parse for run-time parameters