#include <Xpetra_TpetraVector.hpp>

Inheritance diagram for Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >:

Private Types
typedef int	LocalOrdinal

typedef long long	GlobalOrdinal

typedef EpetraNode	Node

Constructor/Destructor Methods
	TpetraVector (const Teuchos::RCP< const Map > &map, bool zeroOut=true)
	Sets all vector entries to zero. More...

	TpetraVector (const Teuchos::RCP< const Map > &map, const Teuchos::ArrayView< const Scalar > &A)
	Set multi-vector values from an array using Teuchos memory management classes. (copy) More...

virtual	~TpetraVector ()
	Destructor. More...

Post-construction modification routines
void	replaceGlobalValue (GlobalOrdinal globalRow, const Scalar &value)
	Replace current value at the specified location with specified value. More...

void	sumIntoGlobalValue (GlobalOrdinal globalRow, const Scalar &value)
	Adds specified value to existing value at the specified location. More...

void	replaceLocalValue (LocalOrdinal myRow, const Scalar &value)
	Replace current value at the specified location with specified values. More...

void	sumIntoLocalValue (LocalOrdinal myRow, const Scalar &value)
	Adds specified value to existing value at the specified location. More...

Mathematical methods
Teuchos::ScalarTraits< Scalar >::magnitudeType	norm1 () const
	Return 1-norm of this Vector. More...

Teuchos::ScalarTraits< Scalar >::magnitudeType	norm2 () const
	Compute 2-norm of this Vector. More...

Teuchos::ScalarTraits< Scalar >::magnitudeType	normInf () const
	Compute Inf-norm of this Vector. More...

Scalar	meanValue () const
	Compute mean (average) value of this Vector. More...

Overridden from Teuchos::Describable
std::string	description () const
	Return 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 some verbosity level to an FancyOStream object. More...

Scalar	dot (const Vector &a) const
	Computes dot product of this Vector against input Vector x. More...

Teuchos::ScalarTraits< Scalar >::magnitudeType	normWeighted (const Vector &weights) const
	Compute Weighted 2-norm (RMS Norm) of this Vector. More...

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

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

Additional Inherited Members
Public Types inherited from Xpetra::Vector< Scalar, int, long long, EpetraNode >
typedef Scalar	scalar_type

typedef int	local_ordinal_type

typedef long long	global_ordinal_type

typedef EpetraNode	node_type

Public Types inherited from Xpetra::MultiVector< Scalar, int, long long, EpetraNode >
typedef Scalar	scalar_type

typedef int	local_ordinal_type

typedef long long	global_ordinal_type

typedef EpetraNode	node_type

Public Member Functions inherited from Xpetra::Vector< Scalar, int, long long, EpetraNode >
virtual	~Vector ()
	Destructor. More...

virtual Scalar	dot (const Vector< Scalar, int, long long, EpetraNode > &a) const=0
	Computes dot product of this Vector against input Vector x. More...

virtual Teuchos::ScalarTraits< Scalar >::magnitudeType	norm1 () const=0
	Return 1-norm of this Vector. More...

virtual Teuchos::ScalarTraits< Scalar >::magnitudeType	norm2 () const=0
	Compute 2-norm of this Vector. More...

virtual Teuchos::ScalarTraits< Scalar >::magnitudeType	normInf () const=0
	Compute Inf-norm of this Vector. More...

virtual Scalar	meanValue () const=0
	Compute mean (average) value of this Vector. More...

virtual std::string	description () const=0
	Return a simple one-line description of this object. More...

Public Member Functions inherited from Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >
	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...

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

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

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

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

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

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)

template<class Node2 >
RCP< MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node2 > >	clone (const RCP< Node2 > &node2) const

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

Public Member Functions inherited from Xpetra::MultiVector< Scalar, int, long long, EpetraNode >
virtual	~MultiVector ()
	Destructor. More...

