Xpetra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node > Class Template Referenceabstract

#include <Xpetra_Export.hpp>

Inheritance diagram for Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >:
Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >

Public Types

typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 

Constructor/Destructor Methods

virtual ~Export ()
 Destructor. More...
 

Export 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 Export. More...
 
virtual Teuchos::RCP< const
Map< LocalOrdinal,
GlobalOrdinal, Node > > 
getTargetMap () const =0
 The target Map used to construct this Export. 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 Export's data to the given output stream. More...
 

Detailed Description

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

Definition at line 62 of file Xpetra_Export.hpp.

Member Typedef Documentation

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

Definition at line 66 of file Xpetra_Export.hpp.

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

Definition at line 67 of file Xpetra_Export.hpp.

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

Definition at line 68 of file Xpetra_Export.hpp.

Constructor & Destructor Documentation

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

Destructor.

Definition at line 74 of file Xpetra_Export.hpp.

Member Function Documentation

template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getNumSameIDs ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getNumPermuteIDs ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual ArrayView< const LocalOrdinal > Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getPermuteFromLIDs ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual ArrayView< const LocalOrdinal > Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getPermuteToLIDs ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getNumRemoteIDs ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual ArrayView< const LocalOrdinal > Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getRemoteLIDs ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getNumExportIDs ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual ArrayView< const LocalOrdinal > Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getExportLIDs ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual ArrayView< const int > Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getExportPIDs ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getSourceMap ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::getTargetMap ( ) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::setDistributorParameters ( const Teuchos::RCP< Teuchos::ParameterList >  params) const
pure virtual
template<class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >::print ( std::ostream &  os) const
pure virtual

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