#include <Xpetra_TpetraVector.hpp>

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

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

◆ TpetraVector() [1/3]

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 109 of file Xpetra_TpetraVector.hpp.

◆ TpetraVector() [2/3]

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 113 of file Xpetra_TpetraVector.hpp.

◆ ~TpetraVector()

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 ( )

inlinevirtual

Destructor.

Definition at line 117 of file Xpetra_TpetraVector.hpp.

◆ TpetraVector() [3/3]

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 177 of file Xpetra_TpetraVector.hpp.

Member Function Documentation

◆ replaceGlobalValue()

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

Replace current value at the specified location with specified value.

Definition at line 125 of file Xpetra_TpetraVector.hpp.

◆ sumIntoGlobalValue()

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

Adds specified value to existing value at the specified location.

Definition at line 128 of file Xpetra_TpetraVector.hpp.

◆ replaceLocalValue()

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

Replace current value at the specified location with specified values.

Definition at line 131 of file Xpetra_TpetraVector.hpp.

◆ sumIntoLocalValue()

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

Adds specified value to existing value at the specified location.

Definition at line 134 of file Xpetra_TpetraVector.hpp.

◆ norm1()

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

Return 1-norm of this Vector.

Definition at line 142 of file Xpetra_TpetraVector.hpp.

◆ norm2()

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

Compute 2-norm of this Vector.

Definition at line 145 of file Xpetra_TpetraVector.hpp.

◆ normInf()

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

Compute Inf-norm of this Vector.

Definition at line 148 of file Xpetra_TpetraVector.hpp.

◆ meanValue()

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

Compute mean (average) value of this Vector.

Definition at line 151 of file Xpetra_TpetraVector.hpp.

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

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

inline

Return a simple one-line description of this object.

Definition at line 159 of file Xpetra_TpetraVector.hpp.

◆ describe()

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

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

Definition at line 162 of file Xpetra_TpetraVector.hpp.

◆ dot()

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

Computes dot product of this Vector against input Vector x.

Definition at line 167 of file Xpetra_TpetraVector.hpp.

◆ normWeighted()

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

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

Definition at line 170 of file Xpetra_TpetraVector.hpp.

◆ getTpetra_Vector()

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 180 of file Xpetra_TpetraVector.hpp.

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

Constructor/Destructor Methods

Post-construction modification routines

Mathematical methods

Overridden from Teuchos::Describable

Xpetra specific

Detailed Description

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()