Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra::TpetraExport< int, int, EpetraNode > Class Reference

#include <Xpetra_TpetraExport_def.hpp>

Inheritance diagram for Xpetra::TpetraExport< int, int, EpetraNode >:
Xpetra::Export< int, int, EpetraNode > Teuchos::Describable Teuchos::LabeledObject

Public Types

typedef int LocalOrdinal
 
typedef int GlobalOrdinal
 
typedef EpetraNode Node
 
typedef Map< LocalOrdinal, GlobalOrdinal, Nodemap_type
 The specialization of Map used by this class.
 
- Public Types inherited from Xpetra::Export< int, int, EpetraNode >
typedef int local_ordinal_type
 
typedef int global_ordinal_type
 
typedef EpetraNode node_type
 

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 LocalOrdinalgetPermuteFromLIDs () const
 List of local IDs in the source Map that are permuted.
 
ArrayView< const LocalOrdinalgetPermuteToLIDs () 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 LocalOrdinalgetRemoteLIDs () 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 LocalOrdinalgetExportLIDs () 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.
 
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 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
 

Additional Inherited Members

- Public Member Functions inherited from Xpetra::Export< int, int, EpetraNode >
virtual ~Export ()
 Destructor.
 
- 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 246 of file Xpetra_TpetraExport_def.hpp.

Member Typedef Documentation

◆ LocalOrdinal

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

Definition at line 251 of file Xpetra_TpetraExport_def.hpp.

◆ GlobalOrdinal

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

Definition at line 252 of file Xpetra_TpetraExport_def.hpp.

◆ Node

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

Definition at line 253 of file Xpetra_TpetraExport_def.hpp.

◆ map_type

The specialization of Map used by this class.

Definition at line 256 of file Xpetra_TpetraExport_def.hpp.

Constructor & Destructor Documentation

◆ TpetraExport() [1/4]

Xpetra::TpetraExport< int, int, EpetraNode >::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 262 of file Xpetra_TpetraExport_def.hpp.

◆ TpetraExport() [2/4]

Xpetra::TpetraExport< int, int, EpetraNode >::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 272 of file Xpetra_TpetraExport_def.hpp.

◆ TpetraExport() [3/4]

Xpetra::TpetraExport< int, int, EpetraNode >::TpetraExport ( const Export< LocalOrdinal, GlobalOrdinal, Node > &  rhs)
inline

Copy constructor.

Definition at line 284 of file Xpetra_TpetraExport_def.hpp.

◆ ~TpetraExport()

Xpetra::TpetraExport< int, int, EpetraNode >::~TpetraExport ( )
inline

Destructor.

Definition at line 294 of file Xpetra_TpetraExport_def.hpp.

◆ TpetraExport() [4/4]

Xpetra::TpetraExport< int, int, EpetraNode >::TpetraExport ( const RCP< const Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node > > &  exp)
inline

TpetraExport constructor to wrap a Tpetra::Export object.

Definition at line 370 of file Xpetra_TpetraExport_def.hpp.

Member Function Documentation

◆ getNumSameIDs()

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

Number of initial identical IDs.

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

Definition at line 304 of file Xpetra_TpetraExport_def.hpp.

◆ getNumPermuteIDs()

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

Number of IDs to permute but not to communicate.

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

Definition at line 308 of file Xpetra_TpetraExport_def.hpp.

◆ getPermuteFromLIDs()

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

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

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

Definition at line 312 of file Xpetra_TpetraExport_def.hpp.

◆ getPermuteToLIDs()

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

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

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

Definition at line 316 of file Xpetra_TpetraExport_def.hpp.

◆ getNumRemoteIDs()

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

Number of entries not on the calling process.

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

Definition at line 320 of file Xpetra_TpetraExport_def.hpp.

◆ getRemoteLIDs()

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

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

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

Definition at line 324 of file Xpetra_TpetraExport_def.hpp.

◆ getNumExportIDs()

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

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

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

Definition at line 328 of file Xpetra_TpetraExport_def.hpp.

◆ getExportLIDs()

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

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

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

Definition at line 332 of file Xpetra_TpetraExport_def.hpp.

◆ getExportPIDs()

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

List of processes to which entries will be sent.

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

Definition at line 336 of file Xpetra_TpetraExport_def.hpp.

◆ getSourceMap()

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

The source Map used to construct this Export.

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

Definition at line 340 of file Xpetra_TpetraExport_def.hpp.

◆ getTargetMap()

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

The target Map used to construct this Export.

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

Definition at line 344 of file Xpetra_TpetraExport_def.hpp.

◆ setDistributorParameters()

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

Set parameters on the underlying object.

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

Definition at line 347 of file Xpetra_TpetraExport_def.hpp.

◆ print()

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

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

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

Definition at line 357 of file Xpetra_TpetraExport_def.hpp.

◆ getTpetra_Export()

RCP< const Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraExport< int, int, EpetraNode >::getTpetra_Export ( ) const
inline

Definition at line 379 of file Xpetra_TpetraExport_def.hpp.


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