#include <Xpetra_MapExtractor.hpp>

Inheritance diagram for Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >:

Public Types
typedef Scalar	scalar_type

typedef LocalOrdinal	local_ordinal_type

typedef GlobalOrdinal	global_ordinal_type

typedef Node	node_type

Public Member Functions
	MapExtractor (const RCP< const Map > &fullmap, const std::vector< RCP< const Map > > &maps, bool bThyraMode=false)

	MapExtractor (const std::vector< RCP< const Map > > &maps, const std::vector< RCP< const Map > > &thyramaps)
	Expert constructor for Thyra maps. More...

	MapExtractor (const Teuchos::RCP< const BlockedMap > &map)

	MapExtractor (const MapExtractor &input)
	copy constructor More...

virtual	~MapExtractor ()
	Destructor. More...

RCP< Vector >	getVector (size_t i, bool bThyraMode=false, bool bZero=true) const

RCP< MultiVector >	getVector (size_t i, size_t numvec, bool bThyraMode=false, bool bZero=true) const

bool	getThyraMode () const
	returns true, if sub maps are stored in Thyra-style numbering More...

Private Attributes
Teuchos::RCP< const BlockedMap >	map_
	blocked map containing the sub block maps (either thyra or xpetra mode) More...

Extract subblocks from full map
void	ExtractVector (const Vector &full, size_t block, Vector &partial) const

void	ExtractVector (const MultiVector &full, size_t block, MultiVector &partial) const

void	ExtractVector (RCP< const Vector > &full, size_t block, RCP< Vector > &partial) const

void	ExtractVector (RCP< Vector > &full, size_t block, RCP< Vector > &partial) const

void	ExtractVector (RCP< const MultiVector > &full, size_t block, RCP< MultiVector > &partial) const

void	ExtractVector (RCP< MultiVector > &full, size_t block, RCP< MultiVector > &partial) const

RCP< Vector >	ExtractVector (RCP< const Vector > &full, size_t block, bool bThyraMode=false) const

RCP< Vector >	ExtractVector (RCP< Vector > &full, size_t block, bool bThyraMode=false) const

RCP< MultiVector >	ExtractVector (RCP< const MultiVector > &full, size_t block, bool bThyraMode=false) const

RCP< MultiVector >	ExtractVector (RCP< MultiVector > &full, size_t block, bool bThyraMode=false) const

RCP< MultiVector >	ExtractVector (RCP< const BlockedMultiVector > &full, size_t block, bool bThyraMode=false) const

RCP< MultiVector >	ExtractVector (RCP< Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &full, size_t block, bool bThyraMode=false) const

Insert subblocks into full map
void	InsertVector (const Vector &partial, size_t block, Vector &full, bool bThyraMode=false) const

void	InsertVector (const MultiVector &partial, size_t block, MultiVector &full, bool bThyraMode=false) const

void	InsertVector (RCP< const Vector > partial, size_t block, RCP< Vector > full, bool bThyraMode=false) const

void	InsertVector (RCP< Vector > partial, size_t block, RCP< Vector > full, bool bThyraMode=false) const

void	InsertVector (RCP< const MultiVector > partial, size_t block, RCP< MultiVector > full, bool bThyraMode=false) const

void	InsertVector (RCP< MultiVector > partial, size_t block, RCP< MultiVector > full, bool bThyraMode=false) const

void	InsertVector (RCP< const MultiVector > partial, size_t block, RCP< Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > full, bool bThyraMode=false) const

void	InsertVector (RCP< MultiVector > partial, size_t block, RCP< Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > full, bool bThyraMode=false) const

Maps
size_t	NumMaps () const
	number of partial maps More...

const RCP< const Map >	getMap (size_t i, bool bThyraMode=false) const

const RCP< const Map >	getMap () const
	get the underlying BlockedMap object (as Map) More...

const RCP< const BlockedMap >	getBlockedMap () const
	get the underlying BlockedMap object (as BlockedMap) More...

const RCP< const Map >	getFullMap () const
	the full map More...

size_t	getMapIndexForGID (GlobalOrdinal gid) const
	returns map index in map extractor which contains GID More...

Detailed Description

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
class Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 78 of file Xpetra_MapExtractor.hpp.

Member Typedef Documentation

◆ scalar_type

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

typedef Scalar Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scalar_type

Definition at line 80 of file Xpetra_MapExtractor.hpp.

◆ local_ordinal_type

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

typedef LocalOrdinal Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Definition at line 81 of file Xpetra_MapExtractor.hpp.

