Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

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

#include <Tpetra_Import.hpp>

Inheritance diagram for Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >:

Inheritance graph
[legend]
List of all members.

Public Member Functions

Constructor/Destructor Methods
 Import (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &source, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &target)
 Constructs a Import object from the source and target Maps.
 Import (const Import< LocalOrdinal, GlobalOrdinal, Node > &import)
 copy constructor.
 ~Import ()
 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 importer.
const Teuchos::RCP< const
Map< LocalOrdinal, GlobalOrdinal,
Node > > & 
getTargetMap () const
 Returns the Target Map used to construct this importer.
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.

Detailed Description

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

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

Import is used to construct a communication plan that can be called repeatedly by computational classes to efficiently import entries from 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.


Constructor & Destructor Documentation

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

Constructs a Import object from the source and target Maps.

template<class LocalOrdinal, class GlobalOrdinal, class Node>
Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::Import ( const Import< LocalOrdinal, GlobalOrdinal, Node > &  import  ) 

copy constructor.

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

destructor.


Member Function Documentation

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

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

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

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

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

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

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

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

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

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

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

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

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

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

template<class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::ArrayView< const int > Tpetra::Import< 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).

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

Returns the Source Map used to construct this importer.

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

Returns the Target Map used to construct this importer.

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

Assignment operator.

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

Print method.


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