#include <Xpetra_BlockedMap_decl.hpp>

Inheritance diagram for Xpetra::BlockedMap< 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

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 Map >	fullmap_

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.

virtual global_indices_array_device_type	getMyGlobalIndicesDevice () 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.

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
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 ()

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 = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node >

Definition at line 23 of file Xpetra_BlockedMap_decl.hpp.

Member Typedef Documentation

◆ local_ordinal_type

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.

◆ global_ordinal_type

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.

◆ node_type

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.

◆ global_indices_array_device_type

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.

◆ local_map_type

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

◆ BlockedMap() [1/4]

template<class LocalOrdinal , class GlobalOrdinal , class Node >

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

Constructor.

Definition at line 22 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]	fullmap	Full map containing all GIDs throughout the full vector. This parameter is only important if bThyraMode == false (see below)
[in]	maps	Vector 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]	bThyraMode	Flag 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 28 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 129 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 172 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 182 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 ( ) const

virtual

The number of elements in this Map.

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

Definition at line 197 of file Xpetra_BlockedMap_def.hpp.

◆ getLocalNumElements()

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.

◆ getIndexBase()

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

◆ getMinLocalIndex()

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

◆ getMaxLocalIndex()

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

◆ getMinGlobalIndex()

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

◆ getMaxGlobalIndex()

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

◆ getMinAllGlobalIndex()

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

◆ getMaxAllGlobalIndex()

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 252 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 259 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 266 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 273 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 283 of file Xpetra_BlockedMap_def.hpp.

◆ getLocalElementList()

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

◆ getMyGlobalIndicesDevice()

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 299 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 305 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 311 of file Xpetra_BlockedMap_def.hpp.

◆ isContiguous()

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

◆ isDistributed()

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 324 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 330 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 349 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 ( ) const

virtual

Get this Map's Comm object.

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

Definition at line 381 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 388 of file Xpetra_BlockedMap_def.hpp.

◆ getThyraMode()

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.

◆ removeEmptyProcesses()

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

◆ lib()

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.

◆ getMap() [1/2]

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

◆ getNumMaps()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

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

number of partial maps

Definition at line 428 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 435 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 456 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 ( ) const

the full map

Definition at line 468 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 475 of file Xpetra_BlockedMap_def.hpp.

◆ getLocalMap()

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.

◆ description()

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 488 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 494 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 515 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

subMaps vector 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 552 of file Xpetra_BlockedMap_def.hpp.

◆ CheckConsistency()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

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

private

Definition at line 583 of file Xpetra_BlockedMap_def.hpp.

Member Data Documentation

◆ fullmap_

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.

◆ maps_

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.

◆ importers_

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.

◆ bThyraMode_

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.

◆ thyraMaps_

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:

Public Types

Xpetra specific

Overridden from Teuchos::Describable

Constructor/Destructor Methods

Attributes

Boolean tests

Attribute access functions

Maps

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ local_ordinal_type

◆ global_ordinal_type

◆ node_type

◆ global_indices_array_device_type

◆ local_map_type

Constructor & Destructor Documentation

◆ BlockedMap() [1/4]

◆ BlockedMap() [2/4]

◆ BlockedMap() [3/4]

◆ BlockedMap() [4/4]

◆ ~BlockedMap()

Member Function Documentation

◆ getGlobalNumElements()

◆ getLocalNumElements()

◆ getIndexBase()

◆ getMinLocalIndex()

◆ getMaxLocalIndex()

◆ getMinGlobalIndex()

◆ getMaxGlobalIndex()

◆ getMinAllGlobalIndex()

◆ getMaxAllGlobalIndex()

◆ getLocalElement()

◆ getGlobalElement()

◆ getRemoteIndexList() [1/2]

◆ getRemoteIndexList() [2/2]

◆ getLocalElementList()

◆ getMyGlobalIndicesDevice()

◆ isNodeLocalElement()

◆ isNodeGlobalElement()

◆ isContiguous()

◆ isDistributed()

◆ isCompatible()

◆ isSameAs()

◆ getComm()

◆ operator=()

◆ getThyraMode()

◆ removeEmptyProcesses()

◆ replaceCommWithSubset()

◆ lib()

◆ getMap() [1/2]

◆ getNumMaps()

◆ getMap() [2/2]

◆ getImporter()

◆ getFullMap()

◆ getMapIndexForGID()

◆ getLocalMap()

◆ description()

◆ describe()

◆ assign()

◆ concatenateMaps()

◆ CheckConsistency()

Member Data Documentation

◆ fullmap_

◆ maps_

◆ importers_

◆ bThyraMode_

◆ thyraMaps_