MultiVector< Scalar, int, long long, EpetraNode > &	operator= (const MultiVector< Scalar, int, long long, EpetraNode > &rhs)
	Assignment operator: Does a deep copy. More...

virtual size_t	getNumVectors () const=0
	Number of columns in the multivector. More...

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

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

virtual std::string	description () const=0
	A simple one-line description of this object. More...

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

Public Member Functions inherited from Xpetra::DistObject< Scalar, int, long long, EpetraNode >
virtual	~DistObject ()
	Destructor. More...

virtual Teuchos::RCP< const Map< int, long long, EpetraNode > >	getMap () const=0
	The Map describing the parallel distribution of this object. More...

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

virtual	~Describable ()

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

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

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

Public Member Functions inherited from Teuchos::LabeledObject
	LabeledObject ()

virtual	~LabeledObject ()

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

virtual std::string	getObjectLabel () const

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

Protected Member Functions inherited from Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >
virtual void	assign (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &rhs)
	Implementation of the assignment operator (operator=); does a deep copy. More...

Protected Member Functions inherited from Xpetra::MultiVector< Scalar, int, long long, EpetraNode >

Detailed Description

template<class Scalar>
class Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >

Definition at line 385 of file Xpetra_TpetraVector.hpp.

Member Typedef Documentation

◆ LocalOrdinal

template<class Scalar >

typedef int Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::LocalOrdinal

private

Definition at line 389 of file Xpetra_TpetraVector.hpp.

◆ GlobalOrdinal

template<class Scalar >

typedef long long Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::GlobalOrdinal

private

Definition at line 390 of file Xpetra_TpetraVector.hpp.

◆ Node

template<class Scalar >

typedef EpetraNode Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::Node

private

Definition at line 391 of file Xpetra_TpetraVector.hpp.

Constructor & Destructor Documentation

◆ TpetraVector() [1/3]

template<class Scalar >

Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::TpetraVector	(	const Teuchos::RCP< const Map > &	map,
		bool	zeroOut = `true`
	)

inline

Sets all vector entries to zero.

Definition at line 412 of file Xpetra_TpetraVector.hpp.

◆ TpetraVector() [2/3]

template<class Scalar >

Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::TpetraVector	(	const Teuchos::RCP< const Map > &	map,
		const Teuchos::ArrayView< const Scalar > &	A
	)

inline

Set multi-vector values from an array using Teuchos memory management classes. (copy)

Definition at line 418 of file Xpetra_TpetraVector.hpp.

◆ ~TpetraVector()

template<class Scalar >

virtual Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::~TpetraVector ( )

inlinevirtual

Destructor.

Definition at line 424 of file Xpetra_TpetraVector.hpp.

◆ TpetraVector() [3/3]

template<class Scalar >

Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::TpetraVector ( const Teuchos::RCP< Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & vec )

inline

TpetraMultiVector constructor to wrap a Tpetra::MultiVector object.

Definition at line 484 of file Xpetra_TpetraVector.hpp.

Member Function Documentation

◆ replaceGlobalValue()

template<class Scalar >

void Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::replaceGlobalValue	(	GlobalOrdinal	globalRow,
		const Scalar &	value
	)

inlinevirtual

Replace current value at the specified location with specified value.

Implements Xpetra::Vector< Scalar, int, long long, EpetraNode >.

Definition at line 432 of file Xpetra_TpetraVector.hpp.

◆ sumIntoGlobalValue()

template<class Scalar >

void Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::sumIntoGlobalValue	(	GlobalOrdinal	globalRow,
		const Scalar &	value
	)

inlinevirtual

Adds specified value to existing value at the specified location.

Implements Xpetra::Vector< Scalar, int, long long, EpetraNode >.

Definition at line 435 of file Xpetra_TpetraVector.hpp.

◆ replaceLocalValue()

template<class Scalar >

void Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::replaceLocalValue	(	LocalOrdinal	myRow,
		const Scalar &	value
	)

inlinevirtual

Replace current value at the specified location with specified values.

Implements Xpetra::Vector< Scalar, int, long long, EpetraNode >.

Definition at line 438 of file Xpetra_TpetraVector.hpp.

◆ sumIntoLocalValue()

template<class Scalar >

void Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::sumIntoLocalValue	(	LocalOrdinal	myRow,
		const Scalar &	value
	)

inlinevirtual

Adds specified value to existing value at the specified location.

Implements Xpetra::Vector< Scalar, int, long long, EpetraNode >.

Definition at line 441 of file Xpetra_TpetraVector.hpp.

◆ norm1()

template<class Scalar >

Teuchos::ScalarTraits< Scalar >::magnitudeType Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::norm1 ( ) const

inline

Return 1-norm of this Vector.

Definition at line 449 of file Xpetra_TpetraVector.hpp.

◆ norm2()

template<class Scalar >

Teuchos::ScalarTraits< Scalar >::magnitudeType Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::norm2 ( ) const

inline

Compute 2-norm of this Vector.

Definition at line 452 of file Xpetra_TpetraVector.hpp.

◆ normInf()

template<class Scalar >

Teuchos::ScalarTraits< Scalar >::magnitudeType Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::normInf ( ) const

inline

Compute Inf-norm of this Vector.

Definition at line 455 of file Xpetra_TpetraVector.hpp.

◆ meanValue()

template<class Scalar >

Scalar Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::meanValue ( ) const

inline

Compute mean (average) value of this Vector.

Definition at line 458 of file Xpetra_TpetraVector.hpp.

◆ description()

template<class Scalar >

std::string Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::description ( ) const

inlinevirtual

Return a simple one-line description of this object.

Reimplemented from Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 466 of file Xpetra_TpetraVector.hpp.

◆ describe()

template<class Scalar >

void Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel = `Teuchos::Describable::verbLevel_default`
	)		const

inlinevirtual

Print the object with some verbosity level to an FancyOStream object.

Reimplemented from Xpetra::TpetraMultiVector< Scalar, int, long long, EpetraNode >.

Definition at line 469 of file Xpetra_TpetraVector.hpp.

◆ dot()

template<class Scalar >

Scalar Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::dot ( const Vector & a ) const

inline

Computes dot product of this Vector against input Vector x.

Definition at line 474 of file Xpetra_TpetraVector.hpp.

◆ normWeighted()

template<class Scalar >

Teuchos::ScalarTraits< Scalar >::magnitudeType Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::normWeighted ( const Vector & weights ) const

inline

Compute Weighted 2-norm (RMS Norm) of this Vector.

Definition at line 477 of file Xpetra_TpetraVector.hpp.

◆ getTpetra_Vector()

template<class Scalar >

RCP<Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >::getTpetra_Vector ( ) const

inline

Get the underlying Tpetra multivector.

Definition at line 489 of file Xpetra_TpetraVector.hpp.

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

Xpetra_TpetraVector.hpp

Private Types

Constructor/Destructor Methods

Post-construction modification routines

Mathematical methods

Overridden from Teuchos::Describable

Xpetra specific

Additional Inherited Members

Detailed Description

template<class Scalar> class Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >

Member Typedef Documentation

◆ LocalOrdinal

◆ GlobalOrdinal

◆ Node

Constructor & Destructor Documentation

◆ TpetraVector() [1/3]

◆ TpetraVector() [2/3]

◆ ~TpetraVector()

◆ TpetraVector() [3/3]

Member Function Documentation

◆ replaceGlobalValue()

◆ sumIntoGlobalValue()

◆ replaceLocalValue()

◆ sumIntoLocalValue()

◆ norm1()

◆ norm2()

◆ normInf()

◆ meanValue()

◆ description()

◆ describe()

◆ dot()

◆ normWeighted()

◆ getTpetra_Vector()

template<class Scalar>
class Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >