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

#include <Xpetra_TpetraImport_def.hpp>

Inheritance diagram for Xpetra::TpetraImport< int, int, EpetraNode >:
Xpetra::Import< int, int, EpetraNode > Xpetra::Import< int, int, EpetraNode > Teuchos::Describable Teuchos::Describable Teuchos::LabeledObject 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.
 
typedef Map< int, int, EpetraNodemap_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, EpetraNodemap_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 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 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
 

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< int, int, EpetraNode > &import)
 Copy constructor.
 
 ~TpetraImport ()
 Destructor.
 
Teuchos::RCP< const Import< int, int, EpetraNode > > createRemoteOnlyImport (const Teuchos::RCP< const map_type > &remoteTarget) const
 Special "constructor".
 

Xpetra specific

 TpetraImport (const RCP< const Tpetra::Import< int, int, EpetraNode > > &import)
 TpetraImport constructor to wrap a Tpetra::Import object.
 
RCP< const Tpetra::Import< int, int, EpetraNode > > getTpetra_Import () const
 
RCP< const Tpetra::Import< int, int, EpetraNode > > import_
 

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 int > getPermuteFromLIDs () const
 List of local IDs in the source Map that are permuted.
 
ArrayView< const int > 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 int > getRemoteLIDs () const
 List of entries in the target Map to receive from other processes.
 
void setDistributorParameters (const Teuchos::RCP< Teuchos::ParameterList > params) const
 Set parameters on distributor.
 
size_t getNumExportIDs () const
 Number of entries that must be sent by the calling process to other processes.
 
ArrayView< const int > 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< int, int, EpetraNode > > getSourceMap () const
 The Source Map used to construct this Import object.
 
Teuchos::RCP< const Map< int, int, EpetraNode > > getTargetMap () const
 The Target Map used to construct this Import object.
 

I/O Methods

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

Additional Inherited Members

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 158 of file Xpetra_TpetraImport_def.hpp.

Member Typedef Documentation

◆ LocalOrdinal

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

Definition at line 162 of file Xpetra_TpetraImport_def.hpp.

◆ GlobalOrdinal

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

Definition at line 163 of file Xpetra_TpetraImport_def.hpp.

◆ Node

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

Definition at line 164 of file Xpetra_TpetraImport_def.hpp.

◆ map_type [1/2]

The specialization of Map used by this class.

Definition at line 167 of file Xpetra_TpetraImport_def.hpp.

◆ map_type [2/2]

typedef Map<int,int,EpetraNode> Xpetra::TpetraImport< int, int, EpetraNode >::map_type

The specialization of Map used by this class.

Definition at line 71 of file Xpetra_TpetraImport_decl.hpp.

Constructor & Destructor Documentation

◆ TpetraImport() [1/8]

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 173 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [2/8]

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 178 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [3/8]

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

Copy constructor.

Definition at line 183 of file Xpetra_TpetraImport_def.hpp.

◆ ~TpetraImport() [1/2]

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

Destructor.

Definition at line 188 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [4/8]

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 252 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [5/8]

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

Construct an Import from the source and target Maps.

Definition at line 77 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [6/8]

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 )

Constructor (with list of parameters).

Definition at line 80 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [7/8]

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

Copy constructor.

Definition at line 83 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [8/8]

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

TpetraImport constructor to wrap a Tpetra::Import object.

Definition at line 147 of file Xpetra_TpetraImport_def.hpp.

◆ ~TpetraImport() [2/2]

Destructor.

Definition at line 86 of file Xpetra_TpetraImport_def.hpp.

Member Function Documentation

◆ createRemoteOnlyImport() [1/2]

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 193 of file Xpetra_TpetraImport_def.hpp.

◆ getNumSameIDs() [1/2]

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

Number of initial identical IDs.

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

Definition at line 203 of file Xpetra_TpetraImport_def.hpp.

◆ getNumPermuteIDs() [1/2]

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 206 of file Xpetra_TpetraImport_def.hpp.

◆ getPermuteFromLIDs() [1/2]

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 209 of file Xpetra_TpetraImport_def.hpp.

◆ getPermuteToLIDs() [1/2]

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

◆ getNumRemoteIDs() [1/2]

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 215 of file Xpetra_TpetraImport_def.hpp.

◆ getRemoteLIDs() [1/2]

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 218 of file Xpetra_TpetraImport_def.hpp.

◆ getNumExportIDs() [1/2]

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

◆ getExportLIDs() [1/2]

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 224 of file Xpetra_TpetraImport_def.hpp.

◆ getExportPIDs() [1/2]

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 227 of file Xpetra_TpetraImport_def.hpp.

◆ getSourceMap() [1/2]

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 230 of file Xpetra_TpetraImport_def.hpp.

◆ getTargetMap() [1/2]

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 233 of file Xpetra_TpetraImport_def.hpp.

◆ setDistributorParameters() [1/2]

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 236 of file Xpetra_TpetraImport_def.hpp.

◆ print() [1/2]

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 244 of file Xpetra_TpetraImport_def.hpp.

◆ getTpetra_Import() [1/2]

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

Definition at line 256 of file Xpetra_TpetraImport_def.hpp.

◆ createRemoteOnlyImport() [2/2]

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

Special "constructor".

Definition at line 90 of file Xpetra_TpetraImport_def.hpp.

◆ getNumSameIDs() [2/2]

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

Number of initial identical IDs.

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

Definition at line 98 of file Xpetra_TpetraImport_def.hpp.

◆ getNumPermuteIDs() [2/2]

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

Number of IDs to permute but not to communicate.

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

Definition at line 101 of file Xpetra_TpetraImport_def.hpp.

◆ getPermuteFromLIDs() [2/2]

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

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

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

Definition at line 104 of file Xpetra_TpetraImport_def.hpp.

◆ getPermuteToLIDs() [2/2]

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

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

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

Definition at line 107 of file Xpetra_TpetraImport_def.hpp.

◆ getNumRemoteIDs() [2/2]

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

Number of entries not on the calling process.

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

Definition at line 110 of file Xpetra_TpetraImport_def.hpp.

◆ getRemoteLIDs() [2/2]

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

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

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

Definition at line 113 of file Xpetra_TpetraImport_def.hpp.

◆ setDistributorParameters() [2/2]

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

Set parameters on distributor.

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

Definition at line 116 of file Xpetra_TpetraImport_def.hpp.

◆ getNumExportIDs() [2/2]

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

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

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

Definition at line 119 of file Xpetra_TpetraImport_def.hpp.

◆ getExportLIDs() [2/2]

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

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

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

Definition at line 122 of file Xpetra_TpetraImport_def.hpp.

◆ getExportPIDs() [2/2]

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

List of processes to which entries will be sent.

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

Definition at line 125 of file Xpetra_TpetraImport_def.hpp.

◆ getSourceMap() [2/2]

Teuchos::RCP< const Map< int, int, EpetraNode > > Xpetra::TpetraImport< int, int, EpetraNode >::getSourceMap ( ) const
virtual

The Source Map used to construct this Import object.

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

Definition at line 128 of file Xpetra_TpetraImport_def.hpp.

◆ getTargetMap() [2/2]

Teuchos::RCP< const Map< int, int, EpetraNode > > Xpetra::TpetraImport< int, int, EpetraNode >::getTargetMap ( ) const
virtual

The Target Map used to construct this Import object.

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

Definition at line 131 of file Xpetra_TpetraImport_def.hpp.

◆ print() [2/2]

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

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

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

Definition at line 139 of file Xpetra_TpetraImport_def.hpp.

◆ getTpetra_Import() [2/2]

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

Definition at line 149 of file Xpetra_TpetraImport_def.hpp.

Member Data Documentation

◆ import_

RCP<const Tpetra::Import< int, int, EpetraNode > > Xpetra::TpetraImport< int, int, EpetraNode >::import_
private

Definition at line 155 of file Xpetra_TpetraImport_decl.hpp.


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