All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Types | Private Attributes
Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <Xpetra_TpetraExport.hpp>

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

List of all members.

Public Types

typedef Map< LocalOrdinal,
GlobalOrdinal, Node > 		map_type
 The specialization of Map used by this class.

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.
 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).
 TpetraExport (const Export< LocalOrdinal, GlobalOrdinal, Node > &rhs)
 Copy constructor.
 ~TpetraExport ()
 Destructor.

Export Attribute Methods

size_t getNumSameIDs () const
 Number of initial identical IDs.
size_t getNumPermuteIDs () const
 Number of IDs to permute but not to communicate.
ArrayView< const LocalOrdinal > getPermuteFromLIDs () const
 List of local IDs in the source Map that are permuted.
ArrayView< const LocalOrdinal > getPermuteToLIDs () const
 List of local IDs in the target Map that are permuted.
size_t getNumRemoteIDs () const
 Number of entries not on the calling process.
ArrayView< const LocalOrdinal > getRemoteLIDs () const
 List of entries in the target Map to receive from other processes.
size_t getNumExportIDs () const
 Number of entries that must be sent by the calling process to other processes.
ArrayView< const LocalOrdinal > getExportLIDs () const
 List of entries in the source Map that will be sent to other processes.
ArrayView< const int > getExportPIDs () const
 List of processes to which entries will be sent.
Teuchos::RCP< const Map
< LocalOrdinal, GlobalOrdinal,
Node > > 		getSourceMap () const
 The source Map used to construct this Export.
Teuchos::RCP< const Map
< LocalOrdinal, GlobalOrdinal,
Node > > 		getTargetMap () const
 The target Map used to construct this Export.

I/O Methods

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

Xpetra specific

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

Detailed Description

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
class Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >

Definition at line 72 of file Xpetra_TpetraExport.hpp.

Member Typedef Documentation

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

The specialization of Map used by this class.

Definition at line 79 of file Xpetra_TpetraExport.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::TpetraExport ( const Teuchos::RCP< const map_type > &  source,
const Teuchos::RCP< const map_type > &  target 
) [inline]

Construct a Export object from the source and target Map.

Definition at line 85 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
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 
) [inline]

Constructor (with list of parameters).

Definition at line 89 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::TpetraExport ( const Export< LocalOrdinal, GlobalOrdinal, Node > &  rhs) [inline]

Copy constructor.

Definition at line 93 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::~TpetraExport ( ) [inline]

Destructor.

Definition at line 97 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::TpetraExport ( const RCP< const Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node > > &  exp) [inline]

TpetraExport constructor to wrap a Tpetra::Export object.

Definition at line 151 of file Xpetra_TpetraExport.hpp.

Member Function Documentation

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
size_t Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getNumSameIDs ( ) const [inline, virtual]

Number of initial identical IDs.

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

Definition at line 105 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
size_t Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getNumPermuteIDs ( ) const [inline, virtual]

Number of IDs to permute but not to communicate.

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

Definition at line 108 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
ArrayView< const LocalOrdinal > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getPermuteFromLIDs ( ) const [inline, virtual]

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

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

Definition at line 111 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
ArrayView< const LocalOrdinal > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getPermuteToLIDs ( ) const [inline, virtual]

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

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

Definition at line 114 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
size_t Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getNumRemoteIDs ( ) const [inline, virtual]

Number of entries not on the calling process.

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

Definition at line 117 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
ArrayView< const LocalOrdinal > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getRemoteLIDs ( ) const [inline, virtual]

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

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

Definition at line 120 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
size_t Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getNumExportIDs ( ) const [inline, virtual]

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

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

Definition at line 123 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
ArrayView< const LocalOrdinal > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getExportLIDs ( ) const [inline, virtual]

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

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

Definition at line 126 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
ArrayView< const int > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getExportPIDs ( ) const [inline, virtual]

List of processes to which entries will be sent.

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

Definition at line 129 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getSourceMap ( ) const [inline, virtual]

The source Map used to construct this Export.

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

Definition at line 132 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getTargetMap ( ) const [inline, virtual]

The target Map used to construct this Export.

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

Definition at line 135 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
void Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::print ( std::ostream &  os) const [inline, virtual]

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

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

Definition at line 143 of file Xpetra_TpetraExport.hpp.

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
RCP< const Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::getTpetra_Export ( ) const [inline]

Definition at line 153 of file Xpetra_TpetraExport.hpp.

Member Data Documentation

template<class LocalOrdinal = Export<>::local_ordinal_type, class GlobalOrdinal = typename Export<LocalOrdinal>::global_ordinal_type, class Node = typename Export<LocalOrdinal, GlobalOrdinal>::node_type>
RCP<const Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraExport< LocalOrdinal, GlobalOrdinal, Node >::export_ [private]

Definition at line 159 of file Xpetra_TpetraExport.hpp.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Generated on Wed Mar 18 2015 22:49:36 for Xpetra by   doxygen 1.7.6.1