Tpetra parallel linear algebra  Version of the Day
Public Types | Public Member Functions | List of all members
Tpetra::Details::Transfer< LO, GO, NT > Class Template Referenceabstract

Common base class of Import and Export. More...

#include <Tpetra_Details_Transfer.hpp>

Inheritance diagram for Tpetra::Details::Transfer< LO, GO, NT >:
Inheritance graph
[legend]

Public Types

typedef ::Tpetra::Map< LO, GO, NT > map_type
 The specialization of Map used by this class and subclasses. More...
 

Public Member Functions

virtual ~Transfer ()
 Destructor (declared virtual for memory safety of derived classes). More...
 
virtual size_t getNumSameIDs () const =0
 Number of initial identical IDs. More...
 
virtual size_t getNumPermuteIDs () const =0
 Number of IDs to permute but not to communicate. More...
 
virtual Teuchos::ArrayView< const LO > getPermuteFromLIDs () const =0
 List of local IDs in the source Map that are permuted. More...
 
virtual Teuchos::ArrayView< const LO > getPermuteToLIDs () const =0
 List of local IDs in the target Map that are permuted. More...
 
virtual size_t getNumRemoteIDs () const =0
 Number of entries not on the calling process. More...
 
virtual Teuchos::ArrayView< const LO > getRemoteLIDs () const =0
 List of entries in the target Map to receive from other processes. More...
 
virtual size_t getNumExportIDs () const =0
 Number of entries that must be sent by the calling process to other processes. More...
 
virtual Teuchos::ArrayView< const LO > getExportLIDs () const =0
 List of entries in the source Map that will be sent to other processes. More...
 
virtual Teuchos::ArrayView< const int > getExportPIDs () const =0
 List of processes to which entries will be sent. More...
 
virtual Teuchos::RCP< const map_typegetSourceMap () const =0
 The source Map used to construct this Export. More...
 
virtual Teuchos::RCP< const map_typegetTargetMap () const =0
 The target Map used to construct this Export. More...
 
virtual ::Tpetra::DistributorgetDistributor () const =0
 The Distributor that this Export object uses to move data. More...
 

Detailed Description

template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
class Tpetra::Details::Transfer< LO, GO, NT >

Common base class of Import and Export.

Warning
This is an implementation detail of Tpetra. We make no promises of backwards compatibility with this class.

Definition at line 69 of file Tpetra_Details_Transfer.hpp.

Member Typedef Documentation

template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
typedef ::Tpetra::Map<LO, GO, NT> Tpetra::Details::Transfer< LO, GO, NT >::map_type

The specialization of Map used by this class and subclasses.

The initial two colons avoid confusion between Tpetra::Map and Tpetra::Detaills::Map.

Definition at line 78 of file Tpetra_Details_Transfer.hpp.

Constructor & Destructor Documentation

template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
virtual Tpetra::Details::Transfer< LO, GO, NT >::~Transfer ( )
inlinevirtual

Destructor (declared virtual for memory safety of derived classes).

Definition at line 72 of file Tpetra_Details_Transfer.hpp.

Member Function Documentation

template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
virtual size_t Tpetra::Details::Transfer< LO, GO, NT >::getNumSameIDs ( ) const
pure virtual

Number of initial identical IDs.

The number of IDs that are identical between the source and target Maps, up to the first different ID.

Implemented in Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >, and Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >.

template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
virtual size_t Tpetra::Details::Transfer< LO, GO, NT >::getNumPermuteIDs ( ) const
pure virtual

Number of IDs to permute but not to communicate.

The number of IDs that are local to the calling process, but not part of the first getNumSameIDs() entries. The Import or Export will permute these entries locally (without distributed-memory communication).

Implemented in Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >, and Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >.

template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
virtual Teuchos::ArrayView<const LO> Tpetra::Details::Transfer< LO, GO, NT >::getPermuteFromLIDs ( ) const
pure virtual

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

Implemented in Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >, and Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >.

template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
virtual Teuchos::ArrayView<const LO> Tpetra::Details::Transfer< LO, GO, NT >::getPermuteToLIDs ( ) const
pure virtual

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

Implemented in Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >, and Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >.

template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
virtual size_t Tpetra::Details::Transfer< LO, GO, NT >::getNumRemoteIDs ( ) const
pure virtual

Number of entries not on the calling process.

Implemented in Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >, and Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >.

template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
virtual Teuchos::ArrayView<const LO> Tpetra::Details::Transfer< LO, GO, NT >::getRemoteLIDs ( ) const
pure virtual

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

Implemented in Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >, and Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >.

template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
virtual size_t Tpetra::Details::Transfer< LO, GO, NT >::getNumExportIDs ( ) const
pure virtual

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

Implemented in Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >, and Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >.

template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
virtual Teuchos::ArrayView<const LO> Tpetra::Details::Transfer< LO, GO, NT >::getExportLIDs ( ) const
pure virtual

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

Implemented in Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >, and Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >.

template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
virtual Teuchos::ArrayView<const int> Tpetra::Details::Transfer< LO, GO, NT >::getExportPIDs ( ) const
pure virtual

List of processes to which entries will be sent.

The entry with local ID getExportLIDs()[i] will be sent to process getExportPiDs()[i].

Implemented in Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >, and Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >.

template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
virtual Teuchos::RCP<const map_type> Tpetra::Details::Transfer< LO, GO, NT >::getSourceMap ( ) const
pure virtual
template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
virtual Teuchos::RCP<const map_type> Tpetra::Details::Transfer< LO, GO, NT >::getTargetMap ( ) const
pure virtual
template<class LO = DefaultTypes::local_ordinal_type, class GO = DefaultTypes::global_ordinal_type, class NT = DefaultTypes::node_type>
virtual ::Tpetra::Distributor& Tpetra::Details::Transfer< LO, GO, NT >::getDistributor ( ) const
pure virtual

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