Xpetra_DistObject.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//             Xpetra: A linear algebra interface package
//
// Copyright 2012 NTESS and the Xpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef XPETRA_DISTOBJECT_HPP
#define XPETRA_DISTOBJECT_HPP
 
/* this file is automatically generated - do not edit (see script/interfaces.py) */
 
#include "Xpetra_ConfigDefs.hpp"
#include "Xpetra_Map.hpp"
#include "Xpetra_Import.hpp"
#include "Xpetra_Export.hpp"
#include <Tpetra_KokkosCompat_DefaultNode.hpp>
#include <Teuchos_Describable.hpp>
 
namespace Xpetra {
 
template <class Packet,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class DistObject
  : virtual public Teuchos::Describable {
 public:
 
 
  virtual ~DistObject() {}
 
 
 
 
  virtual void doImport(const DistObject<Packet, LocalOrdinal, GlobalOrdinal, Node> &source, const Import<LocalOrdinal, GlobalOrdinal, Node> &importer, CombineMode CM) = 0;
 
  virtual void beginImport(const DistObject<Packet, LocalOrdinal, GlobalOrdinal, Node> &source, const Import<LocalOrdinal, GlobalOrdinal, Node> &importer, CombineMode CM) { doImport(source, importer, CM); };
 
  virtual void endImport(const DistObject<Packet, LocalOrdinal, GlobalOrdinal, Node> &source, const Import<LocalOrdinal, GlobalOrdinal, Node> &importer, CombineMode CM){};
 
  virtual void doExport(const DistObject<Packet, LocalOrdinal, GlobalOrdinal, Node> &source, const Export<LocalOrdinal, GlobalOrdinal, Node> &exporter, CombineMode CM) = 0;
 
  virtual void beginExport(const DistObject<Packet, LocalOrdinal, GlobalOrdinal, Node> &source, const Export<LocalOrdinal, GlobalOrdinal, Node> &exporter, CombineMode CM) { doExport(source, exporter, CM); };
 
  virtual void endExport(const DistObject<Packet, LocalOrdinal, GlobalOrdinal, Node> &source, const Export<LocalOrdinal, GlobalOrdinal, Node> &exporter, CombineMode CM){};
 
  virtual void doImport(const DistObject<Packet, LocalOrdinal, GlobalOrdinal, Node> &source, const Export<LocalOrdinal, GlobalOrdinal, Node> &exporter, CombineMode CM) = 0;
 
  virtual void beginImport(const DistObject<Packet, LocalOrdinal, GlobalOrdinal, Node> &source, const Export<LocalOrdinal, GlobalOrdinal, Node> &exporter, CombineMode CM) { doImport(source, exporter, CM); };
 
  virtual void endImport(const DistObject<Packet, LocalOrdinal, GlobalOrdinal, Node> &source, const Export<LocalOrdinal, GlobalOrdinal, Node> &exporter, CombineMode CM){};
 
  virtual void doExport(const DistObject<Packet, LocalOrdinal, GlobalOrdinal, Node> &source, const Import<LocalOrdinal, GlobalOrdinal, Node> &importer, CombineMode CM) = 0;
 
  virtual void beginExport(const DistObject<Packet, LocalOrdinal, GlobalOrdinal, Node> &source, const Import<LocalOrdinal, GlobalOrdinal, Node> &importer, CombineMode CM) { doExport(source, importer, CM); };
 
  virtual void endExport(const DistObject<Packet, LocalOrdinal, GlobalOrdinal, Node> &source, const Import<LocalOrdinal, GlobalOrdinal, Node> &importer, CombineMode CM){};
 
 
 
 
  virtual Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getMap() const = 0;
 
 
 
 
  virtual std::string description() const = 0;
 
  virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel = Teuchos::Describable::verbLevel_default) const = 0;
 
 
};  // DistObject class
 
}  // namespace Xpetra
 
#define XPETRA_DISTOBJECT_SHORT
#endif  // XPETRA_DISTOBJECT_HPP