#include <Xpetra_EpetraVector.hpp>

Inheritance diagram for Xpetra::EpetraVector:

Private Types
typedef double	Scalar
typedef int	LocalOrdinal
typedef int	GlobalOrdinal
typedef Kokkos::DefaultNode::DefaultNodeType	Node
Constructor/Destructor Methods
	EpetraVector (const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, bool zeroOut=true)
	Sets all vector entries to zero.
	EpetraVector (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &source)
	Vector copy constructor.
virtual	~EpetraVector ()
	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
Scalar	dot (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &a) const
	Computes dot product of this Vector against input Vector x.
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.
Teuchos::ScalarTraits< Scalar > ::magnitudeType	normWeighted (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &weights) const
	Compute Weighted 2-norm (RMS 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
	EpetraVector (const Teuchos::RCP< Epetra_Vector > &vec)
	EpetraMultiVector constructor to wrap a Epetra_Vector object.
Epetra_Vector *	getEpetra_Vector () const
	Get the underlying Epetra vector.

Detailed Description

Definition at line 71 of file Xpetra_EpetraVector.hpp.

Member Typedef Documentation

typedef double Xpetra::EpetraVector::Scalar [private]

Reimplemented from Xpetra::EpetraMultiVector.

Definition at line 75 of file Xpetra_EpetraVector.hpp.

typedef int Xpetra::EpetraVector::LocalOrdinal [private]

Reimplemented from Xpetra::EpetraMultiVector.

Definition at line 76 of file Xpetra_EpetraVector.hpp.

typedef int Xpetra::EpetraVector::GlobalOrdinal [private]

Reimplemented from Xpetra::EpetraMultiVector.

Definition at line 77 of file Xpetra_EpetraVector.hpp.

typedef Kokkos::DefaultNode::DefaultNodeType Xpetra::EpetraVector::Node [private]

Reimplemented from Xpetra::EpetraMultiVector.

Definition at line 78 of file Xpetra_EpetraVector.hpp.

Constructor & Destructor Documentation

Xpetra::EpetraVector::EpetraVector	(	const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &	map,
		bool	zeroOut = `true`
	)		`[explicit]`

Sets all vector entries to zero.

Xpetra::EpetraVector::EpetraVector ( const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & source )

Vector copy constructor.

virtual Xpetra::EpetraVector::~EpetraVector ( ) [inline, virtual]

Destructor.

Definition at line 103 of file Xpetra_EpetraVector.hpp.

Xpetra::EpetraVector::EpetraVector ( const Teuchos::RCP< Epetra_Vector > & vec ) [inline]

EpetraMultiVector constructor to wrap a Epetra_Vector object.

Definition at line 162 of file Xpetra_EpetraVector.hpp.

Member Function Documentation

void Xpetra::EpetraVector::replaceGlobalValue	(	GlobalOrdinal	globalRow,
		const Scalar &	value
	)		`[virtual]`

Replace current value at the specified location with specified value.

Implements Xpetra::Vector< double, int, int >.

Definition at line 54 of file Xpetra_EpetraVector.cpp.

void Xpetra::EpetraVector::sumIntoGlobalValue	(	GlobalOrdinal	globalRow,
		const Scalar &	value
	)		`[virtual]`

Adds specified value to existing value at the specified location.

Implements Xpetra::Vector< double, int, int >.

Definition at line 56 of file Xpetra_EpetraVector.cpp.

void Xpetra::EpetraVector::replaceLocalValue	(	LocalOrdinal	myRow,
		const Scalar &	value
	)		`[virtual]`

Replace current value at the specified location with specified values.

Implements Xpetra::Vector< double, int, int >.

Definition at line 58 of file Xpetra_EpetraVector.cpp.

void Xpetra::EpetraVector::sumIntoLocalValue	(	LocalOrdinal	myRow,
		const Scalar &	value
	)		`[virtual]`

Adds specified value to existing value at the specified location.

Implements Xpetra::Vector< double, int, int >.

Definition at line 60 of file Xpetra_EpetraVector.cpp.

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

Computes dot product of this Vector against input Vector x.

Implements Xpetra::Vector< double, int, int >.

Definition at line 62 of file Xpetra_EpetraVector.cpp.

Teuchos::ScalarTraits< double >::magnitudeType Xpetra::EpetraVector::norm1 ( ) const [virtual]

Return 1-norm of this Vector.

Implements Xpetra::Vector< double, int, int >.

Definition at line 74 of file Xpetra_EpetraVector.cpp.

Teuchos::ScalarTraits< double >::magnitudeType Xpetra::EpetraVector::norm2 ( ) const [virtual]

Compute 2-norm of this Vector.

Implements Xpetra::Vector< double, int, int >.

Definition at line 76 of file Xpetra_EpetraVector.cpp.

Teuchos::ScalarTraits< double >::magnitudeType Xpetra::EpetraVector::normInf ( ) const [virtual]

Compute Inf-norm of this Vector.

Implements Xpetra::Vector< double, int, int >.

Definition at line 78 of file Xpetra_EpetraVector.cpp.

Teuchos::ScalarTraits< double >::magnitudeType Xpetra::EpetraVector::normWeighted ( const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & weights ) const [virtual]

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

Implements Xpetra::Vector< double, int, int >.

Definition at line 80 of file Xpetra_EpetraVector.cpp.

double Xpetra::EpetraVector::meanValue ( ) const [virtual]

Compute mean (average) value of this Vector.

Implements Xpetra::Vector< double, int, int >.

Definition at line 87 of file Xpetra_EpetraVector.cpp.

std::string Xpetra::EpetraVector::description ( ) const [virtual]

Return a simple one-line description of this object.

Reimplemented from Xpetra::EpetraMultiVector.

Definition at line 89 of file Xpetra_EpetraVector.cpp.

void Xpetra::EpetraVector::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel = `Teuchos::Describable::verbLevel_default`
	)		const `[virtual]`

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

Reimplemented from Xpetra::EpetraMultiVector.

Definition at line 99 of file Xpetra_EpetraVector.cpp.

Epetra_Vector* Xpetra::EpetraVector::getEpetra_Vector ( ) const [inline]

Get the underlying Epetra vector.

Definition at line 165 of file Xpetra_EpetraVector.hpp.

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

Private Types

Constructor/Destructor Methods

Post-construction modification routines

Mathematical methods

Overridden from Teuchos::Describable

Xpetra specific

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation