PyTrilinos::Anasazi::EigenproblemEpetra Class Reference

Inheritance diagram for PyTrilinos::Anasazi::EigenproblemEpetra:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::Anasazi::EigenproblemEpetra:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def setOperator
def setA
def setM
def setPrec
def setInitVec
def setAuxVecs
def setNEV
def setHermitian
def setProblem
def setSolution
def getOperator
def getA
def getM
def getPrec
def getInitVec
def getAuxVecs
def getNEV
def isHermitian
def isProblemSet
def getSolution
def __init__
def setOperator
def setA
def setM
def setPrec
def setInitVec
def setAuxVecs
def setNEV
def setHermitian
def setProblem
def setSolution
def getOperator
def getA
def getM
def getPrec
def getInitVec
def getAuxVecs
def getNEV
def isHermitian
def isProblemSet
def getSolution


Detailed Description

This class defines the interface required by an eigensolver and status
test class to compute solutions to an eigenproblem.

C++ includes: AnasaziEigenproblem.hpp 

Member Function Documentation

def PyTrilinos::Anasazi::EigenproblemEpetra::getA (   self,
  args 
)

getA(self) -> Teuchos::RCP<(q(const).Epetra_Operator)>

virtual
Teuchos::RCP<const OP> Anasazi::Eigenproblem< ScalarType, MV, OP
>::getA() const =0

Get a pointer to the operator A of the eigenproblem $AX=\\lambda
Mx$. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getA (   self,
  args 
)

getA(self) -> Teuchos::RCP<(q(const).Epetra_Operator)>

virtual
Teuchos::RCP<const OP> Anasazi::Eigenproblem< ScalarType, MV, OP
>::getA() const =0

Get a pointer to the operator A of the eigenproblem $AX=\\lambda
Mx$. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getAuxVecs (   self,
  args 
)

getAuxVecs(self) -> Teuchos::RCP<(q(const).Epetra_MultiVector)>

virtual
Teuchos::RCP<const MV> Anasazi::Eigenproblem< ScalarType, MV, OP
>::getAuxVecs() const =0

Get a pointer to the auxiliary vector. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getAuxVecs (   self,
  args 
)

getAuxVecs(self) -> Teuchos::RCP<(q(const).Epetra_MultiVector)>

virtual
Teuchos::RCP<const MV> Anasazi::Eigenproblem< ScalarType, MV, OP
>::getAuxVecs() const =0

Get a pointer to the auxiliary vector. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getInitVec (   self,
  args 
)

getInitVec(self) -> Teuchos::RCP<(q(const).Epetra_MultiVector)>

virtual
Teuchos::RCP<const MV> Anasazi::Eigenproblem< ScalarType, MV, OP
>::getInitVec() const =0

Get a pointer to the initial vector. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getInitVec (   self,
  args 
)

getInitVec(self) -> Teuchos::RCP<(q(const).Epetra_MultiVector)>

virtual
Teuchos::RCP<const MV> Anasazi::Eigenproblem< ScalarType, MV, OP
>::getInitVec() const =0

Get a pointer to the initial vector. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getM (   self,
  args 
)

getM(self) -> Teuchos::RCP<(q(const).Epetra_Operator)>

virtual
Teuchos::RCP<const OP> Anasazi::Eigenproblem< ScalarType, MV, OP
>::getM() const =0

Get a pointer to the operator M of the eigenproblem $AX=\\lambda
Mx$. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getM (   self,
  args 
)

getM(self) -> Teuchos::RCP<(q(const).Epetra_Operator)>

virtual
Teuchos::RCP<const OP> Anasazi::Eigenproblem< ScalarType, MV, OP
>::getM() const =0

Get a pointer to the operator M of the eigenproblem $AX=\\lambda
Mx$. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getNEV (   self,
  args 
)

getNEV(self) -> int

virtual int
Anasazi::Eigenproblem< ScalarType, MV, OP >::getNEV() const =0

