Implementation of Directory for a distributed noncontiguous Map. More...

Inheritance diagram for Tpetra::Details::DistributedNoncontiguousDirectory< LocalOrdinal, GlobalOrdinal, NodeType >:

Public Member Functions
	DistributedNoncontiguousDirectory (const Teuchos::RCP< const map_type > &map)
	Constructor.
LookupStatus	getEntries (const Teuchos::ArrayView< const GlobalOrdinal > &globalIDs, const Teuchos::ArrayView< int > &nodeIDs, const Teuchos::ArrayView< LocalOrdinal > &localIDs, const bool computeLIDs) const
Implementation of Teuchos::Describable.
std::string	description () const
	A one-line human-readable description of this object.
Protected Member Functions
LookupStatus	getEntriesImpl (const Teuchos::ArrayView< const GlobalOrdinal > &globalIDs, const Teuchos::ArrayView< int > &nodeIDs, const Teuchos::ArrayView< LocalOrdinal > &localIDs, const bool computeLIDs) const
	Find process IDs and (optionally) local IDs for the given global IDs.
Teuchos::RCP< const map_type >	getMap () const
	Get the Map with which this object was created.

Detailed Description

Implementation of Directory for a distributed noncontiguous Map.

Constructor & Destructor Documentation

template<class LocalOrdinal, class GlobalOrdinal, class NodeType>

Tpetra::Details::DistributedNoncontiguousDirectory< LO, GO, NT >::DistributedNoncontiguousDirectory ( const Teuchos::RCP< const map_type > & map )

Constructor.

template<class LO , class GO , class NT >

std::string Tpetra::Details::DistributedNoncontiguousDirectory< LO, GO, NT >::description ( ) const

A one-line human-readable description of this object.

template<class LocalOrdinal, class GlobalOrdinal, class NodeType>

LookupStatus Tpetra::Details::DistributedNoncontiguousDirectory< LO, GO, NT >::getEntriesImpl	(	const Teuchos::ArrayView< const GlobalOrdinal > &	globalIDs,
		const Teuchos::ArrayView< int > &	nodeIDs,
		const Teuchos::ArrayView< LocalOrdinal > &	localIDs,
		const bool	computeLIDs
	)		const `[protected, virtual]`

Find process IDs and (optionally) local IDs for the given global IDs.

template<class LocalOrdinal , class GlobalOrdinal , class NodeType >

LookupStatus Tpetra::Details::Directory< LO, GO, NT >::getEntries	(	const Teuchos::ArrayView< const GlobalOrdinal > &	globalIDs,
		const Teuchos::ArrayView< int > &	nodeIDs,
		const Teuchos::ArrayView< LocalOrdinal > &	localIDs,
		const bool	computeLIDs
	)		const `[inherited]`

Find process IDs and (optionally) local IDs for the given global IDs.

Precondition:: nodeIDs.size() == globalIDs.size(); ! computeLIDs || localIDs.size() == globalIDs.size()

Parameters:

globalIDs	[in] The global IDs for which to find process IDs (and optionally local IDs).
nodeIDs	[out] The process IDs corresponding to the given global IDs. If a global ID does not belong to any process, the corresponding entry of nodeIDs will be -1.
localIDs	[out] If computeLIDs is true, we fill this with the local IDs corresponding to the given global IDs. If a given global ID does not correspond to a local ID, the corresponding entry will be Teuchos::OrdinalTraits<LocalOrdinal>::invalid().
computeLIDs	[in] Whether to fill in localIDs.

Returns:: If at least one GID was not present in the directory, return IDNotPresent. Otherwise, return AllIDsPresent.

Note:: To implementers: The implementation of this method first performs input validation, then invokes getEntriesImpl() (implemented in the subclass) to do the work.

template<class LocalOrdinal , class GlobalOrdinal , class NodeType >

Teuchos::RCP<const map_type> Tpetra::Details::Directory< LocalOrdinal, GlobalOrdinal, NodeType >::getMap ( ) const [inline, protected, inherited]

Get the Map with which this object was created.

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