#include <Xpetra_TpetraMultiVector_decl.hpp>

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

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

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

Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > >	getMap () const
	The Map describing the parallel distribution of this object. More...

void	doImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
	Import data into this object using an Import object ("forward mode"). More...

void	doExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &dest, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
	Export data into this object using an Import object ("reverse mode"). More...

void	doImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
	Import data into this object using an Export object ("reverse mode"). More...

void	doExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &dest, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
	Export data into this object using an Export object ("forward mode"). More...

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

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	Xpetra_randomize ()
	Set multi-vector values to random numbers. XPetra implementation. More...

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

Public Member Functions inherited from Teuchos::Describable
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

Private Types
typedef TpetraMultiVector < Scalar, LocalOrdinal, GlobalOrdinal, Node >	TpetraMultiVectorClass

Constructors and destructor
	TpetraMultiVector (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, size_t NumVectors, bool zeroOut=true)
	Basic constuctor. More...

	TpetraMultiVector (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source)
	Copy constructor (performs a deep copy). More...

	TpetraMultiVector (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, const Teuchos::ArrayView< const Scalar > &A, size_t LDA, size_t NumVectors)
	Create multivector by copying two-dimensional array of local data. More...

	TpetraMultiVector (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, const Teuchos::ArrayView< const Teuchos::ArrayView< const Scalar > > &ArrayOfPtrs, size_t NumVectors)
	Create multivector by copying array of views of local data. More...

virtual	~TpetraMultiVector ()
	Destructor (virtual for memory safety of derived classes). More...

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

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

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

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

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

void	reduce ()
	Sum values of a locally replicated multivector across all processes. More...

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

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

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

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

void	get1dCopy (Teuchos::ArrayView< Scalar > A, size_t LDA) const
	Fill the given array with a copy of this multivector's local values. More...

void	get2dCopy (Teuchos::ArrayView< const Teuchos::ArrayView< Scalar > > ArrayOfPtrs) const
	Fill the given array with a copy of this multivector's local values. More...

Teuchos::ArrayRCP< const Scalar >	get1dView () const
	Const persisting (1-D) view of this multivector's local values. More...

Teuchos::ArrayRCP < Teuchos::ArrayRCP< const Scalar > >	get2dView () const
	Return const persisting pointers to values. More...

Teuchos::ArrayRCP< Scalar >	get1dViewNonConst ()
	Nonconst persisting (1-D) view of this multivector's local values. More...

Teuchos::ArrayRCP < Teuchos::ArrayRCP< Scalar > >	get2dViewNonConst ()
	Return non-const persisting pointers to values. More...

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

void	abs (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A)
	Put element-wise absolute values of input Multi-vector in target: A = abs(this). More...

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

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

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

void	scale (const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A)
	Replace multi-vector values with scaled values of A, this = alpha*A. More...

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

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

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

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

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

void	meanValue (const Teuchos::ArrayView< Scalar > &means) 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...

void	multiply (Teuchos::ETransp transA, Teuchos::ETransp transB, const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, const Scalar &beta)
	Matrix-matrix multiplication: this = betathis + alphaop(A)*op(B). More...

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

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

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

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

Overridden from Teuchos::Describable
std::string	description () const
	A simple one-line description of this object. More...

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

Xpetra specific
RCP< Tpetra::MultiVector < Scalar, LocalOrdinal, GlobalOrdinal, Node > >	vec_
	The Tpetra::MultiVector which this class wraps. More...

	TpetraMultiVector (const Teuchos::RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &vec)
	TpetraMultiVector constructor to wrap a Tpetra::MultiVector object. More...

RCP< Tpetra::MultiVector < Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getTpetra_MultiVector () const
	Get the underlying Tpetra multivector. More...

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

virtual void	assign (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &rhs)
	Implementation of the assignment operator (operator=); does a deep copy. More...

Additional Inherited Members
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

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Detailed Description

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = typename MultiVector<Scalar>::local_ordinal_type, class GlobalOrdinal = typename MultiVector<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename MultiVector<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 87 of file Xpetra_TpetraMultiVector_decl.hpp.

