#include <Xpetra_TpetraImport_def.hpp>

Inheritance diagram for Xpetra::TpetraImport< int, int, EpetraNode >:

Public Types
typedef int	LocalOrdinal

typedef int	GlobalOrdinal

typedef EpetraNode	Node

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

Public Types inherited from Xpetra::Import< int, int, EpetraNode >
typedef int	local_ordinal_type

typedef int	global_ordinal_type

typedef EpetraNode	node_type

typedef Map< int, int, EpetraNode >	map_type

Constructor/Destructor Methods
	TpetraImport (const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target)
	Construct an Import from the source and target Maps.

	TpetraImport (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).

	TpetraImport (const Import< LocalOrdinal, GlobalOrdinal, Node > &import)
	Copy constructor.

	~TpetraImport ()
	Destructor.

Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > >	createRemoteOnlyImport (const Teuchos::RCP< const map_type > &remoteTarget) const
	Special "constructor".

Import 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 Import object.

Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >	getTargetMap () const
	The Target Map used to construct this Import object.

void	setDistributorParameters (const Teuchos::RCP< Teuchos::ParameterList > params) const
	Set parameters on the underlying object.

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

Xpetra specific
	TpetraImport (const RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > &import)
	TpetraImport constructor to wrap a Tpetra::Import object.

RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > >	getTpetra_Import () const

Additional Inherited Members
Public Member Functions inherited from Xpetra::Import< int, int, EpetraNode >
virtual	~Import ()
	Destructor.

virtual Teuchos::RCP< const Import< int, int, EpetraNode > >	createRemoteOnlyImport (const Teuchos::RCP< const map_type > &remoteTarget) const=0
	Special "constructor".

Public Member Functions inherited from Teuchos::Describable
virtual std::string	description () const

virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

virtual std::string	description () const

virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

Public Member Functions inherited from Teuchos::LabeledObject
	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Detailed Description

Definition at line 141 of file Xpetra_TpetraImport_def.hpp.

Member Typedef Documentation

◆ LocalOrdinal

typedef int Xpetra::TpetraImport< int, int, EpetraNode >::LocalOrdinal

Definition at line 143 of file Xpetra_TpetraImport_def.hpp.

◆ GlobalOrdinal

typedef int Xpetra::TpetraImport< int, int, EpetraNode >::GlobalOrdinal

Definition at line 144 of file Xpetra_TpetraImport_def.hpp.

◆ Node

typedef EpetraNode Xpetra::TpetraImport< int, int, EpetraNode >::Node

Definition at line 145 of file Xpetra_TpetraImport_def.hpp.

◆ map_type

typedef Map<LocalOrdinal, GlobalOrdinal, Node> Xpetra::TpetraImport< int, int, EpetraNode >::map_type

The specialization of Map used by this class.

Definition at line 148 of file Xpetra_TpetraImport_def.hpp.

Constructor & Destructor Documentation

◆ TpetraImport() [1/4]

Xpetra::TpetraImport< int, int, EpetraNode >::TpetraImport	(	const Teuchos::RCP< const map_type > &	source,
		const Teuchos::RCP< const map_type > &	target
	)

inline

Construct an Import from the source and target Maps.

Definition at line 154 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [2/4]

Xpetra::TpetraImport< int, int, EpetraNode >::TpetraImport	(	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 159 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [3/4]

Xpetra::TpetraImport< int, int, EpetraNode >::TpetraImport ( const Import< LocalOrdinal, GlobalOrdinal, Node > & import )

inline

Copy constructor.

Definition at line 164 of file Xpetra_TpetraImport_def.hpp.

◆ ~TpetraImport()

Xpetra::TpetraImport< int, int, EpetraNode >::~TpetraImport ( )

inline

Destructor.

Definition at line 169 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [4/4]

Xpetra::TpetraImport< int, int, EpetraNode >::TpetraImport ( const RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > & import )

inline

TpetraImport constructor to wrap a Tpetra::Import object.

Definition at line 233 of file Xpetra_TpetraImport_def.hpp.

Member Function Documentation

◆ createRemoteOnlyImport()

Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< int, int, EpetraNode >::createRemoteOnlyImport ( const Teuchos::RCP< const map_type > & remoteTarget ) const

inline

Special "constructor".

Definition at line 173 of file Xpetra_TpetraImport_def.hpp.

◆ getNumSameIDs()

size_t Xpetra::TpetraImport< int, int, EpetraNode >::getNumSameIDs ( ) const

inlinevirtual

Number of initial identical IDs.

Implements Xpetra::Import< int, int, EpetraNode >.

Definition at line 183 of file Xpetra_TpetraImport_def.hpp.

◆ getNumPermuteIDs()

size_t Xpetra::TpetraImport< int, int, EpetraNode >::getNumPermuteIDs ( ) const

inlinevirtual

Number of IDs to permute but not to communicate.

Implements Xpetra::Import< int, int, EpetraNode >.

Definition at line 186 of file Xpetra_TpetraImport_def.hpp.

◆ getPermuteFromLIDs()

ArrayView< const LocalOrdinal > Xpetra::TpetraImport< int, int, EpetraNode >::getPermuteFromLIDs ( ) const

inlinevirtual

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

Implements Xpetra::Import< int, int, EpetraNode >.

Definition at line 189 of file Xpetra_TpetraImport_def.hpp.

◆ getPermuteToLIDs()

ArrayView< const LocalOrdinal > Xpetra::TpetraImport< int, int, EpetraNode >::getPermuteToLIDs ( ) const

inlinevirtual

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

Implements Xpetra::Import< int, int, EpetraNode >.

Definition at line 192 of file Xpetra_TpetraImport_def.hpp.

◆ getNumRemoteIDs()

size_t Xpetra::TpetraImport< int, int, EpetraNode >::getNumRemoteIDs ( ) const

inlinevirtual

Number of entries not on the calling process.

Implements Xpetra::Import< int, int, EpetraNode >.

Definition at line 195 of file Xpetra_TpetraImport_def.hpp.

◆ getRemoteLIDs()

ArrayView< const LocalOrdinal > Xpetra::TpetraImport< int, int, EpetraNode >::getRemoteLIDs ( ) const

inlinevirtual

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

Implements Xpetra::Import< int, int, EpetraNode >.

Definition at line 198 of file Xpetra_TpetraImport_def.hpp.

◆ getNumExportIDs()

size_t Xpetra::TpetraImport< int, int, EpetraNode >::getNumExportIDs ( ) const

inlinevirtual

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

Implements Xpetra::Import< int, int, EpetraNode >.

Definition at line 201 of file Xpetra_TpetraImport_def.hpp.

◆ getExportLIDs()

ArrayView< const LocalOrdinal > Xpetra::TpetraImport< int, int, EpetraNode >::getExportLIDs ( ) const

inlinevirtual

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

Implements Xpetra::Import< int, int, EpetraNode >.

Definition at line 204 of file Xpetra_TpetraImport_def.hpp.

◆ getExportPIDs()

ArrayView< const int > Xpetra::TpetraImport< int, int, EpetraNode >::getExportPIDs ( ) const

inlinevirtual

List of processes to which entries will be sent.

Implements Xpetra::Import< int, int, EpetraNode >.

Definition at line 207 of file Xpetra_TpetraImport_def.hpp.

◆ getSourceMap()

Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< int, int, EpetraNode >::getSourceMap ( ) const

inlinevirtual

The Source Map used to construct this Import object.

Implements Xpetra::Import< int, int, EpetraNode >.

Definition at line 210 of file Xpetra_TpetraImport_def.hpp.

◆ getTargetMap()

Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< int, int, EpetraNode >::getTargetMap ( ) const

inlinevirtual

The Target Map used to construct this Import object.

Implements Xpetra::Import< int, int, EpetraNode >.

Definition at line 213 of file Xpetra_TpetraImport_def.hpp.

◆ setDistributorParameters()

void Xpetra::TpetraImport< int, int, EpetraNode >::setDistributorParameters ( const Teuchos::RCP< Teuchos::ParameterList > params ) const

inlinevirtual

Set parameters on the underlying object.

Implements Xpetra::Import< int, int, EpetraNode >.

Definition at line 216 of file Xpetra_TpetraImport_def.hpp.

◆ print()

void Xpetra::TpetraImport< int, int, EpetraNode >::print ( std::ostream & os ) const

inlinevirtual

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

Implements Xpetra::Import< int, int, EpetraNode >.

Definition at line 224 of file Xpetra_TpetraImport_def.hpp.

◆ getTpetra_Import()

RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< int, int, EpetraNode >::getTpetra_Import ( ) const

inline

Definition at line 237 of file Xpetra_TpetraImport_def.hpp.

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

Xpetra_TpetraImport_def.hpp

Public Types

Constructor/Destructor Methods

Import Attribute Methods

I/O Methods

Xpetra specific

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ LocalOrdinal

◆ GlobalOrdinal

◆ Node

◆ map_type

Constructor & Destructor Documentation

◆ TpetraImport() [1/4]

◆ TpetraImport() [2/4]

◆ TpetraImport() [3/4]

◆ ~TpetraImport()

◆ TpetraImport() [4/4]

Member Function Documentation

◆ createRemoteOnlyImport()

◆ getNumSameIDs()

◆ getNumPermuteIDs()

◆ getPermuteFromLIDs()

◆ getPermuteToLIDs()

◆ getNumRemoteIDs()

◆ getRemoteLIDs()

◆ getNumExportIDs()

◆ getExportLIDs()

◆ getExportPIDs()

◆ getSourceMap()

◆ getTargetMap()

◆ setDistributorParameters()

◆ print()

◆ getTpetra_Import()