Basic adapter class for Anasazi::MultiVec that uses Epetra_MultiVector. More...

#include <AnasaziEpetraAdapter.hpp>

Inheritance diagram for Anasazi::EpetraMultiVec:

Public Member Functions
Constructors/Destructors
	EpetraMultiVec (const Epetra_BlockMap &Map_in, const int numvecs)
	Basic EpetraMultiVec constructor.

	EpetraMultiVec (const Epetra_MultiVector &P_vec)
	Copy constructor.

	EpetraMultiVec (const Epetra_BlockMap &Map_in, double *array, const int numvecs, const int stride=0)
	Create multi-vector with values from two dimensional array.

	EpetraMultiVec (Epetra_DataAccess CV, const Epetra_MultiVector &P_vec, const std::vector< int > &index)
	Create multi-vector from list of vectors in an existing EpetraMultiVec.

virtual	~EpetraMultiVec ()
	Destructor.

Creation methods
MultiVec< double > *	Clone (const int numvecs) const
	Creates a new empty EpetraMultiVec containing `numvecs` columns.

MultiVec< double > *	CloneCopy () const
	Creates a new EpetraMultiVec and copies contents of `*this` into the new vector (deep copy).

MultiVec< double > *	CloneCopy (const std::vector< int > &index) const
	Creates a new EpetraMultiVec and copies the selected contents of `*this` into the new vector (deep copy).

MultiVec< double > *	CloneViewNonConst (const std::vector< int > &index)
	Creates a new EpetraMultiVec that shares the selected contents of `*this`.

const MultiVec< double > *	CloneView (const std::vector< int > &index) const
	Creates a new EpetraMultiVec that shares the selected contents of `*this`.

ptrdiff_t	GetGlobalLength () const
	The number of rows in the multivector.

Attribute methods
Obtain the vector length of *this.
int	GetNumberVecs () const
	The number of vectors (i.e., columns) in the multivector.

Update methods
void	MvTimesMatAddMv (double alpha, const MultiVec< double > &A, const Teuchos::SerialDenseMatrix< int, double > &B, double beta)
	Update `this` with $\alpha AB + \beta (this)$ .

void	MvAddMv (double alpha, const MultiVec< double > &A, double beta, const MultiVec< double > &B)
	Replace `*this` with $\alpha A + \beta B$ .

void	MvTransMv (double alpha, const MultiVec< double > &A, Teuchos::SerialDenseMatrix< int, double > &B) const
	Compute a dense matrix `B` through the matrix-matrix multiply $\alpha A^T(*this)$ .

void	MvDot (const MultiVec< double > &A, std::vector< double > &b) const
	Compute a vector `b` where the components are the individual dot-products, i.e. where `A`[i] is the i-th column of `A`.

void	MvScale (double alpha)
	Scale each element of the vectors in `*this` with `alpha`.

void	MvScale (const std::vector< double > &alpha)
	Scale each element of the `i-th` vector in `*this` with `alpha`[i].

Norm method
void	MvNorm (std::vector< double > &normvec) const
	Compute the 2-norm of each individual vector of `this`. Upon return, `normvec`[i] holds the 2-norm of the `i-th` vector of `this`.

Initialization methods
void	SetBlock (const MultiVec< double > &A, const std::vector< int > &index)
	Copy the vectors in `A` to a set of vectors in `*this`.

void	MvRandom ()
	Fill the vectors in `*this` with random numbers.

void	MvInit (double alpha)
	Replace each element of the vectors in `*this` with `alpha`.

Accessor methods (inherited from EpetraMultiVecAccessor)
Epetra_MultiVector *	GetEpetraMultiVec ()
	Return the pointer to the Epetra_MultiVector object.

const Epetra_MultiVector *	GetEpetraMultiVec () const
	Return the pointer to the Epetra_MultiVector object.

Print method
void	MvPrint (std::ostream &os) const
	Print `*this` EpetraMultiVec.

Public Member Functions inherited from Anasazi::MultiVec< double >
	MultiVec ()
	Default constructor.

