Tpetra_ImportExportData_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_IMPORTEXPORTDATA_DECL_HPP
#define TPETRA_IMPORTEXPORTDATA_DECL_HPP

#include "Tpetra_ImportExportData_fwd.hpp"
#include "Tpetra_Export_fwd.hpp"
#include "Tpetra_Import_fwd.hpp"
#include "Tpetra_Map_fwd.hpp"
#include "Tpetra_Distributor.hpp"
#include "Teuchos_Array.hpp"
#include "Teuchos_RCP.hpp"

#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Teuchos {
class ParameterList; // forward declaration
} // namespace Teuchos
#endif // DOXYGEN_SHOULD_SKIP_THIS

namespace Tpetra {

  template<class LocalOrdinal,
           class GlobalOrdinal,
           class Node>
  class ImportExportData {
  public:
    typedef LocalOrdinal local_ordinal_type;
    typedef GlobalOrdinal global_ordinal_type;
    typedef Node node_type;
    typedef Map<LocalOrdinal,GlobalOrdinal,Node> map_type;

    ImportExportData () = delete;

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

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

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

    ImportExportData (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);
    ~ImportExportData () = default;

    Teuchos::RCP<ImportExportData<LocalOrdinal, GlobalOrdinal, Node> > reverseClone();

    const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > source_;

    const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > target_;

    Teuchos::RCP<Teuchos::FancyOStream> out_;

    bool verbose_ = false;

    using execution_space = typename Node::device_type::execution_space;
    using memory_space =
      ::Tpetra::Details::DefaultTypes::comm_buffer_memory_space<typename Node::device_type>;
    using device_type = Kokkos::Device<execution_space, memory_space>;

    Kokkos::DualView<LocalOrdinal*, device_type> permuteToLIDs_;

    Kokkos::DualView<LocalOrdinal*, device_type> permuteFromLIDs_;

    Kokkos::DualView<LocalOrdinal*, device_type> remoteLIDs_;

    bool remoteLIDsContiguous_ = false;

    bool exportLIDsContiguous_ = false;

    Kokkos::DualView<LocalOrdinal*, device_type> exportLIDs_;

    Teuchos::Array<int> exportPIDs_;

    size_t numSameIDs_;

    Distributor distributor_;

    bool isLocallyComplete_;

  private:
    ImportExportData (const ImportExportData<LocalOrdinal,GlobalOrdinal,Node> &rhs);
    ImportExportData<LocalOrdinal,GlobalOrdinal,Node>&
    operator= (const ImportExportData<LocalOrdinal,GlobalOrdinal,Node> & rhs);
  }; // class ImportExportData

} // namespace Tpetra

#endif // TPETRA_IMPORTEXPORTDATA_DECL_HPP