Tpetra::Directory< OrdinalType > Class Template Reference

Tpetra::Directory. More...

#include <Tpetra_Directory.hpp>

Inheritance diagram for Tpetra::Directory< OrdinalType >:

[legend]Collaboration diagram for Tpetra::Directory< OrdinalType >:

[legend]List of all members.

Public Member Functions
	Directory (ElementSpace< OrdinalType > const &ElementSpace)
	constructor
	Directory (Directory< OrdinalType > const &Directory)
	copy constructor
	~Directory ()
	destructor.
void	getDirectoryEntries (std::vector< OrdinalType > const &globalEntries, std::vector< OrdinalType > &images) const
	getDirectoryEntries : Returns image info for non-local ElementSpace entries
void	getDirectoryEntries (std::vector< OrdinalType > const &globalEntries, std::vector< OrdinalType > &images, std::vector< OrdinalType > &localEntries) const
	getDirectoryEntries : Returns image and local id info for non-local ElementSpace entries

---

Detailed Description

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

Tpetra::Directory.

For ElementSpace objects, a Directory object must be created to allow referencing of non-local elements. Tpetra::Directory produces and contains a uniform linear ElementSpace 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 ElementSpace object.

---

Member Function Documentation

template<typename OrdinalType>

void Tpetra::Directory< OrdinalType >::getDirectoryEntries	(	std::vector< OrdinalType > const &	globalEntries,
		std::vector< OrdinalType > &	images,
		std::vector< OrdinalType > &	localEntries
	)			const [inline]

getDirectoryEntries : Returns image and local id info for non-local ElementSpace 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. If LocalEntries is 0, then local IDs are not returned. If EntrySizes is nonzero, it will contain a list of corresponding element sizes for the requested global 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.
	Out	localEntries - On return contains the local ID of the global on the owning image.

template<typename OrdinalType>

void Tpetra::Directory< OrdinalType >::getDirectoryEntries	(	std::vector< OrdinalType > const &	globalEntries,
		std::vector< OrdinalType > &	images
	)			const [inline]

getDirectoryEntries : Returns image info for non-local ElementSpace 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.

---

The documentation for this class was generated from the following file:

• Tpetra_Directory.hpp

---