Member Typedef Documentation

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = typename MultiVector<Scalar>::local_ordinal_type, class GlobalOrdinal = typename MultiVector<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename MultiVector<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

typedef TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraMultiVectorClass

private

Definition at line 92 of file Xpetra_TpetraMultiVector_decl.hpp.

Constructor & Destructor Documentation

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

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

Basic constuctor.

Definition at line 64 of file Xpetra_TpetraMultiVector_def.hpp.

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

Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraMultiVector ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & source )

Copy constructor (performs a deep copy).

Definition at line 73 of file Xpetra_TpetraMultiVector_def.hpp.

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

Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraMultiVector	(	const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	map,
		const Teuchos::ArrayView< const Scalar > &	A,
		size_t	LDA,
		size_t	NumVectors
	)

Create multivector by copying two-dimensional array of local data.

Definition at line 79 of file Xpetra_TpetraMultiVector_def.hpp.

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

Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraMultiVector	(	const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	map,
		const Teuchos::ArrayView< const Teuchos::ArrayView< const Scalar > > &	ArrayOfPtrs,
		size_t	NumVectors
	)

Create multivector by copying array of views of local data.

Definition at line 88 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

virtual

Destructor (virtual for memory safety of derived classes).

Definition at line 98 of file Xpetra_TpetraMultiVector_def.hpp.

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

Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraMultiVector ( const Teuchos::RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & vec )

TpetraMultiVector constructor to wrap a Tpetra::MultiVector object.

TpetraMultiVector constructor to wrap a Tpetra::MultiVector objecT.

Definition at line 368 of file Xpetra_TpetraMultiVector_def.hpp.

Member Function Documentation

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceGlobalValue	(	GlobalOrdinal	globalRow,
		size_t	vectorIndex,
		const Scalar &	value
	)

virtual

Replace value, using global (row) index.

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

Definition at line 103 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sumIntoGlobalValue	(	GlobalOrdinal	globalRow,
		size_t	vectorIndex,
		const Scalar &	value
	)

virtual

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

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

Definition at line 108 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceLocalValue	(	LocalOrdinal	myRow,
		size_t	vectorIndex,
		const Scalar &	value
	)

virtual

Replace value, using local (row) index.

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

Definition at line 113 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sumIntoLocalValue	(	LocalOrdinal	myRow,
		size_t	vectorIndex,
		const Scalar &	value
	)

virtual

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

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

Definition at line 118 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< 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 >.

Definition at line 123 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::reduce ( )

Sum values of a locally replicated multivector across all processes.

Definition at line 128 of file Xpetra_TpetraMultiVector_def.hpp.

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

Teuchos::RCP< const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraMultiVector< 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 >.

Definition at line 134 of file Xpetra_TpetraMultiVector_def.hpp.

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

Teuchos::RCP< Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraMultiVector< 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 >.

Definition at line 140 of file Xpetra_TpetraMultiVector_def.hpp.

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

Teuchos::ArrayRCP< const Scalar > Xpetra::TpetraMultiVector< 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 >.

Definition at line 146 of file Xpetra_TpetraMultiVector_def.hpp.

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

Teuchos::ArrayRCP< Scalar > Xpetra::TpetraMultiVector< 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 >.

Definition at line 152 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::get1dCopy	(	Teuchos::ArrayView< Scalar >	A,
		size_t	LDA
	)		const

Fill the given array with a copy of this multivector's local values.

Definition at line 158 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::get2dCopy ( Teuchos::ArrayView< const Teuchos::ArrayView< Scalar > > ArrayOfPtrs ) const

Fill the given array with a copy of this multivector's local values.

Definition at line 164 of file Xpetra_TpetraMultiVector_def.hpp.

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

Teuchos::ArrayRCP< const Scalar > Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::get1dView ( ) const

Const persisting (1-D) view of this multivector's local values.

Definition at line 170 of file Xpetra_TpetraMultiVector_def.hpp.

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

Teuchos::ArrayRCP< Teuchos::ArrayRCP< const Scalar > > Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::get2dView ( ) const

Return const persisting pointers to values.

