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

#include <Xpetra_TpetraExport_decl.hpp>

Inheritance diagram for Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >:
Xpetra::Export< 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::Export< LocalOrdinal, GlobalOrdinal, Node >
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 

Private Attributes

RCP< const Tpetra::Export
< LocalOrdinal, GlobalOrdinal,
Node > > 
export_
 

Constructor/Destructor Methods

 TpetraExport (const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target)
 Construct a Export object from the source and target Map. More...
 
 TpetraExport (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...
 
 TpetraExport (const Export< LocalOrdinal, GlobalOrdinal, Node > &rhs)
 Copy constructor. More...
 
 ~TpetraExport ()
 Destructor. More...
 

Export 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 Export. More...
 
Teuchos::RCP< const Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
getTargetMap () const
 The target Map used to construct this Export. More...
 
void setDistributorParameters (const Teuchos::RCP< Teuchos::ParameterList > params) const
 Set distributor parameters. More...
 

I/O Methods

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

Xpetra specific

 TpetraExport (const RCP< const Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >> &exp)
 TpetraExport constructor to wrap a Tpetra::Export object. More...
 
RCP< const Tpetra::Export
< LocalOrdinal, GlobalOrdinal,
Node > > 
getTpetra_Export () const
 

Detailed Description

template<class LocalOrdinal, class GlobalOrdinal, class Node>
class Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >

Definition at line 78 of file Xpetra_TpetraExport_decl.hpp.

Member Typedef Documentation

template<class LocalOrdinal, class GlobalOrdinal, class Node>
typedef Map<LocalOrdinal, GlobalOrdinal, Node> Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::map_type

The specialization of Map used by this class.

Definition at line 84 of file Xpetra_TpetraExport_decl.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::TpetraExport ( const Teuchos::RCP< const map_type > &  source,
const Teuchos::RCP< const map_type > &  target 
)

Construct a Export object from the source and target Map.

Definition at line 57 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::TpetraExport ( 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).

Definition at line 66 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::TpetraExport ( const Export< LocalOrdinal, GlobalOrdinal, Node > &  rhs)

Copy constructor.

Definition at line 76 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::~TpetraExport ( )

Destructor.

Definition at line 84 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::TpetraExport ( const RCP< const Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node >> &  exp)

TpetraExport constructor to wrap a Tpetra::Export object.

Definition at line 222 of file Xpetra_TpetraExport_def.hpp.

Member Function Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getNumSameIDs ( ) const
virtual

Number of initial identical IDs.

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

Definition at line 92 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getNumPermuteIDs ( ) const
virtual

Number of IDs to permute but not to communicate.

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

Definition at line 102 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getPermuteFromLIDs ( ) const
virtual

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

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

Definition at line 112 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getPermuteToLIDs ( ) const
virtual

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

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

Definition at line 122 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getNumRemoteIDs ( ) const
virtual

Number of entries not on the calling process.

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

Definition at line 132 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getRemoteLIDs ( ) const
virtual

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

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

Definition at line 142 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getNumExportIDs ( ) const
virtual

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

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

Definition at line 152 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getExportLIDs ( ) const
virtual

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

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

Definition at line 162 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const int > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getExportPIDs ( ) const
virtual

List of processes to which entries will be sent.

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

Definition at line 172 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getSourceMap ( ) const
virtual

The source Map used to construct this Export.

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

Definition at line 182 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getTargetMap ( ) const
virtual

The target Map used to construct this Export.

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

Definition at line 192 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::setDistributorParameters ( const Teuchos::RCP< Teuchos::ParameterList >  params) const
virtual

Set distributor parameters.

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

Definition at line 201 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::print ( std::ostream &  os) const
virtual

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

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

Definition at line 213 of file Xpetra_TpetraExport_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getTpetra_Export ( ) const

Definition at line 232 of file Xpetra_TpetraExport_def.hpp.

Member Data Documentation

template<class LocalOrdinal, class GlobalOrdinal, class Node>
RCP<const Tpetra::Export<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::export_
private

Definition at line 188 of file Xpetra_TpetraExport_decl.hpp.


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