Template specialization of Anasazi::MultiVecTraits class using the Epetra_MultiVector class. More...

#include <AnasaziEpetraAdapter.hpp>

Static Public Member Functions
Creation methods
static Teuchos::RCP< Epetra_MultiVector >	Clone (const Epetra_MultiVector &mv, const int outNumVecs)
	Creates a new empty Epetra_MultiVector containing `numVecs` columns.

static Teuchos::RCP< Epetra_MultiVector >	CloneCopy (const Epetra_MultiVector &mv)
	Creates a new Epetra_MultiVector and copies contents of `mv` into the new vector (deep copy).

static Teuchos::RCP< Epetra_MultiVector >	CloneCopy (const Epetra_MultiVector &mv, const std::vector< int > &index)
	Creates a new Epetra_MultiVector and copies the selected contents of `mv` into the new vector (deep copy).

static Teuchos::RCP< Epetra_MultiVector >	CloneViewNonConst (Epetra_MultiVector &mv, const std::vector< int > &index)
	Creates a new Epetra_MultiVector that shares the selected contents of `mv` (shallow copy).

static Teuchos::RCP< const Epetra_MultiVector >	CloneView (const Epetra_MultiVector &mv, const std::vector< int > &index)
	Creates a new const Epetra_MultiVector that shares the selected contents of `mv` (shallow copy).

Attribute methods
static ptrdiff_t	GetGlobalLength (const Epetra_MultiVector &mv)
	Obtain the vector length of `mv`.

static int	GetNumberVecs (const Epetra_MultiVector &mv)
	Obtain the number of vectors in `mv`.

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

static void	MvAddMv (double alpha, const Epetra_MultiVector &A, double beta, const Epetra_MultiVector &B, Epetra_MultiVector &mv)
	Replace `mv` with $\alpha A + \beta B$ .

static void	MvTransMv (double alpha, const Epetra_MultiVector &A, const Epetra_MultiVector &mv, Teuchos::SerialDenseMatrix< int, double > &B)
	Compute a dense matrix `B` through the matrix-matrix multiply $\alpha A^Tmv$ .

static void	MvDot (const Epetra_MultiVector &A, const Epetra_MultiVector &B, std::vector< double > &b)
	Compute a vector `b` where the components are the individual dot-products of the `i-th` columns of `A` and `mv`, i.e. .

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

Initialization methods
static void	SetBlock (const Epetra_MultiVector &A, const std::vector< int > &index, Epetra_MultiVector &mv)
	Copy the vectors in `A` to a set of vectors in `mv` indicated by the indices given in `index`.

static void	MvScale (Epetra_MultiVector &mv, double alpha)
	Scale each element of the vectors in `mv` with `alpha`.

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

static void	MvRandom (Epetra_MultiVector &mv)
	Replace the vectors in `mv` with random vectors.

static void	MvInit (Epetra_MultiVector &mv, double alpha=Teuchos::ScalarTraits< double >::zero())
	Replace each element of the vectors in `mv` with `alpha`.

Print method
static void	MvPrint (const Epetra_MultiVector &mv, std::ostream &os)
	Print the `mv` multi-vector to the `os` output stream.

Detailed Description

Template specialization of Anasazi::MultiVecTraits class using the Epetra_MultiVector class.

This interface will ensure that any Epetra_MultiVector will be accepted by the Anasazi templated solvers.

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

Definition at line 684 of file AnasaziEpetraAdapter.hpp.

Member Function Documentation

◆ Clone()

static Teuchos::RCP< Epetra_MultiVector > Anasazi::MultiVecTraits< double, Epetra_MultiVector >::Clone	(	const Epetra_MultiVector &	mv,
		const int	outNumVecs
	)

inlinestatic

Creates a new empty Epetra_MultiVector containing numVecs columns.

Returns: Reference-counted pointer to the new Epetra_MultiVector.

