Xpetra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Types | List of all members
Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node > Class Template Referenceabstract

#include <Xpetra_Import.hpp>

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

Public Types

typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
typedef Map< LocalOrdinal,
GlobalOrdinal, Node > 		map_type
 

Constructor/Destructor Methods

virtual ~Import ()
 Destructor. More...
 
virtual Teuchos::RCP< const
Import< LocalOrdinal,
GlobalOrdinal, Node > > 		createRemoteOnlyImport (const Teuchos::RCP< const map_type > &remoteTarget) const =0
 Special "constructor". More...
 

Import Attribute Methods

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 ArrayView< const
LocalOrdinal > 		getPermuteFromLIDs () const =0
 List of local IDs in the source Map that are permuted. More...
 
virtual ArrayView< const
LocalOrdinal > 		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 ArrayView< const
LocalOrdinal > 		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 ArrayView< const
LocalOrdinal > 		getExportLIDs () const =0
 List of entries in the source Map that will be sent to other processes. More...
 
virtual ArrayView< const int > getExportPIDs () const =0
 List of processes to which entries will be sent. More...
 
virtual Teuchos::RCP< const
Map< LocalOrdinal,
GlobalOrdinal, Node > > 		getSourceMap () const =0
 The Source Map used to construct this Import object. More...
 
virtual Teuchos::RCP< const
Map< LocalOrdinal,
GlobalOrdinal, Node > > 		getTargetMap () const =0
 The Target Map used to construct this Import object. More...
 
virtual void setDistributorParameters (const Teuchos::RCP< Teuchos::ParameterList > params) const =0
 Set parameters on the underlying object. More...
 

I/O Methods

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

Detailed Description

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

Definition at line 26 of file Xpetra_Import.hpp.

Member Typedef Documentation

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
typedef LocalOrdinal Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Definition at line 29 of file Xpetra_Import.hpp.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
typedef GlobalOrdinal Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Definition at line 30 of file Xpetra_Import.hpp.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
typedef Node Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::node_type

Definition at line 31 of file Xpetra_Import.hpp.

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

Definition at line 32 of file Xpetra_Import.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::~Import ( )
inlinevirtual

Destructor.

Definition at line 38 of file Xpetra_Import.hpp.

Member Function Documentation

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::createRemoteOnlyImport ( const Teuchos::RCP< const map_type > &  remoteTarget) const
pure virtual

Special "constructor".

Implemented in Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getNumSameIDs ( ) const
pure virtual

Number of initial identical IDs.

Implemented in Xpetra::TpetraImport< int, long long, EpetraNode >, Xpetra::TpetraImport< int, int, EpetraNode >, Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >, and Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getNumPermuteIDs ( ) const
pure virtual

Number of IDs to permute but not to communicate.

Implemented in Xpetra::TpetraImport< int, long long, EpetraNode >, Xpetra::TpetraImport< int, int, EpetraNode >, Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >, and Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual ArrayView<const LocalOrdinal> Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getPermuteFromLIDs ( ) const
pure virtual

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

Implemented in Xpetra::TpetraImport< int, long long, EpetraNode >, Xpetra::TpetraImport< int, int, EpetraNode >, Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >, and Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual ArrayView<const LocalOrdinal> Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getPermuteToLIDs ( ) const
pure virtual

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

Implemented in Xpetra::TpetraImport< int, long long, EpetraNode >, Xpetra::TpetraImport< int, int, EpetraNode >, Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >, and Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getNumRemoteIDs ( ) const
pure virtual

Number of entries not on the calling process.

Implemented in Xpetra::TpetraImport< int, long long, EpetraNode >, Xpetra::TpetraImport< int, int, EpetraNode >, Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >, and Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual ArrayView<const LocalOrdinal> Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getRemoteLIDs ( ) const
pure virtual

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

Implemented in Xpetra::TpetraImport< int, long long, EpetraNode >, Xpetra::TpetraImport< int, int, EpetraNode >, Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >, and Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getNumExportIDs ( ) const
pure virtual

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

Implemented in Xpetra::TpetraImport< int, long long, EpetraNode >, Xpetra::TpetraImport< int, int, EpetraNode >, Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >, and Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual ArrayView<const LocalOrdinal> Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getExportLIDs ( ) const
pure virtual

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

Implemented in Xpetra::TpetraImport< int, long long, EpetraNode >, Xpetra::TpetraImport< int, int, EpetraNode >, Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >, and Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual ArrayView<const int> Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getExportPIDs ( ) const
pure virtual

List of processes to which entries will be sent.

Implemented in Xpetra::TpetraImport< int, long long, EpetraNode >, Xpetra::TpetraImport< int, int, EpetraNode >, Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >, and Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getSourceMap ( ) const
pure virtual

The Source Map used to construct this Import object.

Implemented in Xpetra::TpetraImport< int, long long, EpetraNode >, Xpetra::TpetraImport< int, int, EpetraNode >, Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >, and Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getTargetMap ( ) const
pure virtual

The Target Map used to construct this Import object.

Implemented in Xpetra::TpetraImport< int, long long, EpetraNode >, Xpetra::TpetraImport< int, int, EpetraNode >, Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >, and Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::setDistributorParameters ( const Teuchos::RCP< Teuchos::ParameterList >  params) const
pure virtual

Set parameters on the underlying object.

Implemented in Xpetra::TpetraImport< int, long long, EpetraNode >, Xpetra::TpetraImport< int, int, EpetraNode >, Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >, and Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::print ( std::ostream &  os) const
pure virtual

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

Implemented in Xpetra::TpetraImport< int, long long, EpetraNode >, Xpetra::TpetraImport< int, int, EpetraNode >, Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >, and Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >.

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