Xpetra::EpetraVectorT< EpetraGlobalOrdinal > Class Template Reference

#include <Xpetra_EpetraVector.hpp>

Inheritance diagram for Xpetra::EpetraVectorT< EpetraGlobalOrdinal >:

List of all members.

Private Types
typedef double	Scalar
typedef int	LocalOrdinal
typedef EpetraGlobalOrdinal	GlobalOrdinal
typedef KokkosClassic::DefaultNode::DefaultNodeType	Node
Private Attributes
const RCP< const Epetra_MultiVector >	internalRefToBaseMV_
Constructor/Destructor Methods
	EpetraVectorT (const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, bool zeroOut=true)
	Sets all vector entries to zero.
virtual	~EpetraVectorT ()
	Vector copy constructor.
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
	EpetraVectorT (const Teuchos::RCP< Epetra_Vector > &vec)
	EpetraMultiVectorT constructor to wrap a Epetra_Vector object.
Epetra_Vector *	getEpetra_Vector () const
	Get the underlying Epetra vector.
	EpetraVectorT (const RCP< Epetra_MultiVector > &mv, size_t j)

---

Detailed Description

template<class EpetraGlobalOrdinal>
class Xpetra::EpetraVectorT< EpetraGlobalOrdinal >

Definition at line 74 of file Xpetra_EpetraVector.hpp.

---

Member Typedef Documentation

template<class EpetraGlobalOrdinal >

typedef double Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::Scalar [private]

Reimplemented from Xpetra::EpetraMultiVectorT< EpetraGlobalOrdinal >.

Definition at line 78 of file Xpetra_EpetraVector.hpp.

template<class EpetraGlobalOrdinal >

typedef int Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::LocalOrdinal [private]

Reimplemented from Xpetra::EpetraMultiVectorT< EpetraGlobalOrdinal >.

Definition at line 79 of file Xpetra_EpetraVector.hpp.

template<class EpetraGlobalOrdinal >

typedef EpetraGlobalOrdinal Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::GlobalOrdinal [private]

Reimplemented from Xpetra::EpetraMultiVectorT< EpetraGlobalOrdinal >.

Definition at line 80 of file Xpetra_EpetraVector.hpp.

template<class EpetraGlobalOrdinal >

typedef KokkosClassic::DefaultNode::DefaultNodeType Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::Node [private]

Reimplemented from Xpetra::EpetraMultiVectorT< EpetraGlobalOrdinal >.

Definition at line 81 of file Xpetra_EpetraVector.hpp.

---

Constructor & Destructor Documentation

template<class EpetraGlobalOrdinal >

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

Sets all vector entries to zero.

template<class EpetraGlobalOrdinal >

virtual Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::~EpetraVectorT

(

)

[inline, virtual]

Vector copy constructor.

Destructor.

Definition at line 107 of file Xpetra_EpetraVector.hpp.

template<class EpetraGlobalOrdinal >

Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::EpetraVectorT

(

const Teuchos::RCP< Epetra_Vector > &

vec

)

[inline]

EpetraMultiVectorT constructor to wrap a Epetra_Vector object.

Definition at line 166 of file Xpetra_EpetraVector.hpp.

template<class EpetraGlobalOrdinal >

Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::EpetraVectorT	(	const RCP< Epetra_MultiVector > &	mv,
		size_t	j
	)

This constructor creates a Vector which is a view of column j of the MultiVector 'mv'. It implements the logic of MultiVector::getVector/getVectorNonConst() for Epetra MultiVector. The newly created Xpetra::EpetraVectorT will remain valid after the disappearance of the references to 'mv' in user code.

Definition at line 128 of file Xpetra_EpetraVector.cpp.

---

Member Function Documentation

template<class EpetraGlobalOrdinal >

void Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::replaceGlobalValue	(	GlobalOrdinal	globalRow,
		const Scalar &	value
	)		[virtual]

Replace current value at the specified location with specified value.

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

Definition at line 56 of file Xpetra_EpetraVector.cpp.

template<class EpetraGlobalOrdinal >

void Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::sumIntoGlobalValue	(	GlobalOrdinal	globalRow,
		const Scalar &	value
	)		[virtual]

Adds specified value to existing value at the specified location.

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

Definition at line 59 of file Xpetra_EpetraVector.cpp.

template<class EpetraGlobalOrdinal >

void Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::replaceLocalValue	(	LocalOrdinal	myRow,
		const Scalar &	value
	)		[virtual]

Replace current value at the specified location with specified values.

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

Definition at line 62 of file Xpetra_EpetraVector.cpp.

template<class EpetraGlobalOrdinal >

void Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::sumIntoLocalValue	(	LocalOrdinal	myRow,
		const Scalar &	value
	)		[virtual]

Adds specified value to existing value at the specified location.

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

Definition at line 65 of file Xpetra_EpetraVector.cpp.

template<class EpetraGlobalOrdinal >

double Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::dot

(

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

a

)

const

Computes dot product of this Vector against input Vector x.

Definition at line 68 of file Xpetra_EpetraVector.cpp.

template<class EpetraGlobalOrdinal >

Teuchos::ScalarTraits< double >::magnitudeType Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::norm1

(

)

const [virtual]

Return 1-norm of this Vector.

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

Definition at line 81 of file Xpetra_EpetraVector.cpp.

template<class EpetraGlobalOrdinal >

Teuchos::ScalarTraits< double >::magnitudeType Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::norm2

(

)

const [virtual]

Compute 2-norm of this Vector.

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

Definition at line 84 of file Xpetra_EpetraVector.cpp.

template<class EpetraGlobalOrdinal >

Teuchos::ScalarTraits< double >::magnitudeType Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::normInf

(

)

const [virtual]

Compute Inf-norm of this Vector.

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

Definition at line 87 of file Xpetra_EpetraVector.cpp.

template<class EpetraGlobalOrdinal >

Teuchos::ScalarTraits< double >::magnitudeType Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::normWeighted

(

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

weights

)

const

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

Definition at line 91 of file Xpetra_EpetraVector.cpp.

template<class EpetraGlobalOrdinal >

double Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::meanValue

(

)

const [virtual]

Compute mean (average) value of this Vector.

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

Definition at line 100 of file Xpetra_EpetraVector.cpp.

template<class EpetraGlobalOrdinal >

std::string Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::description

(

)

const [virtual]

Return a simple one-line description of this object.

Reimplemented from Xpetra::EpetraMultiVectorT< EpetraGlobalOrdinal >.

Definition at line 108 of file Xpetra_EpetraVector.cpp.

template<class EpetraGlobalOrdinal >

void Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::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::EpetraMultiVectorT< EpetraGlobalOrdinal >.

Definition at line 119 of file Xpetra_EpetraVector.cpp.

template<class EpetraGlobalOrdinal >

Epetra_Vector* Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::getEpetra_Vector

(

)

const [inline]

Get the underlying Epetra vector.

Definition at line 169 of file Xpetra_EpetraVector.hpp.

---

Member Data Documentation

template<class EpetraGlobalOrdinal >

const RCP<const Epetra_MultiVector> Xpetra::EpetraVectorT< EpetraGlobalOrdinal >::internalRefToBaseMV_ [private]

Definition at line 182 of file Xpetra_EpetraVector.hpp.

---

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

• Xpetra_EpetraVector.hpp
• Xpetra_EpetraVector.cpp