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

#include <Xpetra_Vector.hpp>

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

List of all members.

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.
Post-construction modification routines
virtual void	replaceGlobalValue (GlobalOrdinal globalRow, const Scalar &value)=0
	Replace current value at the specified location with specified value.
virtual void	sumIntoGlobalValue (GlobalOrdinal globalRow, const Scalar &value)=0
	Adds specified value to existing value at the specified location.
virtual void	replaceLocalValue (LocalOrdinal myRow, const Scalar &value)=0
	Replace current value at the specified location with specified values.
virtual void	sumIntoLocalValue (LocalOrdinal myRow, const Scalar &value)=0
	Adds specified value to existing value at the specified location.
Mathematical methods
virtual Scalar	dot (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &a) const =0
	Computes dot product of this Vector against input Vector x.
virtual Teuchos::ScalarTraits < Scalar >::magnitudeType	norm1 () const =0
	Return 1-norm of this Vector.
virtual Teuchos::ScalarTraits < Scalar >::magnitudeType	norm2 () const =0
	Compute 2-norm of this Vector.
virtual Teuchos::ScalarTraits < Scalar >::magnitudeType	normInf () const =0
	Compute Inf-norm of this Vector.
virtual Teuchos::ScalarTraits < Scalar >::magnitudeType	normWeighted (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &weights) const =0
	Compute Weighted 2-norm (RMS Norm) of this Vector.
virtual Scalar	meanValue () const =0
	Compute mean (average) value of this Vector.
Overridden from Teuchos::Describable
virtual std::string	description () const =0
	Return a simple one-line description of this object.
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.

---

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

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

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

Definition at line 67 of file Xpetra_Vector.hpp.

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

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

Definition at line 68 of file Xpetra_Vector.hpp.

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

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

Definition at line 69 of file Xpetra_Vector.hpp.

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

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

Definition at line 70 of file Xpetra_Vector.hpp.

---

Constructor & Destructor Documentation

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

(

)

[inline, virtual]

Destructor.

Definition at line 87 of file Xpetra_Vector.hpp.

---

Member Function Documentation

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, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraIntVectorT< EpetraGlobalOrdinal >, and Xpetra::EpetraVectorT< EpetraGlobalOrdinal >.

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, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraIntVectorT< EpetraGlobalOrdinal >, and Xpetra::EpetraVectorT< EpetraGlobalOrdinal >.

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, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraIntVectorT< EpetraGlobalOrdinal >, and Xpetra::EpetraVectorT< EpetraGlobalOrdinal >.

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, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraIntVectorT< EpetraGlobalOrdinal >, and Xpetra::EpetraVectorT< EpetraGlobalOrdinal >.

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

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.

Implemented in Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraVectorT< EpetraGlobalOrdinal >, and Xpetra::EpetraIntVectorT< EpetraGlobalOrdinal >.

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.

Implemented in Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraVectorT< EpetraGlobalOrdinal >, and Xpetra::EpetraIntVectorT< EpetraGlobalOrdinal >.

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.

Implemented in Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraVectorT< EpetraGlobalOrdinal >, and Xpetra::EpetraIntVectorT< EpetraGlobalOrdinal >.

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 >::normWeighted

(

const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &

weights

)

const [pure virtual]

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

Implemented in Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

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.

Implemented in Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, Xpetra::EpetraVectorT< EpetraGlobalOrdinal >, and Xpetra::EpetraIntVectorT< EpetraGlobalOrdinal >.

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.

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

Implemented in Xpetra::EpetraIntVectorT< EpetraGlobalOrdinal >, Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraVectorT< EpetraGlobalOrdinal >.

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.

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

Implemented in Xpetra::EpetraIntVectorT< EpetraGlobalOrdinal >, Xpetra::TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and Xpetra::EpetraVectorT< EpetraGlobalOrdinal >.

---

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

• Xpetra_Vector.hpp