Tpetra_Export_decl.hpp

// @HEADER
// *****************************************************************************
//          Tpetra: Templated Linear Algebra Services Package
//
// Copyright 2008 NTESS and the Tpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TPETRA_EXPORT_DECL_HPP
#define TPETRA_EXPORT_DECL_HPP

#include "Tpetra_Details_Transfer.hpp"
#include "Tpetra_Export_fwd.hpp"
#include "Tpetra_Import_fwd.hpp"
#include "Teuchos_ArrayView.hpp"
#include "Teuchos_RCP.hpp"

#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Teuchos {
template <class T>
class Array;          // forward declaration
class ParameterList;  // forward declaration
}  // namespace Teuchos
#endif  // DOXYGEN_SHOULD_SKIP_THIS

namespace Tpetra {
template <class LocalOrdinal,
          class GlobalOrdinal,
          class Node>
class Export : public ::Tpetra::Details::Transfer<LocalOrdinal, GlobalOrdinal, Node> {
 private:
  friend class Import<LocalOrdinal, GlobalOrdinal, Node>;
  using base_type =
      ::Tpetra::Details::Transfer<LocalOrdinal, GlobalOrdinal, Node>;

 public:
  using map_type = ::Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node>;



  Export(const Teuchos::RCP<const map_type>& source,
         const Teuchos::RCP<const map_type>& target);

  Export(const Teuchos::RCP<const map_type>& source,
         const Teuchos::RCP<const map_type>& target,
         const Teuchos::RCP<Teuchos::FancyOStream>& out);

  Export(const Teuchos::RCP<const map_type>& source,
         const Teuchos::RCP<const map_type>& target,
         const Teuchos::RCP<Teuchos::ParameterList>& plist);

  Export(const Teuchos::RCP<const map_type>& source,
         const Teuchos::RCP<const map_type>& target,
         const Teuchos::RCP<Teuchos::FancyOStream>& out,
         const Teuchos::RCP<Teuchos::ParameterList>& plist);

  Export(const Export<LocalOrdinal, GlobalOrdinal, Node>& rhs);

  Export(const Import<LocalOrdinal, GlobalOrdinal, Node>& importer);

  Export<LocalOrdinal, GlobalOrdinal, Node>&
  operator=(const Export<LocalOrdinal, GlobalOrdinal, Node>& rhs) = default;

  virtual ~Export() = default;



  virtual void
  describe(Teuchos::FancyOStream& out,
           const Teuchos::EVerbosityLevel verbLevel =
               Teuchos::Describable::verbLevel_default) const;

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

  void setupSamePermuteExport(Teuchos::Array<GlobalOrdinal>& exportGIDs);

  void setupRemote(Teuchos::Array<GlobalOrdinal>& exportGIDs);
};  // class Export

template <class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP<const Export<LocalOrdinal, GlobalOrdinal, Node> >
createExport(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& src,
             const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& tgt) {
  if (src == tgt) {
    return Teuchos::null;
  }
#ifdef HAVE_TPETRA_DEBUG
  TEUCHOS_TEST_FOR_EXCEPTION(src == Teuchos::null || tgt == Teuchos::null, std::runtime_error,
                             "Tpetra::createExport: Neither source nor target map may be null.");
#endif  // HAVE_TPETRA_DEBUG
  using export_type = Export<LocalOrdinal, GlobalOrdinal, Node>;
  return Teuchos::rcp(new export_type(src, tgt));
}

}  // namespace Tpetra

#endif  // TPETRA_EXPORT_DECL_HPP