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

#include <Xpetra_TpetraMap_def.hpp>

Inheritance diagram for Xpetra::TpetraMap< int, int, EpetraNode >:
Xpetra::Map< int, int, EpetraNode > Teuchos::Describable Teuchos::LabeledObject

Public Types

typedef int GlobalOrdinal
 
typedef int LocalOrdinal
 
typedef EpetraNode Node
 
- Public Types inherited from Xpetra::Map< int, int, EpetraNode >
typedef int local_ordinal_type
 
typedef int global_ordinal_type
 
typedef EpetraNode node_type
 
typedef Tpetra::Map< int, int, EpetraNode >::local_map_type local_map_type
 

Xpetra specific

using local_map_type = typename Map<LocalOrdinal, GlobalOrdinal, Node>::local_map_type
 
 TpetraMap (const Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &map)
 TpetraMap constructor to wrap a Tpetra::Map object.
 
UnderlyingLib lib () const
 Get the library used by this object (Tpetra or Epetra?)
 
RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getTpetra_Map () const
 Get the underlying Tpetra map.
 
local_map_type getLocalMap () const
 Get the local Map for Kokkos kernels.
 

Constructors and destructor

 TpetraMap (global_size_t numGlobalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalGlobal lg=GloballyDistributed)
 Constructor with Tpetra-defined contiguous uniform distribution.
 
 TpetraMap (global_size_t numGlobalElements, size_t numLocalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
 Constructor with a user-defined contiguous distribution.
 
 TpetraMap (global_size_t numGlobalElements, const Teuchos::ArrayView< const GlobalOrdinal > &elementList, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
 Constructor with user-defined arbitrary (possibly noncontiguous) distribution.
 
 ~TpetraMap ()
 Destructor.
 

Attributes

global_size_t getGlobalNumElements () const
 The number of elements in this Map.
 
size_t getLocalNumElements () const
 The number of elements belonging to the calling node.
 
GlobalOrdinal getIndexBase () const
 The index base for this Map.
 
LocalOrdinal getMinLocalIndex () const
 The minimum local index.
 
LocalOrdinal getMaxLocalIndex () const
 The maximum local index on the calling process.
 
GlobalOrdinal getMinGlobalIndex () const
 The minimum global index owned by the calling process.
 
GlobalOrdinal getMaxGlobalIndex () const
 The maximum global index owned by the calling process.
 
GlobalOrdinal getMinAllGlobalIndex () const
 The minimum global index over all processes in the communicator.
 
GlobalOrdinal getMaxAllGlobalIndex () const
 The maximum global index over all processes in the communicator.
 
LocalOrdinal getLocalElement (GlobalOrdinal globalIndex) const
 The local index corresponding to the given global index.
 
GlobalOrdinal getGlobalElement (LocalOrdinal localIndex) const
 The global index corresponding to the given local index.
 
LookupStatus getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList, const Teuchos::ArrayView< LocalOrdinal > &LIDList) const
 Return the process IDs and corresponding local IDs for the given global IDs.
 
LookupStatus getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList) const
 Return the process IDs for the given global IDs.
 
Teuchos::ArrayView< const GlobalOrdinalgetLocalElementList () const
 Return a view of the global indices owned by this node.
 

Boolean tests

bool isNodeLocalElement (LocalOrdinal localIndex) const
 True if the local index is valid for this Map on this node, else false.
 
bool isNodeGlobalElement (GlobalOrdinal globalIndex) const
 True if the global index is found in this Map on this node, else false.
 
bool isContiguous () const
 True if this Map is distributed contiguously, else false.
 
bool isDistributed () const
 Whether this Map is globally distributed or locally replicated.
 
bool isCompatible (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const
 True if and only if map is compatible with this Map.
 
bool isSameAs (const Map< LocalOrdinal, GlobalOrdinal, Node > &map) const
 True if and only if map is identical to this Map.
 
Teuchos::RCP< const Teuchos::Comm< int > > getComm () const
 Get this Map's Comm object.
 
std::string description () const
 Return a simple one-line description of this object.
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
 Print this object with the given verbosity level to the given FancyOStream.
 
RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > removeEmptyProcesses () const
 Return a new Map with processes with zero elements removed.
 
RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > replaceCommWithSubset (const Teuchos::RCP< const Teuchos::Comm< int > > &newComm) const
 Replace this Map's communicator with a subset communicator.
 

Additional Inherited Members

- Public Member Functions inherited from Xpetra::Map< int, int, EpetraNode >
virtual RCP< const Xpetra::Map< int, int, EpetraNode > > getMap () const
 
virtual ~Map ()
 Destructor.
 
- Public Member Functions inherited from Teuchos::Describable
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)
 
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 261 of file Xpetra_TpetraMap_def.hpp.

Member Typedef Documentation

◆ GlobalOrdinal

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

Definition at line 265 of file Xpetra_TpetraMap_def.hpp.

◆ LocalOrdinal

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

Definition at line 266 of file Xpetra_TpetraMap_def.hpp.

◆ Node

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

Definition at line 267 of file Xpetra_TpetraMap_def.hpp.

◆ local_map_type

using Xpetra::TpetraMap< int, int, EpetraNode >::local_map_type = typename Map<LocalOrdinal, GlobalOrdinal, Node>::local_map_type

Definition at line 419 of file Xpetra_TpetraMap_def.hpp.

Constructor & Destructor Documentation

◆ TpetraMap() [1/4]

Xpetra::TpetraMap< int, int, EpetraNode >::TpetraMap ( global_size_t numGlobalElements,
GlobalOrdinal indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > & comm,
LocalGlobal lg = GloballyDistributed )
inline

Constructor with Tpetra-defined contiguous uniform distribution.

Definition at line 276 of file Xpetra_TpetraMap_def.hpp.

◆ TpetraMap() [2/4]

Xpetra::TpetraMap< int, int, EpetraNode >::TpetraMap ( global_size_t numGlobalElements,
size_t numLocalElements,
GlobalOrdinal indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > & comm )
inline

Constructor with a user-defined contiguous distribution.

Definition at line 287 of file Xpetra_TpetraMap_def.hpp.

◆ TpetraMap() [3/4]

Xpetra::TpetraMap< int, int, EpetraNode >::TpetraMap ( global_size_t numGlobalElements,
const Teuchos::ArrayView< const GlobalOrdinal > & elementList,
GlobalOrdinal indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > & comm )
inline

Constructor with user-defined arbitrary (possibly noncontiguous) distribution.

Definition at line 298 of file Xpetra_TpetraMap_def.hpp.

◆ ~TpetraMap()

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

Destructor.

Definition at line 307 of file Xpetra_TpetraMap_def.hpp.

◆ TpetraMap() [4/4]

Xpetra::TpetraMap< int, int, EpetraNode >::TpetraMap ( const Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > & map)
inline

TpetraMap constructor to wrap a Tpetra::Map object.

Definition at line 408 of file Xpetra_TpetraMap_def.hpp.

Member Function Documentation

◆ getGlobalNumElements()

global_size_t Xpetra::TpetraMap< int, int, EpetraNode >::getGlobalNumElements ( ) const
inlinevirtual

The number of elements in this Map.

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

Definition at line 315 of file Xpetra_TpetraMap_def.hpp.

◆ getLocalNumElements()

size_t Xpetra::TpetraMap< int, int, EpetraNode >::getLocalNumElements ( ) const
inlinevirtual

The number of elements belonging to the calling node.

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

Definition at line 318 of file Xpetra_TpetraMap_def.hpp.

◆ getIndexBase()

GlobalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getIndexBase ( ) const
inlinevirtual

The index base for this Map.

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

Definition at line 321 of file Xpetra_TpetraMap_def.hpp.

◆ getMinLocalIndex()

LocalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getMinLocalIndex ( ) const
inlinevirtual

The minimum local index.

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

Definition at line 324 of file Xpetra_TpetraMap_def.hpp.

◆ getMaxLocalIndex()

LocalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getMaxLocalIndex ( ) const
inlinevirtual

The maximum local index on the calling process.

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

Definition at line 327 of file Xpetra_TpetraMap_def.hpp.

◆ getMinGlobalIndex()

GlobalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getMinGlobalIndex ( ) const
inlinevirtual

The minimum global index owned by the calling process.

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

Definition at line 330 of file Xpetra_TpetraMap_def.hpp.

◆ getMaxGlobalIndex()

GlobalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getMaxGlobalIndex ( ) const
inlinevirtual

The maximum global index owned by the calling process.

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

Definition at line 333 of file Xpetra_TpetraMap_def.hpp.

◆ getMinAllGlobalIndex()

GlobalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getMinAllGlobalIndex ( ) const
inlinevirtual

The minimum global index over all processes in the communicator.

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

Definition at line 336 of file Xpetra_TpetraMap_def.hpp.

◆ getMaxAllGlobalIndex()

GlobalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getMaxAllGlobalIndex ( ) const
inlinevirtual

The maximum global index over all processes in the communicator.

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

Definition at line 339 of file Xpetra_TpetraMap_def.hpp.

◆ getLocalElement()

LocalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getLocalElement ( GlobalOrdinal globalIndex) const
inlinevirtual

The local index corresponding to the given global index.

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

Definition at line 342 of file Xpetra_TpetraMap_def.hpp.

◆ getGlobalElement()

GlobalOrdinal Xpetra::TpetraMap< int, int, EpetraNode >::getGlobalElement ( LocalOrdinal localIndex) const
inlinevirtual

The global index corresponding to the given local index.

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

Definition at line 345 of file Xpetra_TpetraMap_def.hpp.

◆ getRemoteIndexList() [1/2]

LookupStatus Xpetra::TpetraMap< int, int, EpetraNode >::getRemoteIndexList ( const Teuchos::ArrayView< const GlobalOrdinal > & GIDList,
const Teuchos::ArrayView< int > & nodeIDList,
const Teuchos::ArrayView< LocalOrdinal > & LIDList ) const
inlinevirtual

Return the process IDs and corresponding local IDs for the given global IDs.

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

Definition at line 348 of file Xpetra_TpetraMap_def.hpp.

◆ getRemoteIndexList() [2/2]

LookupStatus Xpetra::TpetraMap< int, int, EpetraNode >::getRemoteIndexList ( const Teuchos::ArrayView< const GlobalOrdinal > & GIDList,
const Teuchos::ArrayView< int > & nodeIDList ) const
inlinevirtual

Return the process IDs for the given global IDs.

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

Definition at line 351 of file Xpetra_TpetraMap_def.hpp.

◆ getLocalElementList()

Teuchos::ArrayView< const GlobalOrdinal > Xpetra::TpetraMap< int, int, EpetraNode >::getLocalElementList ( ) const
inlinevirtual

Return a view of the global indices owned by this node.

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

Definition at line 354 of file Xpetra_TpetraMap_def.hpp.

◆ isNodeLocalElement()

bool Xpetra::TpetraMap< int, int, EpetraNode >::isNodeLocalElement ( LocalOrdinal localIndex) const
inlinevirtual

True if the local index is valid for this Map on this node, else false.

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

Definition at line 362 of file Xpetra_TpetraMap_def.hpp.

◆ isNodeGlobalElement()

bool Xpetra::TpetraMap< int, int, EpetraNode >::isNodeGlobalElement ( GlobalOrdinal globalIndex) const
inlinevirtual

True if the global index is found in this Map on this node, else false.

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

Definition at line 365 of file Xpetra_TpetraMap_def.hpp.

◆ isContiguous()

bool Xpetra::TpetraMap< int, int, EpetraNode >::isContiguous ( ) const
inlinevirtual

True if this Map is distributed contiguously, else false.

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

Definition at line 368 of file Xpetra_TpetraMap_def.hpp.

◆ isDistributed()

bool Xpetra::TpetraMap< int, int, EpetraNode >::isDistributed ( ) const
inlinevirtual

Whether this Map is globally distributed or locally replicated.

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

Definition at line 371 of file Xpetra_TpetraMap_def.hpp.

◆ isCompatible()

bool Xpetra::TpetraMap< int, int, EpetraNode >::isCompatible ( const Map< LocalOrdinal, GlobalOrdinal, Node > & map) const
inlinevirtual

True if and only if map is compatible with this Map.

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

Definition at line 374 of file Xpetra_TpetraMap_def.hpp.

◆ isSameAs()

bool Xpetra::TpetraMap< int, int, EpetraNode >::isSameAs ( const Map< LocalOrdinal, GlobalOrdinal, Node > & map) const
inlinevirtual

True if and only if map is identical to this Map.

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

Definition at line 377 of file Xpetra_TpetraMap_def.hpp.

◆ getComm()

Teuchos::RCP< const Teuchos::Comm< int > > Xpetra::TpetraMap< int, int, EpetraNode >::getComm ( ) const
inlinevirtual

Get this Map's Comm object.

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

Definition at line 385 of file Xpetra_TpetraMap_def.hpp.

◆ description()

std::string Xpetra::TpetraMap< int, int, EpetraNode >::description ( ) const
inlinevirtual

Return a simple one-line description of this object.

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

Definition at line 394 of file Xpetra_TpetraMap_def.hpp.

◆ describe()

void Xpetra::TpetraMap< int, int, EpetraNode >::describe ( Teuchos::FancyOStream & out,
const Teuchos::EVerbosityLevel verbLevel = Teuchos::Describable::verbLevel_default ) const
inlinevirtual

Print this object with the given verbosity level to the given FancyOStream.

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

Definition at line 397 of file Xpetra_TpetraMap_def.hpp.

◆ removeEmptyProcesses()

RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraMap< int, int, EpetraNode >::removeEmptyProcesses ( ) const
inlinevirtual

Return a new Map with processes with zero elements removed.

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

Definition at line 399 of file Xpetra_TpetraMap_def.hpp.

◆ replaceCommWithSubset()

RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraMap< int, int, EpetraNode >::replaceCommWithSubset ( const Teuchos::RCP< const Teuchos::Comm< int > > & newComm) const
inlinevirtual

Replace this Map's communicator with a subset communicator.

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

Definition at line 400 of file Xpetra_TpetraMap_def.hpp.

◆ lib()

UnderlyingLib Xpetra::TpetraMap< int, int, EpetraNode >::lib ( ) const
inlinevirtual

Get the library used by this object (Tpetra or Epetra?)

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

Definition at line 413 of file Xpetra_TpetraMap_def.hpp.

◆ getTpetra_Map()

RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraMap< int, int, EpetraNode >::getTpetra_Map ( ) const
inline

Get the underlying Tpetra map.

Definition at line 416 of file Xpetra_TpetraMap_def.hpp.

◆ getLocalMap()

local_map_type Xpetra::TpetraMap< int, int, EpetraNode >::getLocalMap ( ) const
inlinevirtual

Get the local Map for Kokkos kernels.

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

Definition at line 421 of file Xpetra_TpetraMap_def.hpp.


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