Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node > Class Template Reference

#include <Xpetra_EpetraImport.hpp>

Inheritance diagram for Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >:
Xpetra::Import< int, EpetraGlobalOrdinal, Node > Teuchos::Describable Teuchos::LabeledObject

Private Types

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

Xpetra specific

RCP< const Epetra_Importimport_
 
 EpetraImportT (const RCP< const Epetra_Import > &import)
 EpetraImportT constructor to wrap a Epetra_Import object.
 
RCP< const Epetra_ImportgetEpetra_Import () const
 Get the underlying Epetra import.
 

Constructor/Destructor Methods

 EpetraImportT (const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target)
 Construct an Import from the source and target Maps.
 
 ~EpetraImportT ()
 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.
 
ArrayView< const LocalOrdinalgetRemotePIDs () 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.
 

Additional Inherited Members

- Public Types inherited from Xpetra::Import< int, EpetraGlobalOrdinal, Node >
typedef int local_ordinal_type
 
typedef EpetraGlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
typedef Map< int, EpetraGlobalOrdinal, Node > map_type
 
- Public Member Functions inherited from Xpetra::Import< int, EpetraGlobalOrdinal, Node >
virtual ~Import ()
 Destructor.
 
virtual Teuchos::RCP< const Import< int, EpetraGlobalOrdinal, Node > > 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

template<class EpetraGlobalOrdinal, class Node>
class Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >

Definition at line 66 of file Xpetra_EpetraImport.hpp.

Member Typedef Documentation

◆ LocalOrdinal

template<class EpetraGlobalOrdinal , class Node >
typedef int Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::LocalOrdinal
private

Definition at line 70 of file Xpetra_EpetraImport.hpp.

◆ GlobalOrdinal

template<class EpetraGlobalOrdinal , class Node >
typedef EpetraGlobalOrdinal Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::GlobalOrdinal
private

Definition at line 71 of file Xpetra_EpetraImport.hpp.

◆ map_type

template<class EpetraGlobalOrdinal , class Node >
typedef Map<LocalOrdinal,GlobalOrdinal,Node> Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::map_type
private

The specialization of Map used by this class.

Definition at line 73 of file Xpetra_EpetraImport.hpp.

Constructor & Destructor Documentation

◆ EpetraImportT() [1/2]

template<class EpetraGlobalOrdinal , class Node >
Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::EpetraImportT ( 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 81 of file Xpetra_EpetraImport.hpp.

◆ ~EpetraImportT()

template<class EpetraGlobalOrdinal , class Node >
Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::~EpetraImportT ( )
inline

Destructor.

Definition at line 94 of file Xpetra_EpetraImport.hpp.

◆ EpetraImportT() [2/2]

template<class EpetraGlobalOrdinal , class Node >
Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::EpetraImportT ( const RCP< const Epetra_Import > & import)
inline

EpetraImportT constructor to wrap a Epetra_Import object.

Definition at line 174 of file Xpetra_EpetraImport.hpp.

Member Function Documentation

◆ createRemoteOnlyImport()

template<class EpetraGlobalOrdinal , class Node >
Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::createRemoteOnlyImport ( const Teuchos::RCP< const map_type > & remoteTarget) const
inline

Special "constructor".

Definition at line 98 of file Xpetra_EpetraImport.hpp.

◆ getNumSameIDs()

template<class EpetraGlobalOrdinal , class Node >
size_t Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getNumSameIDs ( ) const
inlinevirtual

Number of initial identical IDs.

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 106 of file Xpetra_EpetraImport.hpp.

◆ getNumPermuteIDs()

template<class EpetraGlobalOrdinal , class Node >
size_t Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getNumPermuteIDs ( ) const
inlinevirtual

Number of IDs to permute but not to communicate.

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 109 of file Xpetra_EpetraImport.hpp.

◆ getPermuteFromLIDs()

template<class EpetraGlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getPermuteFromLIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 112 of file Xpetra_EpetraImport.hpp.

◆ getPermuteToLIDs()

template<class EpetraGlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getPermuteToLIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 118 of file Xpetra_EpetraImport.hpp.

◆ getNumRemoteIDs()

template<class EpetraGlobalOrdinal , class Node >
size_t Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getNumRemoteIDs ( ) const
inlinevirtual

Number of entries not on the calling process.

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 124 of file Xpetra_EpetraImport.hpp.

◆ getRemoteLIDs()

template<class EpetraGlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getRemoteLIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 127 of file Xpetra_EpetraImport.hpp.

◆ getRemotePIDs()

template<class EpetraGlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getRemotePIDs ( ) const
inline

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

Definition at line 133 of file Xpetra_EpetraImport.hpp.

◆ getNumExportIDs()

template<class EpetraGlobalOrdinal , class Node >
size_t Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getNumExportIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 139 of file Xpetra_EpetraImport.hpp.

◆ getExportLIDs()

template<class EpetraGlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getExportLIDs ( ) const
inlinevirtual

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

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 143 of file Xpetra_EpetraImport.hpp.

◆ getExportPIDs()

template<class EpetraGlobalOrdinal , class Node >
ArrayView< const int > Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getExportPIDs ( ) const
inlinevirtual

List of processes to which entries will be sent.

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 149 of file Xpetra_EpetraImport.hpp.

◆ getSourceMap()

template<class EpetraGlobalOrdinal , class Node >
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getSourceMap ( ) const
inlinevirtual

The Source Map used to construct this Import object.

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 153 of file Xpetra_EpetraImport.hpp.

◆ getTargetMap()

template<class EpetraGlobalOrdinal , class Node >
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getTargetMap ( ) const
inlinevirtual

The Target Map used to construct this Import object.

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 156 of file Xpetra_EpetraImport.hpp.

◆ setDistributorParameters()

template<class EpetraGlobalOrdinal , class Node >
void Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::setDistributorParameters ( const Teuchos::RCP< Teuchos::ParameterList > params) const
inlinevirtual

Set parameters on the underlying object.

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 158 of file Xpetra_EpetraImport.hpp.

◆ print()

template<class EpetraGlobalOrdinal , class Node >
void Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::print ( std::ostream & os) const
inlinevirtual

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

Implements Xpetra::Import< int, EpetraGlobalOrdinal, Node >.

Definition at line 166 of file Xpetra_EpetraImport.hpp.

◆ getEpetra_Import()

template<class EpetraGlobalOrdinal , class Node >
RCP< const Epetra_Import > Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::getEpetra_Import ( ) const
inline

Get the underlying Epetra import.

Definition at line 177 of file Xpetra_EpetraImport.hpp.

Member Data Documentation

◆ import_

template<class EpetraGlobalOrdinal , class Node >
RCP<const Epetra_Import> Xpetra::EpetraImportT< EpetraGlobalOrdinal, Node >::import_
private

Definition at line 183 of file Xpetra_EpetraImport.hpp.


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