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

#include <Xpetra_TpetraImport_decl.hpp>

Inheritance diagram for Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >:
Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >

Public Types

typedef Map< LocalOrdinal,
GlobalOrdinal, Node > 
map_type
 The specialization of Map used by this class. More...
 
- Public Types inherited from Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
typedef Map< LocalOrdinal,
GlobalOrdinal, Node > 
map_type
 

Private Attributes

RCP< const Tpetra::Import
< LocalOrdinal, GlobalOrdinal,
Node > > 
import_
 

Constructor/Destructor Methods

 TpetraImport (const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target)
 Construct an Import from the source and target Maps. More...
 
 TpetraImport (const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target, const Teuchos::RCP< Teuchos::ParameterList > &plist)
 Constructor (with list of parameters). More...
 
 TpetraImport (const Import< LocalOrdinal, GlobalOrdinal, Node > &import)
 Copy constructor. More...
 
 ~TpetraImport ()
 Destructor. More...
 
Teuchos::RCP< const Import
< LocalOrdinal, GlobalOrdinal,
Node > > 
createRemoteOnlyImport (const Teuchos::RCP< const map_type > &remoteTarget) const
 Special "constructor". More...
 

Import Attribute Methods

size_t getNumSameIDs () const
 Number of initial identical IDs. More...
 
size_t getNumPermuteIDs () const
 Number of IDs to permute but not to communicate. More...
 
ArrayView< const LocalOrdinal > getPermuteFromLIDs () const
 List of local IDs in the source Map that are permuted. More...
 
ArrayView< const LocalOrdinal > getPermuteToLIDs () const
 List of local IDs in the target Map that are permuted. More...
 
size_t getNumRemoteIDs () const
 Number of entries not on the calling process. More...
 
ArrayView< const LocalOrdinal > getRemoteLIDs () const
 List of entries in the target Map to receive from other processes. More...
 
void setDistributorParameters (const Teuchos::RCP< Teuchos::ParameterList > params) const
 Set parameters on distributor. More...
 
size_t getNumExportIDs () const
 Number of entries that must be sent by the calling process to other processes. More...
 
ArrayView< const LocalOrdinal > getExportLIDs () const
 List of entries in the source Map that will be sent to other processes. More...
 
ArrayView< const int > getExportPIDs () const
 List of processes to which entries will be sent. More...
 
Teuchos::RCP< const Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
getSourceMap () const
 The Source Map used to construct this Import object. More...
 
Teuchos::RCP< const Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
getTargetMap () const
 The Target Map used to construct this Import object. More...
 

I/O Methods

void print (std::ostream &os) const
 Print the Import's data to the given output stream. More...
 

Xpetra specific

 TpetraImport (const RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > &import)
 TpetraImport constructor to wrap a Tpetra::Import object. More...
 
RCP< const Tpetra::Import
< LocalOrdinal, GlobalOrdinal,
Node > > 
getTpetra_Import () const
 

Detailed Description

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

Definition at line 28 of file Xpetra_TpetraImport_decl.hpp.

Member Typedef Documentation

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
typedef Map<LocalOrdinal, GlobalOrdinal, Node> Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::map_type

The specialization of Map used by this class.

Definition at line 32 of file Xpetra_TpetraImport_decl.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::TpetraImport ( const Teuchos::RCP< const map_type > &  source,
const Teuchos::RCP< const map_type > &  target 
)

Construct an Import from the source and target Maps.

Definition at line 25 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::TpetraImport ( const Teuchos::RCP< const map_type > &  source,
const Teuchos::RCP< const map_type > &  target,
const Teuchos::RCP< Teuchos::ParameterList > &  plist 
)

Constructor (with list of parameters).

Definition at line 29 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::TpetraImport ( const Import< LocalOrdinal, GlobalOrdinal, Node > &  import)

Copy constructor.

Definition at line 33 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::~TpetraImport ( )

Destructor.

Definition at line 37 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::TpetraImport ( const RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > &  import)

TpetraImport constructor to wrap a Tpetra::Import object.

Definition at line 128 of file Xpetra_TpetraImport_def.hpp.

Member Function Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::createRemoteOnlyImport ( const Teuchos::RCP< const map_type > &  remoteTarget) const
virtual

Special "constructor".

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 41 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getNumSameIDs ( ) const
virtual

Number of initial identical IDs.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 47 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getNumPermuteIDs ( ) const
virtual

Number of IDs to permute but not to communicate.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 53 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getPermuteFromLIDs ( ) const
virtual

List of local IDs in the source Map that are permuted.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 59 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getPermuteToLIDs ( ) const
virtual

List of local IDs in the target Map that are permuted.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 65 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getNumRemoteIDs ( ) const
virtual

Number of entries not on the calling process.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 71 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getRemoteLIDs ( ) const
virtual

List of entries in the target Map to receive from other processes.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 86 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::setDistributorParameters ( const Teuchos::RCP< Teuchos::ParameterList >  params) const
virtual

Set parameters on distributor.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 77 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getNumExportIDs ( ) const
virtual

Number of entries that must be sent by the calling process to other processes.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 92 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getExportLIDs ( ) const
virtual

List of entries in the source Map that will be sent to other processes.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 98 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const int > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getExportPIDs ( ) const
virtual

List of processes to which entries will be sent.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 104 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getSourceMap ( ) const
virtual

The Source Map used to construct this Import object.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 110 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getTargetMap ( ) const
virtual

The Target Map used to construct this Import object.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 116 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::print ( std::ostream &  os) const
virtual

Print the Import's data to the given output stream.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 122 of file Xpetra_TpetraImport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getTpetra_Import ( ) const

Definition at line 132 of file Xpetra_TpetraImport_def.hpp.

Member Data Documentation

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
RCP<const Tpetra::Import<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::import_
private

Definition at line 115 of file Xpetra_TpetraImport_decl.hpp.


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