atlas::interpolation::method::Binning class
#include <atlas/interpolation/method/binning/Binning.h>

Base classes

class atlas::interpolation::Method

Public types

using Config = eckit::Parametrisation
using Metadata = util::Metadata

Constructors, destructors, conversion operators

Binning(const Config& config)
Binning procedure to carry out a regridding from high to low resolution.
~Binning() override

Public functions

void print(std::ostream&) const override
auto source() const -> const FunctionSpace& override
auto target() const -> const FunctionSpace& override
void setup(const FunctionSpace& source, const FunctionSpace& target)
Setup the interpolator relating two functionspaces.
void setup(const Grid& source, const Grid& target)
void setup(const FunctionSpace& source, const Field& target)
void setup(const FunctionSpace& source, const FieldSet& target)
void setup(const Grid& source, const Grid& target, const Cache&)
auto execute(const FieldSet& source, FieldSet& target) const -> Metadata
auto execute(const Field& source, Field& target) const -> Metadata
auto execute_adjoint(FieldSet& source, const FieldSet& target) const -> Metadata
execute_adjoint
auto execute_adjoint(Field& source, const Field& target) const -> Metadata
auto createCache() const -> interpolation::Cache virtual

Private functions

void do_setup(const FunctionSpace& source, const FunctionSpace& target) override
void do_setup(const Grid& source, const Grid& target, const Cache&) override

Typedef documentation

using atlas::interpolation::method::Binning::Config = eckit::Parametrisation
#include <atlas/interpolation/method/Method.h>

using atlas::interpolation::method::Binning::Metadata = util::Metadata
#include <atlas/interpolation/method/Method.h>

Function documentation

atlas::interpolation::method::Binning::Binning(const Config& config)

Binning procedure to carry out a regridding from high to low resolution.

This method is part of the family of the Interpolation operations; it relies on the evaluation of the transpose of an interpolation matrix. The rigridding from high to low resolution is carried out by using a 'binning matrix': binning matrix: B = N A^T W area weights matrix: W interpolation matrix: A normalization factor matrix: N

Setup, configuration variables: <type>: method used to evaluate the 'B' matrix; value: 'binning' <scheme>: method used to evaluate the 'A' matrix; value: 'cubedsphere-bilinear', 'structured-bilinear', ... <halo_exchange>: flag to control the halo exchange procedure value: 'true', 'false' <adjoint>: flag to control the adjoint operation value: 'true', 'false'

void atlas::interpolation::method::Binning::setup(const FunctionSpace& source, const FunctionSpace& target)
#include <atlas/interpolation/method/Method.h>

Setup the interpolator relating two functionspaces.

Parameters
source functionspace containing source elements
target functionspace containing target points

void atlas::interpolation::method::Binning::setup(const Grid& source, const Grid& target)
#include <atlas/interpolation/method/Method.h>

void atlas::interpolation::method::Binning::setup(const FunctionSpace& source, const Field& target)
#include <atlas/interpolation/method/Method.h>

void atlas::interpolation::method::Binning::setup(const FunctionSpace& source, const FieldSet& target)
#include <atlas/interpolation/method/Method.h>

void atlas::interpolation::method::Binning::setup(const Grid& source, const Grid& target, const Cache&)
#include <atlas/interpolation/method/Method.h>

Metadata atlas::interpolation::method::Binning::execute(const FieldSet& source, FieldSet& target) const
#include <atlas/interpolation/method/Method.h>

Metadata atlas::interpolation::method::Binning::execute(const Field& source, Field& target) const
#include <atlas/interpolation/method/Method.h>

Metadata atlas::interpolation::method::Binning::execute_adjoint(FieldSet& source, const FieldSet& target) const
#include <atlas/interpolation/method/Method.h>

execute_adjoint

Parameters
source - it is either a FieldSet or a Field
target - it is either a FieldSet or a Field Note that formally in an adjoint operation of this type we should be setting the values in the target to zero. This is not done for efficiency reasons and because in most cases it is not necessary.

Metadata atlas::interpolation::method::Binning::execute_adjoint(Field& source, const Field& target) const
#include <atlas/interpolation/method/Method.h>

interpolation::Cache atlas::interpolation::method::Binning::createCache() const virtual
#include <atlas/interpolation/method/Method.h>