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

#include <Xpetra_BlockedMap_decl.hpp>

Inheritance diagram for Xpetra::BlockedMap< 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
 
using local_map_type = typename Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >::local_map_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

BlockedMap< LocalOrdinal,
GlobalOrdinal, Node > & 
operator= (const BlockedMap &rhs)
 Assignment operator: Does a deep copy. More...
 
size_t getNumMaps () const
 number of partial maps More...
 
const RCP< const Xpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
getMap (size_t i, bool bThyraMode=false) const
 
const RCP< Xpetra::Import
< LocalOrdinal, GlobalOrdinal,
Node > > 
getImporter (size_t i) const
 get the importer between full map and partial map More...
 
const RCP< const Xpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
getFullMap () const
 the full map More...
 
size_t getMapIndexForGID (GlobalOrdinal gid) const
 returns map index in map extractor which contains GID More...
 
local_map_type getLocalMap () const
 Get the local Map for Kokkos kernels. 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...
 

Protected Member Functions

virtual void assign (const BlockedMap &input)
 Implementation of the assignment operator (operator=); does a deep copy. More...
 

Static Protected Member Functions

static Teuchos::RCP< const
Xpetra::Map< LocalOrdinal,
GlobalOrdinal, Node > > 
concatenateMaps (const std::vector< Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >>> &subMaps)
 Helper function to concatenate several maps. More...
 

Private Member Functions

bool CheckConsistency () const
 

Private Attributes

RCP< const Mapfullmap_
 
std::vector< RCP< const Map > > maps_
 
std::vector< RCP< Import > > importers_
 
bool bThyraMode_
 
std::vector< RCP< const Map > > thyraMaps_
 

Constructor/Destructor Methods

 BlockedMap ()
 Constructor. More...
 
 BlockedMap (const RCP< const Map > &fullmap, const std::vector< RCP< const Map >> &maps, bool bThyraMode=false)
 
 BlockedMap (const std::vector< RCP< const Map >> &maps, const std::vector< RCP< const Map >> &thyramaps)
 Expert constructor for Thyra maps. More...
 
 BlockedMap (const BlockedMap &input)
 copy constructor More...
 
virtual ~BlockedMap ()
 Destructor. More...
 

Attributes

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

Boolean tests

virtual bool isNodeLocalElement (LocalOrdinal localIndex) const
 Whether the given local index is valid for this Map on this process. More...
 
virtual bool isNodeGlobalElement (GlobalOrdinal globalIndex) const
 Whether the given global index is valid for this Map on this process. More...
 
virtual bool isContiguous () const
 True if this Map is distributed contiguously, else false. More...
 
virtual bool isDistributed () const
 Whether this Map is globally distributed or locally replicated. More...
 
virtual bool isCompatible (const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &map) const
 True if and only if map is compatible with this Map. More...
 
virtual bool isSameAs (const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &map) const
 True if and only if map is identical to this Map. More...
 
virtual Teuchos::RCP< const
Teuchos::Comm< int > > 
getComm () const
 Get this Map's Comm object. More...
 

Attribute access functions

virtual bool getThyraMode () const
 Local number of rows on the calling process. More...
 

Maps

virtual RCP< const Xpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
removeEmptyProcesses () const
 Return a new Map with processes with zero elements removed. More...
 
virtual RCP< const Xpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
replaceCommWithSubset (const Teuchos::RCP< const Teuchos::Comm< int >> &) const
 Replace this Map's communicator with a subset communicator. More...
 

Xpetra specific

virtual UnderlyingLib lib () const
 Get the library used by this object (Tpetra or Epetra?) More...
 
virtual RCP< const Xpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node > > 
getMap () const
 

Overridden from Teuchos::Describable

virtual std::string description () const
 A simple one-line description of this object. More...
 
virtual void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
 Print the object with the given verbosity level to a FancyOStream. More...
 

Detailed Description

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >

Definition at line 23 of file Xpetra_BlockedMap_decl.hpp.

Member Typedef Documentation

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
typedef LocalOrdinal Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Definition at line 25 of file Xpetra_BlockedMap_decl.hpp.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
typedef GlobalOrdinal Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Definition at line 26 of file Xpetra_BlockedMap_decl.hpp.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
typedef Node Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::node_type

