Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <Xpetra_TpetraVector.hpp>

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

List of all members.

Public Member Functions
Scalar	dot (const Vector &a) const
	Computes dot product of this Vector against input Vector x.
Teuchos::ScalarTraits< Scalar > ::magnitudeType	normWeighted (const Vector &weights) const
	Compute Weighted 2-norm (RMS Norm) of this Vector.
Constructor/Destructor Methods
	TpetraVector (const Teuchos::RCP< const Map > &map, bool zeroOut=true)
	Sets all vector entries to zero.
	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)
virtual	~TpetraVector ()
	Destructor.
Post-construction modification routines
void	replaceGlobalValue (GlobalOrdinal globalRow, const Scalar &value)
	Replace current value at the specified location with specified value.
void	sumIntoGlobalValue (GlobalOrdinal globalRow, const Scalar &value)
	Adds specified value to existing value at the specified location.
void	replaceLocalValue (LocalOrdinal myRow, const Scalar &value)
	Replace current value at the specified location with specified values.
void	sumIntoLocalValue (LocalOrdinal myRow, const Scalar &value)
	Adds specified value to existing value at the specified location.
Mathematical methods
Teuchos::ScalarTraits< Scalar > ::magnitudeType	norm1 () const
	Return 1-norm of this Vector.
Teuchos::ScalarTraits< Scalar > ::magnitudeType	norm2 () const
	Compute 2-norm of this Vector.
Teuchos::ScalarTraits< Scalar > ::magnitudeType	normInf () const
	Compute Inf-norm of this Vector.
Scalar	meanValue () const
	Compute mean (average) value of this Vector.
Overridden from Teuchos::Describable
std::string	description () const
	Return a simple one-line description of this object.
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.
Xpetra specific
	TpetraVector (const Teuchos::RCP< Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &vec)
	TpetraMultiVector constructor to wrap a Tpetra::MultiVector object.
RCP< Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getTpetra_Vector () const
	Get the underlying Tpetra multivector.

---

Detailed Description

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

Definition at line 86 of file Xpetra_TpetraVector.hpp.

---

Constructor & Destructor Documentation

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

Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraVector	(	const Teuchos::RCP< const Map > &	map,
		bool	zeroOut = true
	)		[inline]

Sets all vector entries to zero.

Definition at line 110 of file Xpetra_TpetraVector.hpp.

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

Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::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 114 of file Xpetra_TpetraVector.hpp.

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

virtual Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~TpetraVector

(

)

[inline, virtual]

Destructor.

Definition at line 118 of file Xpetra_TpetraVector.hpp.

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

Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraVector

(

const Teuchos::RCP< Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &

vec

)

[inline]

TpetraMultiVector constructor to wrap a Tpetra::MultiVector object.

Definition at line 178 of file Xpetra_TpetraVector.hpp.

---

Member Function Documentation

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

void Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceGlobalValue	(	GlobalOrdinal	globalRow,
		const Scalar &	value
	)		[inline, virtual]

Replace current value at the specified location with specified value.

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

Definition at line 126 of file Xpetra_TpetraVector.hpp.

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

void Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sumIntoGlobalValue	(	GlobalOrdinal	globalRow,
		const Scalar &	value
	)		[inline, virtual]

Adds specified value to existing value at the specified location.

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

Definition at line 129 of file Xpetra_TpetraVector.hpp.

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

void Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceLocalValue	(	LocalOrdinal	myRow,
		const Scalar &	value
	)		[inline, virtual]

Replace current value at the specified location with specified values.

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

Definition at line 132 of file Xpetra_TpetraVector.hpp.

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

void Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sumIntoLocalValue	(	LocalOrdinal	myRow,
		const Scalar &	value
	)		[inline, virtual]

Adds specified value to existing value at the specified location.

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

Definition at line 135 of file Xpetra_TpetraVector.hpp.

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

Teuchos::ScalarTraits< Scalar >::magnitudeType Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm1

(

)

const [inline, virtual]

Return 1-norm of this Vector.

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

Definition at line 143 of file Xpetra_TpetraVector.hpp.

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

Teuchos::ScalarTraits< Scalar >::magnitudeType Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm2

(

)

const [inline, virtual]

Compute 2-norm of this Vector.

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

Definition at line 146 of file Xpetra_TpetraVector.hpp.

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

Teuchos::ScalarTraits< Scalar >::magnitudeType Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::normInf

(

)

const [inline, virtual]

Compute Inf-norm of this Vector.

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

Definition at line 149 of file Xpetra_TpetraVector.hpp.

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

Scalar Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::meanValue

(

)

const [inline, virtual]

Compute mean (average) value of this Vector.

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

Definition at line 152 of file Xpetra_TpetraVector.hpp.

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

std::string Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::description

(

)

const [inline, virtual]

Return a simple one-line description of this object.

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

Definition at line 160 of file Xpetra_TpetraVector.hpp.

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

void Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel = Teuchos::Describable::verbLevel_default
	)		const [inline, virtual]

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

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

Definition at line 163 of file Xpetra_TpetraVector.hpp.

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

Scalar Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dot

(

const Vector &

a

)

const [inline, virtual]

Computes dot product of this Vector against input Vector x.

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

Definition at line 168 of file Xpetra_TpetraVector.hpp.

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

Teuchos::ScalarTraits< Scalar >::magnitudeType Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::normWeighted

(

const Vector &

weights

)

const [inline, virtual]

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

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

Definition at line 171 of file Xpetra_TpetraVector.hpp.

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

RCP<Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getTpetra_Vector

(

)

const [inline]

Get the underlying Tpetra multivector.

Definition at line 181 of file Xpetra_TpetraVector.hpp.

---

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

• Xpetra_TpetraVector.hpp