virtual	~MultiVec ()
	Destructor (virtual for memory safety of derived classes).

virtual void	MvNorm (std::vector< typename Teuchos::ScalarTraits< double >::magnitudeType > &normvec) const=0
	Compute the 2-norm of each vector in `*this`.

Public Member Functions inherited from Anasazi::EpetraMultiVecAccessor
virtual	~EpetraMultiVecAccessor ()
	Destructor.

Detailed Description

Basic adapter class for Anasazi::MultiVec that uses Epetra_MultiVector.

Note: The Epetra package performs double-precision arithmetic, so the use of Epetra with Anasazi will only provide a double-precision eigensolver.

Examples: BlockKrylovSchur/BlockKrylovSchurEpetraExSVD.cpp, and MVOPTester/MVOPTesterEx.cpp.

Definition at line 96 of file AnasaziEpetraAdapter.hpp.

Constructor & Destructor Documentation

◆ EpetraMultiVec() [1/4]

Anasazi::EpetraMultiVec::EpetraMultiVec	(	const Epetra_BlockMap &	Map_in,
		const int	numvecs
	)

Basic EpetraMultiVec constructor.

Parameters

Map	[in] An Epetra_LocalMap, Epetra_Map or Epetra_BlockMap.
numvecs	[in] Number of vectors in multi-vector.

Returns: Pointer to an EpetraMultiVec

Definition at line 33 of file AnasaziEpetraAdapter.cpp.

◆ EpetraMultiVec() [2/4]

Anasazi::EpetraMultiVec::EpetraMultiVec ( const Epetra_MultiVector & P_vec )

Copy constructor.

Definition at line 47 of file AnasaziEpetraAdapter.cpp.

◆ EpetraMultiVec() [3/4]

Anasazi::EpetraMultiVec::EpetraMultiVec	(	const Epetra_BlockMap &	Map_in,
		double *	array,
		const int	numvecs,
		const int	stride = `0`
	)

Create multi-vector with values from two dimensional array.

Parameters

Map	[in] An Epetra_LocalMap, Epetra_Map or Epetra_BlockMap
array	[in] Pointer to an array of double precision numbers. The first vector starts at `array`, the second at `array+stride`, and so on. This array is copied.
numvecs	[in] Number of vectors in the multi-vector.
stride	[in] The stride between vectors in memory of `array`.

Returns: Pointer to an EpetraMultiVec

Definition at line 26 of file AnasaziEpetraAdapter.cpp.

◆ EpetraMultiVec() [4/4]

Anasazi::EpetraMultiVec::EpetraMultiVec	(	Epetra_DataAccess	CV,
		const Epetra_MultiVector &	P_vec,
		const std::vector< int > &	index
	)

Create multi-vector from list of vectors in an existing EpetraMultiVec.

Parameters

CV	[in] Enumerated type set to Copy or View.
P_vec	[in] An existing fully constructed Epetra_MultiVector.
index	[in] A integer vector containing the indices of the vectors to copy out of `P_vec`.

Returns: Pointer to an EpetraMultiVec

Definition at line 39 of file AnasaziEpetraAdapter.cpp.

◆ ~EpetraMultiVec()

virtual Anasazi::EpetraMultiVec::~EpetraMultiVec ( )

inlinevirtual

Destructor.

Definition at line 133 of file AnasaziEpetraAdapter.hpp.

Member Function Documentation

◆ Clone()

MultiVec< double > * Anasazi::EpetraMultiVec::Clone ( const int numvecs ) const

virtual

Creates a new empty EpetraMultiVec containing numvecs columns.

Returns: Pointer to an EpetraMultiVec

Implements Anasazi::MultiVec< double >.

Definition at line 62 of file AnasaziEpetraAdapter.cpp.

◆ CloneCopy() [1/2]

MultiVec< double > * Anasazi::EpetraMultiVec::CloneCopy ( ) const

virtual

Creates a new EpetraMultiVec and copies contents of *this into the new vector (deep copy).

