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

#include <Xpetra_TpetraVector_decl.hpp>

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

	TpetraVector (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &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< Scalar, LocalOrdinal, GlobalOrdinal, Node > &a) const
	Computes dot product of this Vector against input Vector x. 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, class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 79 of file Xpetra_TpetraVector_decl.hpp.

Constructor & Destructor Documentation

◆ TpetraVector() [1/3]

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

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

Sets all vector entries to zero.

Definition at line 55 of file Xpetra_TpetraVector_def.hpp.

◆ TpetraVector() [2/3]

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

Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraVector	(	const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &	map,
		const Teuchos::ArrayView< const Scalar > &	A
	)

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

Definition at line 64 of file Xpetra_TpetraVector_def.hpp.

◆ ~TpetraVector()

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

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

virtual

Destructor.

Definition at line 73 of file Xpetra_TpetraVector_def.hpp.

◆ TpetraVector() [3/3]

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

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

TpetraMultiVector constructor to wrap a Tpetra::MultiVector object.

Definition at line 202 of file Xpetra_TpetraVector_def.hpp.

Member Function Documentation

◆ replaceGlobalValue()

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

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

Replace current value at the specified location with specified value.

Definition at line 81 of file Xpetra_TpetraVector_def.hpp.

◆ sumIntoGlobalValue()

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

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

Adds specified value to existing value at the specified location.

Definition at line 91 of file Xpetra_TpetraVector_def.hpp.

◆ replaceLocalValue()

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

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

Replace current value at the specified location with specified values.

Definition at line 101 of file Xpetra_TpetraVector_def.hpp.

◆ sumIntoLocalValue()

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

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

Adds specified value to existing value at the specified location.

Definition at line 111 of file Xpetra_TpetraVector_def.hpp.

◆ norm1()

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

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

Return 1-norm of this Vector.

Definition at line 121 of file Xpetra_TpetraVector_def.hpp.

◆ norm2()

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

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

Compute 2-norm of this Vector.

Definition at line 131 of file Xpetra_TpetraVector_def.hpp.

◆ normInf()

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

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

Compute Inf-norm of this Vector.

Definition at line 141 of file Xpetra_TpetraVector_def.hpp.

◆ meanValue()

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

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

Compute mean (average) value of this Vector.

Definition at line 151 of file Xpetra_TpetraVector_def.hpp.

◆ description()

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

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

Return a simple one-line description of this object.

Definition at line 161 of file Xpetra_TpetraVector_def.hpp.

◆ describe()

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

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

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

Definition at line 171 of file Xpetra_TpetraVector_def.hpp.

◆ dot()

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

Scalar Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dot ( const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & a ) const

Computes dot product of this Vector against input Vector x.

Definition at line 181 of file Xpetra_TpetraVector_def.hpp.

◆ getTpetra_Vector()

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

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

Get the underlying Tpetra multivector.

Definition at line 211 of file Xpetra_TpetraVector_def.hpp.

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