Tpetra::Export< Ordinal > Class Template Reference

Tpetra::Export: This class builds an export object for efficient exporting of off-processor entries. More...

#include <Tpetra_Export.hpp>

Inheritance diagram for Tpetra::Export< Ordinal >:

Teuchos::Object List of all members.

Public Member Functions

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

Detailed Description

template<typename Ordinal>
class Tpetra::Export< Ordinal >

Tpetra::Export: This class builds an export object for efficient exporting of off-processor entries.

Export is used to construct a communication plan that can be called repeatedly by computational classes such the Tpetra CisMatrix and Vector classes to efficiently export entries to other images. 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. The first Map specifies the distribution we have now. The second Map specifies the distribution we want to have after exporting.

NOTE: Behavior is undefined if the destination Map is not uniquely-owned.


Constructor & Destructor Documentation

template<typename Ordinal>
Tpetra::Export< Ordinal >::Export ( const Map< Ordinal > &  source,
const Map< Ordinal > &  target 
)

Constructs a Export object from the source and target Map.

template<typename Ordinal>
Tpetra::Export< Ordinal >::Export ( Export< Ordinal > const &  rhs  ) 

copy constructor.

template<typename Ordinal>
Tpetra::Export< Ordinal >::~Export (  ) 

destructor.


Member Function Documentation

template<typename Ordinal>
Ordinal Tpetra::Export< Ordinal >::getNumSameIDs (  )  const

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

template<typename Ordinal>
Ordinal Tpetra::Export< Ordinal >::getNumPermuteIDs (  )  const

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

template<typename Ordinal>
Teuchos::ArrayView< const Ordinal > Tpetra::Export< Ordinal >::getPermuteFromLIDs (  )  const

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

template<typename Ordinal>
Teuchos::ArrayView< const Ordinal > Tpetra::Export< Ordinal >::getPermuteToLIDs (  )  const

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

template<typename Ordinal>
Ordinal Tpetra::Export< Ordinal >::getNumRemoteIDs (  )  const

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

template<typename Ordinal>
Teuchos::ArrayView< const Ordinal > Tpetra::Export< Ordinal >::getRemoteLIDs (  )  const

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

template<typename Ordinal>
Ordinal Tpetra::Export< Ordinal >::getNumExportIDs (  )  const

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

template<typename Ordinal>
Teuchos::ArrayView< const Ordinal > Tpetra::Export< Ordinal >::getExportLIDs (  )  const

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

template<typename Ordinal>
Teuchos::ArrayView< const Ordinal > Tpetra::Export< Ordinal >::getExportImageIDs (  )  const

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

template<typename Ordinal>
const Map< Ordinal > & Tpetra::Export< Ordinal >::getSourceMap (  )  const

Returns the Source Map used to construct this exporter.

template<typename Ordinal>
const Map< Ordinal > & Tpetra::Export< Ordinal >::getTargetMap (  )  const

Returns the Target Map used to construct this exporter.

template<typename Ordinal>
Export< Ordinal > & Tpetra::Export< Ordinal >::operator= ( const Export< Ordinal > &  Source  ) 

Assignment operator.

template<typename Ordinal>
void Tpetra::Export< Ordinal >::print ( std::ostream &  os  )  const [virtual]

Print method inherited from Teuchos::Object.

Reimplemented from Teuchos::Object.


The documentation for this class was generated from the following file:
Generated on Wed May 12 21:59:41 2010 for Tpetra Matrix/Vector Services by  doxygen 1.4.7