This class builds an object containing information necesary for efficiently exporting entries off-processor. More...

#include <Tpetra_Export.hpp>

Inherits Describable.

Public Member Functions
Constructor/Destructor Methods
	Export (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &source, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &target)
	Constructs a Export object from the source and target Map.
	Export (const Export< LocalOrdinal, GlobalOrdinal, Node > &rhs)
	copy constructor.
	~Export ()
	destructor.
Export Attribute Methods
size_t	getNumSameIDs () const
	Returns the number of entries that are identical between the source and target Maps, up to the first different ID.
size_t	getNumPermuteIDs () const
	Returns the number of entries that are local to the calling image, but not part of the first getNumSameIDs() entries.
Teuchos::ArrayView< const LocalOrdinal >	getPermuteFromLIDs () const
	List of entries in the source Map that are permuted. (non-persisting view)
Teuchos::ArrayView< const LocalOrdinal >	getPermuteToLIDs () const
	List of entries in the target Map that are permuted. (non-persisting view)
size_t	getNumRemoteIDs () const
	Returns the number of entries that are not on the calling image.
Teuchos::ArrayView< const LocalOrdinal >	getRemoteLIDs () const
	List of entries in the target Map that are coming from other images. (non-persisting view)
size_t	getNumExportIDs () const
	Returns the number of entries that must be sent by the calling image to other images.
Teuchos::ArrayView< const LocalOrdinal >	getExportLIDs () const
	List of entries in the source Map that will be sent to other images. (non-persisting view)
Teuchos::ArrayView< const int >	getExportImageIDs () const
	List of images to which entries will be sent, getExportLIDs() [i] will be sent to image getExportImageIDs() [i]. (non-persisting view)
const Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > &	getSourceMap () const
	Returns the Source Map used to construct this exporter.
const Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > &	getTargetMap () const
	Returns the Target Map used to construct this exporter.
Distributor &	getDistributor () const
Export< LocalOrdinal, GlobalOrdinal, Node > &	operator= (const Export< LocalOrdinal, GlobalOrdinal, Node > &Source)
	Assignment operator.
I/O Methods
virtual void	print (std::ostream &os) const
	Print method.

Detailed Description

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

This class builds an object containing information necesary for efficiently exporting entries off-processor.

Export is used to construct a communication plan that can be called repeatedly by computational classes to efficiently export entries to other nodes. For example, an exporter is used when we start out with a multiple-ownership distribution, and we want to merge that into a uniquely-owned distribution.

This class currently has one constructor, taking two Map objects specifying the distributions of the distributed objects on which the Export class will operate.

This class is templated on LocalOrdinal and GlobalOrdinal. The GlobalOrdinal type, if omitted, defaults to the LocalOrdinal type.

Definition at line 56 of file Tpetra_Export.hpp.