Xpetra Version of the Day
Loading...
Searching...
No Matches
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 > Teuchos::Describable Teuchos::LabeledObject

Public Types

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

Xpetra specific

RCP< const Tpetra::Export< LocalOrdinal, GlobalOrdinal, Node > > export_
 
 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
 

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.
 
void setDistributorParameters (const Teuchos::RCP< Teuchos::ParameterList > params) const
 Set distributor parameters.
 

I/O Methods

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

Additional Inherited Members

- Public Member Functions inherited from Xpetra::Export< LocalOrdinal, GlobalOrdinal, Node >
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

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

◆ map_type

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

◆ TpetraExport() [1/4]

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 56 of file Xpetra_TpetraExport_def.hpp.

◆ TpetraExport() [2/4]

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 65 of file Xpetra_TpetraExport_def.hpp.

◆ TpetraExport() [3/4]

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

Copy constructor.

Definition at line 75 of file Xpetra_TpetraExport_def.hpp.

◆ ~TpetraExport()

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

Destructor.

Definition at line 83 of file Xpetra_TpetraExport_def.hpp.

◆ TpetraExport() [4/4]

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 221 of file Xpetra_TpetraExport_def.hpp.

Member Function Documentation

◆ getNumSameIDs()

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 91 of file Xpetra_TpetraExport_def.hpp.

◆ getNumPermuteIDs()

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 101 of file Xpetra_TpetraExport_def.hpp.

◆ getPermuteFromLIDs()

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 111 of file Xpetra_TpetraExport_def.hpp.

◆ getPermuteToLIDs()

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 121 of file Xpetra_TpetraExport_def.hpp.

◆ getNumRemoteIDs()

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 131 of file Xpetra_TpetraExport_def.hpp.

◆ getRemoteLIDs()

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 141 of file Xpetra_TpetraExport_def.hpp.

◆ getNumExportIDs()

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 151 of file Xpetra_TpetraExport_def.hpp.

◆ getExportLIDs()

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 161 of file Xpetra_TpetraExport_def.hpp.

◆ getExportPIDs()

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 171 of file Xpetra_TpetraExport_def.hpp.

◆ getSourceMap()

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 181 of file Xpetra_TpetraExport_def.hpp.

◆ getTargetMap()

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 191 of file Xpetra_TpetraExport_def.hpp.

◆ setDistributorParameters()

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 200 of file Xpetra_TpetraExport_def.hpp.

◆ print()

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 212 of file Xpetra_TpetraExport_def.hpp.

◆ getTpetra_Export()

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 231 of file Xpetra_TpetraExport_def.hpp.

Member Data Documentation

◆ export_

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: