atlas::interpolation::method::GridBoxAverage class final
#include <atlas/interpolation/method/knn/GridBoxAverage.h>

Base classes

class GridBoxMethod

Public types

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

Constructors, destructors, conversion operators

GridBoxMethod(const Config&)

Public functions

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

Private functions

void do_execute(const FieldSet& source, FieldSet& target, Metadata&) const override
void do_execute(const Field& source, Field& target, Metadata&) const override

Typedef documentation

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

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

Function documentation

void atlas::interpolation::method::GridBoxAverage::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::GridBoxAverage::setup(const Grid& source, const Grid& target)
#include <atlas/interpolation/method/Method.h>

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

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

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

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

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

Metadata atlas::interpolation::method::GridBoxAverage::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::GridBoxAverage::execute_adjoint(Field& source, const Field& target) const
#include <atlas/interpolation/method/Method.h>