Tpetra parallel linear algebra  Version of the Day
Public Member Functions | List of all members
Tpetra::Details::LocalMap< LocalOrdinal, GlobalOrdinal, DeviceType > Class Template Reference

"Local" part of Map suitable for Kokkos kernels. More...

#include <Tpetra_Map_decl.hpp>

Public Member Functions

KOKKOS_INLINE_FUNCTION LocalOrdinal getNodeNumElements () const
 The number of indices that live on the calling process. More...
 
KOKKOS_INLINE_FUNCTION GlobalOrdinal getIndexBase () const
 The (global) index base. More...
 
KOKKOS_INLINE_FUNCTION bool isContiguous () const
 Whether the Map is (locally) contiguous. More...
 
KOKKOS_INLINE_FUNCTION LocalOrdinal getMinLocalIndex () const
 The minimum local index. More...
 
KOKKOS_INLINE_FUNCTION LocalOrdinal getMaxLocalIndex () const
 The maximum local index. More...
 
KOKKOS_INLINE_FUNCTION GlobalOrdinal getMinGlobalIndex () const
 The minimum global index on the calling process. More...
 
KOKKOS_INLINE_FUNCTION GlobalOrdinal getMaxGlobalIndex () const
 The maximum global index on the calling process. More...
 
KOKKOS_INLINE_FUNCTION LocalOrdinal getLocalElement (const GlobalOrdinal globalIndex) const
 Get the local index corresponding to the given global index. More...
 
KOKKOS_INLINE_FUNCTION GlobalOrdinal getGlobalElement (const LocalOrdinal localIndex) const
 Get the global index corresponding to the given local index. More...
 

Detailed Description

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>
class Tpetra::Details::LocalMap< LocalOrdinal, GlobalOrdinal, DeviceType >

"Local" part of Map suitable for Kokkos kernels.

Warning
This object's interface is not yet fixed. We provide this object currently only as a service to advanced users.

The "local" Map is suitable for use in Kokkos parallel operations in the Map's native execution space, which is Map::device_type::execution_space.

By "local," we mean that the object performs no MPI communication, and can only access information that would never need MPI communication, no matter what kind of Map this is.

Definition at line 111 of file Tpetra_Map_decl.hpp.

Member Function Documentation

template<class LocalOrdinal , class GlobalOrdinal , class DeviceType >
KOKKOS_INLINE_FUNCTION LocalOrdinal Tpetra::Details::LocalMap< LocalOrdinal, GlobalOrdinal, DeviceType >::getNodeNumElements ( ) const
inline

The number of indices that live on the calling process.

Definition at line 134 of file Tpetra_Map_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class DeviceType >
KOKKOS_INLINE_FUNCTION GlobalOrdinal Tpetra::Details::LocalMap< LocalOrdinal, GlobalOrdinal, DeviceType >::getIndexBase ( ) const
inline

The (global) index base.

Definition at line 139 of file Tpetra_Map_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class DeviceType >
KOKKOS_INLINE_FUNCTION bool Tpetra::Details::LocalMap< LocalOrdinal, GlobalOrdinal, DeviceType >::isContiguous ( ) const
inline

Whether the Map is (locally) contiguous.

This is conservative; a Map is "contiguous" if and only if it is stored that way.

Definition at line 147 of file Tpetra_Map_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class DeviceType >
KOKKOS_INLINE_FUNCTION LocalOrdinal Tpetra::Details::LocalMap< LocalOrdinal, GlobalOrdinal, DeviceType >::getMinLocalIndex ( ) const
inline

The minimum local index.

Definition at line 152 of file Tpetra_Map_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class DeviceType >
KOKKOS_INLINE_FUNCTION LocalOrdinal Tpetra::Details::LocalMap< LocalOrdinal, GlobalOrdinal, DeviceType >::getMaxLocalIndex ( ) const
inline

The maximum local index.

Definition at line 158 of file Tpetra_Map_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class DeviceType >
KOKKOS_INLINE_FUNCTION GlobalOrdinal Tpetra::Details::LocalMap< LocalOrdinal, GlobalOrdinal, DeviceType >::getMinGlobalIndex ( ) const
inline

The minimum global index on the calling process.

Definition at line 168 of file Tpetra_Map_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class DeviceType >
KOKKOS_INLINE_FUNCTION GlobalOrdinal Tpetra::Details::LocalMap< LocalOrdinal, GlobalOrdinal, DeviceType >::getMaxGlobalIndex ( ) const
inline

The maximum global index on the calling process.

Definition at line 173 of file Tpetra_Map_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class DeviceType >
KOKKOS_INLINE_FUNCTION LocalOrdinal Tpetra::Details::LocalMap< LocalOrdinal, GlobalOrdinal, DeviceType >::getLocalElement ( const GlobalOrdinal  globalIndex) const
inline

Get the local index corresponding to the given global index.

Definition at line 179 of file Tpetra_Map_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class DeviceType >
KOKKOS_INLINE_FUNCTION GlobalOrdinal Tpetra::Details::LocalMap< LocalOrdinal, GlobalOrdinal, DeviceType >::getGlobalElement ( const LocalOrdinal  localIndex) const
inline

Get the global index corresponding to the given local index.

Definition at line 200 of file Tpetra_Map_decl.hpp.


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