namespace mom_diag_vkernels

Overview

Provides kernels for single-column interpolation, re-integration (re-mapping of integrated quantities) and intensive-variable remapping in the vertical. More…

namespace mom_diag_vkernels {

// global functions

subroutine, public interpolate_column(
    nsrc nsrc,
    h_src h_src,
    u_src u_src,
    ndest ndest,
    h_dest h_dest,
    missing_value missing_value,
    u_dest u_dest
    );

subroutine, public reintegrate_column(
    nsrc nsrc,
    h_src h_src,
    uh_src uh_src,
    ndest ndest,
    h_dest h_dest,
    missing_value missing_value,
    uh_dest uh_dest
    );

logical function, public diag_vkernels_unit_tests(verbose verbose);

} // namespace mom_diag_vkernels

Detailed Documentation

Provides kernels for single-column interpolation, re-integration (re-mapping of integrated quantities) and intensive-variable remapping in the vertical.

Global Functions

subroutine, public interpolate_column(
    nsrc nsrc,
    h_src h_src,
    u_src u_src,
    ndest ndest,
    h_dest h_dest,
    missing_value missing_value,
    u_dest u_dest
    )

Linearly interpolate interface data, u_src, from grid h_src to a grid h_dest.

Parameters:

nsrc	Number of source cells
h_src	Thickness of source cells
u_src	Values at source cell interfaces
ndest	Number of destination cells
h_dest	Thickness of destination cells
missing_value	Value to assign in vanished cells
u_dest	Interpolated value at destination cell interfaces

subroutine, public reintegrate_column(
    nsrc nsrc,
    h_src h_src,
    uh_src uh_src,
    ndest ndest,
    h_dest h_dest,
    missing_value missing_value,
    uh_dest uh_dest
    )

Conservatively calculate integrated data, uh_dest, on grid h_dest, from layer-integrated data, uh_src, on grid h_src.

Parameters:

nsrc	Number of source cells
h_src	Thickness of source cells
uh_src	Values at source cell interfaces
ndest	Number of destination cells
h_dest	Thickness of destination cells
missing_value	Value to assign in vanished cells
uh_dest	Interpolated value at destination cell interfaces

logical function, public diag_vkernels_unit_tests(verbose verbose)

Returns true if any unit tests for module MOM_diag_vkernels fail.

Parameters:

verbose

If true, write results to stdout