Tpetra::Directory< Ordinal > Class Template Reference

Tpetra::Directory. More...

#include <Tpetra_DirectoryDecl.hpp>

Inheritance diagram for Tpetra::Directory< Ordinal >:

Teuchos::Object List of all members.

Constructors/Destructor.

 Directory (const Map< Ordinal > &map)
 constructor
 ~Directory ()
 destructor.

Public Member Functions

Query methods.
bool getDirectoryEntries (const Teuchos::ArrayView< const Ordinal > &globalEntries, const Teuchos::ArrayView< Ordinal > &images) const
 getDirectoryEntries : Returns image info for non-local Map entries
bool getDirectoryEntries (const Teuchos::ArrayView< const Ordinal > &globalEntries, const Teuchos::ArrayView< Ordinal > &images, const Teuchos::ArrayView< Ordinal > &localEntries) const
 getDirectoryEntries : Returns image and local id info for non-local Map entries

Detailed Description

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

Tpetra::Directory.

For Map objects, a Directory object must be created to allow referencing of non-local elements. Tpetra::Directory produces and contains a uniform linear Map and a list of imageIDs allowing non-local elements to be accessed by dereferencing throught the Directory.

This class currently has one constructor, taking an Map object.


Constructor & Destructor Documentation

template<typename Ordinal>
Tpetra::Directory< Ordinal >::Directory ( const Map< Ordinal > &  map  ) 

constructor

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

destructor.


Member Function Documentation

template<typename Ordinal>
bool Tpetra::Directory< Ordinal >::getDirectoryEntries ( const Teuchos::ArrayView< const Ordinal > &  globalEntries,
const Teuchos::ArrayView< Ordinal > &  images 
) const

getDirectoryEntries : Returns image info for non-local Map entries

Given a list of Global Entry IDs, this function returns the list of IDs of the owning memory image that correspond to the list of entries.

Parameters:
In globalEntries - List of Global IDs being passed in.
Out images - On return contains list of Image IDs owning the Global IDs in question. -1 correspond to global entries not present in the directory.
Returns:
true signifies at least one specified global entry was not present in the directory.

template<typename Ordinal>
bool Tpetra::Directory< Ordinal >::getDirectoryEntries ( const Teuchos::ArrayView< const Ordinal > &  globalEntries,
const Teuchos::ArrayView< Ordinal > &  images,
const Teuchos::ArrayView< Ordinal > &  localEntries 
) const

getDirectoryEntries : Returns image and local id info for non-local Map entries

Given a list of Global Entry IDs, this function returns the list of image IDs and local IDs on the owning memory image that correspond to the list of entries.

Parameters:
In globalEntries - List of Global IDs being passed in.
Out images - On return contains list of Image IDs owning the Global IDs in question. -1 correspond to global entries not present in the directory.
Out localEntries - On return contains the local ID of the global on the owning image. -1 correspond to global entries not present in the directory.
Returns:
true signifies at least one specified global entry was not present in the directory.


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