Get the number of eigenvalues (NEV) that are required by this
eigenproblem. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getNEV (   self,
  args 
)

getNEV(self) -> int

virtual int
Anasazi::Eigenproblem< ScalarType, MV, OP >::getNEV() const =0

Get the number of eigenvalues (NEV) that are required by this
eigenproblem. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getOperator (   self,
  args 
)

getOperator(self) -> Teuchos::RCP<(q(const).Epetra_Operator)>

virtual
Teuchos::RCP<const OP> Anasazi::Eigenproblem< ScalarType, MV, OP
>::getOperator() const =0

Get a pointer to the operator for which eigenvalues will be computed.

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getOperator (   self,
  args 
)

getOperator(self) -> Teuchos::RCP<(q(const).Epetra_Operator)>

virtual
Teuchos::RCP<const OP> Anasazi::Eigenproblem< ScalarType, MV, OP
>::getOperator() const =0

Get a pointer to the operator for which eigenvalues will be computed.

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getPrec (   self,
  args 
)

getPrec(self) -> Teuchos::RCP<(q(const).Epetra_Operator)>

virtual
Teuchos::RCP<const OP> Anasazi::Eigenproblem< ScalarType, MV, OP
>::getPrec() const =0

Get a pointer to the preconditioner. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getPrec (   self,
  args 
)

getPrec(self) -> Teuchos::RCP<(q(const).Epetra_Operator)>

virtual
Teuchos::RCP<const OP> Anasazi::Eigenproblem< ScalarType, MV, OP
>::getPrec() const =0

Get a pointer to the preconditioner. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getSolution (   self,
  args 
)

getSolution(self) -> EigensolutionEpetra

virtual
const Eigensolution<ScalarType,MV>& Anasazi::Eigenproblem< ScalarType,
MV, OP >::getSolution() const =0

Get the solution to the eigenproblem.

There is no computation associated with this method. It only provides
a mechanism for associating an Eigensolution with a Eigenproblem. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::getSolution (   self,
  args 
)

getSolution(self) -> EigensolutionEpetra

virtual
const Eigensolution<ScalarType,MV>& Anasazi::Eigenproblem< ScalarType,
MV, OP >::getSolution() const =0

Get the solution to the eigenproblem.

There is no computation associated with this method. It only provides
a mechanism for associating an Eigensolution with a Eigenproblem. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::isHermitian (   self,
  args 
)

isHermitian(self) -> bool

virtual
bool Anasazi::Eigenproblem< ScalarType, MV, OP >::isHermitian() const
=0

Get the symmetry information for this eigenproblem. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::isHermitian (   self,
  args 
)

isHermitian(self) -> bool

virtual
bool Anasazi::Eigenproblem< ScalarType, MV, OP >::isHermitian() const
=0

Get the symmetry information for this eigenproblem. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::isProblemSet (   self,
  args 
)

isProblemSet(self) -> bool

virtual
bool Anasazi::Eigenproblem< ScalarType, MV, OP >::isProblemSet() const
=0

If the problem has been set, this method will return true. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::isProblemSet (   self,
  args 
)

isProblemSet(self) -> bool

virtual
bool Anasazi::Eigenproblem< ScalarType, MV, OP >::isProblemSet() const
=0

If the problem has been set, this method will return true. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setA (   self,
  args 
)

setA(self, Teuchos::RCP<(q(const).Epetra_Operator)> A)

virtual void
Anasazi::Eigenproblem< ScalarType, MV, OP >::setA(const Teuchos::RCP<
const OP > &A)=0

Set the operator A of the eigenvalue problem $Ax=\\lambda Mx$. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setA (   self,
  args 
)

setA(self, Teuchos::RCP<(q(const).Epetra_Operator)> A)

virtual void
Anasazi::Eigenproblem< ScalarType, MV, OP >::setA(const Teuchos::RCP<
const OP > &A)=0

Set the operator A of the eigenvalue problem $Ax=\\lambda Mx$. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setAuxVecs (   self,
  args 
)

setAuxVecs(self, Teuchos::RCP<(q(const).Epetra_MultiVector)> AuxVecs)

virtual
void Anasazi::Eigenproblem< ScalarType, MV, OP >::setAuxVecs(const
Teuchos::RCP< const MV > &AuxVecs)=0

Set auxiliary vectors.

This multivector can have any number of columns, and most likely will
contain vectors that will be used by the eigensolver to orthogonalize
against. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setAuxVecs (   self,
  args 
)

setAuxVecs(self, Teuchos::RCP<(q(const).Epetra_MultiVector)> AuxVecs)

virtual
void Anasazi::Eigenproblem< ScalarType, MV, OP >::setAuxVecs(const
Teuchos::RCP< const MV > &AuxVecs)=0

Set auxiliary vectors.

This multivector can have any number of columns, and most likely will
contain vectors that will be used by the eigensolver to orthogonalize
against. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setHermitian (   self,
  args 
)

setHermitian(self, bool isSym)

virtual
void Anasazi::Eigenproblem< ScalarType, MV, OP >::setHermitian(bool
isSym)=0

Specify the symmetry of the eigenproblem.

This knowledge may allow the solver to take advantage of the
eigenproblems' symmetry. Some computational work may be avoided by
setting this properly. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setHermitian (   self,
  args 
)

setHermitian(self, bool isSym)

virtual
void Anasazi::Eigenproblem< ScalarType, MV, OP >::setHermitian(bool
isSym)=0

Specify the symmetry of the eigenproblem.

This knowledge may allow the solver to take advantage of the
eigenproblems' symmetry. Some computational work may be avoided by
setting this properly. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setInitVec (   self,
  args 
)

setInitVec(self, Teuchos::RCP<(Epetra_MultiVector)> InitVec)

virtual
void Anasazi::Eigenproblem< ScalarType, MV, OP >::setInitVec(const
Teuchos::RCP< MV > &InitVec)=0

Set the initial guess.

This multivector should have the same number of columns as the
blocksize. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setInitVec (   self,
  args 
)

setInitVec(self, Teuchos::RCP<(Epetra_MultiVector)> InitVec)

virtual
void Anasazi::Eigenproblem< ScalarType, MV, OP >::setInitVec(const
Teuchos::RCP< MV > &InitVec)=0

Set the initial guess.

This multivector should have the same number of columns as the
blocksize. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setM (   self,
  args 
)

setM(self, Teuchos::RCP<(q(const).Epetra_Operator)> M)

virtual void
Anasazi::Eigenproblem< ScalarType, MV, OP >::setM(const Teuchos::RCP<
const OP > &M)=0

Set the operator M of the eigenvalue problem $Ax=\\lambda Mx$. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setM (   self,
  args 
)

setM(self, Teuchos::RCP<(q(const).Epetra_Operator)> M)

virtual void
Anasazi::Eigenproblem< ScalarType, MV, OP >::setM(const Teuchos::RCP<
const OP > &M)=0

Set the operator M of the eigenvalue problem $Ax=\\lambda Mx$. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setNEV (   self,
  args 
)

setNEV(self, int nev)

virtual void
Anasazi::Eigenproblem< ScalarType, MV, OP >::setNEV(int nev)=0

The number of eigenvalues (NEV) that are requested. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setNEV (   self,
  args 
)

setNEV(self, int nev)

virtual void
Anasazi::Eigenproblem< ScalarType, MV, OP >::setNEV(int nev)=0

The number of eigenvalues (NEV) that are requested. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setOperator (   self,
  args 
)

setOperator(self, Teuchos::RCP<(q(const).Epetra_Operator)> Op)

virtual
void Anasazi::Eigenproblem< ScalarType, MV, OP >::setOperator(const
Teuchos::RCP< const OP > &Op)=0

Set the operator for which eigenvalues will be computed.

This may be different from the A if a spectral transformation is
employed. For example, this operator may apply the operation
$(A-\\sigma I)^{-1}$ if you are looking for eigenvalues of A around
$\\sigma$. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setOperator (   self,
  args 
)

setOperator(self, Teuchos::RCP<(q(const).Epetra_Operator)> Op)

virtual
void Anasazi::Eigenproblem< ScalarType, MV, OP >::setOperator(const
Teuchos::RCP< const OP > &Op)=0

Set the operator for which eigenvalues will be computed.

This may be different from the A if a spectral transformation is
employed. For example, this operator may apply the operation
$(A-\\sigma I)^{-1}$ if you are looking for eigenvalues of A around
$\\sigma$. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setPrec (   self,
  args 
)

setPrec(self, Teuchos::RCP<(q(const).Epetra_Operator)> Prec)

virtual void
Anasazi::Eigenproblem< ScalarType, MV, OP >::setPrec(const
Teuchos::RCP< const OP > &Prec)=0

Set the preconditioner for this eigenvalue problem $Ax=\\lambda Mx$.

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setPrec (   self,
  args 
)

setPrec(self, Teuchos::RCP<(q(const).Epetra_Operator)> Prec)

virtual void
Anasazi::Eigenproblem< ScalarType, MV, OP >::setPrec(const
Teuchos::RCP< const OP > &Prec)=0

Set the preconditioner for this eigenvalue problem $Ax=\\lambda Mx$.

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setProblem (   self,
  args 
)

setProblem(self) -> bool

virtual
bool Anasazi::Eigenproblem< ScalarType, MV, OP >::setProblem()=0

Specify that this eigenproblem is fully defined.

This routine serves multiple purpose: sanity check that the
eigenproblem has been fully and consistently defined

opportunity for the eigenproblem to allocate internal storage for
eigenvalues and eigenvectors (to be used by eigensolvers and solver
managers)

The user MUST call this routine before they send the eigenproblem to
any solver or solver manager.

true signifies success, false signifies error. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setProblem (   self,
  args 
)

setProblem(self) -> bool

virtual
bool Anasazi::Eigenproblem< ScalarType, MV, OP >::setProblem()=0

Specify that this eigenproblem is fully defined.

This routine serves multiple purpose: sanity check that the
eigenproblem has been fully and consistently defined

opportunity for the eigenproblem to allocate internal storage for
eigenvalues and eigenvectors (to be used by eigensolvers and solver
managers)

The user MUST call this routine before they send the eigenproblem to
any solver or solver manager.

true signifies success, false signifies error. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setSolution (   self,
  args 
)

setSolution(self, EigensolutionEpetra sol)

virtual
void Anasazi::Eigenproblem< ScalarType, MV, OP >::setSolution(const
Eigensolution< ScalarType, MV > &sol)=0

Set the solution to the eigenproblem.

This mechanism allows an Eigensolution struct to be associated with an
Eigenproblem object. setSolution() is usually called by a solver
manager at the end of its SolverManager::solve() routine. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.

def PyTrilinos::Anasazi::EigenproblemEpetra::setSolution (   self,
  args 
)

setSolution(self, EigensolutionEpetra sol)

virtual
void Anasazi::Eigenproblem< ScalarType, MV, OP >::setSolution(const
Eigensolution< ScalarType, MV > &sol)=0

Set the solution to the eigenproblem.

This mechanism allows an Eigensolution struct to be associated with an
Eigenproblem object. setSolution() is usually called by a solver
manager at the end of its SolverManager::solve() routine. 

Reimplemented in PyTrilinos::Anasazi::BasicEigenproblemEpetra, and PyTrilinos::Anasazi::BasicEigenproblemEpetra.


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

Generated on Thu Dec 17 11:00:19 2009 for PyTrilinos by  doxygen 1.5.9