Definition at line 696 of file AnasaziEpetraAdapter.hpp.

◆ CloneCopy() [1/2]

static Teuchos::RCP< Epetra_MultiVector > Anasazi::MultiVecTraits< double, Epetra_MultiVector >::CloneCopy ( const Epetra_MultiVector & mv )

inlinestatic

Creates a new Epetra_MultiVector and copies contents of mv into the new vector (deep copy).

Returns: Reference-counted pointer to the new Epetra_MultiVector.

Definition at line 714 of file AnasaziEpetraAdapter.hpp.

◆ CloneCopy() [2/2]

static Teuchos::RCP< Epetra_MultiVector > Anasazi::MultiVecTraits< double, Epetra_MultiVector >::CloneCopy	(	const Epetra_MultiVector &	mv,
		const std::vector< int > &	index
	)

inlinestatic

Creates a new Epetra_MultiVector and copies the selected contents of mv into the new vector (deep copy).

The copied vectors from mv are indicated by the indeX.size() indices in index.

Returns: Reference-counted pointer to the new Epetra_MultiVector.

Definition at line 725 of file AnasaziEpetraAdapter.hpp.

◆ CloneViewNonConst()

static Teuchos::RCP< Epetra_MultiVector > Anasazi::MultiVecTraits< double, Epetra_MultiVector >::CloneViewNonConst	(	Epetra_MultiVector &	mv,
		const std::vector< int > &	index
	)

inlinestatic

Creates a new Epetra_MultiVector that shares the selected contents of mv (shallow copy).

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

Returns: Reference-counted pointer to the new Epetra_MultiVector.

Definition at line 815 of file AnasaziEpetraAdapter.hpp.

◆ CloneView()

static Teuchos::RCP< const Epetra_MultiVector > Anasazi::MultiVecTraits< double, Epetra_MultiVector >::CloneView	(	const Epetra_MultiVector &	mv,
		const std::vector< int > &	index
	)

inlinestatic

Creates a new const Epetra_MultiVector that shares the selected contents of mv (shallow copy).

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

Returns: Reference-counted pointer to the new const Epetra_MultiVector.

Definition at line 906 of file AnasaziEpetraAdapter.hpp.

◆ GetGlobalLength()

static ptrdiff_t Anasazi::MultiVecTraits< double, Epetra_MultiVector >::GetGlobalLength ( const Epetra_MultiVector & mv )

inlinestatic

Obtain the vector length of mv.

Definition at line 997 of file AnasaziEpetraAdapter.hpp.

◆ GetNumberVecs()

static int Anasazi::MultiVecTraits< double, Epetra_MultiVector >::GetNumberVecs ( const Epetra_MultiVector & mv )

inlinestatic

Obtain the number of vectors in mv.

Definition at line 1006 of file AnasaziEpetraAdapter.hpp.

◆ MvTimesMatAddMv()

static void Anasazi::MultiVecTraits< double, Epetra_MultiVector >::MvTimesMatAddMv	(	double	alpha,
		const Epetra_MultiVector &	A,
		const Teuchos::SerialDenseMatrix< int, double > &	B,
		double	beta,
		Epetra_MultiVector &	mv
	)

inlinestatic

Update mv with $\alpha AB + \beta mv$ .

Definition at line 1018 of file AnasaziEpetraAdapter.hpp.

◆ MvAddMv()

static void Anasazi::MultiVecTraits< double, Epetra_MultiVector >::MvAddMv	(	double	alpha,
		const Epetra_MultiVector &	A,
		double	beta,
		const Epetra_MultiVector &	B,
		Epetra_MultiVector &	mv
	)

inlinestatic

Replace mv with $\alpha A + \beta B$ .

Definition at line 1031 of file AnasaziEpetraAdapter.hpp.

◆ MvTransMv()

static void Anasazi::MultiVecTraits< double, Epetra_MultiVector >::MvTransMv	(	double	alpha,
		const Epetra_MultiVector &	A,
		const Epetra_MultiVector &	mv,
		Teuchos::SerialDenseMatrix< int, double > &	B
	)

inlinestatic

Compute a dense matrix B through the matrix-matrix multiply $\alpha A^Tmv$ .

Definition at line 1088 of file AnasaziEpetraAdapter.hpp.

◆ MvDot()

static void Anasazi::MultiVecTraits< double, Epetra_MultiVector >::MvDot	(	const Epetra_MultiVector &	A,
		const Epetra_MultiVector &	B,
		std::vector< double > &	b
	)

inlinestatic

Compute a vector b where the components are the individual dot-products of the i-th columns of A and mv, i.e. .

Definition at line 1103 of file AnasaziEpetraAdapter.hpp.

◆ MvNorm()

static void Anasazi::MultiVecTraits< double, Epetra_MultiVector >::MvNorm	(	const Epetra_MultiVector &	mv,
		std::vector< double > &	normvec
	)

inlinestatic

Compute the 2-norm of each individual vector of mv.
Upon return, normvec[i] holds the value of , the i-th column of mv.

Definition at line 1126 of file AnasaziEpetraAdapter.hpp.

◆ SetBlock()

static void Anasazi::MultiVecTraits< double, Epetra_MultiVector >::SetBlock	(	const Epetra_MultiVector &	A,
		const std::vector< int > &	index,
		Epetra_MultiVector &	mv
	)

inlinestatic

Copy the vectors in A to a set of vectors in mv indicated by the indices given in index.

Definition at line 1143 of file AnasaziEpetraAdapter.hpp.

◆ MvScale() [1/2]

static void Anasazi::MultiVecTraits< double, Epetra_MultiVector >::MvScale	(	Epetra_MultiVector &	mv,
		double	alpha
	)

inlinestatic

Scale each element of the vectors in mv with alpha.

Definition at line 1289 of file AnasaziEpetraAdapter.hpp.

◆ MvScale() [2/2]

static void Anasazi::MultiVecTraits< double, Epetra_MultiVector >::MvScale	(	Epetra_MultiVector &	mv,
		const std::vector< double > &	alpha
	)

inlinestatic

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

Definition at line 1297 of file AnasaziEpetraAdapter.hpp.

◆ MvRandom()

static void Anasazi::MultiVecTraits< double, Epetra_MultiVector >::MvRandom ( Epetra_MultiVector & mv )

inlinestatic

Replace the vectors in mv with random vectors.

Definition at line 1313 of file AnasaziEpetraAdapter.hpp.

◆ MvInit()

static void Anasazi::MultiVecTraits< double, Epetra_MultiVector >::MvInit	(	Epetra_MultiVector &	mv,
		double	alpha = `Teuchos::ScalarTraits<double>::zero()`
	)

inlinestatic

Replace each element of the vectors in mv with alpha.

Definition at line 1321 of file AnasaziEpetraAdapter.hpp.

◆ MvPrint()

static void Anasazi::MultiVecTraits< double, Epetra_MultiVector >::MvPrint	(	const Epetra_MultiVector &	mv,
		std::ostream &	os
	)

inlinestatic

Print the mv multi-vector to the os output stream.

Definition at line 1334 of file AnasaziEpetraAdapter.hpp.

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

AnasaziEpetraAdapter.hpp

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ Clone()

◆ CloneCopy() [1/2]

◆ CloneCopy() [2/2]

◆ CloneViewNonConst()

◆ CloneView()

◆ GetGlobalLength()

◆ GetNumberVecs()

◆ MvTimesMatAddMv()

◆ MvAddMv()

◆ MvTransMv()

◆ MvDot()

◆ MvNorm()

◆ SetBlock()

◆ MvScale() [1/2]

◆ MvScale() [2/2]

◆ MvRandom()

◆ MvInit()

◆ MvPrint()