PyTrilinos::Anasazi::BasicEigenproblemEpetra Class Reference

Inheritance diagram for PyTrilinos::Anasazi::BasicEigenproblemEpetra:

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

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

Public Attributes

 this


Detailed Description

This provides a basic implementation for defining standard or
generalized eigenvalue problems.

C++ includes: AnasaziBasicEigenproblem.hpp 

Member Function Documentation

def PyTrilinos::Anasazi::BasicEigenproblemEpetra::__init__ (   self,
  args 
)

__init__(self) -> BasicEigenproblemEpetra
__init__(self, Teuchos::RCP<(q(const).Epetra_Operator)> Op, Teuchos::RCP<(Epetra_MultiVector)> InitVec) -> BasicEigenproblemEpetra
__init__(self, Teuchos::RCP<(q(const).Epetra_Operator)> Op, Teuchos::RCP<(q(const).Epetra_Operator)> B, 
    Teuchos::RCP<(Epetra_MultiVector)> InitVec) -> BasicEigenproblemEpetra
__init__(self, BasicEigenproblemEpetra Problem) -> BasicEigenproblemEpetra

Anasazi::BasicEigenproblem< ScalarType, MV, OP
>::BasicEigenproblem(const BasicEigenproblem< ScalarType, MV, OP >
&Problem)

Copy Constructor. 

def PyTrilinos::Anasazi::BasicEigenproblemEpetra::__init__ (   self,
  args 
)

__init__(self) -> BasicEigenproblemEpetra
__init__(self, Teuchos::RCP<(q(const).Epetra_Operator)> Op, Teuchos::RCP<(Epetra_MultiVector)> InitVec) -> BasicEigenproblemEpetra
__init__(self, Teuchos::RCP<(q(const).Epetra_Operator)> Op, Teuchos::RCP<(q(const).Epetra_Operator)> B, 
    Teuchos::RCP<(Epetra_MultiVector)> InitVec) -> BasicEigenproblemEpetra
__init__(self, BasicEigenproblemEpetra Problem) -> BasicEigenproblemEpetra

Anasazi::BasicEigenproblem< ScalarType, MV, OP
>::BasicEigenproblem(const BasicEigenproblem< ScalarType, MV, OP >
&Problem)

Copy Constructor. 

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

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

Teuchos::RCP<const OP> Anasazi::BasicEigenproblem< ScalarType, MV, OP
>::getA() const

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

Teuchos::RCP<const OP> Anasazi::BasicEigenproblem< ScalarType, MV, OP
>::getA() const

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

Teuchos::RCP<const MV> Anasazi::BasicEigenproblem< ScalarType, MV, OP
>::getAuxVecs() const

Get a pointer to the auxiliary vector. 

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

Teuchos::RCP<const MV> Anasazi::BasicEigenproblem< ScalarType, MV, OP
>::getAuxVecs() const

Get a pointer to the auxiliary vector. 

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

Teuchos::RCP<const MV> Anasazi::BasicEigenproblem< ScalarType, MV, OP
>::getInitVec() const

Get a pointer to the initial vector. 

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

Teuchos::RCP<const MV> Anasazi::BasicEigenproblem< ScalarType, MV, OP
>::getInitVec() const

Get a pointer to the initial vector. 

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

Teuchos::RCP<const OP> Anasazi::BasicEigenproblem< ScalarType, MV, OP
>::getM() const

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

Teuchos::RCP<const OP> Anasazi::BasicEigenproblem< ScalarType, MV, OP
>::getM() const

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

getNEV(self) -> int

int
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::getNEV() const

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

getNEV(self) -> int

int
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::getNEV() const

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

Teuchos::RCP<const OP> Anasazi::BasicEigenproblem< ScalarType, MV, OP
>::getOperator() const

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

Teuchos::RCP<const OP> Anasazi::BasicEigenproblem< ScalarType, MV, OP
>::getOperator() const

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

Teuchos::RCP<const OP> Anasazi::BasicEigenproblem< ScalarType, MV, OP
>::getPrec() const