Returns: Pointer to an EpetraMultiVec

Implements Anasazi::MultiVec< double >.

Definition at line 73 of file AnasaziEpetraAdapter.cpp.

◆ CloneCopy() [2/2]

MultiVec< double > * Anasazi::EpetraMultiVec::CloneCopy ( const std::vector< int > & index ) const

virtual

Creates a new EpetraMultiVec and copies the selected contents of *this into the new vector (deep copy).

The copied vectors from *this are indicated by the index.size() indices in index.

Returns: Pointer to an EpetraMultiVec

Implements Anasazi::MultiVec< double >.

Definition at line 80 of file AnasaziEpetraAdapter.cpp.

◆ CloneViewNonConst()

MultiVec< double > * Anasazi::EpetraMultiVec::CloneViewNonConst ( const std::vector< int > & index )

virtual

Creates a new EpetraMultiVec that shares the selected contents of *this.

The index of the numvecs vectors shallow copied from *this are indicated by the indices given in index.

Returns: Pointer to an EpetraMultiVec

Implements Anasazi::MultiVec< double >.

Definition at line 87 of file AnasaziEpetraAdapter.cpp.

◆ CloneView()

const MultiVec< double > * Anasazi::EpetraMultiVec::CloneView ( const std::vector< int > & index ) const

virtual

Creates a new EpetraMultiVec that shares the selected contents of *this.

The index of the numvecs vectors shallow copied from *this are indicated by the indices given in index.

Returns: Pointer to an EpetraMultiVec

Implements Anasazi::MultiVec< double >.

Definition at line 93 of file AnasaziEpetraAdapter.cpp.

◆ GetGlobalLength()

ptrdiff_t Anasazi::EpetraMultiVec::GetGlobalLength ( ) const

inlinevirtual

The number of rows in the multivector.

Implements Anasazi::MultiVec< double >.

Definition at line 183 of file AnasaziEpetraAdapter.hpp.

◆ GetNumberVecs()

int Anasazi::EpetraMultiVec::GetNumberVecs ( ) const

inlinevirtual

The number of vectors (i.e., columns) in the multivector.

Implements Anasazi::MultiVec< double >.

Definition at line 193 of file AnasaziEpetraAdapter.hpp.

◆ MvTimesMatAddMv()

void Anasazi::EpetraMultiVec::MvTimesMatAddMv	(	double	alpha,
		const MultiVec< double > &	A,
		const Teuchos::SerialDenseMatrix< int, double > &	B,
		double	beta
	)

virtual

Update *this with $\alpha AB + \beta (*this)$ .

Implements Anasazi::MultiVec< double >.

Examples: BlockKrylovSchur/BlockKrylovSchurEpetraExSVD.cpp.

Definition at line 126 of file AnasaziEpetraAdapter.cpp.

◆ MvAddMv()

void Anasazi::EpetraMultiVec::MvAddMv	(	double	alpha,
		const MultiVec< double > &	A,
		double	beta,
		const MultiVec< double > &	B
	)

virtual

Replace *this with $\alpha A + \beta B$ .

Implements Anasazi::MultiVec< double >.

Definition at line 146 of file AnasaziEpetraAdapter.cpp.

◆ MvTransMv()

void Anasazi::EpetraMultiVec::MvTransMv	(	double	alpha,
		const MultiVec< double > &	A,
		Teuchos::SerialDenseMatrix< int, double > &	B
	)		const

virtual

Compute a dense matrix B through the matrix-matrix multiply $\alpha A^T(*this)$ .

Implements Anasazi::MultiVec< double >.

Definition at line 165 of file AnasaziEpetraAdapter.cpp.

◆ MvDot()

void Anasazi::EpetraMultiVec::MvDot	(	const MultiVec< double > &	A,
		std::vector< double > &	b
	)		const

virtual

Compute a vector b where the components are the individual dot-products, i.e. where A[i] is the i-th column of A.

Implements Anasazi::MultiVec< double >.

