Communication plan for data redistribution from a uniquely-owned to a (possibly) multiply-owned distribution. More...

#include <Tpetra_Import.hpp>

Inherits Describable.

Public Types
typedef Map< LocalOrdinal, GlobalOrdinal, Node >	map_type
	The specialization of Map used by this class.
Public Member Functions
Constructor/Destructor Methods
	Import (const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target)
	Construct an Import from the source and target Maps.
	Import (const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target, const Teuchos::RCP< Teuchos::ParameterList > &plist)
	Constructor (with list of parameters)
	Import (const Import< LocalOrdinal, GlobalOrdinal, Node > &import)
	Copy constructor.
	~Import ()
	Destructor.
Import Attribute Methods
size_t	getNumSameIDs () const
	Number of initial identical IDs.
size_t	getNumPermuteIDs () const
	Number of IDs to permute but not to communicate.
ArrayView< const LocalOrdinal >	getPermuteFromLIDs () const
	List of local IDs in the source Map that are permuted.
ArrayView< const LocalOrdinal >	getPermuteToLIDs () const
	List of local IDs in the target Map that are permuted.
size_t	getNumRemoteIDs () const
	Number of entries not on the calling process.
ArrayView< const LocalOrdinal >	getRemoteLIDs () const
	List of entries in the target Map to receive from other processes.
size_t	getNumExportIDs () const
	Number of entries that must be sent by the calling process to other processes.
ArrayView< const LocalOrdinal >	getExportLIDs () const
	List of entries in the source Map that will be sent to other processes.
ArrayView< const int >	getExportImageIDs () const
	List of processes to which entries will be sent.
const RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > &	getSourceMap () const
	The Source Map used to construct this Import object.
const RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > &	getTargetMap () const
	The Target Map used to construct this Import object.
Distributor &	getDistributor () const
	The `Distributor` that this `Import` object uses to move data.
Import< LocalOrdinal, GlobalOrdinal, Node > &	operator= (const Import< LocalOrdinal, GlobalOrdinal, Node > &Source)
	Assignment operator.
I/O Methods
virtual void	print (std::ostream &os) const
	Print method.
Related Functions
(Note that these are not member functions.)
template<class LO , class GO , class Node >
RCP< const Import< LO, GO, Node > >	createImport (const RCP< const Map< LO, GO, Node > > &src, const RCP< const Map< LO, GO, Node > > &tgt)
	Non-member constructor for Import objects.

Detailed Description

template<class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
class Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >

Communication plan for data redistribution from a uniquely-owned to a (possibly) multiply-owned distribution.

Tpetra users should use this class to construct a communication plan between two data distributions (i.e., two Map objects). The plan can be called repeatedly by computational classes to perform communication according to the same pattern. Constructing the plan may be expensive, both in terms of communication and computation. However, it can be reused inexpensively.

Tpetra has two classes for data redistribution: Import and Export. Import is for redistributing data from a uniquely-owned distribution to a possibly multiply-owned distribution. Export is for redistributing data from a possibly multiply-owned distribution to a uniquely-owned distribution.

One use case of Import is bringing in remote source vector data for a distributed sparse matrix-vector multiply. The source vector itself is uniquely owned, but must be brought in into an overlapping distribution so that each process can compute its part of the target vector without further communication.

Epetra separated Import and Export for performance reasons. The implementation is different, depending on which direction is the uniquely-owned Map. Tpetra retains this convention.

This class is templated on the same template arguments as Map: the local ordinal type (LocalOrdinal), the global ordinal type (GlobalOrdinal), and the Kokkos Node type (Node).

Definition at line 90 of file Tpetra_Import.hpp.

Member Typedef Documentation

template<class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>

typedef Map<LocalOrdinal,GlobalOrdinal,Node> Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::map_type

The specialization of Map used by this class.

Definition at line 94 of file Tpetra_Import.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>

Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::Import	(	const Teuchos::RCP< const map_type > &	source,
		const Teuchos::RCP< const map_type > &	target
	)

Construct an Import from the source and target Maps.

Parameters:

source	[in] The source distribution. This must be a uniquely owned (nonoverlapping) distribution.
target	[in] The target distribution. This may be a multiply owned (overlapping) distribution.

template<class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>

Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::Import	(	const Teuchos::RCP< const map_type > &	source,
		const Teuchos::RCP< const map_type > &	target,
		const Teuchos::RCP< Teuchos::ParameterList > &	plist
	)

Constructor (with list of parameters)

Parameters:

source	[in] The source distribution. This must be a uniquely owned (nonoverlapping) distribution.
target	[in] The target distribution. This may be a multiply owned (overlapping) distribution.
plist	[in/out] List of parameters. Currently passed directly to the Distributor that implements communication.