#include <Xpetra_Vector.hpp>

Public Types
typedef Scalar	scalar_type

typedef LocalOrdinal	local_ordinal_type

typedef GlobalOrdinal	global_ordinal_type

typedef Node	node_type

Constructor/Destructor Methods
virtual	~Vector ()
	Destructor. More...

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

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

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

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

Mathematical methods
virtual Scalar	dot (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &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...

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

virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const =0
	Print the object with some verbosity level to an FancyOStream object. More...

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::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 63 of file Xpetra_Vector.hpp.

Member Typedef Documentation

◆ scalar_type

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 Scalar Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scalar_type

Definition at line 67 of file Xpetra_Vector.hpp.

◆ local_ordinal_type

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 LocalOrdinal Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Definition at line 68 of file Xpetra_Vector.hpp.

◆ global_ordinal_type

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 GlobalOrdinal Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Definition at line 69 of file Xpetra_Vector.hpp.

◆ node_type

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 Node Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type

Definition at line 70 of file Xpetra_Vector.hpp.

Constructor & Destructor Documentation

◆ ~Vector()

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>

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

inlinevirtual

Destructor.

Definition at line 115 of file Xpetra_Vector.hpp.

Member Function Documentation

◆ replaceGlobalValue()

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>

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

pure virtual

Replace current value at the specified location with specified value.

Implemented in Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >, Xpetra::TpetraVector< Scalar, int, int, EpetraNode >, Xpetra::EpetraVectorT< long long, EpetraNode >, Xpetra::EpetraVectorT< int, EpetraNode >, Xpetra::EpetraIntVectorT< long long, EpetraNode >, and Xpetra::EpetraIntVectorT< int, EpetraNode >.

◆ sumIntoGlobalValue()

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>

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

pure virtual

Adds specified value to existing value at the specified location.

Implemented in Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >, Xpetra::TpetraVector< Scalar, int, int, EpetraNode >, Xpetra::EpetraVectorT< long long, EpetraNode >, Xpetra::EpetraVectorT< int, EpetraNode >, Xpetra::EpetraIntVectorT< long long, EpetraNode >, and Xpetra::EpetraIntVectorT< int, EpetraNode >.

◆ replaceLocalValue()

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>

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

pure virtual

Replace current value at the specified location with specified values.

Implemented in Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >, Xpetra::TpetraVector< Scalar, int, int, EpetraNode >, Xpetra::EpetraVectorT< long long, EpetraNode >, Xpetra::EpetraVectorT< int, EpetraNode >, Xpetra::EpetraIntVectorT< long long, EpetraNode >, and Xpetra::EpetraIntVectorT< int, EpetraNode >.

◆ sumIntoLocalValue()

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>

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

pure virtual

Adds specified value to existing value at the specified location.

Implemented in Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >, Xpetra::TpetraVector< Scalar, int, int, EpetraNode >, Xpetra::EpetraVectorT< long long, EpetraNode >, Xpetra::EpetraVectorT< int, EpetraNode >, Xpetra::EpetraIntVectorT< long long, EpetraNode >, and Xpetra::EpetraIntVectorT< int, EpetraNode >.

◆ dot()

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>

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

pure virtual

Computes dot product of this Vector against input Vector x.

Implemented in Xpetra::EpetraVectorT< long long, EpetraNode >, Xpetra::EpetraVectorT< int, EpetraNode >, Xpetra::EpetraIntVectorT< long long, EpetraNode >, and Xpetra::EpetraIntVectorT< int, EpetraNode >.

◆ norm1()

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>

virtual Teuchos::ScalarTraits< Scalar >::magnitudeType Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm1 ( ) const

pure virtual

Return 1-norm of this Vector.

◆ norm2()

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>

virtual Teuchos::ScalarTraits< Scalar >::magnitudeType Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm2 ( ) const

pure virtual

Compute 2-norm of this Vector.

◆ normInf()

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>

virtual Teuchos::ScalarTraits< Scalar >::magnitudeType Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::normInf ( ) const

pure virtual

Compute Inf-norm of this Vector.

◆ meanValue()

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>

virtual Scalar Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::meanValue ( ) const

pure virtual

Compute mean (average) value of this Vector.

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

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

pure virtual

Return a simple one-line description of this object.

◆ describe()

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>

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

pure virtual

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

Implemented in Xpetra::TpetraVector< Scalar, int, long long, EpetraNode >, Xpetra::TpetraVector< Scalar, int, int, EpetraNode >, Xpetra::EpetraVectorT< long long, EpetraNode >, Xpetra::EpetraVectorT< int, EpetraNode >, Xpetra::EpetraIntVectorT< long long, EpetraNode >, Xpetra::EpetraIntVectorT< int, EpetraNode >, and Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

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

Public Types

Constructor/Destructor Methods

Post-construction modification routines

Mathematical methods

Overridden from Teuchos::Describable

Detailed Description

Member Typedef Documentation

◆ scalar_type

◆ local_ordinal_type

◆ global_ordinal_type

◆ node_type

Constructor & Destructor Documentation

◆ ~Vector()

Member Function Documentation

◆ replaceGlobalValue()

◆ sumIntoGlobalValue()

◆ replaceLocalValue()

◆ sumIntoLocalValue()

◆ dot()

◆ norm1()

◆ norm2()

◆ normInf()

◆ meanValue()

◆ description()

◆ describe()