Tpetra_Import_Util.hpp File Reference

Internal functions and macros designed for use with Tpetra::Import and Tpetra::Export objects. More...

#include "Tpetra_ConfigDefs.hpp"
#include "Tpetra_Import.hpp"
#include "Tpetra_HashTable.hpp"
#include "Tpetra_Map.hpp"
#include "Tpetra_Util.hpp"
#include "Tpetra_Distributor.hpp"
#include <Teuchos_Array.hpp>
#include <utility>

Go to the source code of this file.

Namespaces
namespace	Tpetra
	Namespace Tpetra contains the class and methods constituting the Tpetra library.

Functions
template<typename LocalOrdinal , typename GlobalOrdinal , typename Node >
void	Tpetra::Import_Util::getPidGidPairs (const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &Importer, Teuchos::Array< std::pair< int, GlobalOrdinal > > &gpids, bool use_minus_one_for_local)
	For each GID in the TargetMap, find who owns the GID in the SourceMap.
template<typename LocalOrdinal , typename GlobalOrdinal , typename Node >
void	Tpetra::Import_Util::getPids (const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &Importer, Teuchos::Array< int > &pids, bool use_minus_one_for_local)
	Like getPidGidPairs, but just gets the PIDs, ordered by the column Map.
template<typename LocalOrdinal , typename GlobalOrdinal , typename Node >
void	Tpetra::Import_Util::getPids (const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &Importer, Teuchos::ArrayView< int > &pids, bool use_minus_one_for_local)
	Like getPidGidPairs, but just gets the PIDs, ordered by the column Map.
template<typename LocalOrdinal , typename GlobalOrdinal , typename Node >
void	Tpetra::Import_Util::getRemotePIDs (const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &Importer, Teuchos::Array< int > &RemotePIDs)
	Get a list of remote PIDs from an importer in the order corresponding to the remote LIDs.

Detailed Description

Internal functions and macros designed for use with Tpetra::Import and Tpetra::Export objects.

Warning

The functions in this file are implementation details of Tpetra. We make no promises of backwards compatibility.

Definition in file Tpetra_Import_Util.hpp.

Function Documentation

getPidGidPairs()

template<typename LocalOrdinal , typename GlobalOrdinal , typename Node >

void Tpetra::Import_Util::getPidGidPairs	(	const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &	Importer,
		Teuchos::Array< std::pair< int, GlobalOrdinal > > &	gpids,
		bool	use_minus_one_for_local
	)

For each GID in the TargetMap, find who owns the GID in the SourceMap.

This only uses the Distributor and does not communicate. It returns (as an output argument) an array of (PID,GID) pairs. If use_minus_one_for_local is true, any GIDs owned by this processor get -1 instead of their PID.

Definition at line 67 of file Tpetra_Import_Util.hpp.

getPids() [1/2]

template<typename LocalOrdinal , typename GlobalOrdinal , typename Node >

void Tpetra::Import_Util::getPids	(	const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &	Importer,
		Teuchos::Array< int > &	pids,
		bool	use_minus_one_for_local
	)

Like getPidGidPairs, but just gets the PIDs, ordered by the column Map.

Definition at line 110 of file Tpetra_Import_Util.hpp.

getPids() [2/2]

template<typename LocalOrdinal , typename GlobalOrdinal , typename Node >

void Tpetra::Import_Util::getPids	(	const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &	Importer,
		Teuchos::ArrayView< int > &	pids,
		bool	use_minus_one_for_local
	)

Like getPidGidPairs, but just gets the PIDs, ordered by the column Map.

Definition at line 120 of file Tpetra_Import_Util.hpp.

getRemotePIDs()

template<typename LocalOrdinal , typename GlobalOrdinal , typename Node >

void Tpetra::Import_Util::getRemotePIDs	(	const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &	Importer,
		Teuchos::Array< int > &	RemotePIDs
	)

Get a list of remote PIDs from an importer in the order corresponding to the remote LIDs.

Definition at line 158 of file Tpetra_Import_Util.hpp.