#include <Xpetra_BlockedMultiVector_decl.hpp>

Inheritance diagram for Xpetra::BlockedMultiVector< 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 Types inherited from Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >
typedef Scalar	scalar_type

typedef LocalOrdinal	local_ordinal_type

typedef GlobalOrdinal	global_ordinal_type

typedef Node	node_type

Public Member Functions
Teuchos::RCP< const Map >	getMap () const
	Access function for the underlying Map this DistObject was constructed with. More...

Teuchos::RCP< const Xpetra::BlockedMap < LocalOrdinal, GlobalOrdinal, Node > >	getBlockedMap () const
	Access function for the underlying Map this DistObject was constructed with. More...

Teuchos::RCP< MultiVector >	getMultiVector (size_t r) const
	return partial multivector associated with block row r More...

Teuchos::RCP< MultiVector >	getMultiVector (size_t r, bool bThyraMode) const
	return partial multivector associated with block row r More...

void	setMultiVector (size_t r, Teuchos::RCP< const MultiVector > v, bool bThyraMode)
	set partial multivector associated with block row r More...

Teuchos::RCP< MultiVector >	Merge () const
	merge BlockedMultiVector blocks to a single MultiVector More...

Public Member Functions inherited from Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >
virtual	~MultiVector ()
	Destructor. More...

MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	operator= (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &rhs)
	Assignment operator: Does a deep copy. More...

virtual void	replaceMap (const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &map)=0

Public Member Functions inherited from Xpetra::DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node >
virtual	~DistObject ()
	Destructor. More...

Protected Member Functions
virtual void	assign (const MultiVector &rhs)
	Implementation of the assignment operator (operator=); does a deep copy. More...

Private Member Functions
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< 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

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

void	InsertVector (const MultiVector &partial, size_t block, MultiVector &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

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

std::vector< Teuchos::RCP < MultiVector > >	vv_
	array containing RCPs of the partial vectors More...

size_t	numVectors_
	number of vectors (columns in multi vector) More...

Constructor/Destructor Methods
	BlockedMultiVector (const Teuchos::RCP< const BlockedMap > &map, size_t NumVectors, bool zeroOut=true)
	Constructor. More...

	BlockedMultiVector (Teuchos::RCP< const Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node > > bmap, Teuchos::RCP< const MultiVector > v)

	BlockedMultiVector (Teuchos::RCP< const Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >> mapExtractor, Teuchos::RCP< const MultiVector > v)

	BlockedMultiVector (const Teuchos::RCP< const BlockedMap > &map, std::vector< Teuchos::RCP< MultiVector > > &vin)

virtual	~BlockedMultiVector ()
	Destructor. More...

BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	operator= (const MultiVector &rhs)
	Assignment operator: Does a deep copy. More...

Post-construction modification routines
virtual void	replaceGlobalValue (GlobalOrdinal, size_t, const Scalar &)
	Replace value, using global (row) index. More...

virtual void	sumIntoGlobalValue (GlobalOrdinal, size_t, const Scalar &)
	Add value to existing value, using global (row) index. More...

virtual void	replaceLocalValue (LocalOrdinal, size_t, const Scalar &)
	Replace value, using local (row) index. More...

virtual void	sumIntoLocalValue (LocalOrdinal, size_t, const Scalar &)
	Add value to existing value, using local (row) index. More...

virtual void	putScalar (const Scalar &value)
	Set all values in the multivector with the given value. More...

Data Copy and View get methods
virtual Teuchos::RCP< const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getVector (size_t j) const
	Return a Vector which is a const view of column j. More...

virtual Teuchos::RCP < Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getVectorNonConst (size_t j)
	Return a Vector which is a nonconst view of column j. More...

virtual Teuchos::ArrayRCP < const Scalar >	getData (size_t j) const
	Const view of the local values in a particular vector of this multivector. More...

virtual Teuchos::ArrayRCP< Scalar >	getDataNonConst (size_t j)
	View of the local values in a particular vector of this multivector. More...

Mathematical methods
virtual void	dot (const MultiVector &, const Teuchos::ArrayView< Scalar > &) const
	Compute dot product of each corresponding pair of vectors, dots[i] = this[i].dot(A[i]). More...

virtual void	abs (const MultiVector &)
	Put element-wise absolute values of input Multi-vector in target: A = abs(this). More...

virtual void	reciprocal (const MultiVector &)
	Put element-wise reciprocal values of input Multi-vector in target, this(i,j) = 1/A(i,j). More...

virtual void	scale (const Scalar &alpha)
	Scale the current values of a multi-vector, this = alpha*this. More...

virtual void	scale (Teuchos::ArrayView< const Scalar > alpha)
	Scale the current values of a multi-vector, this[j] = alpha[j]*this[j]. More...

virtual void	update (const Scalar &alpha, const MultiVector &A, const Scalar &beta)
	Update multi-vector values with scaled values of A, this = betathis + alphaA. More...

virtual void	update (const Scalar &alpha, const MultiVector &A, const Scalar &beta, const MultiVector &B, const Scalar &gamma)
	Update multi-vector with scaled values of A and B, this = gammathis + alphaA + beta*B. More...

virtual void	norm1 (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const
	Compute 1-norm of each vector in multi-vector. More...

virtual void	norm2 (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const

virtual void	normInf (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const
	Compute Inf-norm of each vector in multi-vector. More...

virtual void	meanValue (const Teuchos::ArrayView< Scalar > &) const
	Compute mean (average) value of each vector in multi-vector. The outcome of this routine is undefined for non-floating point scalar types (e.g., int). More...

virtual void	multiply (Teuchos::ETransp, Teuchos::ETransp, const Scalar &, const MultiVector &, const MultiVector &, const Scalar &)
	Matrix-matrix multiplication: this = betathis + alphaop(A)*op(B). More...

virtual void	elementWiseMultiply (Scalar scalarAB, const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector &B, Scalar scalarThis)
	Element-wise multiply of a Vector A with a MultiVector B. More...

Attribute access functions
virtual size_t	getNumVectors () const
	Number of columns in the multivector. More...

virtual size_t	getLocalLength () const
	Local number of rows on the calling process. More...

virtual global_size_t	getGlobalLength () const
	Global number of rows in the multivector. More...

virtual bool	isSameSize (const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &vec) const
	Local number of rows on the calling process. More...

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...

virtual void	replaceMap (const RCP< const Map > &map)

virtual void	doImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, const Import &, CombineMode)
	Import. More...

virtual void	doExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, const Import &, CombineMode)
	Export. More...

virtual void	doImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, const Export &, CombineMode)
	Import (using an Exporter). More...

virtual void	doExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, const Export &, CombineMode)
	Export (using an Importer). More...