Definition at line 176 of file Xpetra_TpetraMultiVector_def.hpp.

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

Teuchos::ArrayRCP< Scalar > Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::get1dViewNonConst ( )

Nonconst persisting (1-D) view of this multivector's local values.

Definition at line 182 of file Xpetra_TpetraMultiVector_def.hpp.

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

Teuchos::ArrayRCP< Teuchos::ArrayRCP< Scalar > > Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::get2dViewNonConst ( )

Return non-const persisting pointers to values.

Definition at line 188 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

virtual

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

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

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

Definition at line 193 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

virtual

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

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

Definition at line 198 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

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

Definition at line 203 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< 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 >.

Definition at line 208 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< 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 >.

Definition at line 213 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

Replace multi-vector values with scaled values of A, this = alpha*A.

Definition at line 218 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::update	(	const Scalar &	alpha,
		const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	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 >.

Definition at line 223 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::update	(	const Scalar &	alpha,
		const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	A,
		const Scalar &	beta,
		const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	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 >.

Definition at line 228 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< 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 >.

Definition at line 233 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

virtual

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

Definition at line 238 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< 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 >.

Definition at line 243 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::meanValue ( const Teuchos::ArrayView< Scalar > & means ) 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 >.

Definition at line 248 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::multiply	(	Teuchos::ETransp	transA,
		Teuchos::ETransp	transB,
		const Scalar &	alpha,
		const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	A,
		const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	B,
		const Scalar &	beta
	)

virtual

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

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

Definition at line 253 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

virtual

Number of columns in the multivector.

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

Definition at line 259 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

virtual

Local number of rows on the calling process.

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

Definition at line 264 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

virtual

Global number of rows in the multivector.

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

Definition at line 269 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

virtual

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

Definition at line 274 of file Xpetra_TpetraMultiVector_def.hpp.

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

std::string Xpetra::TpetraMultiVector< 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::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 279 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

Definition at line 284 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

virtual

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

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

Definition at line 1032 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

virtual

Set multi-vector values to random numbers.

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

Definition at line 289 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

virtual

The Map describing the parallel distribution of this object.

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

Definition at line 301 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doImport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	source,
		const Import< LocalOrdinal, GlobalOrdinal, Node > &	importer,
		CombineMode	CM
	)

virtual

Import data into this object using an Import object ("forward mode").

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

Definition at line 305 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doExport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	source,
		const Import< LocalOrdinal, GlobalOrdinal, Node > &	importer,
		CombineMode	CM
	)

virtual

Export data into this object using an Import object ("reverse mode").

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

Definition at line 315 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doImport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	source,
		const Export< LocalOrdinal, GlobalOrdinal, Node > &	exporter,
		CombineMode	CM
	)

virtual

Import data into this object using an Export object ("reverse mode").

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

Definition at line 326 of file Xpetra_TpetraMultiVector_def.hpp.

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

void Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doExport	(	const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	source,
		const Export< LocalOrdinal, GlobalOrdinal, Node > &	exporter,
		CombineMode	CM
	)

virtual

Export data into this object using an Export object ("forward mode").

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

Definition at line 337 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

virtual

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

Definition at line 348 of file Xpetra_TpetraMultiVector_def.hpp.

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

RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getTpetra_MultiVector ( ) const

Get the underlying Tpetra multivector.

Definition at line 374 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

virtual

Set seed for Random function.

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

Definition at line 379 of file Xpetra_TpetraMultiVector_def.hpp.

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

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

protectedvirtual

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

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

Definition at line 430 of file Xpetra_TpetraMultiVector_def.hpp.

Member Data Documentation

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = typename MultiVector<Scalar>::local_ordinal_type, class GlobalOrdinal = typename MultiVector<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename MultiVector<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node> > Xpetra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::vec_

private

The Tpetra::MultiVector which this class wraps.

Definition at line 324 of file Xpetra_TpetraMultiVector_decl.hpp.

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

Public Member Functions

Private Types

Constructors and destructor

Post-construction modification routines

Data Copy and View get methods

Mathematical methods

Attribute access functions

Overridden from Teuchos::Describable

Xpetra specific

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation