Xpetra Version of the Day
Loading...
Searching...
No Matches
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 > Teuchos::Describable Teuchos::LabeledObject

Public Types

typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_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 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
 
virtual UnderlyingLib lib () const
 Get the library used by this object (Tpetra or Epetra?)
 
virtual RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getMap () const
 
size_t getNumMaps () const
 number of partial maps
 
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
 
const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getFullMap () const
 the full map
 
size_t getMapIndexForGID (GlobalOrdinal gid) const
 returns map index in map extractor which contains GID
 
local_map_type getLocalMap () const
 Get the local Map for Kokkos kernels.
 

Overridden from Teuchos::Describable

RCP< const Mapfullmap_
 
std::vector< RCP< const Map > > maps_
 
std::vector< RCP< Import > > importers_
 
bool bThyraMode_
 
std::vector< RCP< const Map > > thyraMaps_
 
virtual std::string description () const
 A simple one-line description of this object.
 
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.
 
virtual void assign (const BlockedMap &input)
 Implementation of the assignment operator (operator=); does a deep copy.
 
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.
 
bool CheckConsistency () const
 

Constructor/Destructor Methods

 BlockedMap ()
 Constructor.
 
 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.
 
 BlockedMap (const BlockedMap &input)
 copy constructor
 
virtual ~BlockedMap ()
 Destructor.
 

Attributes

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

Boolean tests

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

Attribute access functions

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

Maps

virtual RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > removeEmptyProcesses () const
 Return a new Map with processes with zero elements removed.
 
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.
 

Additional Inherited Members

- Public Member Functions inherited from Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node >
virtual ~Map ()
 Destructor.
 
- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
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)
 
virtual std::string description () const
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
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

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

Definition at line 64 of file Xpetra_BlockedMap_decl.hpp.

Member Typedef Documentation

◆ local_ordinal_type

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

Definition at line 68 of file Xpetra_BlockedMap_decl.hpp.

◆ global_ordinal_type

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

Definition at line 69 of file Xpetra_BlockedMap_decl.hpp.

◆ node_type

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

Definition at line 70 of file Xpetra_BlockedMap_decl.hpp.

◆ local_map_type

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

Definition at line 321 of file Xpetra_BlockedMap_decl.hpp.

Constructor & Destructor Documentation

◆ BlockedMap() [1/4]

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

Constructor.

Definition at line 63 of file Xpetra_BlockedMap_def.hpp.

◆ BlockedMap() [2/4]

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 71 of file Xpetra_BlockedMap_def.hpp.

◆ BlockedMap() [3/4]

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 185 of file Xpetra_BlockedMap_def.hpp.

◆ BlockedMap() [4/4]

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

copy constructor

Definition at line 234 of file Xpetra_BlockedMap_def.hpp.

◆ ~BlockedMap()

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

Destructor.

Definition at line 246 of file Xpetra_BlockedMap_def.hpp.

Member Function Documentation

◆ getGlobalNumElements()

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

The number of elements in this Map.

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

Definition at line 264 of file Xpetra_BlockedMap_def.hpp.

◆ getLocalNumElements()

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

The number of elements belonging to the calling process.

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

Definition at line 273 of file Xpetra_BlockedMap_def.hpp.

◆ getIndexBase()

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

The index base for this Map.

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

Definition at line 281 of file Xpetra_BlockedMap_def.hpp.

◆ getMinLocalIndex()

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

The minimum local index.

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

Definition at line 290 of file Xpetra_BlockedMap_def.hpp.

◆ getMaxLocalIndex()

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

The maximum local index on the calling process.

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

Definition at line 299 of file Xpetra_BlockedMap_def.hpp.

◆ getMinGlobalIndex()

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

The minimum global index owned by the calling process.

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

Definition at line 308 of file Xpetra_BlockedMap_def.hpp.

◆ getMaxGlobalIndex()

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

The maximum global index owned by the calling process.

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

Definition at line 317 of file Xpetra_BlockedMap_def.hpp.

◆ getMinAllGlobalIndex()

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

The minimum global index over all processes in the communicator.

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

Definition at line 326 of file Xpetra_BlockedMap_def.hpp.

◆ getMaxAllGlobalIndex()

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

The maximum global index over all processes in the communicator.

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

Definition at line 335 of file Xpetra_BlockedMap_def.hpp.

◆ getLocalElement()

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 344 of file Xpetra_BlockedMap_def.hpp.

◆ getGlobalElement()

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 353 of file Xpetra_BlockedMap_def.hpp.

◆ getRemoteIndexList() [1/2]

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 362 of file Xpetra_BlockedMap_def.hpp.

◆ getRemoteIndexList() [2/2]

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 374 of file Xpetra_BlockedMap_def.hpp.

◆ getLocalElementList()

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

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

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

Definition at line 385 of file Xpetra_BlockedMap_def.hpp.

◆ isNodeLocalElement()

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 394 of file Xpetra_BlockedMap_def.hpp.

◆ isNodeGlobalElement()

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 403 of file Xpetra_BlockedMap_def.hpp.

◆ isContiguous()

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

True if this Map is distributed contiguously, else false.

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

Definition at line 412 of file Xpetra_BlockedMap_def.hpp.

◆ isDistributed()

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

Whether this Map is globally distributed or locally replicated.

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

Definition at line 422 of file Xpetra_BlockedMap_def.hpp.

◆ isCompatible()

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 431 of file Xpetra_BlockedMap_def.hpp.

◆ isSameAs()

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 455 of file Xpetra_BlockedMap_def.hpp.

◆ getComm()

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

Get this Map's Comm object.

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

Definition at line 495 of file Xpetra_BlockedMap_def.hpp.

◆ operator=()

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 506 of file Xpetra_BlockedMap_def.hpp.

◆ getThyraMode()

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

◆ removeEmptyProcesses()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::removeEmptyProcesses
virtual

Return a new Map with processes with zero elements removed.

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

Definition at line 523 of file Xpetra_BlockedMap_def.hpp.

◆ replaceCommWithSubset()

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.

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

Definition at line 532 of file Xpetra_BlockedMap_def.hpp.

◆ lib()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
UnderlyingLib Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >::lib
virtual

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

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

Definition at line 541 of file Xpetra_BlockedMap_def.hpp.

◆ getMap() [1/2]

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

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

Definition at line 549 of file Xpetra_BlockedMap_def.hpp.

◆ getNumMaps()

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

number of partial maps

Definition at line 558 of file Xpetra_BlockedMap_def.hpp.

◆ getMap() [2/2]

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 567 of file Xpetra_BlockedMap_def.hpp.

◆ getImporter()

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 591 of file Xpetra_BlockedMap_def.hpp.

◆ getFullMap()

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

the full map

Definition at line 605 of file Xpetra_BlockedMap_def.hpp.

◆ getMapIndexForGID()

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 614 of file Xpetra_BlockedMap_def.hpp.

◆ getLocalMap()

template<class LocalOrdinal , class GlobalOrdinal , class Node = 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 324 of file Xpetra_BlockedMap_decl.hpp.

◆ description()

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

A simple one-line description of this object.

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

Definition at line 629 of file Xpetra_BlockedMap_def.hpp.

◆ describe()

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 638 of file Xpetra_BlockedMap_def.hpp.

◆ assign()

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 665 of file Xpetra_BlockedMap_def.hpp.

◆ concatenateMaps()

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 706 of file Xpetra_BlockedMap_def.hpp.

◆ CheckConsistency()

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

Definition at line 743 of file Xpetra_BlockedMap_def.hpp.

Member Data Documentation

◆ fullmap_

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

Definition at line 385 of file Xpetra_BlockedMap_decl.hpp.

◆ maps_

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

Definition at line 386 of file Xpetra_BlockedMap_decl.hpp.

◆ importers_

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

Definition at line 387 of file Xpetra_BlockedMap_decl.hpp.

◆ bThyraMode_

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

Definition at line 388 of file Xpetra_BlockedMap_decl.hpp.

◆ thyraMaps_

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

Definition at line 389 of file Xpetra_BlockedMap_decl.hpp.


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