Get a pointer to the preconditioner of the eigenproblem $Ax=\\lambda
Mx$. 

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

Teuchos::RCP<const OP> Anasazi::BasicEigenproblem< ScalarType, MV, OP
>::getPrec() const

Get a pointer to the preconditioner of the eigenproblem $Ax=\\lambda
Mx$. 

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

getSolution(self) -> EigensolutionEpetra

const
Eigensolution<ScalarType,MV>& Anasazi::BasicEigenproblem< ScalarType,
MV, OP >::getSolution() const

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 from PyTrilinos::Anasazi::EigenproblemEpetra.

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

getSolution(self) -> EigensolutionEpetra

const
Eigensolution<ScalarType,MV>& Anasazi::BasicEigenproblem< ScalarType,
MV, OP >::getSolution() const

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 from PyTrilinos::Anasazi::EigenproblemEpetra.

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

isHermitian(self) -> bool

bool
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::isHermitian() const

Get the symmetry information for this eigenproblem. 

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

isHermitian(self) -> bool

bool
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::isHermitian() const

Get the symmetry information for this eigenproblem. 

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

isProblemSet(self) -> bool

bool
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::isProblemSet() const

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

isProblemSet(self) -> bool

bool
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::isProblemSet() const

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setA(const
Teuchos::RCP< const OP > &A)

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setA(const
Teuchos::RCP< const OP > &A)

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setAuxVecs(const
Teuchos::RCP< const MV > &AuxVecs)

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 from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setAuxVecs(const
Teuchos::RCP< const MV > &AuxVecs)

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 from PyTrilinos::Anasazi::EigenproblemEpetra.

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

setHermitian(self, bool isSym)

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setHermitian(bool
isSym)

Specify the symmetry of this eigenproblem.

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

setHermitian(self, bool isSym)

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setHermitian(bool
isSym)

Specify the symmetry of this eigenproblem.

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setInitVec(const
Teuchos::RCP< MV > &InitVec)

Set the initial guess.

This vector is required to create all the space needed by Anasazi to
solve the eigenvalue problem.

Even if an initial guess is not known by the user, an initial vector
must be passed in. 

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setInitVec(const
Teuchos::RCP< MV > &InitVec)

Set the initial guess.

This vector is required to create all the space needed by Anasazi to
solve the eigenvalue problem.

Even if an initial guess is not known by the user, an initial vector
must be passed in. 

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setM(const
Teuchos::RCP< const OP > &M)

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setM(const
Teuchos::RCP< const OP > &M)

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

setNEV(self, int nev)

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setNEV(int nev)

Specify the number of eigenvalues (NEV) that are requested. 

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

setNEV(self, int nev)

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setNEV(int nev)

Specify the number of eigenvalues (NEV) that are requested. 

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setOperator(const
Teuchos::RCP< const OP > &Op)

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 from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setOperator(const
Teuchos::RCP< const OP > &Op)

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 from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setPrec(const
Teuchos::RCP< const OP > &Prec)

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

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

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setPrec(const
Teuchos::RCP< const OP > &Prec)

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

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

setProblem(self) -> bool

bool
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setProblem()

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)

This method reallocates internal storage, so that any previously
retrieved references to internal storage (eigenvectors or eigenvalues)
are invalidated.

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

true signifies success, false signifies error. 

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

setProblem(self) -> bool

bool
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setProblem()

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)

This method reallocates internal storage, so that any previously
retrieved references to internal storage (eigenvectors or eigenvalues)
are invalidated.

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

true signifies success, false signifies error. 

Reimplemented from PyTrilinos::Anasazi::EigenproblemEpetra.

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

setSolution(self, EigensolutionEpetra sol)

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setSolution(const
Eigensolution< ScalarType, MV > &sol)

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 from PyTrilinos::Anasazi::EigenproblemEpetra.

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

setSolution(self, EigensolutionEpetra sol)

void
Anasazi::BasicEigenproblem< ScalarType, MV, OP >::setSolution(const
Eigensolution< ScalarType, MV > &sol)

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 from PyTrilinos::Anasazi::EigenproblemEpetra.


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