Xpetra specific
virtual void	setSeed (unsigned int seed)
	Set seed for Random function. More...

virtual void	randomize (bool bUseXpetraImplementation=false)
	Set multi-vector values to random numbers. More...

virtual void	Xpetra_randomize ()
	Set multi-vector values to random numbers. XPetra implementation. More...

Detailed Description

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

Definition at line 75 of file Xpetra_BlockedMultiVector_decl.hpp.

Member Typedef Documentation

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

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

Definition at line 79 of file Xpetra_BlockedMultiVector_decl.hpp.

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

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

Definition at line 80 of file Xpetra_BlockedMultiVector_decl.hpp.

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

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

Definition at line 81 of file Xpetra_BlockedMultiVector_decl.hpp.

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

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

Definition at line 82 of file Xpetra_BlockedMultiVector_decl.hpp.

Constructor & Destructor Documentation

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

Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BlockedMultiVector	(	const Teuchos::RCP< const BlockedMap > &	map,
		size_t	NumVectors,
		bool	zeroOut = `true`
	)

Constructor.

Const version of constructor which accepts a const version of a blocked map

Parameters

map	BlockedMap defining the block structure of the multi vector
NumVectors	Number of vector columns in multi vector
zeroOut	If true initialize multivector with zeros

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

Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BlockedMultiVector	(	Teuchos::RCP< const Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node > >	bmap,
		Teuchos::RCP< const MultiVector >	v
	)

Const version of constructor which accepts a const version of the multi-vector

Note: If you change the information in input vector v the data in the blocked multi-vector are not affected (and vice versa). Consider the blocked multivector to be a copy of the input multivector (not a view)

Parameters

bmap	BlockedMap object containing information about the block splitting
v	MultiVector that is to be splitted into a blocked multi vector

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

Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BlockedMultiVector	(	Teuchos::RCP< const Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >>	mapExtractor,
		Teuchos::RCP< const MultiVector >	v
	)

Const version of constructor which accepts a const version of the multi-vector

Note: If you change the information in input vector v the data in the blocked multi-vector are not affected (and vice versa). Consider the blocked multivector to be a copy of the input multivector (not a view)

Parameters

mapExtractor	MapExtractor object containing information about the block splitting
v	MultiVector that is to be splitted into a blocked multi vector

Definition at line 137 of file Xpetra_BlockedMultiVector_def.hpp.

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

Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BlockedMultiVector	(	const Teuchos::RCP< const BlockedMap > &	map,
		std::vector< Teuchos::RCP< MultiVector > > &	vin
	)

Constructor to build a blocked multivector from a blocked map and component vectors

Note: We do NOT check map compatibility between the BlockedMap and the array of multivectors

Parameters

map	BlockedMap object containing information about the block splitting
vin	A std::vector of RCPs to component vectors

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

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

virtual

Destructor.

Definition at line 173 of file Xpetra_BlockedMultiVector_def.hpp.

Member Function Documentation

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

BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::operator= ( const MultiVector & 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 188 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceGlobalValue	(	GlobalOrdinal	,
		size_t	,
		const Scalar &
	)

virtual

Replace value, using global (row) index.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 198 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sumIntoGlobalValue	(	GlobalOrdinal	,
		size_t	,
		const Scalar &
	)

virtual

Add value to existing value, using global (row) index.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 207 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceLocalValue	(	LocalOrdinal	,
		size_t	,
		const Scalar &
	)

virtual

Replace value, using local (row) index.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 215 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sumIntoLocalValue	(	LocalOrdinal	,
		size_t	,
		const Scalar &
	)

virtual

Add value to existing value, using local (row) index.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 224 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::putScalar ( const Scalar & value )

virtual

Set all values in the multivector with the given value.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 234 of file Xpetra_BlockedMultiVector_def.hpp.

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

Teuchos::RCP< const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getVector ( size_t j ) const

virtual

Return a Vector which is a const view of column j.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 247 of file Xpetra_BlockedMultiVector_def.hpp.

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

Teuchos::RCP< Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getVectorNonConst ( size_t j )

virtual

Return a Vector which is a nonconst view of column j.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 265 of file Xpetra_BlockedMultiVector_def.hpp.

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

Teuchos::ArrayRCP< const Scalar > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getData ( size_t j ) const

virtual

Const view of the local values in a particular vector of this multivector.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 276 of file Xpetra_BlockedMultiVector_def.hpp.

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

Teuchos::ArrayRCP< Scalar > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDataNonConst ( size_t j )

virtual

View of the local values in a particular vector of this multivector.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 290 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dot	(	const MultiVector &	,
		const Teuchos::ArrayView< Scalar > &
	)		const

virtual

Compute dot product of each corresponding pair of vectors, dots[i] = this[i].dot(A[i]).

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 304 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::abs ( const MultiVector & )

virtual

Put element-wise absolute values of input Multi-vector in target: A = abs(this).

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 313 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::reciprocal ( const MultiVector & )

virtual

Put element-wise reciprocal values of input Multi-vector in target, this(i,j) = 1/A(i,j).

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 322 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scale ( const Scalar & alpha )

virtual

Scale the current values of a multi-vector, this = alpha*this.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 331 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scale ( Teuchos::ArrayView< const Scalar > alpha )

virtual

Scale the current values of a multi-vector, this[j] = alpha[j]*this[j].

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 347 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::update	(	const Scalar &	alpha,
		const MultiVector &	A,
		const Scalar &	beta
	)

virtual

Update multi-vector values with scaled values of A, this = beta*this + alpha*A.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 363 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::update	(	const Scalar &	alpha,
		const MultiVector &	A,
		const Scalar &	beta,
		const MultiVector &	B,
		const Scalar &	gamma
	)

virtual

Update multi-vector with scaled values of A and B, this = gamma*this + alpha*A + beta*B.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 468 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm1 ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > & norms ) const

virtual

Compute 1-norm of each vector in multi-vector.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 514 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm2 ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > & norms ) const

virtual

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 537 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::normInf ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > & norms ) const

virtual

Compute Inf-norm of each vector in multi-vector.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 563 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::meanValue ( const Teuchos::ArrayView< Scalar > & ) const

virtual

Compute mean (average) value of each vector in multi-vector. The outcome of this routine is undefined for non-floating point scalar types (e.g., int).

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 585 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::multiply	(	Teuchos::ETransp	,
		Teuchos::ETransp	,
		const Scalar &	,
		const MultiVector &	,
		const MultiVector &	,
		const Scalar &
	)

virtual

