Public Types | List of all members
Xpetra::TpetraImport< int, long long, EpetraNode > Class Template Reference

#include <Xpetra_TpetraImport.hpp>

Inheritance diagram for Xpetra::TpetraImport< int, long long, EpetraNode >:
Xpetra::Import< int, long long, EpetraNode >

Public Types

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

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...
 

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 LocalOrdinalgetPermuteFromLIDs () const
 List of local IDs in the source Map that are permuted. More...
 
ArrayView< const LocalOrdinalgetPermuteToLIDs () 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 LocalOrdinalgetRemoteLIDs () const
 List of entries in the target Map to receive from other processes. More...
 
size_t getNumExportIDs () const
 Number of entries that must be sent by the calling process to other processes. More...
 
ArrayView< const LocalOrdinalgetExportLIDs () 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
 

Additional Inherited Members

- Public Member Functions inherited from Xpetra::Import< int, long long, EpetraNode >
virtual ~Import ()
 Destructor. More...
 

Detailed Description

template<>
class Xpetra::TpetraImport< int, long long, EpetraNode >

Definition at line 270 of file Xpetra_TpetraImport.hpp.

Member Typedef Documentation

◆ LocalOrdinal

typedef int Xpetra::TpetraImport< int, long long, EpetraNode >::LocalOrdinal

Definition at line 274 of file Xpetra_TpetraImport.hpp.

◆ GlobalOrdinal

typedef long long Xpetra::TpetraImport< int, long long, EpetraNode >::GlobalOrdinal

Definition at line 275 of file Xpetra_TpetraImport.hpp.

◆ Node

typedef EpetraNode Xpetra::TpetraImport< int, long long, EpetraNode >::Node

Definition at line 276 of file Xpetra_TpetraImport.hpp.

◆ map_type

The specialization of Map used by this class.

Definition at line 279 of file Xpetra_TpetraImport.hpp.

Constructor & Destructor Documentation

◆ TpetraImport() [1/4]

Xpetra::TpetraImport< int, long long, EpetraNode >::TpetraImport ( const Teuchos::RCP< const map_type > &  source,
const Teuchos::RCP< const map_type > &  target 
)
inline

Construct an Import from the source and target Maps.

Definition at line 285 of file Xpetra_TpetraImport.hpp.

◆ TpetraImport() [2/4]

Xpetra::TpetraImport< int, long long, EpetraNode >::TpetraImport ( const Teuchos::RCP< const map_type > &  source,
const Teuchos::RCP< const map_type > &  target,
const Teuchos::RCP< Teuchos::ParameterList > &  plist 
)
inline

Constructor (with list of parameters).

Definition at line 290 of file Xpetra_TpetraImport.hpp.

◆ TpetraImport() [3/4]

Xpetra::TpetraImport< int, long long, EpetraNode >::TpetraImport ( const Import< LocalOrdinal, GlobalOrdinal, Node > &  import)
inline

Copy constructor.

Definition at line 295 of file Xpetra_TpetraImport.hpp.

◆ ~TpetraImport()

Xpetra::TpetraImport< int, long long, EpetraNode >::~TpetraImport ( )
inline

Destructor.

Definition at line 300 of file Xpetra_TpetraImport.hpp.

◆ TpetraImport() [4/4]

Xpetra::TpetraImport< int, long long, EpetraNode >::TpetraImport ( const RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > &  import)
inline

TpetraImport constructor to wrap a Tpetra::Import object.

Definition at line 354 of file Xpetra_TpetraImport.hpp.

Member Function Documentation

◆ getNumSameIDs()

size_t Xpetra::TpetraImport< int, long long, EpetraNode >::getNumSameIDs ( ) const
inlinevirtual

Number of initial identical IDs.

Implements Xpetra::Import< int, long long, EpetraNode >.

Definition at line 308 of file Xpetra_TpetraImport.hpp.

◆ getNumPermuteIDs()

size_t Xpetra::TpetraImport< int, long long, EpetraNode >::getNumPermuteIDs ( ) const
inlinevirtual

Number of IDs to permute but not to communicate.

Implements Xpetra::Import< int, long long, EpetraNode >.

Definition at line 311 of file Xpetra_TpetraImport.hpp.

◆ getPermuteFromLIDs()

ArrayView< const LocalOrdinal > Xpetra::TpetraImport< int, long long, EpetraNode >::getPermuteFromLIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, long long, EpetraNode >.

Definition at line 314 of file Xpetra_TpetraImport.hpp.

◆ getPermuteToLIDs()

ArrayView< const LocalOrdinal > Xpetra::TpetraImport< int, long long, EpetraNode >::getPermuteToLIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, long long, EpetraNode >.

Definition at line 317 of file Xpetra_TpetraImport.hpp.

◆ getNumRemoteIDs()

size_t Xpetra::TpetraImport< int, long long, EpetraNode >::getNumRemoteIDs ( ) const
inlinevirtual

Number of entries not on the calling process.

Implements Xpetra::Import< int, long long, EpetraNode >.

Definition at line 320 of file Xpetra_TpetraImport.hpp.

◆ getRemoteLIDs()

ArrayView< const LocalOrdinal > Xpetra::TpetraImport< int, long long, EpetraNode >::getRemoteLIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, long long, EpetraNode >.

Definition at line 323 of file Xpetra_TpetraImport.hpp.

◆ getNumExportIDs()

size_t Xpetra::TpetraImport< int, long long, EpetraNode >::getNumExportIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, long long, EpetraNode >.

Definition at line 326 of file Xpetra_TpetraImport.hpp.

◆ getExportLIDs()

ArrayView< const LocalOrdinal > Xpetra::TpetraImport< int, long long, EpetraNode >::getExportLIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, long long, EpetraNode >.

Definition at line 329 of file Xpetra_TpetraImport.hpp.

◆ getExportPIDs()

ArrayView< const int > Xpetra::TpetraImport< int, long long, EpetraNode >::getExportPIDs ( ) const
inlinevirtual

List of processes to which entries will be sent.

Implements Xpetra::Import< int, long long, EpetraNode >.

Definition at line 332 of file Xpetra_TpetraImport.hpp.

◆ getSourceMap()

Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< int, long long, EpetraNode >::getSourceMap ( ) const
inlinevirtual

The Source Map used to construct this Import object.

Implements Xpetra::Import< int, long long, EpetraNode >.

Definition at line 335 of file Xpetra_TpetraImport.hpp.

◆ getTargetMap()

Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< int, long long, EpetraNode >::getTargetMap ( ) const
inlinevirtual

The Target Map used to construct this Import object.

Implements Xpetra::Import< int, long long, EpetraNode >.

Definition at line 338 of file Xpetra_TpetraImport.hpp.

◆ print()

void Xpetra::TpetraImport< int, long long, EpetraNode >::print ( std::ostream &  os) const
inlinevirtual

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

Implements Xpetra::Import< int, long long, EpetraNode >.

Definition at line 346 of file Xpetra_TpetraImport.hpp.

◆ getTpetra_Import()

RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< int, long long, EpetraNode >::getTpetra_Import ( ) const
inline

Definition at line 358 of file Xpetra_TpetraImport.hpp.


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