Definition at line 190 of file AnasaziEpetraAdapter.cpp.

◆ MvScale() [1/2]

void Anasazi::EpetraMultiVec::MvScale ( double alpha )

inlinevirtual

Scale each element of the vectors in *this with alpha.

Implements Anasazi::MultiVec< double >.

Definition at line 228 of file AnasaziEpetraAdapter.hpp.

◆ MvScale() [2/2]

void Anasazi::EpetraMultiVec::MvScale ( const std::vector< double > & alpha )

virtual

Scale each element of the i-th vector in *this with alpha[i].

Implements Anasazi::MultiVec< double >.

Definition at line 211 of file AnasaziEpetraAdapter.cpp.

◆ MvNorm()

void Anasazi::EpetraMultiVec::MvNorm ( std::vector< double > & normvec ) const

inline

Compute the 2-norm of each individual vector of *this.
Upon return, normvec[i] holds the 2-norm of the i-th vector of *this.

Definition at line 244 of file AnasaziEpetraAdapter.hpp.

◆ SetBlock()

void Anasazi::EpetraMultiVec::SetBlock	(	const MultiVec< double > &	A,
		const std::vector< int > &	index
	)

virtual

Copy the vectors in A to a set of vectors in *this.

The numvecs vectors in A are copied to a subset of vectors in *this indicated by the indices given in index.

Implements Anasazi::MultiVec< double >.

Definition at line 100 of file AnasaziEpetraAdapter.cpp.

◆ MvRandom()

void Anasazi::EpetraMultiVec::MvRandom ( )

inlinevirtual

Fill the vectors in *this with random numbers.

Implements Anasazi::MultiVec< double >.

Definition at line 263 of file AnasaziEpetraAdapter.hpp.

◆ MvInit()

void Anasazi::EpetraMultiVec::MvInit ( double alpha )

inlinevirtual

Replace each element of the vectors in *this with alpha.

Implements Anasazi::MultiVec< double >.

Definition at line 270 of file AnasaziEpetraAdapter.hpp.

◆ GetEpetraMultiVec() [1/2]

Epetra_MultiVector * Anasazi::EpetraMultiVec::GetEpetraMultiVec ( )

inlinevirtual

Return the pointer to the Epetra_MultiVector object.

Reimplemented from Anasazi::EpetraMultiVecAccessor.

Definition at line 279 of file AnasaziEpetraAdapter.hpp.

◆ GetEpetraMultiVec() [2/2]

const Epetra_MultiVector * Anasazi::EpetraMultiVec::GetEpetraMultiVec ( ) const

inlinevirtual

Return the pointer to the Epetra_MultiVector object.

Reimplemented from Anasazi::EpetraMultiVecAccessor.

Definition at line 282 of file AnasaziEpetraAdapter.hpp.

◆ MvPrint()

void Anasazi::EpetraMultiVec::MvPrint ( std::ostream & os ) const

inlinevirtual

Print *this EpetraMultiVec.

Implements Anasazi::MultiVec< double >.

Definition at line 291 of file AnasaziEpetraAdapter.hpp.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ EpetraMultiVec() [1/4]

◆ EpetraMultiVec() [2/4]

◆ EpetraMultiVec() [3/4]

◆ EpetraMultiVec() [4/4]

◆ ~EpetraMultiVec()

Member Function Documentation

◆ Clone()

◆ CloneCopy() [1/2]

◆ CloneCopy() [2/2]

◆ CloneViewNonConst()

◆ CloneView()

◆ GetGlobalLength()

◆ GetNumberVecs()

◆ MvTimesMatAddMv()

◆ MvAddMv()

◆ MvTransMv()

◆ MvDot()

◆ MvScale() [1/2]

◆ MvScale() [2/2]

◆ MvNorm()

◆ SetBlock()

◆ MvRandom()

◆ MvInit()

◆ GetEpetraMultiVec() [1/2]

◆ GetEpetraMultiVec() [2/2]

◆ MvPrint()