Xpetra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Xpetra::ImportUtils< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Xpetra utility class for Import-related routines. More...

#include <Xpetra_ImportUtils.hpp>

Public Member Functions

void getPidGidPairs (const 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. More...
 
void getPids (const 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. More...
 
void getPids (const 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. More...
 
void getRemotePIDs (const 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. More...
 

Detailed Description

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class Xpetra::ImportUtils< LocalOrdinal, GlobalOrdinal, Node >

Xpetra utility class for Import-related routines.

The routines should be independent from Epetra/Tpetra and be purely implemented in Xpetra.

Definition at line 44 of file Xpetra_ImportUtils.hpp.

Member Function Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
void Xpetra::ImportUtils< LocalOrdinal, GlobalOrdinal, Node >::getPidGidPairs ( const Import< LocalOrdinal, GlobalOrdinal, Node > &  Importer,
Teuchos::Array< std::pair< int, GlobalOrdinal > > &  gpids,
bool  use_minus_one_for_local 
)
inline

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 55 of file Xpetra_ImportUtils.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
void Xpetra::ImportUtils< LocalOrdinal, GlobalOrdinal, Node >::getPids ( const Import< LocalOrdinal, GlobalOrdinal, Node > &  Importer,
Teuchos::Array< int > &  pids,
bool  use_minus_one_for_local 
)
inline

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

Definition at line 72 of file Xpetra_ImportUtils.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
void Xpetra::ImportUtils< LocalOrdinal, GlobalOrdinal, Node >::getPids ( const Import< LocalOrdinal, GlobalOrdinal, Node > &  Importer,
Teuchos::ArrayView< int > &  pids,
bool  use_minus_one_for_local 
)
inline

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

Definition at line 90 of file Xpetra_ImportUtils.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
void Xpetra::ImportUtils< LocalOrdinal, GlobalOrdinal, Node >::getRemotePIDs ( const Import< LocalOrdinal, GlobalOrdinal, Node > &  Importer,
Teuchos::Array< int > &  RemotePIDs 
)
inline

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

Definition at line 108 of file Xpetra_ImportUtils.hpp.


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