Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node > Class Template Reference

#include <Xpetra_EpetraExport.hpp>

Inheritance diagram for Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >:

Private Types
typedef int	LocalOrdinal
typedef EpetraGlobalOrdinal	GlobalOrdinal
typedef Map< LocalOrdinal, GlobalOrdinal, Node >	map_type
	The specialization of Map used by this class. More...

Private Attributes
RCP< const Epetra_Export >	export_

Constructor/Destructor Methods
	EpetraExportT (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...
	~EpetraExportT ()
	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 parameters on the underlying object. More...

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

Xpetra specific
	EpetraExportT (const RCP< const Epetra_Export > &exp)
	EpetraExportT constructor to wrap a Epetra_Export object. More...
RCP< const Epetra_Export >	getEpetra_Export () const
	Get the underlying Epetra export. More...

Additional Inherited Members
Public Types inherited from Xpetra::Export< int, EpetraGlobalOrdinal, Node >
typedef int	local_ordinal_type
typedef EpetraGlobalOrdinal	global_ordinal_type
typedef Node	node_type
Public Member Functions inherited from Xpetra::Export< int, EpetraGlobalOrdinal, Node >
virtual	~Export ()
	Destructor. More...

Detailed Description

template<class EpetraGlobalOrdinal, class Node>
class Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >

Definition at line 76 of file Xpetra_EpetraExport.hpp.

Member Typedef Documentation

template<class EpetraGlobalOrdinal , class Node >

typedef int Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::LocalOrdinal

private

Definition at line 78 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

typedef EpetraGlobalOrdinal Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::GlobalOrdinal

private

Definition at line 79 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

typedef Map<LocalOrdinal, GlobalOrdinal, Node> Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::map_type

private

The specialization of Map used by this class.

Definition at line 81 of file Xpetra_EpetraExport.hpp.

Constructor & Destructor Documentation

template<class EpetraGlobalOrdinal , class Node >

Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::EpetraExportT ( 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 88 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::~EpetraExportT ( )

inline

Destructor.

Definition at line 100 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::EpetraExportT ( const RCP< const Epetra_Export > &  exp )

inline

EpetraExportT constructor to wrap a Epetra_Export object.

Definition at line 193 of file Xpetra_EpetraExport.hpp.

Member Function Documentation

template<class EpetraGlobalOrdinal , class Node >

size_t Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::getNumSameIDs ( ) const

inlinevirtual

Number of initial identical IDs.

Implements Xpetra::Export< int, EpetraGlobalOrdinal, Node >.

Definition at line 108 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

size_t Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::getNumPermuteIDs ( ) const

inlinevirtual

Number of IDs to permute but not to communicate.

Implements Xpetra::Export< int, EpetraGlobalOrdinal, Node >.

Definition at line 114 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

ArrayView<const LocalOrdinal> Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::getPermuteFromLIDs ( ) const

inlinevirtual

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

Implements Xpetra::Export< int, EpetraGlobalOrdinal, Node >.

Definition at line 120 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

ArrayView<const LocalOrdinal> Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::getPermuteToLIDs ( ) const

inlinevirtual

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

Implements Xpetra::Export< int, EpetraGlobalOrdinal, Node >.

Definition at line 126 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

size_t Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::getNumRemoteIDs ( ) const

inlinevirtual

Number of entries not on the calling process.

Implements Xpetra::Export< int, EpetraGlobalOrdinal, Node >.

Definition at line 132 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

ArrayView<const LocalOrdinal> Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::getRemoteLIDs ( ) const

inlinevirtual

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

Implements Xpetra::Export< int, EpetraGlobalOrdinal, Node >.

Definition at line 138 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

size_t Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::getNumExportIDs ( ) const

inlinevirtual

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

Implements Xpetra::Export< int, EpetraGlobalOrdinal, Node >.

Definition at line 144 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

ArrayView<const LocalOrdinal> Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::getExportLIDs ( ) const

inlinevirtual

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

Implements Xpetra::Export< int, EpetraGlobalOrdinal, Node >.

Definition at line 150 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

ArrayView<const int> Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::getExportPIDs ( ) const

inlinevirtual

List of processes to which entries will be sent.

Implements Xpetra::Export< int, EpetraGlobalOrdinal, Node >.

Definition at line 156 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::getSourceMap ( ) const

inlinevirtual

The source Map used to construct this Export.

Implements Xpetra::Export< int, EpetraGlobalOrdinal, Node >.

Definition at line 162 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::getTargetMap ( ) const

inlinevirtual

The target Map used to construct this Export.

Implements Xpetra::Export< int, EpetraGlobalOrdinal, Node >.

Definition at line 168 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

void Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::setDistributorParameters ( const Teuchos::RCP< Teuchos::ParameterList >  params ) const

inlinevirtual

Set parameters on the underlying object.

Implements Xpetra::Export< int, EpetraGlobalOrdinal, Node >.

Definition at line 174 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

void Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::print ( std::ostream &  os ) const

inlinevirtual

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

Implements Xpetra::Export< int, EpetraGlobalOrdinal, Node >.

Definition at line 182 of file Xpetra_EpetraExport.hpp.

template<class EpetraGlobalOrdinal , class Node >

RCP<const Epetra_Export> Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::getEpetra_Export ( ) const

inline

Get the underlying Epetra export.

Definition at line 197 of file Xpetra_EpetraExport.hpp.

Member Data Documentation

template<class EpetraGlobalOrdinal , class Node >

RCP<const Epetra_Export> Xpetra::EpetraExportT< EpetraGlobalOrdinal, Node >::export_

private

Definition at line 202 of file Xpetra_EpetraExport.hpp.

---

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

• Xpetra_EpetraExport.hpp