Definition at line 27 of file Xpetra_BlockedMap_decl.hpp.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
typedef Map<LocalOrdinal, GlobalOrdinal, Node>::global_indices_array_device_type Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::global_indices_array_device_type

Definition at line 28 of file Xpetra_BlockedMap_decl.hpp.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
using Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::local_map_type = typename Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node>::local_map_type

Definition at line 235 of file Xpetra_BlockedMap_decl.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::BlockedMap ( )

Constructor.

Definition at line 23 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::BlockedMap ( const RCP< const Map > &  fullmap,
const std::vector< RCP< const Map >> &  maps,
bool  bThyraMode = false 
)

BlockedMap basic constructor

Parameters
[in]fullmapFull map containing all GIDs throughout the full vector. This parameter is only important if bThyraMode == false (see below)
[in]mapsVector containing submaps. The set of all GIDs stored in the submaps should be the same than stored in fullmap, if bThyraMode == false. In Thyra mode, the submaps should contain consecutive GIDs starting with 0 in each submap.
[in]bThyraModeFlag which allows to switch between generating a MapExtractor in Thyra mode or Xpetra mode

In Thyra mode, fullmap is not important as a fullmap with unique blocked GIDs is automatically generated which map the GIDs of the submaps to uniquely defined GIDs in the fullmap. The user has to provide a fullmap in Thyra mode to specify the underlying linear algebra library (Epetra or Tpetra) and some other map information (e.g. indexBase). This could be fixed.

In Xpetra mode, the fullmap has to be the same as the union of the GIDs stored in the submaps in maps. The intersection of the GIDs of the sub- maps in maps must be empty.

Definition at line 29 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::BlockedMap ( const std::vector< RCP< const Map >> &  maps,
const std::vector< RCP< const Map >> &  thyramaps 
)

Expert constructor for Thyra maps.

Definition at line 130 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::BlockedMap ( const BlockedMap< LocalOrdinal, GlobalOrdinal, Node > &  input)

copy constructor

Definition at line 173 of file Xpetra_BlockedMap_def.hpp.

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

Destructor.

Definition at line 183 of file Xpetra_BlockedMap_def.hpp.

Member Function Documentation

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

The number of elements in this Map.

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

Definition at line 198 of file Xpetra_BlockedMap_def.hpp.

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

The number of elements belonging to the calling process.

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

Definition at line 204 of file Xpetra_BlockedMap_def.hpp.

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

The index base for this Map.

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

Definition at line 211 of file Xpetra_BlockedMap_def.hpp.

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

The minimum local index.

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

Definition at line 218 of file Xpetra_BlockedMap_def.hpp.

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

The maximum local index on the calling process.

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

Definition at line 225 of file Xpetra_BlockedMap_def.hpp.

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

The minimum global index owned by the calling process.

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

Definition at line 232 of file Xpetra_BlockedMap_def.hpp.

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

The maximum global index owned by the calling process.

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

Definition at line 239 of file Xpetra_BlockedMap_def.hpp.

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

The minimum global index over all processes in the communicator.

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

Definition at line 246 of file Xpetra_BlockedMap_def.hpp.

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

The maximum global index over all processes in the communicator.

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

Definition at line 253 of file Xpetra_BlockedMap_def.hpp.

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

The local index corresponding to the given global index.

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

Definition at line 260 of file Xpetra_BlockedMap_def.hpp.

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

The global index corresponding to the given local index.

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

Definition at line 267 of file Xpetra_BlockedMap_def.hpp.

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

Return the process ranks and corresponding local indices for the given global indices.

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

Definition at line 274 of file Xpetra_BlockedMap_def.hpp.

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

Return the process ranks for the given global indices.

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

Definition at line 284 of file Xpetra_BlockedMap_def.hpp.

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

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

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

Definition at line 293 of file Xpetra_BlockedMap_def.hpp.

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

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

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

Definition at line 300 of file Xpetra_BlockedMap_def.hpp.

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

Whether the given local index is valid for this Map on this process.

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

Definition at line 306 of file Xpetra_BlockedMap_def.hpp.

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

Whether the given global index is valid for this Map on this process.

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

Definition at line 312 of file Xpetra_BlockedMap_def.hpp.

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

True if this Map is distributed contiguously, else false.

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

Definition at line 318 of file Xpetra_BlockedMap_def.hpp.

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

Whether this Map is globally distributed or locally replicated.

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

Definition at line 325 of file Xpetra_BlockedMap_def.hpp.

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

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

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

Definition at line 331 of file Xpetra_BlockedMap_def.hpp.

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

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

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

Definition at line 350 of file Xpetra_BlockedMap_def.hpp.

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

Get this Map's Comm object.

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

Definition at line 382 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
BlockedMap< LocalOrdinal, GlobalOrdinal, Node > & Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::operator= ( const BlockedMap< LocalOrdinal, GlobalOrdinal, Node > &  rhs)

Assignment operator: Does a deep copy.

The assignment operator does a deep copy, just like subclasses' copy constructors.

Note
This currently only works if both *this and the input argument are instances of the same subclass.

Definition at line 389 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::getThyraMode ( ) const
virtual

Local number of rows on the calling process.

Global number of rows in the multivector. returns true if internally stored sub maps are in Thyra mode (i.e. start all with GIDs=0)

Definition at line 395 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMap< 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 402 of file Xpetra_BlockedMap_def.hpp.

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

Replace this Map's communicator with a subset communicator.

Definition at line 409 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
UnderlyingLib Xpetra::BlockedMap< 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 415 of file Xpetra_BlockedMap_def.hpp.

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

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

Definition at line 422 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::getNumMaps ( ) const

number of partial maps

Definition at line 429 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::getMap ( size_t  i,
bool  bThyraMode = false 
) const

get the map returns the sub map i from list of sub maps depending on the parameter bThyraMode the sub map that is returned uses Thyra or Xpetra numbering Note: Thyra-numbering is only allowed if the BlockedMap is also constructed using Thyra numbering

Definition at line 436 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
const RCP< Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::getImporter ( size_t  i) const

get the importer between full map and partial map

Definition at line 457 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::getFullMap ( ) const

the full map

Definition at line 469 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::getMapIndexForGID ( GlobalOrdinal  gid) const

returns map index in map extractor which contains GID

Definition at line 476 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
local_map_type Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::getLocalMap ( ) const
inlinevirtual

Get the local Map for Kokkos kernels.

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

Definition at line 238 of file Xpetra_BlockedMap_decl.hpp.

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

A simple one-line description of this object.

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

Definition at line 489 of file Xpetra_BlockedMap_def.hpp.

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

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

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

Definition at line 495 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::assign ( const BlockedMap< LocalOrdinal, GlobalOrdinal, Node > &  input)
protectedvirtual

Implementation of the assignment operator (operator=); does a deep copy.

Definition at line 516 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::concatenateMaps ( const std::vector< Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >>> &  subMaps)
staticprotected

Helper function to concatenate several maps.

Parameters
subMapsvector of maps which are concatenated
Returns
concatenated map

The routine builds a global map by concatenating all provided maps in the ordering defined by the vector. The GIDs are just appended in the same ordering as in the subMaps. No reordering or sorting is performed. This routine is supposed to generate the full map in an Xpetra::MapExtractor for a block operator. Note, it should not be used for strided maps since the GIDs are not reordered.

Example: subMap[0] = { 0, 1, 3, 4 }; subMap[1] = { 2, 5 }; concatenated map = { 0, 1, 3, 4, 2 ,5 };

Definition at line 553 of file Xpetra_BlockedMap_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::CheckConsistency ( ) const
private

Definition at line 584 of file Xpetra_BlockedMap_def.hpp.

Member Data Documentation

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
RCP<const Map> Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::fullmap_
private

Definition at line 285 of file Xpetra_BlockedMap_decl.hpp.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
std::vector<RCP<const Map> > Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::maps_
private

Definition at line 286 of file Xpetra_BlockedMap_decl.hpp.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
std::vector<RCP<Import> > Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::importers_
private

Definition at line 287 of file Xpetra_BlockedMap_decl.hpp.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
bool Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::bThyraMode_
private

Definition at line 288 of file Xpetra_BlockedMap_decl.hpp.

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
std::vector<RCP<const Map> > Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::thyraMaps_
private

Definition at line 289 of file Xpetra_BlockedMap_decl.hpp.


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