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
 

Constructor/Destructor Methods

virtual ~Import ()
 Destructor. 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...
 

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

Definition at line 62 of file Xpetra_Import.hpp.

Member Typedef Documentation

◆ local_ordinal_type

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

Definition at line 66 of file Xpetra_Import.hpp.

◆ global_ordinal_type

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

Definition at line 67 of file Xpetra_Import.hpp.

◆ node_type

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

Definition at line 68 of file Xpetra_Import.hpp.

Constructor & Destructor Documentation

◆ ~Import()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::~Import ( )
inlinevirtual

Destructor.

Definition at line 74 of file Xpetra_Import.hpp.

Member Function Documentation

◆ getNumSameIDs()

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

◆ getNumPermuteIDs()

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

◆ getPermuteFromLIDs()

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

◆ getPermuteToLIDs()

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

◆ getNumRemoteIDs()

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

◆ getRemoteLIDs()

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

◆ getNumExportIDs()

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

◆ getExportLIDs()

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

◆ getExportPIDs()

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

◆ getSourceMap()

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

◆ getTargetMap()

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

◆ print()

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

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