Xpetra_Import.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_IMPORT_HPP
#define XPETRA_IMPORT_HPP

/* this file is automatically generated - do not edit (see script/interfaces.py) */

#include <Tpetra_KokkosCompat_DefaultNode.hpp>
#include <Teuchos_Describable.hpp>
#include <Teuchos_as.hpp>
#include "Xpetra_Map.hpp"
#include <iterator>

namespace Xpetra {

template <class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class Import
  : public Teuchos::Describable {
 public:
  typedef LocalOrdinal local_ordinal_type;
  typedef GlobalOrdinal global_ordinal_type;
  typedef Node node_type;
  typedef Map<LocalOrdinal, GlobalOrdinal, Node> map_type;



  virtual ~Import() {}

  virtual Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> >
  createRemoteOnlyImport(const Teuchos::RCP<const map_type>& remoteTarget) const = 0;




  virtual size_t getNumSameIDs() const = 0;

  virtual size_t getNumPermuteIDs() const = 0;

  virtual ArrayView<const LocalOrdinal> getPermuteFromLIDs() const = 0;

  virtual ArrayView<const LocalOrdinal> getPermuteToLIDs() const = 0;

  virtual size_t getNumRemoteIDs() const = 0;

  virtual ArrayView<const LocalOrdinal> getRemoteLIDs() const = 0;

  virtual size_t getNumExportIDs() const = 0;

  virtual ArrayView<const LocalOrdinal> getExportLIDs() const = 0;

  virtual ArrayView<const int> getExportPIDs() const = 0;

  virtual Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getSourceMap() const = 0;

  virtual Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getTargetMap() const = 0;

  virtual void setDistributorParameters(const Teuchos::RCP<Teuchos::ParameterList> params) const = 0;




  virtual void print(std::ostream& os) const = 0;


};  // Import class

}  // namespace Xpetra

#define XPETRA_IMPORT_SHORT
#endif  // XPETRA_IMPORT_HPP