Xpetra Version of the Day
|
Class that stores a strided map. More...
#include <Xpetra_StridedMap_decl.hpp>
Public Types | |
typedef LocalOrdinal | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
![]() | |
typedef LocalOrdinal | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
typedef Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::local_map_type | local_map_type |
Xpetra specific | |
using | local_map_type = typename Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>::local_map_type |
RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > | map_ |
std::vector< size_t > | stridingInfo_ |
Vector with size of strided blocks (dofs) | |
LocalOrdinal | stridedBlockId_ |
Member variable denoting which dofs are stored in map. | |
GlobalOrdinal | offset_ |
Offset for gids in map (default = 0) | |
GlobalOrdinal | indexBase_ |
Index base for the strided map (default = 0) | |
RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > | getMap () const |
local_map_type | getLocalMap () const |
Get the local Map for Kokkos kernels. | |
virtual bool | CheckConsistency () |
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. | |
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. | |
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. | |
StridedMap (const RCP< const Map > &map, std::vector< size_t > &stridingInfo, GlobalOrdinal, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0) | |
virtual | ~StridedMap () |
Destructor. | |
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) | |
bool | isBlocked () const |
GlobalOrdinal | getOffset () const |
void | setOffset (GlobalOrdinal offset) |
size_t | GID2StridingBlockId (GlobalOrdinal gid) const |
Map Attribute Methods | |
global_size_t | getGlobalNumElements () const |
Returns the number of elements in this Map. | |
size_t | getLocalNumElements () const |
Returns the number of elements belonging to the calling node. | |
GlobalOrdinal | getIndexBase () const |
Returns the index base for this Map. | |
LocalOrdinal | getMinLocalIndex () const |
Returns minimum local index. | |
LocalOrdinal | getMaxLocalIndex () const |
Returns maximum local index. | |
GlobalOrdinal | getMinGlobalIndex () const |
Returns minimum global index owned by this node. | |
GlobalOrdinal | getMaxGlobalIndex () const |
Returns maximum global index owned by this node. | |
GlobalOrdinal | getMinAllGlobalIndex () const |
Return the minimum global index over all nodes. | |
GlobalOrdinal | getMaxAllGlobalIndex () const |
Return the maximum global index over all nodes. | |
LocalOrdinal | getLocalElement (GlobalOrdinal globalIndex) const |
Return the local index for a given global index. | |
GlobalOrdinal | getGlobalElement (LocalOrdinal localIndex) const |
Return the global index for a given local index. | |
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. | |
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. | |
Teuchos::ArrayView< const GlobalOrdinal > | getLocalElementList () const |
Return a list of the global indices owned by this node. | |
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. | |
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. | |
bool | isContiguous () const |
Returns true if this Map is distributed contiguously; returns false otherwise. | |
bool | isDistributed () const |
Returns true if this Map is distributed across more than one node; returns false otherwise. | |
bool | isCompatible (const Map &map) const |
Returns true if map is compatible with this Map. | |
bool | isSameAs (const Map &map) const |
Returns true if map is identical to this Map. | |
Teuchos::RCP< const Teuchos::Comm< int > > | getComm () const |
Get the Comm object for this Map. | |
RCP< const Map > | removeEmptyProcesses () const |
Return a new Map with processes with zero elements removed. | |
RCP< const Map > | replaceCommWithSubset (const Teuchos::RCP< const Teuchos::Comm< int > > &newComm) const |
Replace this Map's communicator with a subset communicator. | |
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 the object with some verbosity level to a FancyOStream object. | |
UnderlyingLib | lib () const |
Get the library used by this object (Tpetra or Epetra?) | |
Additional Inherited Members | |
![]() | |
virtual | ~Map () |
Destructor. | |
![]() | |
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 () |
![]() | |
LabeledObject () | |
virtual | ~LabeledObject () |
virtual void | setObjectLabel (const std::string &objectLabel) |
virtual std::string | getObjectLabel () const |
![]() | |
static const EVerbosityLevel | verbLevel_default |
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:
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
returns a map with the gids 0, 1, 3, 4, 6, 7, ... (which contains only the velocity dofs)
and
creates a map with only the pressure dofs 2, 5, 8, ...
Definition at line 101 of file Xpetra_StridedMap_decl.hpp.
typedef LocalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type |
Definition at line 108 of file Xpetra_StridedMap_decl.hpp.
typedef GlobalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type |
Definition at line 109 of file Xpetra_StridedMap_decl.hpp.
typedef Node Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::node_type |
Definition at line 110 of file Xpetra_StridedMap_decl.hpp.
using Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::local_map_type = typename Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>::local_map_type |
Definition at line 268 of file Xpetra_StridedMap_decl.hpp.
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.
Definition at line 66 of file Xpetra_StridedMap_def.hpp.
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.
Definition at line 179 of file Xpetra_StridedMap_def.hpp.
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.
Definition at line 308 of file Xpetra_StridedMap_def.hpp.
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 401 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Destructor.
Definition at line 428 of file Xpetra_StridedMap_def.hpp.
std::vector< size_t > Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getStridingData | ( | ) | const |
Definition at line 436 of file Xpetra_StridedMap_def.hpp.
void Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::setStridingData | ( | std::vector< size_t > | stridingInfo | ) |
Definition at line 445 of file Xpetra_StridedMap_def.hpp.
size_t Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getFixedBlockSize | ( | ) | const |
Definition at line 454 of file Xpetra_StridedMap_def.hpp.
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 468 of file Xpetra_StridedMap_def.hpp.
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 477 of file Xpetra_StridedMap_def.hpp.
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 486 of file Xpetra_StridedMap_def.hpp.
GlobalOrdinal Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::getOffset | ( | ) | const |
Definition at line 495 of file Xpetra_StridedMap_def.hpp.
void Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::setOffset | ( | GlobalOrdinal | offset | ) |
Definition at line 504 of file Xpetra_StridedMap_def.hpp.
size_t Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node >::GID2StridingBlockId | ( | GlobalOrdinal | gid | ) | const |
Definition at line 513 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Reimplemented from Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 536 of file Xpetra_StridedMap_def.hpp.
|
inlinevirtual |
Get the local Map for Kokkos kernels.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 271 of file Xpetra_StridedMap_decl.hpp.
|
privatevirtual |
Definition at line 545 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Returns the number of elements in this Map.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 629 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Returns the number of elements belonging to the calling node.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 638 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Returns the index base for this Map.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 647 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Returns minimum local index.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 656 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Returns maximum local index.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 665 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Returns minimum global index owned by this node.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 674 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Returns maximum global index owned by this node.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 683 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Return the minimum global index over all nodes.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 692 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Return the maximum global index over all nodes.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 701 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Return the local index for a given global index.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 710 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Return the global index for a given local index.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 719 of file Xpetra_StridedMap_def.hpp.
|
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 728 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Returns the node IDs for a given list of global indices.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 739 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Return a list of the global indices owned by this node.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 749 of file Xpetra_StridedMap_def.hpp.
|
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 758 of file Xpetra_StridedMap_def.hpp.
|
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 767 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Returns true if this Map is distributed contiguously; returns false otherwise.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 776 of file Xpetra_StridedMap_def.hpp.
|
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 785 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Returns true if map is compatible with this Map.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 794 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Returns true if map is identical to this Map.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 803 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Get the Comm object for this Map.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 812 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Return a new Map with processes with zero elements removed.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 823 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Replace this Map's communicator with a subset communicator.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 832 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Return a simple one-line description of this object.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 841 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Print the object with some verbosity level to a FancyOStream object.
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 850 of file Xpetra_StridedMap_def.hpp.
|
virtual |
Get the library used by this object (Tpetra or Epetra?)
Implements Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 859 of file Xpetra_StridedMap_def.hpp.
|
private |
Definition at line 328 of file Xpetra_StridedMap_decl.hpp.
|
private |
Vector with size of strided blocks (dofs)
Definition at line 331 of file Xpetra_StridedMap_decl.hpp.
|
private |
Member variable denoting which dofs are stored in map.
Definition at line 338 of file Xpetra_StridedMap_decl.hpp.
|
private |
Offset for gids in map (default = 0)
Definition at line 341 of file Xpetra_StridedMap_decl.hpp.
|
private |
Index base for the strided map (default = 0)
Definition at line 344 of file Xpetra_StridedMap_decl.hpp.