41 #ifndef TPETRA_DISTOBJECT_DECL_HPP
42 #define TPETRA_DISTOBJECT_DECL_HPP
47 #include "Tpetra_Details_DistributorActor.hpp"
48 #include "Tpetra_Map.hpp"
49 #include "Tpetra_Import.hpp"
50 #include "Tpetra_Export.hpp"
53 #include "Kokkos_ArithTraits.hpp"
55 #include <type_traits>
61 #ifdef HAVE_TPETRA_TRANSFER_TIMERS
62 # undef HAVE_TPETRA_TRANSFER_TIMERS
63 #endif // HAVE_TPETRA_TRANSFER_TIMERS
65 namespace KokkosClassic {
70 enum ReadWriteOption {
160 template<
class DistObjectType>
163 const Teuchos::RCP<
const Map<
typename DistObjectType::local_ordinal_type,
164 typename DistObjectType::global_ordinal_type,
165 typename DistObjectType::node_type> >& newMap);
203 template<
class DistObjectType>
318 template <
class Packet,
324 virtual public Teuchos::Describable
334 using packet_type = typename ::Kokkos::ArithTraits<Packet>::val_type;
357 explicit DistObject (
const Teuchos::RCP<const map_type>& map);
417 const bool restrictedMode =
false);
450 const bool restrictedMode =
false);
484 const bool restrictedMode =
false);
518 const bool restrictedMode =
false);
524 const bool restrictedMode =
false);
530 const bool restrictedMode =
false);
536 const bool restrictedMode =
false);
542 const bool restrictedMode =
false);
548 const bool restrictedMode =
false);
554 const bool restrictedMode =
false);
560 const bool restrictedMode =
false);
566 const bool restrictedMode =
false);
589 virtual Teuchos::RCP<const map_type>
getMap ()
const {
return map_; }
599 void print (std::ostream& os)
const;
616 describe (Teuchos::FancyOStream &out,
617 const Teuchos::EVerbosityLevel verbLevel =
618 Teuchos::Describable::verbLevel_default)
const;
728 const ::Tpetra::Details::Transfer<local_ordinal_type, global_ordinal_type, node_type>& transfer,
729 const char modeString[],
732 const bool restrictedMode);
750 const size_t numImportLIDs);
756 ::Tpetra::Details::DefaultTypes::comm_buffer_memory_space<device_type>;
770 Kokkos::Device<
typename device_type::execution_space,
779 const ::Tpetra::Details::Transfer<local_ordinal_type, global_ordinal_type, node_type>& transfer,
780 const char modeString[],
783 const bool restrictedMode);
786 const ::Tpetra::Details::Transfer<local_ordinal_type, global_ordinal_type, node_type>& transfer,
787 const char modeString[],
790 const bool restrictedMode);
793 size_t constantNumPackets,
795 std::shared_ptr<std::string> prefix,
796 const bool canTryAliasing,
800 const Kokkos::DualView<const local_ordinal_type*, buffer_device_type>& exportLIDs,
801 size_t& constantNumPackets,
804 void doUnpackAndCombine(
const Kokkos::DualView<const local_ordinal_type*, buffer_device_type>& remoteLIDs,
805 size_t constantNumPackets,
858 const size_t numSameIDs,
870 const Kokkos::DualView<const local_ordinal_type *, buffer_device_type>
872 const Kokkos::DualView<const local_ordinal_type *, buffer_device_type>
920 Kokkos::DualView<
size_t*,
922 size_t& constantNumPackets);
932 Kokkos::DualView<
size_t*,
934 size_t& constantNumPackets,
981 Kokkos::DualView<
size_t*,
983 const size_t constantNumPackets,
991 Kokkos::DualView<
size_t*,
993 const size_t constantNumPackets,
998 Teuchos::RCP<const map_type>
map_;
1001 std::unique_ptr<std::string>
1002 createPrefix(
const char className[],
1003 const char methodName[])
const;
1011 Kokkos::DualView<packet_type*, buffer_device_type>
imports_;
1034 const std::string* prefix,
1035 const bool remoteLIDsContiguous=
false,
1058 Kokkos::DualView<packet_type*, buffer_device_type>
exports_;
1078 Details::DistributorActor distributorActor_;
1080 #ifdef HAVE_TPETRA_TRANSFER_TIMERS
1081 Teuchos::RCP<Teuchos::Time> doXferTimer_;
1082 Teuchos::RCP<Teuchos::Time> copyAndPermuteTimer_;
1083 Teuchos::RCP<Teuchos::Time> packAndPrepareTimer_;
1084 Teuchos::RCP<Teuchos::Time> doPostsAndWaitsTimer_;
1085 Teuchos::RCP<Teuchos::Time> unpackAndCombineTimer_;
1086 #endif // HAVE_TPETRA_TRANSFER_TIMERS
1090 #endif // TPETRA_DISTOBJECT_DECL_HPP
Communication plan for data redistribution from a uniquely-owned to a (possibly) multiply-owned distr...
Node node_type
The Node type. If you don't know what this is, don't use it.
Kokkos::DualView< size_t *, buffer_device_type > numExportPacketsPerLID_
Number of packets to send for each send operation.
virtual void copyAndPermute(const SrcDistObject &source, const size_t numSameIDs, const Kokkos::DualView< const local_ordinal_type *, buffer_device_type > &permuteToLIDs, const Kokkos::DualView< const local_ordinal_type *, buffer_device_type > &permuteFromLIDs, const CombineMode CM)
Perform copies and permutations that are local to the calling (MPI) process.
void doImport(const SrcDistObject &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, const CombineMode CM, const bool restrictedMode=false)
Import data into this object using an Import object ("forward mode").
typename::Kokkos::ArithTraits< GlobalOrdinal >::val_type packet_type
The type of each datum being sent or received in an Import or Export.
void print(std::ostream &os) const
Print this object to the given output stream.
virtual bool reallocArraysForNumPacketsPerLid(const size_t numExportLIDs, const size_t numImportLIDs)
Reallocate numExportPacketsPerLID_ and/or numImportPacketsPerLID_, if necessary.
Abstract base class for sources of an Import or Export.
bool isDistributed() const
Whether this is a globally distributed object.
Forward declaration of Tpetra::DistObject.
void removeEmptyProcessesInPlace(Teuchos::RCP< DistObjectType > &input, const Teuchos::RCP< const Map< typename DistObjectType::local_ordinal_type, typename DistObjectType::global_ordinal_type, typename DistObjectType::node_type > > &newMap)
Remove processes which contain no elements in this object's Map.
virtual void unpackAndCombine(const Kokkos::DualView< const local_ordinal_type *, buffer_device_type > &importLIDs, Kokkos::DualView< packet_type *, buffer_device_type > imports, Kokkos::DualView< size_t *, buffer_device_type > numPacketsPerLID, const size_t constantNumPackets, const CombineMode combineMode)
Perform any unpacking and combining after communication.
virtual void doTransfer(const SrcDistObject &src, const ::Tpetra::Details::Transfer< local_ordinal_type, global_ordinal_type, node_type > &transfer, const char modeString[], const ReverseOption revOp, const CombineMode CM, const bool restrictedMode)
Redistribute data across (MPI) processes.
typename Node::device_type device_type
The Kokkos Device type.
void beginTransfer(const SrcDistObject &src, const ::Tpetra::Details::Transfer< local_ordinal_type, global_ordinal_type, node_type > &transfer, const char modeString[], const ReverseOption revOp, const CombineMode CM, const bool restrictedMode)
Implementation detail of doTransfer.
GlobalOrdinal global_ordinal_type
The type of global indices.
virtual ~DistObject()=default
Destructor (virtual for memory safety of derived classes).
Kokkos::DualView< size_t *, buffer_device_type > numImportPacketsPerLID_
Number of packets to receive for each receive operation.
Insert new values that don't currently exist.
typename device_type::execution_space execution_space
The Kokkos execution space.
Kokkos::DualView< packet_type *, buffer_device_type > imports_
Buffer into which packed data are imported (received from other processes).
Kokkos::DualView< packet_type *, buffer_device_type > exports_
Buffer from which packed data are exported (sent to other processes).
::Tpetra::Details::DefaultTypes::comm_buffer_memory_space< device_type > buffer_memory_space
Kokkos memory space for communication buffers.
Communication plan for data redistribution from a (possibly) multiply-owned to a uniquely-owned distr...
virtual void packAndPrepare(const SrcDistObject &source, const Kokkos::DualView< const local_ordinal_type *, buffer_device_type > &exportLIDs, Kokkos::DualView< packet_type *, buffer_device_type > &exports, Kokkos::DualView< size_t *, buffer_device_type > numPacketsPerLID, size_t &constantNumPackets)
Pack data and metadata for communication (sends).
CombineMode
Rule for combining data in an Import or Export.
Teuchos::RCP< const map_type > map_
The Map over which this object is distributed.
Abstract base class for objects that can be the source of an Import or Export operation.
DistObject & operator=(const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &)=default
Assignment operator (default).
LocalOrdinal local_ordinal_type
The type of local indices.
DistObject(const Teuchos::RCP< const map_type > &map)
Constructor.
virtual std::string description() const
One-line descriptiion of this object.
bool transferArrived() const
Whether the data from an import/export operation has arrived, and is ready for the unpack and combine...
virtual size_t constantNumberOfPackets() const
Whether the implementation's instance promises always to have a constant number of packets per LID (l...
virtual bool reallocImportsIfNeeded(const size_t newSize, const bool verbose, const std::string *prefix, const bool remoteLIDsContiguous=false, const CombineMode CM=INSERT)
Reallocate imports_ if needed.
A parallel distribution of indices over processes.
void doExport(const SrcDistObject &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, const CombineMode CM, const bool restrictedMode=false)
Export data into this object using an Export object ("forward mode").
virtual Teuchos::RCP< const map_type > getMap() const
The Map describing the parallel distribution of this object.
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
Print a descriptiion of this object to the given output stream.
Kokkos::Device< typename device_type::execution_space, buffer_memory_space > buffer_device_type
Base class for distributed Tpetra objects that support data redistribution.
virtual void removeEmptyProcessesInPlace(const Teuchos::RCP< const map_type > &newMap)
Remove processes which contain no entries in this object's Map.
virtual bool checkSizes(const SrcDistObject &source)=0
Compare the source and target (this) objects for compatibility.