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

#include <Xpetra_EpetraImport.hpp>

Inheritance diagram for Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >:
Xpetra::Import< int, EpetraGlobalOrdinal, Node >

Private Types

typedef int LocalOrdinal
 
typedef EpetraGlobalOrdinal GlobalOrdinal
 
typedef Map< LocalOrdinal,
GlobalOrdinal, Node > 
map_type
 The specialization of Map used by this class. More...
 

Private Attributes

RCP< const Epetra_Import > import_
 

Constructor/Destructor Methods

 EpetraImportT (const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target)
 Construct an Import from the source and target Maps. More...
 
 ~EpetraImportT ()
 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 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...
 
ArrayView< const LocalOrdinalgetRemotePIDs () 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...
 
void setDistributorParameters (const Teuchos::RCP< Teuchos::ParameterList > params) const
 Set parameters on the underlying object. More...
 

I/O Methods

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

Xpetra specific

 EpetraImportT (const RCP< const Epetra_Import > &import)
 EpetraImportT constructor to wrap a Epetra_Import object. More...
 
RCP< const Epetra_Import > getEpetra_Import () const
 Get the underlying Epetra import. More...
 

Additional Inherited Members

- Public Types inherited from Xpetra::Import< int, EpetraGlobalOrdinal, Node >
typedef int local_ordinal_type
 
typedef EpetraGlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
typedef Map< int,
EpetraGlobalOrdinal, Node > 
map_type
 
- Public Member Functions inherited from Xpetra::Import< int, EpetraGlobalOrdinal, Node >
virtual ~Import ()
 Destructor. More...
 
virtual Teuchos::RCP< const
Import< int,
EpetraGlobalOrdinal, Node > > 
createRemoteOnlyImport (const Teuchos::RCP< const map_type > &remoteTarget) const =0
 Special "constructor". More...
 

Detailed Description

template<class EpetraGlobalOrdinal, class Node>
class Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >

Definition at line 66 of file Xpetra_EpetraImport.hpp.

Member Typedef Documentation

template<class EpetraGlobalOrdinal , class Node >
typedef int Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::LocalOrdinal
private

Definition at line 68 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
typedef EpetraGlobalOrdinal Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::GlobalOrdinal
private

Definition at line 69 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
typedef Map<LocalOrdinal, GlobalOrdinal, Node> Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::map_type
private

The specialization of Map used by this class.

Definition at line 71 of file Xpetra_EpetraImport.hpp.

Constructor & Destructor Documentation

template<class EpetraGlobalOrdinal , class Node >
Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::EpetraImportT ( 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 78 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::~EpetraImportT ( )
inline

Destructor.

Definition at line 90 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::EpetraImportT ( const RCP< const Epetra_Import > &  import)
inline

EpetraImportT constructor to wrap a Epetra_Import object.

Definition at line 192 of file Xpetra_EpetraImport.hpp.

Member Function Documentation

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

Special "constructor".

Definition at line 94 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
size_t Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getNumSameIDs ( ) const
inlinevirtual

Number of initial identical IDs.

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 102 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
size_t Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getNumPermuteIDs ( ) const
inlinevirtual

Number of IDs to permute but not to communicate.

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 108 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
ArrayView<const LocalOrdinal> Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getPermuteFromLIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 114 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
ArrayView<const LocalOrdinal> Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getPermuteToLIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 120 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
size_t Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getNumRemoteIDs ( ) const
inlinevirtual

Number of entries not on the calling process.

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 126 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
ArrayView<const LocalOrdinal> Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getRemoteLIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 132 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
ArrayView<const LocalOrdinal> Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getRemotePIDs ( ) const
inline

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

Definition at line 138 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
size_t Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getNumExportIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 144 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
ArrayView<const LocalOrdinal> Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getExportLIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 150 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
ArrayView<const int> Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getExportPIDs ( ) const
inlinevirtual

List of processes to which entries will be sent.

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 156 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getSourceMap ( ) const
inlinevirtual

The Source Map used to construct this Import object.

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 162 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getTargetMap ( ) const
inlinevirtual

The Target Map used to construct this Import object.

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 168 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
void Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::setDistributorParameters ( const Teuchos::RCP< Teuchos::ParameterList >  params) const
inlinevirtual

Set parameters on the underlying object.

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 173 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
void Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::print ( std::ostream &  os) const
inlinevirtual

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

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 181 of file Xpetra_EpetraImport.hpp.

template<class EpetraGlobalOrdinal , class Node >
RCP<const Epetra_Import> Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getEpetra_Import ( ) const
inline

Get the underlying Epetra import.

Definition at line 196 of file Xpetra_EpetraImport.hpp.

Member Data Documentation

template<class EpetraGlobalOrdinal , class Node >
RCP<const Epetra_Import> Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::import_
private

Definition at line 201 of file Xpetra_EpetraImport.hpp.


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