namespace mom_horizontal_regridding

Overview

Horizontal interpolation. More…

namespace mom_horizontal_regridding {

// interfaces

interface fill_boundaries;
interface horiz_interp_and_extrap_tracer;

// global functions

subroutine, public mystats(
    array array,
    missing missing,
    is is,
    ie ie,
    js js,
    je je,
    k k,
    mesg mesg
    );

subroutine horiz_interp_and_extrap_tracer_record(
    filename filename,
    varnam varnam,
    conversion conversion,
    recnum recnum,
    G G,
    tr_z tr_z,
    mask_z mask_z,
    z_in z_in,
    z_edges_in z_edges_in,
    missing_value missing_value,
    reentrant_x reentrant_x,
    tripolar_n tripolar_n,
    homogenize homogenize,
    m_to_Z m_to_Z
    );

} // namespace mom_horizontal_regridding

Detailed Documentation

Horizontal interpolation.

Global Functions

subroutine, public mystats(
    array array,
    missing missing,
    is is,
    ie ie,
    js js,
    je je,
    k k,
    mesg mesg
    )

Write to the terminal some basic statistics about the k-th level of an array.

Parameters:

array	input array (ND)
missing	missing value (ND)
is	Horizontal loop bounds to calculate statistics for
ie	Horizontal loop bounds to calculate statistics for
js	Horizontal loop bounds to calculate statistics for
je	Horizontal loop bounds to calculate statistics for
k	Level to calculate statistics for
mesg	Label to use in message

subroutine horiz_interp_and_extrap_tracer_record(
    filename filename,
    varnam varnam,
    conversion conversion,
    recnum recnum,
    G G,
    tr_z tr_z,
    mask_z mask_z,
    z_in z_in,
    z_edges_in z_edges_in,
    missing_value missing_value,
    reentrant_x reentrant_x,
    tripolar_n tripolar_n,
    homogenize homogenize,
    m_to_Z m_to_Z
    )

Extrapolate and interpolate from a file record.

Parameters:

filename	Path to file containing tracer to be interpolated.
varnam	Name of tracer in filee.
conversion	Conversion factor for tracer.
recnum	Record number of tracer to be read.
g	Grid object
tr_z	pointer to allocatable tracer array on local model grid and input-file vertical levels.
mask_z	pointer to allocatable tracer mask array on local model grid and input-file vertical levels.
z_in	Cell grid values for input data.
z_edges_in	Cell grid edge values for input data.
missing_value	The missing value in the returned array.
reentrant_x	If true, this grid is reentrant in the x-direction
tripolar_n	If true, this is a northern tripolar grid
homogenize	If present and true, horizontally homogenize data to produce perfectly “flat” initial conditions
m_to_z	A conversion factor from meters to the units of depth. If missing, GbathyT must be in m.