/* * (C) Copyright 2013 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/library/config.h" #include "atlas/util/ObjectHandle.h" namespace eckit { class Configuration; } namespace atlas { class Field; class FieldSet; class Grid; class Projection; namespace functionspace { class FunctionSpaceImpl; class HaloDescription; } namespace parallel { class GatherScatter; } // namespace parallel namespace util { class PartitionPolygon; class PartitionPolygons; } // namespace util } // namespace atlas namespace atlas { //------------------------------------------------------------------------------------------------------ class FunctionSpace : DOXYGEN_HIDE(public util::ObjectHandle) { public: using Handle::Handle; FunctionSpace(); std::string type() const; operator bool() const; size_t footprint() const; std::string distribution() const; Field createField(const eckit::Configuration&) const; Field createField(const Field&) const; Field createField(const Field&, const eckit::Configuration&) const; template Field createField(const eckit::Configuration&) const; template Field createField() const; void haloExchange(const FieldSet&, bool on_device = false) const; void haloExchange(const Field&, bool on_device = false) const; void adjointHaloExchange(const FieldSet&, bool on_device = false) const; void adjointHaloExchange(const Field&, bool on_device = false) const; void gather(const FieldSet&, FieldSet&) const; void gather(const Field&, Field&) const; void scatter(const FieldSet&, FieldSet&) const; void scatter(const Field&, Field&) const; const util::PartitionPolygon& polygon(idx_t halo = 0) const; const util::PartitionPolygons& polygons() const; const Projection& projection() const; idx_t part() const; idx_t nb_parts() const; idx_t size() const; const Grid& grid() const; Field lonlat() const; Field ghost() const; Field global_index() const; Field remote_index() const; Field partition() const; const functionspace::HaloDescription& halo_description() const; const parallel::GatherScatter& gather() const; const parallel::GatherScatter& scatter() const; std::string mpi_comm() const; }; //------------------------------------------------------------------------------------------------------ extern template Field FunctionSpace::createField() const; extern template Field FunctionSpace::createField() const; extern template Field FunctionSpace::createField() const; extern template Field FunctionSpace::createField() const; extern template Field FunctionSpace::createField(const eckit::Configuration&) const; extern template Field FunctionSpace::createField(const eckit::Configuration&) const; extern template Field FunctionSpace::createField(const eckit::Configuration&) const; extern template Field FunctionSpace::createField(const eckit::Configuration&) const; //------------------------------------------------------------------------------------------------------ } // namespace atlas