Anasazi Version of the Day
Anasazi::MultiVecTraits< double, Epetra_MultiVector > Class Template Reference

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

#include <AnasaziEpetraAdapter.hpp>

List of all members.

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
CloneCopy (const Epetra_MultiVector &mv, const Teuchos::Range1D &index)
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
< Epetra_MultiVector
CloneViewNonConst (Epetra_MultiVector &mv, const Teuchos::Range1D &index)
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).
static Teuchos::RCP
< Epetra_MultiVector
CloneView (const Epetra_MultiVector &mv, const Teuchos::Range1D &index)
Attribute methods
static int GetVecLength (const Epetra_MultiVector &mv)
 Obtain the vector length of mv.
static int GetNumberVecs (const Epetra_MultiVector &mv)
 Obtain the number of vectors in mv.
static bool HasConstantStride (const Epetra_MultiVector &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. $b[i] = A[i]^Tmv[i]$.
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 $||mv_i||_2$, 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 SetBlock (const Epetra_MultiVector &A, const Teuchos::Range1D &index, Epetra_MultiVector &mv)
static void Assign (const Epetra_MultiVector &A, Epetra_MultiVector &mv)
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<>
class Anasazi::MultiVecTraits< double, Epetra_MultiVector >

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.
Examples:

BlockDavidson/BlockDavidsonEpetraEx.cpp, BlockDavidson/BlockDavidsonEpetraExGen.cpp, BlockDavidson/BlockDavidsonEpetraExGenPrecIfpack.cpp, LOBPCG/LOBPCGEpetraEx.cpp, LOBPCG/LOBPCGEpetraExGen.cpp, LOBPCG/LOBPCGEpetraExGenPrecIfpack.cpp, and LOBPCG/LOBPCGEpetraExSimple.cpp.

Definition at line 690 of file AnasaziEpetraAdapter.hpp.


Member Function Documentation

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

Creates a new empty Epetra_MultiVector containing numVecs columns.

Returns:
Reference-counted pointer to the new Epetra_MultiVector.

Definition at line 702 of file AnasaziEpetraAdapter.hpp.

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

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 720 of file AnasaziEpetraAdapter.hpp.

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

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 731 of file AnasaziEpetraAdapter.hpp.

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

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 822 of file AnasaziEpetraAdapter.hpp.

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

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 913 of file AnasaziEpetraAdapter.hpp.

static int Anasazi::MultiVecTraits< double, Epetra_MultiVector >::GetVecLength ( const Epetra_MultiVector mv) [inline, static]

Obtain the vector length of mv.

Definition at line 1004 of file AnasaziEpetraAdapter.hpp.

static int Anasazi::MultiVecTraits< double, Epetra_MultiVector >::GetNumberVecs ( const Epetra_MultiVector mv) [inline, static]

Obtain the number of vectors in mv.

Definition at line 1008 of file AnasaziEpetraAdapter.hpp.

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 
) [inline, static]

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

Definition at line 1020 of file AnasaziEpetraAdapter.hpp.

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

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

Definition at line 1033 of file AnasaziEpetraAdapter.hpp.

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

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

Definition at line 1090 of file AnasaziEpetraAdapter.hpp.

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

Compute a vector b where the components are the individual dot-products of the i-th columns of A and mv, i.e. $b[i] = A[i]^Tmv[i]$.

Definition at line 1105 of file AnasaziEpetraAdapter.hpp.

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

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

Definition at line 1128 of file AnasaziEpetraAdapter.hpp.

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

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

Definition at line 1145 of file AnasaziEpetraAdapter.hpp.

static void Anasazi::MultiVecTraits< double, Epetra_MultiVector >::MvScale ( Epetra_MultiVector mv,
double  alpha 
) [inline, static]

Scale each element of the vectors in mv with alpha.

Definition at line 1291 of file AnasaziEpetraAdapter.hpp.

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

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

Definition at line 1299 of file AnasaziEpetraAdapter.hpp.

static void Anasazi::MultiVecTraits< double, Epetra_MultiVector >::MvRandom ( Epetra_MultiVector mv) [inline, static]

Replace the vectors in mv with random vectors.

Definition at line 1315 of file AnasaziEpetraAdapter.hpp.

static void Anasazi::MultiVecTraits< double, Epetra_MultiVector >::MvInit ( Epetra_MultiVector mv,
double  alpha = Teuchos::ScalarTraits<double>::zero() 
) [inline, static]

Replace each element of the vectors in mv with alpha.

Definition at line 1323 of file AnasaziEpetraAdapter.hpp.

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

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

Definition at line 1336 of file AnasaziEpetraAdapter.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends