Xpetra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Class that stores a strided map. More...

#include <Xpetra_StridedMap_fwd.hpp>

Inheritance diagram for Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >:
Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >

Public Types

typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
typedef Map< LocalOrdinal,
GlobalOrdinal, Node >
::global_indices_array_device_type 
global_indices_array_device_type
 
- Public Types inherited from Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
typedef Kokkos::View< const
global_ordinal_type
*, typename Node::device_type > 
global_indices_array_device_type
 
typedef Tpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node >::local_map_type 
local_map_type
 

Public Member Functions

bool isCompatible (const Map &map) const
 Returns true if map is compatible with this Map. More...
 
bool isSameAs (const Map &map) const
 Returns true if map is identical to this Map. More...
 
Teuchos::RCP< const
Teuchos::Comm< int > > 
getComm () const
 Get the Comm object for this Map. More...
 
RCP< const MapremoveEmptyProcesses () const
 Return a new Map with processes with zero elements removed. More...
 
RCP< const MapreplaceCommWithSubset (const Teuchos::RCP< const Teuchos::Comm< int >> &newComm) const
 
std::string description () const
 Return a simple one-line description of this object. More...
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
 Print the object with some verbosity level to a FancyOStream object. More...
 
UnderlyingLib lib () const
 Get the library used by this object (Tpetra or Epetra?) More...
 
- Public Member Functions inherited from Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >
virtual ~Map ()
 Destructor. More...
 
virtual RCP< const Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
replaceCommWithSubset (const Teuchos::RCP< const Teuchos::Comm< int > > &newComm) const =0
 Replace this Map's communicator with a subset communicator. More...
 

Private Member Functions

virtual bool CheckConsistency ()
 

Private Attributes

RCP< const Xpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
map_
 
std::vector< size_t > stridingInfo_
 Vector with size of strided blocks (dofs) More...
 
LocalOrdinal stridedBlockId_
 Member variable denoting which dofs are stored in map. More...
 
GlobalOrdinal offset_
 Offset for gids in map (default = 0) More...
 
GlobalOrdinal indexBase_
 Index base for the strided map (default = 0) More...
 

Constructor/Destructor Methods

 StridedMap (UnderlyingLib xlib, global_size_t numGlobalElements, GlobalOrdinal indexBase, std::vector< size_t > &stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int >> &comm, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0, LocalGlobal lg=GloballyDistributed)
 Map constructor with contiguous uniform distribution. More...
 
 StridedMap (UnderlyingLib xlib, global_size_t numGlobalElements, size_t numLocalElements, GlobalOrdinal indexBase, std::vector< size_t > &stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int >> &comm, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0)
 Map constructor with a user-defined contiguous distribution. More...
 
 StridedMap (UnderlyingLib xlib, global_size_t numGlobalElements, const Teuchos::ArrayView< const GlobalOrdinal > &elementList, GlobalOrdinal indexBase, std::vector< size_t > &stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int >> &comm, LocalOrdinal stridedBlockId=-1)
 Map constructor with user-defined non-contiguous (arbitrary) distribution. More...
 
 StridedMap (const RCP< const Map > &map, std::vector< size_t > &stridingInfo, GlobalOrdinal, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0)
 
virtual ~StridedMap ()
 Destructor. More...
 

Access functions for striding data

std::vector< size_t > getStridingData () const
 
void setStridingData (std::vector< size_t > stridingInfo)
 
size_t getFixedBlockSize () const
 
LocalOrdinal getStridedBlockId () const
 
bool isStrided () const
 returns true, if this is a strided map (i.e. more than 1 strided blocks) More...
 
bool isBlocked () const
 
GlobalOrdinal getOffset () const
 
void setOffset (GlobalOrdinal offset)
 
size_t GID2StridingBlockId (GlobalOrdinal gid) const
 

Xpetra specific

using local_map_type = typename Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::local_map_type
 
RCP< const Xpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
getMap () const
 
local_map_type getLocalMap () const
 Get the local Map for Kokkos kernels. More...
 

Map Attribute Methods

global_size_t getGlobalNumElements () const
 Returns the number of elements in this Map. More...
 
size_t getLocalNumElements () const
 Returns the number of elements belonging to the calling node. More...
 
GlobalOrdinal getIndexBase () const
 Returns the index base for this Map. More...
 
LocalOrdinal getMinLocalIndex () const
 Returns minimum local index. More...
 
LocalOrdinal getMaxLocalIndex () const
 Returns maximum local index. More...
 
