/* * (C) Copyright 1996- ECMWF. * * This software is licensed under the terms of the Apache Licence Version 2.0 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0. * * In applying this licence, ECMWF does not waive the privileges and immunities * granted to it by virtue of its status as an intergovernmental organisation nor * does it submit to any jurisdiction. */ #pragma once #include #include "atlas/interpolation/nonlinear/NonLinear.h" #include "atlas/library/config.h" #include "atlas/util/ObjectHandle.h" namespace atlas { class Field; namespace util { class Config; } } // namespace atlas namespace atlas { namespace interpolation { /** * @brief NonLinear class applies non-linear corrections to an interpolation matrix */ struct NonLinear : DOXYGEN_HIDE(public util::ObjectHandle) { using Spec = util::Config; using Config = nonlinear::NonLinear::Config; using Matrix = nonlinear::NonLinear::Matrix; /** * @brief ctor */ using Handle::Handle; NonLinear(); NonLinear(const Config&); NonLinear(const std::string& type, const Config&); /** * @brief bool operator * @return if NonLinear object has been setup */ using Handle::operator bool; // (ensure this exists) /** * @brief if NonLinear applies to field * @param [in] f field * @return if NonLinear applies to field */ bool operator()(const Field& f) const; /** * @brief Apply non-linear corrections to interpolation matrix * @param [inout] W interpolation matrix * @param [in] f field * @return if W was modified */ bool execute(Matrix& W, const Field& f) const; /** * @brief Apply non-linear corrections to interpolation matrix * @param [inout] W interpolation matrix * @param [in] a array containing possibly missing values * @param [in] c configuration containing missing value diagnostic information * @return if W was modified */ bool execute(Matrix& W, const array::Array& a, const Config& c) const; }; } // namespace interpolation } // namespace atlas