Matrix-matrix multiplication: this = beta*this + alpha*op(A)*op(B).

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 594 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::elementWiseMultiply	(	Scalar	scalarAB,
		const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	A,
		const MultiVector &	B,
		Scalar	scalarThis
	)

virtual

Element-wise multiply of a Vector A with a MultiVector B.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 608 of file Xpetra_BlockedMultiVector_def.hpp.

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

size_t Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNumVectors ( ) const

virtual

Number of columns in the multivector.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 656 of file Xpetra_BlockedMultiVector_def.hpp.

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

size_t Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalLength ( ) const

virtual

Local number of rows on the calling process.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 665 of file Xpetra_BlockedMultiVector_def.hpp.

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

global_size_t Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalLength ( ) const

virtual

Global number of rows in the multivector.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 675 of file Xpetra_BlockedMultiVector_def.hpp.

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

bool Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::isSameSize ( const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & vec ) const

virtual

Local number of rows on the calling process.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 685 of file Xpetra_BlockedMultiVector_def.hpp.

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

std::string Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::description ( ) const

virtual

A simple one-line description of this object.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::ReorderedBlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 706 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, 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::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::ReorderedBlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 715 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceMap ( const RCP< const Map > & map )

virtual

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 726 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doImport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	,
		const Import &	,
		CombineMode
	)

virtual

Import.

Implements Xpetra::DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 759 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doExport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	,
		const Import &	,
		CombineMode
	)

virtual

Export.

Implements Xpetra::DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 770 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doImport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	,
		const Export &	,
		CombineMode
	)

virtual

Import (using an Exporter).

Implements Xpetra::DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 781 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doExport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	,
		const Export &	,
		CombineMode
	)

virtual

Export (using an Importer).

Implements Xpetra::DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 792 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setSeed ( unsigned int seed )

virtual

Set seed for Random function.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 803 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::randomize ( bool bUseXpetraImplementation = false )

virtual

Set multi-vector values to random numbers.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 815 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Xpetra_randomize ( )

virtual

Set multi-vector values to random numbers. XPetra implementation.

Reimplemented from Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 827 of file Xpetra_BlockedMultiVector_def.hpp.

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

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

virtual

Access function for the underlying Map this DistObject was constructed with.

Implements Xpetra::DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 836 of file Xpetra_BlockedMultiVector_def.hpp.

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

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

Access function for the underlying Map this DistObject was constructed with.

Definition at line 846 of file Xpetra_BlockedMultiVector_def.hpp.

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

Teuchos::RCP< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMultiVector ( size_t r ) const

return partial multivector associated with block row r

Definition at line 856 of file Xpetra_BlockedMultiVector_def.hpp.

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

Teuchos::RCP< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMultiVector	(	size_t	r,
		bool	bThyraMode
	)		const

return partial multivector associated with block row r

Definition at line 870 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setMultiVector	(	size_t	r,
		Teuchos::RCP< const MultiVector >	v,
		bool	bThyraMode
	)

set partial multivector associated with block row r

Definition at line 887 of file Xpetra_BlockedMultiVector_def.hpp.

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

Teuchos::RCP< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Merge ( ) const

merge BlockedMultiVector blocks to a single MultiVector

Definition at line 915 of file Xpetra_BlockedMultiVector_def.hpp.

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

void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::assign ( const MultiVector & rhs )

protectedvirtual

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

Each subclass must implement this. This includes Xpetra::EpetraMultiVector and Xpetra::TpetraMultiVector as well as Xpetra::BockedMultiVector

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 945 of file Xpetra_BlockedMultiVector_def.hpp.

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

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

private

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

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

private

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

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

private

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

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

private

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

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

private

Definition at line 1132 of file Xpetra_BlockedMultiVector_def.hpp.

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

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

private

Definition at line 1148 of file Xpetra_BlockedMultiVector_def.hpp.

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

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

private

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

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

private

Member Data Documentation

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

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

private

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

Definition at line 433 of file Xpetra_BlockedMultiVector_decl.hpp.

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

std::vector<Teuchos::RCP<MultiVector> > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::vv_

private

array containing RCPs of the partial vectors

Definition at line 434 of file Xpetra_BlockedMultiVector_decl.hpp.

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

size_t Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::numVectors_

private

number of vectors (columns in multi vector)

Definition at line 435 of file Xpetra_BlockedMultiVector_decl.hpp.

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

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Constructor/Destructor Methods

Post-construction modification routines

Data Copy and View get methods

Mathematical methods

Attribute access functions

Overridden from Teuchos::Describable

Xpetra specific

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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