GlobalOrdinal getMinGlobalIndex () const
 Returns minimum global index owned by this node. More...
 
GlobalOrdinal getMaxGlobalIndex () const
 Returns maximum global index owned by this node. More...
 
GlobalOrdinal getMinAllGlobalIndex () const
 Return the minimum global index over all nodes. More...
 
GlobalOrdinal getMaxAllGlobalIndex () const
 Return the maximum global index over all nodes. More...
 
LocalOrdinal getLocalElement (GlobalOrdinal globalIndex) const
 Return the local index for a given global index. More...
 
GlobalOrdinal getGlobalElement (LocalOrdinal localIndex) const
 Return the global index for a given local index. More...
 
LookupStatus getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList, const Teuchos::ArrayView< LocalOrdinal > &LIDList) const
 Returns the node IDs and corresponding local indices for a given list of global indices. More...
 
LookupStatus getRemoteIndexList (const Teuchos::ArrayView< const GlobalOrdinal > &GIDList, const Teuchos::ArrayView< int > &nodeIDList) const
 Returns the node IDs for a given list of global indices. More...
 
Teuchos::ArrayView< const
GlobalOrdinal > 
getLocalElementList () const
 Return a list of the global indices owned by this node. More...
 
global_indices_array_device_type getMyGlobalIndicesDevice () const
 Return a view of the global indices owned by this process on the Map's device. More...
 
bool isNodeLocalElement (LocalOrdinal localIndex) const
 Returns true if the local index is valid for this Map on this node; returns false if it isn't. More...
 
bool isNodeGlobalElement (GlobalOrdinal globalIndex) const
 Returns true if the global index is found in this Map on this node; returns false if it isn't. More...
 
bool isContiguous () const
 Returns true if this Map is distributed contiguously; returns false otherwise. More...
 
bool isDistributed () const
 Returns true if this Map is distributed across more than one node; returns false otherwise. More...
 

Detailed Description

template<class LocalOrdinal, class GlobalOrdinal, class Node>
class Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >

Class that stores a strided map.

StridedMap extends the functionality of Xpetra::Map .

It derives from Xpetra::Map and adds a std::vector, which contains the striding information. E.g. for a strided map with 3 dofs per node (2 velocity dofs, 1 pressure dof), the striding information looks like:

std::vector<size_t> stridingInformation;
stridingInformation.push_back(2); // 2 velocity dofs per node
stridingInformation.push_back(1); // 1 pressure dof per node

For this example, getFixedBlockSize() returns 3 (3 dofs per node). When providing a stridedBlockId parameter in the constructor, the strided map only contains dofs of one strided block, e.g. with above stridingInformation the call

StridedMap M(lib, 33, 0, stridiningInformation, comm, 0); // striding block 0 (velocity dofs)

returns a map with the gids 0, 1, 3, 4, 6, 7, ... (which contains only the velocity dofs)

and

StridedMap M(lib, 33, 0, stridiningInformation, comm, 1); // striding block 1 (pressure dofs)

creates a map with only the pressure dofs 2, 5, 8, ...

Note
There's no support for global offset, yet.

Definition at line 51 of file Xpetra_StridedMap_fwd.hpp.

Member Typedef Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
typedef LocalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Definition at line 103 of file Xpetra_StridedMap_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
typedef GlobalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Definition at line 104 of file Xpetra_StridedMap_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
typedef Node Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::node_type

Definition at line 105 of file Xpetra_StridedMap_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
typedef Map<LocalOrdinal, GlobalOrdinal, Node>::global_indices_array_device_type Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::global_indices_array_device_type

Definition at line 106 of file Xpetra_StridedMap_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
using Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::local_map_type = typename Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>::local_map_type

Definition at line 239 of file Xpetra_StridedMap_decl.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::StridedMap ( UnderlyingLib  xlib,
global_size_t  numGlobalElements,
GlobalOrdinal  indexBase,
std::vector< size_t > &  stridingInfo,
const Teuchos::RCP< const Teuchos::Comm< int >> &  comm,
LocalOrdinal  stridedBlockId = -1,
GlobalOrdinal  offset = 0,
LocalGlobal  lg = GloballyDistributed 
)

Map constructor with contiguous uniform distribution.

Map constructor with contiguous uniform distribution. The elements are distributed among nodes so that the subsets of global elements are non-overlapping and contiguous and as evenly distributed across the nodes as possible.

If numGlobalElements == Teuchos::OrdinalTraits<global_size_t>::invalid(), the number of global elements will be computed via a global communication. Otherwise, it must be equal to the sum of the local elements across all nodes. This will only be verified if Trilinos' Teuchos package was built with debug support (CMake Boolean option TEUCHOS_ENABLE_DEBUG=ON). If verification fails, a std::invalid_argument exception will be thrown.

Precondition
stridingInfo.size() > 0
numGlobalElements % getFixedBlockSize() == 0

Definition at line 63 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::StridedMap ( UnderlyingLib  xlib,
global_size_t  numGlobalElements,
size_t  numLocalElements,
GlobalOrdinal  indexBase,
std::vector< size_t > &  stridingInfo,
const Teuchos::RCP< const Teuchos::Comm< int >> &  comm,
LocalOrdinal  stridedBlockId = -1,
GlobalOrdinal  offset = 0 
)

Map constructor with a user-defined contiguous distribution.

Map constructor with a user-defined contiguous distribution.

Map constructor with a user-defined contiguous distribution. The elements are distributed among nodes so that the subsets of global elements are non-overlapping and contiguous and as evenly distributed across the nodes as possible.

If numGlobalElements == Teuchos::OrdinalTraits<global_size_t>::invalid(), the number of global elements will be computed via a global communication. Otherwise, it must be equal to the sum of the local elements across all nodes. This will only be verified if Trilinos' Teuchos package was built with debug support (CMake Boolean option TEUCHOS_ENABLE_DEBUG=ON). If verification fails, a std::invalid_argument exception will be thrown.

Precondition
stridingInfo.size() > 0
numGlobalElements % getFixedBlockSize() == 0
numLocalElements % getFixedBlockSize() == 0

Definition at line 159 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::StridedMap ( UnderlyingLib  xlib,
global_size_t  numGlobalElements,
const Teuchos::ArrayView< const GlobalOrdinal > &  elementList,
GlobalOrdinal  indexBase,
std::vector< size_t > &  stridingInfo,
const Teuchos::RCP< const Teuchos::Comm< int >> &  comm,
LocalOrdinal  stridedBlockId = -1 
)

Map constructor with user-defined non-contiguous (arbitrary) distribution.

createse a strided map using the GIDs in elementList and the striding information provided by user.

Precondition
stridingInfo.size() > 0
numGlobalElements % getFixedBlockSize() == 0
elementList.size() % getFixedBlockSize() == 0
Postcondition
CheckConsistency() == true

Definition at line 269 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::StridedMap ( const RCP< const Map > &  map,
std::vector< size_t > &  stridingInfo,
GlobalOrdinal  ,
LocalOrdinal  stridedBlockId = -1,
GlobalOrdinal  offset = 0 
)

Definition at line 356 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::~StridedMap ( )
virtual

Destructor.

Definition at line 378 of file Xpetra_StridedMap_def.hpp.

Member Function Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
std::vector< size_t > Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getStridingData ( ) const

Definition at line 384 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::setStridingData ( std::vector< size_t >  stridingInfo)

Definition at line 390 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getFixedBlockSize ( ) const

Definition at line 397 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
LocalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getStridedBlockId ( ) const

returns strided block id of the dofs stored in this map or -1 if full strided map is stored in this map

Definition at line 408 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::isStrided ( ) const

returns true, if this is a strided map (i.e. more than 1 strided blocks)

Definition at line 414 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::isBlocked ( ) const

returns true, if this is a blocked map (i.e. more than 1 dof per node) either strided or just 1 block per node

Definition at line 420 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
GlobalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getOffset ( ) const

Definition at line 427 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::setOffset ( GlobalOrdinal  offset)

Definition at line 433 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::GID2StridingBlockId ( GlobalOrdinal  gid) const

Definition at line 440 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getMap ( ) const
virtual

Reimplemented from Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 459 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
local_map_type Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getLocalMap ( ) const
inlinevirtual

Get the local Map for Kokkos kernels.

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

Definition at line 242 of file Xpetra_StridedMap_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::CheckConsistency ( )
privatevirtual

Definition at line 465 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
global_size_t Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getGlobalNumElements ( ) const
virtual

Returns the number of elements in this Map.

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

Definition at line 536 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getLocalNumElements ( ) const
virtual

Returns the number of elements belonging to the calling node.

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

Definition at line 543 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
GlobalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getIndexBase ( ) const
virtual

Returns the index base for this Map.

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

Definition at line 550 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
LocalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getMinLocalIndex ( ) const
virtual

Returns minimum local index.

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

Definition at line 557 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
LocalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getMaxLocalIndex ( ) const
virtual

Returns maximum local index.

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

Definition at line 564 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
GlobalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getMinGlobalIndex ( ) const
virtual

Returns minimum global index owned by this node.

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

Definition at line 571 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
GlobalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getMaxGlobalIndex ( ) const
virtual

Returns maximum global index owned by this node.

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

Definition at line 578 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
GlobalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getMinAllGlobalIndex ( ) const
virtual

Return the minimum global index over all nodes.

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

Definition at line 585 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
GlobalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getMaxAllGlobalIndex ( ) const
virtual

Return the maximum global index over all nodes.

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

Definition at line 592 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
LocalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getLocalElement ( GlobalOrdinal  globalIndex) const
virtual

Return the local index for a given global index.

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

Definition at line 599 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
GlobalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getGlobalElement ( LocalOrdinal  localIndex) const
virtual

Return the global index for a given local index.

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

Definition at line 606 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
LookupStatus Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getRemoteIndexList ( const Teuchos::ArrayView< const GlobalOrdinal > &  GIDList,
const Teuchos::ArrayView< int > &  nodeIDList,
const Teuchos::ArrayView< LocalOrdinal > &  LIDList 
) const
virtual

Returns the node IDs and corresponding local indices for a given list of global indices.

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

Definition at line 613 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
LookupStatus Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getRemoteIndexList ( const Teuchos::ArrayView< const GlobalOrdinal > &  GIDList,
const Teuchos::ArrayView< int > &  nodeIDList 
) const
virtual

Returns the node IDs for a given list of global indices.

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

Definition at line 622 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::ArrayView< const GlobalOrdinal > Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getLocalElementList ( ) const
virtual

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

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

Definition at line 630 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Map< LocalOrdinal, GlobalOrdinal, Node >::global_indices_array_device_type Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getMyGlobalIndicesDevice ( ) const
virtual

Return a view of the global indices owned by this process on the Map's device.

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

Definition at line 637 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::isNodeLocalElement ( LocalOrdinal  localIndex) const
virtual

Returns true if the local index is valid for this Map on this node; returns false if it isn't.

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

Definition at line 643 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::isNodeGlobalElement ( GlobalOrdinal  globalIndex) const
virtual

Returns true if the global index is found in this Map on this node; returns false if it isn't.

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

Definition at line 649 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::isContiguous ( ) const
virtual

Returns true if this Map is distributed contiguously; returns false otherwise.

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

Definition at line 655 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::isDistributed ( ) const
virtual

Returns true if this Map is distributed across more than one node; returns false otherwise.

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

Definition at line 661 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::isCompatible ( const Map map) const
virtual

Returns true if map is compatible with this Map.

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

Definition at line 667 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::isSameAs ( const Map map) const
virtual

Returns true if map is identical to this Map.

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

Definition at line 673 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< const Teuchos::Comm< int > > Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getComm ( ) const
virtual

Get the Comm object for this Map.

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

Definition at line 680 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::removeEmptyProcesses ( ) const
virtual

Return a new Map with processes with zero elements removed.

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

Definition at line 687 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::replaceCommWithSubset ( const Teuchos::RCP< const Teuchos::Comm< int >> &  newComm) const

Definition at line 694 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
std::string Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
virtual

Return a simple one-line description of this object.

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

Definition at line 701 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel = Teuchos::Describable::verbLevel_default 
) const
virtual

Print the object with some verbosity level to a FancyOStream object.

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

Definition at line 707 of file Xpetra_StridedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
UnderlyingLib Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::lib ( ) const
virtual

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

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

Definition at line 714 of file Xpetra_StridedMap_def.hpp.

Member Data Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
RCP<const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::map_
private

Definition at line 292 of file Xpetra_StridedMap_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
std::vector<size_t> Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::stridingInfo_
private

Vector with size of strided blocks (dofs)

Definition at line 295 of file Xpetra_StridedMap_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
LocalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::stridedBlockId_
private

Member variable denoting which dofs are stored in map.

  • stridedBlock == -1: the full map (with all strided block dofs)
  • stridedBlock > -1: only dofs of strided block with index "stridedBlockId" are stored in this map

Definition at line 302 of file Xpetra_StridedMap_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
GlobalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::offset_
private

Offset for gids in map (default = 0)

Definition at line 305 of file Xpetra_StridedMap_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
GlobalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::indexBase_
private

Index base for the strided map (default = 0)

Definition at line 308 of file Xpetra_StridedMap_decl.hpp.


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