Public Types | Private Attributes | List of all members
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <Xpetra_TpetraImport.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
 

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

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

Additional Inherited Members

- Public Member Functions inherited from Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >
virtual ~Import ()
 Destructor. More...
 

Detailed Description

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
class Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >

Definition at line 72 of file Xpetra_TpetraImport.hpp.

Member Typedef Documentation

◆ map_type

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
typedef Map<LocalOrdinal,GlobalOrdinal,Node> Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::map_type

The specialization of Map used by this class.

Definition at line 79 of file Xpetra_TpetraImport.hpp.

Constructor & Destructor Documentation

◆ TpetraImport() [1/4]

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::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 85 of file Xpetra_TpetraImport.hpp.

◆ TpetraImport() [2/4]

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
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 
)
inline

Constructor (with list of parameters).

Definition at line 89 of file Xpetra_TpetraImport.hpp.

◆ TpetraImport() [3/4]

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::TpetraImport ( const Import< LocalOrdinal, GlobalOrdinal, Node > &  import)
inline

Copy constructor.

Definition at line 93 of file Xpetra_TpetraImport.hpp.

◆ ~TpetraImport()

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::~TpetraImport ( )
inline

Destructor.

Definition at line 97 of file Xpetra_TpetraImport.hpp.

◆ TpetraImport() [4/4]

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::TpetraImport ( const RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > &  import)
inline

TpetraImport constructor to wrap a Tpetra::Import object.

Definition at line 151 of file Xpetra_TpetraImport.hpp.

Member Function Documentation

◆ getNumSameIDs()

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
size_t Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getNumSameIDs ( ) const
inlinevirtual

Number of initial identical IDs.

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

Definition at line 105 of file Xpetra_TpetraImport.hpp.

◆ getNumPermuteIDs()

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
size_t Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getNumPermuteIDs ( ) const
inlinevirtual

Number of IDs to permute but not to communicate.

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

Definition at line 108 of file Xpetra_TpetraImport.hpp.

◆ getPermuteFromLIDs()

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
ArrayView< const LocalOrdinal > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getPermuteFromLIDs ( ) const
inlinevirtual

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

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

Definition at line 111 of file Xpetra_TpetraImport.hpp.

◆ getPermuteToLIDs()

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
ArrayView< const LocalOrdinal > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getPermuteToLIDs ( ) const
inlinevirtual

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

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

Definition at line 114 of file Xpetra_TpetraImport.hpp.

◆ getNumRemoteIDs()

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
size_t Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getNumRemoteIDs ( ) const
inlinevirtual

Number of entries not on the calling process.

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

Definition at line 117 of file Xpetra_TpetraImport.hpp.

◆ getRemoteLIDs()

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
ArrayView< const LocalOrdinal > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getRemoteLIDs ( ) const
inlinevirtual

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

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

Definition at line 120 of file Xpetra_TpetraImport.hpp.

◆ getNumExportIDs()

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
size_t Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getNumExportIDs ( ) const
inlinevirtual

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

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

Definition at line 123 of file Xpetra_TpetraImport.hpp.

◆ getExportLIDs()

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
ArrayView< const LocalOrdinal > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getExportLIDs ( ) const
inlinevirtual

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

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

Definition at line 126 of file Xpetra_TpetraImport.hpp.

◆ getExportPIDs()

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
ArrayView< const int > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getExportPIDs ( ) const
inlinevirtual

List of processes to which entries will be sent.

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

Definition at line 129 of file Xpetra_TpetraImport.hpp.

◆ getSourceMap()

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getSourceMap ( ) const
inlinevirtual

The Source Map used to construct this Import object.

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

Definition at line 132 of file Xpetra_TpetraImport.hpp.

◆ getTargetMap()

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getTargetMap ( ) const
inlinevirtual

The Target Map used to construct this Import object.

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

Definition at line 135 of file Xpetra_TpetraImport.hpp.

◆ print()

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
void Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::print ( std::ostream &  os) const
inlinevirtual

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

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

Definition at line 143 of file Xpetra_TpetraImport.hpp.

◆ getTpetra_Import()

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getTpetra_Import ( ) const
inline

Definition at line 153 of file Xpetra_TpetraImport.hpp.

Member Data Documentation

◆ import_

template<class LocalOrdinal = Import<>::local_ordinal_type, class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type, class Node = typename Import<LocalOrdinal, GlobalOrdinal>::node_type>
RCP<const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::import_
private

Definition at line 159 of file Xpetra_TpetraImport.hpp.


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