Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <Xpetra_TpetraImport_decl.hpp>

Inheritance diagram for Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >:
Xpetra::Import< 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::Import< LocalOrdinal, GlobalOrdinal, Node >
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
typedef Map< LocalOrdinal, GlobalOrdinal, Node > map_type
 

Xpetra specific

RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > import_
 
 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< 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 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.
 
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 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 Import object.
 
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > 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

- Public Member Functions inherited from Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >
virtual ~Import ()
 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 = KokkosClassic::DefaultNode::DefaultNodeType>
class Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >

Definition at line 64 of file Xpetra_TpetraImport_decl.hpp.

Member Typedef Documentation

◆ map_type

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef Map<LocalOrdinal,GlobalOrdinal,Node> Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::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/4]

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::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 61 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [2/4]

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::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 65 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [3/4]

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::TpetraImport ( const Import< LocalOrdinal, GlobalOrdinal, Node > &  import)

Copy constructor.

Definition at line 69 of file Xpetra_TpetraImport_def.hpp.

◆ ~TpetraImport()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::~TpetraImport

Destructor.

Definition at line 73 of file Xpetra_TpetraImport_def.hpp.

◆ TpetraImport() [4/4]

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::TpetraImport ( const RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > &  import)

TpetraImport constructor to wrap a Tpetra::Import object.

Definition at line 143 of file Xpetra_TpetraImport_def.hpp.

Member Function Documentation

◆ createRemoteOnlyImport()

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

Special "constructor".

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 78 of file Xpetra_TpetraImport_def.hpp.

◆ getNumSameIDs()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getNumSameIDs
virtual

Number of initial identical IDs.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 86 of file Xpetra_TpetraImport_def.hpp.

◆ getNumPermuteIDs()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getNumPermuteIDs
virtual

Number of IDs to permute but not to communicate.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 90 of file Xpetra_TpetraImport_def.hpp.

◆ getPermuteFromLIDs()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getPermuteFromLIDs
virtual

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

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 94 of file Xpetra_TpetraImport_def.hpp.

◆ getPermuteToLIDs()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getPermuteToLIDs
virtual

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

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 98 of file Xpetra_TpetraImport_def.hpp.

◆ getNumRemoteIDs()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getNumRemoteIDs
virtual

Number of entries not on the calling process.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 102 of file Xpetra_TpetraImport_def.hpp.

◆ getRemoteLIDs()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getRemoteLIDs
virtual

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

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 115 of file Xpetra_TpetraImport_def.hpp.

◆ setDistributorParameters()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::setDistributorParameters ( const Teuchos::RCP< Teuchos::ParameterList params) const
virtual

Set parameters on distributor.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 106 of file Xpetra_TpetraImport_def.hpp.

◆ getNumExportIDs()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getNumExportIDs
virtual

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

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 119 of file Xpetra_TpetraImport_def.hpp.

◆ getExportLIDs()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const LocalOrdinal > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getExportLIDs
virtual

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

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 123 of file Xpetra_TpetraImport_def.hpp.

◆ getExportPIDs()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayView< const int > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getExportPIDs
virtual

List of processes to which entries will be sent.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 127 of file Xpetra_TpetraImport_def.hpp.

◆ getSourceMap()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getSourceMap
virtual

The Source Map used to construct this Import object.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 131 of file Xpetra_TpetraImport_def.hpp.

◆ getTargetMap()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getTargetMap
virtual

The Target Map used to construct this Import object.

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 135 of file Xpetra_TpetraImport_def.hpp.

◆ print()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::print ( std::ostream &  os) const
virtual

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

Implements Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 139 of file Xpetra_TpetraImport_def.hpp.

◆ getTpetra_Import()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::getTpetra_Import

Definition at line 147 of file Xpetra_TpetraImport_def.hpp.

Member Data Documentation

◆ import_

template<class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
RCP<const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraImport< LocalOrdinal, GlobalOrdinal, Node >::import_
private

Definition at line 155 of file Xpetra_TpetraImport_decl.hpp.


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