◆ global_ordinal_type

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

typedef GlobalOrdinal Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Definition at line 82 of file Xpetra_MapExtractor.hpp.

◆ node_type

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

typedef Node Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type

Definition at line 83 of file Xpetra_MapExtractor.hpp.

Constructor & Destructor Documentation

◆ MapExtractor() [1/4]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MapExtractor	(	const RCP< const Map > &	fullmap,
		const std::vector< RCP< const Map > > &	maps,
		bool	bThyraMode = `false`
	)

inline

MapExtractor 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 103 of file Xpetra_MapExtractor.hpp.

◆ MapExtractor() [2/4]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MapExtractor	(	const std::vector< RCP< const Map > > &	maps,
		const std::vector< RCP< const Map > > &	thyramaps
	)

inline

Expert constructor for Thyra maps.

Definition at line 108 of file Xpetra_MapExtractor.hpp.

◆ MapExtractor() [3/4]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MapExtractor ( const Teuchos::RCP< const BlockedMap > & map )

inline

Constructor which accepts a const version of a blocked map

Parameters

map	BlockedMap defining the block structure of the multi vector

Definition at line 119 of file Xpetra_MapExtractor.hpp.

◆ MapExtractor() [4/4]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MapExtractor ( const MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node > & input )

inline

copy constructor

Definition at line 123 of file Xpetra_MapExtractor.hpp.

◆ ~MapExtractor()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

virtual Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~MapExtractor ( )

inlinevirtual

Destructor.

Definition at line 128 of file Xpetra_MapExtractor.hpp.

Member Function Documentation

◆ ExtractVector() [1/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector	(	const Vector &	full,
		size_t	block,
		Vector &	partial
	)		const

inline

Definition at line 134 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [2/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector	(	const MultiVector &	full,
		size_t	block,
		MultiVector &	partial
	)		const

inline

Definition at line 141 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [3/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector	(	RCP< const Vector > &	full,
		size_t	block,
		RCP< Vector > &	partial
	)		const

inline

Definition at line 148 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [4/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector	(	RCP< Vector > &	full,
		size_t	block,
		RCP< Vector > &	partial
	)		const

inline

Definition at line 149 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [5/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector	(	RCP< const MultiVector > &	full,
		size_t	block,
		RCP< MultiVector > &	partial
	)		const

inline

Definition at line 150 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [6/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector	(	RCP< MultiVector > &	full,
		size_t	block,
		RCP< MultiVector > &	partial
	)		const

inline

Definition at line 151 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [7/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< Vector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector	(	RCP< const Vector > &	full,
		size_t	block,
		bool	bThyraMode = `false`
	)		const

inline

Definition at line 153 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [8/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< Vector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector	(	RCP< Vector > &	full,
		size_t	block,
		bool	bThyraMode = `false`
	)		const

inline

Definition at line 166 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [9/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP<MultiVector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector	(	RCP< const MultiVector > &	full,
		size_t	block,
		bool	bThyraMode = `false`
	)		const

inline

Definition at line 179 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [10/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP<MultiVector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector	(	RCP< MultiVector > &	full,
		size_t	block,
		bool	bThyraMode = `false`
	)		const

inline

Definition at line 210 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [11/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP<MultiVector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector	(	RCP< const BlockedMultiVector > &	full,
		size_t	block,
		bool	bThyraMode = `false`
	)		const

inline

Definition at line 240 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [12/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP<MultiVector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector	(	RCP< Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &	full,
		size_t	block,
		bool	bThyraMode = `false`
	)		const

inline

Definition at line 249 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [1/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector	(	const Vector &	partial,
		size_t	block,
		Vector &	full,
		bool	bThyraMode = `false`
	)		const

inline

Definition at line 262 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [2/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector	(	const MultiVector &	partial,
		size_t	block,
		MultiVector &	full,
		bool	bThyraMode = `false`
	)		const

inline

Definition at line 302 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [3/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector	(	RCP< const Vector >	partial,
		size_t	block,
		RCP< Vector >	full,
		bool	bThyraMode = `false`
	)		const

inline

Definition at line 343 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [4/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector	(	RCP< Vector >	partial,
		size_t	block,
		RCP< Vector >	full,
		bool	bThyraMode = `false`
	)		const

inline

Definition at line 344 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [5/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector	(	RCP< const MultiVector >	partial,
		size_t	block,
		RCP< MultiVector >	full,
		bool	bThyraMode = `false`
	)		const

inline

Definition at line 345 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [6/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector	(	RCP< MultiVector >	partial,
		size_t	block,
		RCP< MultiVector >	full,
		bool	bThyraMode = `false`
	)		const

inline

Definition at line 355 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [7/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector	(	RCP< const MultiVector >	partial,
		size_t	block,
		RCP< Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	full,
		bool	bThyraMode = `false`
	)		const

inline

Definition at line 365 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [8/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector	(	RCP< MultiVector >	partial,
		size_t	block,
		RCP< Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	full,
		bool	bThyraMode = `false`
	)		const

inline

Definition at line 370 of file Xpetra_MapExtractor.hpp.

◆ getVector() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< Vector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getVector	(	size_t	i,
		bool	bThyraMode = `false`,
		bool	bZero = `true`
	)		const

inline

Definition at line 378 of file Xpetra_MapExtractor.hpp.

◆ getVector() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP<MultiVector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getVector	(	size_t	i,
		size_t	numvec,
		bool	bThyraMode = `false`,
		bool	bZero = `true`
	)		const

inline

Definition at line 384 of file Xpetra_MapExtractor.hpp.

◆ getThyraMode()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

bool Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getThyraMode ( ) const

inline

returns true, if sub maps are stored in Thyra-style numbering

Definition at line 392 of file Xpetra_MapExtractor.hpp.

◆ NumMaps()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

size_t Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::NumMaps ( ) const

inline

number of partial maps

Definition at line 398 of file Xpetra_MapExtractor.hpp.

◆ getMap() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

const RCP<const Map> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMap	(	size_t	i,
		bool	bThyraMode = `false`
	)		const

inline

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 MapExtractor is also constructed using Thyra numbering

Definition at line 404 of file Xpetra_MapExtractor.hpp.

◆ getMap() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

const RCP<const Map> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMap ( ) const

inline

get the underlying BlockedMap object (as Map)

Definition at line 409 of file Xpetra_MapExtractor.hpp.

◆ getBlockedMap()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

const RCP<const BlockedMap> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getBlockedMap ( ) const

inline

get the underlying BlockedMap object (as BlockedMap)

Definition at line 412 of file Xpetra_MapExtractor.hpp.

◆ getFullMap()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

const RCP<const Map> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getFullMap ( ) const

inline

the full map

Definition at line 415 of file Xpetra_MapExtractor.hpp.

◆ getMapIndexForGID()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

size_t Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMapIndexForGID ( GlobalOrdinal gid ) const

inline

returns map index in map extractor which contains GID

Definition at line 418 of file Xpetra_MapExtractor.hpp.

Member Data Documentation

◆ map_

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Teuchos::RCP<const BlockedMap> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::map_

private

blocked map containing the sub block maps (either thyra or xpetra mode)

Definition at line 425 of file Xpetra_MapExtractor.hpp.

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

Xpetra_MapExtractor.hpp

Public Types

Public Member Functions

Private Attributes

Extract subblocks from full map

Insert subblocks into full map

Maps

Detailed Description

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node> class Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Member Typedef Documentation

◆ scalar_type

◆ local_ordinal_type

◆ global_ordinal_type

◆ node_type

Constructor & Destructor Documentation

◆ MapExtractor() [1/4]

◆ MapExtractor() [2/4]

◆ MapExtractor() [3/4]

◆ MapExtractor() [4/4]

◆ ~MapExtractor()

Member Function Documentation

◆ ExtractVector() [1/12]

◆ ExtractVector() [2/12]

◆ ExtractVector() [3/12]

◆ ExtractVector() [4/12]

◆ ExtractVector() [5/12]

◆ ExtractVector() [6/12]

◆ ExtractVector() [7/12]

◆ ExtractVector() [8/12]

◆ ExtractVector() [9/12]

◆ ExtractVector() [10/12]

◆ ExtractVector() [11/12]

◆ ExtractVector() [12/12]

◆ InsertVector() [1/8]

◆ InsertVector() [2/8]

◆ InsertVector() [3/8]

◆ InsertVector() [4/8]

◆ InsertVector() [5/8]

◆ InsertVector() [6/8]

◆ InsertVector() [7/8]

◆ InsertVector() [8/8]

◆ getVector() [1/2]

◆ getVector() [2/2]

◆ getThyraMode()

◆ NumMaps()

◆ getMap() [1/2]

◆ getMap() [2/2]

◆ getBlockedMap()

◆ getFullMap()

◆ getMapIndexForGID()

Member Data Documentation

◆ map_

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
class Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >