Tpetra Matrix/Vector Services Version of the Day
Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

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

#include <Tpetra_Export.hpp>

Inheritance diagram for Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >:
Inheritance graph
[legend]

List of all members.

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.
DistributorgetDistributor () 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.


Constructor & Destructor Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::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.

Definition at line 140 of file Tpetra_Export.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::Export ( const Export< LocalOrdinal, GlobalOrdinal, Node > &  rhs)

copy constructor.

Definition at line 151 of file Tpetra_Export.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::~Export ( )

destructor.

Definition at line 156 of file Tpetra_Export.hpp.


Member Function Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getNumSameIDs ( ) const

Returns the number of entries that are identical between the source and target Maps, up to the first different ID.

Definition at line 160 of file Tpetra_Export.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getNumPermuteIDs ( ) const

Returns the number of entries that are local to the calling image, but not part of the first getNumSameIDs() entries.

Definition at line 165 of file Tpetra_Export.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::ArrayView< const LocalOrdinal > Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getPermuteFromLIDs ( ) const

List of entries in the source Map that are permuted. (non-persisting view)

Definition at line 171 of file Tpetra_Export.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::ArrayView< const LocalOrdinal > Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getPermuteToLIDs ( ) const

List of entries in the target Map that are permuted. (non-persisting view)

Definition at line 177 of file Tpetra_Export.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getNumRemoteIDs ( ) const

Returns the number of entries that are not on the calling image.

Definition at line 182 of file Tpetra_Export.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::ArrayView< const LocalOrdinal > Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getRemoteLIDs ( ) const

List of entries in the target Map that are coming from other images. (non-persisting view)

Definition at line 188 of file Tpetra_Export.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getNumExportIDs ( ) const

Returns the number of entries that must be sent by the calling image to other images.

Definition at line 193 of file Tpetra_Export.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::ArrayView< const LocalOrdinal > Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getExportLIDs ( ) const

List of entries in the source Map that will be sent to other images. (non-persisting view)

Definition at line 199 of file Tpetra_Export.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::ArrayView< const int > Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getExportImageIDs ( ) const

List of images to which entries will be sent, getExportLIDs() [i] will be sent to image getExportImageIDs() [i]. (non-persisting view)

Definition at line 205 of file Tpetra_Export.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > & Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getSourceMap ( ) const

Returns the Source Map used to construct this exporter.

Definition at line 211 of file Tpetra_Export.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > & Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getTargetMap ( ) const

Returns the Target Map used to construct this exporter.

Definition at line 217 of file Tpetra_Export.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Export< LocalOrdinal, GlobalOrdinal, Node > & Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::operator= ( const Export< LocalOrdinal, GlobalOrdinal, Node > &  Source)

Assignment operator.

Definition at line 228 of file Tpetra_Export.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::print ( std::ostream &  os) const [virtual]

Print method.

Definition at line 234 of file Tpetra_Export.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines