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

#include <Xpetra_TpetraImport_def.hpp>

Inheritance diagram for Xpetra::TpetraImport< int, long long, EpetraNode >:
Xpetra::Import< int, long long, EpetraNode > Teuchos::Describable Teuchos::LabeledObject

Public Types

typedef int LocalOrdinal
 
typedef long long GlobalOrdinal
 
typedef EpetraNode Node
 
typedef Map< LocalOrdinal, GlobalOrdinal, Nodemap_type
 The specialization of Map used by this class.
 
- Public Types inherited from Xpetra::Import< int, long long, EpetraNode >
typedef int local_ordinal_type
 
typedef long long global_ordinal_type
 
typedef EpetraNode node_type
 
typedef Map< int, long long, 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
 

Additional Inherited Members

- Public Member Functions inherited from Xpetra::Import< int, long long, EpetraNode >
virtual ~Import ()
 Destructor.
 
virtual Teuchos::RCP< const Import< int, long long, 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 268 of file Xpetra_TpetraImport_def.hpp.

Member Typedef Documentation

◆ LocalOrdinal

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

Definition at line 272 of file Xpetra_TpetraImport_def.hpp.

◆ GlobalOrdinal

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

Definition at line 273 of file Xpetra_TpetraImport_def.hpp.

◆ Node

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

Definition at line 274 of file Xpetra_TpetraImport_def.hpp.

◆ map_type

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

The specialization of Map used by this class.

Definition at line 277 of file Xpetra_TpetraImport_def.hpp.

Constructor & Destructor Documentation

◆ TpetraImport() [1/4]

Xpetra::TpetraImport< int, long long, 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 283 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [2/4]

Xpetra::TpetraImport< int, long long, 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 288 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [3/4]

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

Copy constructor.

Definition at line 293 of file Xpetra_TpetraImport_def.hpp.

◆ ~TpetraImport()

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

Destructor.

Definition at line 298 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [4/4]

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

TpetraImport constructor to wrap a Tpetra::Import object.

Definition at line 361 of file Xpetra_TpetraImport_def.hpp.

Member Function Documentation

◆ createRemoteOnlyImport()

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

Special "constructor".

Definition at line 302 of file Xpetra_TpetraImport_def.hpp.

◆ getNumSameIDs()

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

Number of initial identical IDs.

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

Definition at line 312 of file Xpetra_TpetraImport_def.hpp.

◆ getNumPermuteIDs()

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

Number of IDs to permute but not to communicate.

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

Definition at line 315 of file Xpetra_TpetraImport_def.hpp.

◆ getPermuteFromLIDs()

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

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

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

Definition at line 318 of file Xpetra_TpetraImport_def.hpp.

◆ getPermuteToLIDs()

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

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

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

Definition at line 321 of file Xpetra_TpetraImport_def.hpp.

◆ getNumRemoteIDs()

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

Number of entries not on the calling process.

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

Definition at line 324 of file Xpetra_TpetraImport_def.hpp.

◆ getRemoteLIDs()

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

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

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

Definition at line 327 of file Xpetra_TpetraImport_def.hpp.

◆ getNumExportIDs()

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

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

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

Definition at line 330 of file Xpetra_TpetraImport_def.hpp.

◆ getExportLIDs()

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

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

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

Definition at line 333 of file Xpetra_TpetraImport_def.hpp.

◆ getExportPIDs()

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

List of processes to which entries will be sent.

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

Definition at line 336 of file Xpetra_TpetraImport_def.hpp.

◆ getSourceMap()

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

The Source Map used to construct this Import object.

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

Definition at line 339 of file Xpetra_TpetraImport_def.hpp.

◆ getTargetMap()

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

The Target Map used to construct this Import object.

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

Definition at line 342 of file Xpetra_TpetraImport_def.hpp.

◆ setDistributorParameters()

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

Set parameters on the underlying object.

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

Definition at line 345 of file Xpetra_TpetraImport_def.hpp.

◆ print()

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

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

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

Definition at line 353 of file Xpetra_TpetraImport_def.hpp.

◆ getTpetra_Import()

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

Definition at line 365 of file Xpetra_TpetraImport_def.hpp.


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