PyTrilinos::Anasazi::BlockKrylovSchurEpetra Class Reference

Inheritance diagram for PyTrilinos::Anasazi::BlockKrylovSchurEpetra:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def iterate
def initialize
def isInitialized
def getState
def getNumIters
def resetNumIters
def getRitzVectors
def getRitzValues
def getRitzIndex
def getResNorms
def getRes2Norms
def getRitzRes2Norms
def setStatusTest
def getStatusTest
def getProblem
def setSize
def setBlockSize
def setStepSize
def setNumRitzVectors
def getStepSize
def getBlockSize
def getNumRitzVectors
def getCurSubspaceDim
def getMaxSubspaceDim
def setAuxVecs
def getAuxVecs
def currentStatus
def isRitzVecsCurrent
def isRitzValsCurrent
def isSchurCurrent
def computeRitzVectors
def computeRitzValues
def computeSchurForm
def __init__
def iterate
def initialize
def isInitialized
def getState
def getNumIters
def resetNumIters
def getRitzVectors
def getRitzValues
def getRitzIndex
def getResNorms
def getRes2Norms
def getRitzRes2Norms
def setStatusTest
def getStatusTest
def getProblem
def setSize
def setBlockSize
def setStepSize
def setNumRitzVectors
def getStepSize
def getBlockSize
def getNumRitzVectors
def getCurSubspaceDim
def getMaxSubspaceDim
def setAuxVecs
def getAuxVecs
def currentStatus
def isRitzVecsCurrent
def isRitzValsCurrent
def isSchurCurrent
def computeRitzVectors
def computeRitzValues
def computeSchurForm

Public Attributes

 this


Detailed Description

This class implements the block Krylov-Schur iteration, for solving
linear eigenvalue problems.

This method is a block version of the iteration presented by G.W.
Stewart in "A Krylov-Schur Algorithm for Large Eigenproblems", SIAM
J. Matrix Anal. Appl., Vol 23(2001), No. 3, pp. 601-614.

Chris Baker, Ulrich Hetmaniuk, Rich Lehoucq, Heidi Thornquist

C++ includes: AnasaziBlockKrylovSchur.hpp 

Member Function Documentation

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

__init__(self, Teuchos::RCP<(Anasazi::Eigenproblem<(double,Epetra_MultiVector,Epetra_Operator)>)> problem, 
    Teuchos::RCP<(Anasazi::SortManager<(Teuchos::ScalarTraits<(double)>::magnitudeType)>)> sorter, 
    Teuchos::RCP<(Anasazi::OutputManager<(double)>)> printer, 
    Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)> tester, 
    Teuchos::RCP<(Anasazi::OrthoManager<(double,Epetra_MultiVector)>)> ortho, 
    ParameterList params) -> BlockKrylovSchurEpetra

Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::BlockKrylovSchur(const Teuchos::RCP< Eigenproblem< ScalarType, MV,
OP > > &problem, const Teuchos::RCP< SortManager< typename
Teuchos::ScalarTraits< ScalarType >::magnitudeType > > &sorter, const
Teuchos::RCP< OutputManager< ScalarType > > &printer, const
Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &tester, const
Teuchos::RCP< OrthoManager< ScalarType, MV > > &ortho,
Teuchos::ParameterList &params)

BlockKrylovSchur constructor with eigenproblem, solver utilities, and
parameter list of solver options.

This constructor takes pointers required by the eigensolver, in
addition to a parameter list of options for the eigensolver. These
options include the following: "Block Size" - an int specifying the
block size used by the algorithm. This can also be specified using the
setBlockSize() method. Default: 1

"Num Blocks" - an int specifying the maximum number of blocks
allocated for the solver basis. Default: 3*problem->getNEV()

"Step Size" - an int specifying how many iterations are performed
between computations of eigenvalues and eigenvectors.  Note: This
parameter is mandatory.

"Number of Ritz Vectors" - an int specifying how many Ritz vectors
are computed on calls to getRitzVectors(). Default: 0

"Print Number of Ritz Values" - an int specifying how many Ritz
values are printed on calls to currentStatus(). Default: "Block
Size" 

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

__init__(self, Teuchos::RCP<(Anasazi::Eigenproblem<(double,Epetra_MultiVector,Epetra_Operator)>)> problem, 
    Teuchos::RCP<(Anasazi::SortManager<(Teuchos::ScalarTraits<(double)>::magnitudeType)>)> sorter, 
    Teuchos::RCP<(Anasazi::OutputManager<(double)>)> printer, 
    Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)> tester, 
    Teuchos::RCP<(Anasazi::OrthoManager<(double,Epetra_MultiVector)>)> ortho, 
    ParameterList params) -> BlockKrylovSchurEpetra

Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::BlockKrylovSchur(const Teuchos::RCP< Eigenproblem< ScalarType, MV,
OP > > &problem, const Teuchos::RCP< SortManager< typename
Teuchos::ScalarTraits< ScalarType >::magnitudeType > > &sorter, const
Teuchos::RCP< OutputManager< ScalarType > > &printer, const
Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &tester, const
Teuchos::RCP< OrthoManager< ScalarType, MV > > &ortho,
Teuchos::ParameterList &params)

BlockKrylovSchur constructor with eigenproblem, solver utilities, and
parameter list of solver options.

This constructor takes pointers required by the eigensolver, in
addition to a parameter list of options for the eigensolver. These
options include the following: "Block Size" - an int specifying the
block size used by the algorithm. This can also be specified using the
setBlockSize() method. Default: 1

"Num Blocks" - an int specifying the maximum number of blocks
allocated for the solver basis. Default: 3*problem->getNEV()

"Step Size" - an int specifying how many iterations are performed
between computations of eigenvalues and eigenvectors.  Note: This
parameter is mandatory.

"Number of Ritz Vectors" - an int specifying how many Ritz vectors
are computed on calls to getRitzVectors(). Default: 0

"Print Number of Ritz Values" - an int specifying how many Ritz
values are printed on calls to currentStatus(). Default: "Block
Size" 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::computeRitzValues (   self,
  args 
)

computeRitzValues(self)

void Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::computeRitzValues()

Compute the Ritz values using the current Krylov factorization. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::computeRitzValues (   self,
  args 
)

computeRitzValues(self)

void Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::computeRitzValues()

Compute the Ritz values using the current Krylov factorization. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::computeRitzVectors (   self,
  args 
)

computeRitzVectors(self)

void Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::computeRitzVectors()

Compute the Ritz vectors using the current Krylov factorization. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::computeRitzVectors (   self,
  args 
)

computeRitzVectors(self)

void Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::computeRitzVectors()

Compute the Ritz vectors using the current Krylov factorization. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::computeSchurForm (   self,
  args 
)

computeSchurForm(self, bool sort = True)

void Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::computeSchurForm(const bool sort=true)

Compute the Schur form of the projected eigenproblem from the current
Krylov factorization. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::computeSchurForm (   self,
  args 
)

computeSchurForm(self, bool sort = True)

void Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::computeSchurForm(const bool sort=true)

Compute the Schur form of the projected eigenproblem from the current
Krylov factorization. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::currentStatus (   self,
  args 
)

currentStatus(self, ostream os)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::currentStatus(std::ostream &os)

This method requests that the solver print out its current status to
screen. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::currentStatus (   self,
  args 
)

currentStatus(self, ostream os)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::currentStatus(std::ostream &os)

This method requests that the solver print out its current status to
screen. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

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

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

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

Get the auxiliary vectors for the solver. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

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

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

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

Get the auxiliary vectors for the solver. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getBlockSize (   self,
  args 
)

getBlockSize(self) -> int

int
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::getBlockSize() const

Get the blocksize to be used by the iterative solver in solving this
eigenproblem. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getBlockSize (   self,
  args 
)

getBlockSize(self) -> int

int
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::getBlockSize() const

Get the blocksize to be used by the iterative solver in solving this
eigenproblem. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getCurSubspaceDim (   self,
  args 
)

getCurSubspaceDim(self) -> int

int Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::getCurSubspaceDim() const

Get the dimension of the search subspace used to generate the current
eigenvectors and eigenvalues.

An integer specifying the rank of the Krylov subspace currently in use
by the eigensolver. If isInitialized() == false, the return is 0. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getCurSubspaceDim (   self,
  args 
)

getCurSubspaceDim(self) -> int

int Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::getCurSubspaceDim() const

Get the dimension of the search subspace used to generate the current
eigenvectors and eigenvalues.

An integer specifying the rank of the Krylov subspace currently in use
by the eigensolver. If isInitialized() == false, the return is 0. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getMaxSubspaceDim (   self,
  args 
)

getMaxSubspaceDim(self) -> int

int Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::getMaxSubspaceDim() const

Get the maximum dimension allocated for the search subspace. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getMaxSubspaceDim (   self,
  args 
)

getMaxSubspaceDim(self) -> int

int Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::getMaxSubspaceDim() const

Get the maximum dimension allocated for the search subspace. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getNumIters (   self,
  args 
)

getNumIters(self) -> int

int
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::getNumIters() const

Get the current iteration count. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getNumIters (   self,
  args 
)

getNumIters(self) -> int

int
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::getNumIters() const

Get the current iteration count. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getNumRitzVectors (   self,
  args 
)

getNumRitzVectors(self) -> int

int Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::getNumRitzVectors() const

Get the number of Ritz vectors to compute. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getNumRitzVectors (   self,
  args 
)

getNumRitzVectors(self) -> int

int Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::getNumRitzVectors() const

Get the number of Ritz vectors to compute. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getProblem (   self,
  args 
)

getProblem(self) -> EigenproblemEpetra

const
Eigenproblem<ScalarType,MV,OP>& Anasazi::BlockKrylovSchur< ScalarType,
MV, OP >::getProblem() const

Get a constant reference to the eigenvalue problem. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getProblem (   self,
  args 
)

getProblem(self) -> EigenproblemEpetra

const
Eigenproblem<ScalarType,MV,OP>& Anasazi::BlockKrylovSchur< ScalarType,
MV, OP >::getProblem() const

Get a constant reference to the eigenvalue problem. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getRes2Norms (   self,
  args 
)

getRes2Norms(self) -> std::vector<(Teuchos::ScalarTraits<(double)>::magnitudeType,std::allocator<(Teuchos::ScalarTraits<(double)>::magnitudeType)>)>

std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType>
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::getRes2Norms()

Get the current residual 2-norms.

Block Krylov-Schur cannot provide this so a zero length vector will be
returned. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getRes2Norms (   self,
  args 
)

getRes2Norms(self) -> std::vector<(Teuchos::ScalarTraits<(double)>::magnitudeType,std::allocator<(Teuchos::ScalarTraits<(double)>::magnitudeType)>)>

std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType>
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::getRes2Norms()

Get the current residual 2-norms.

Block Krylov-Schur cannot provide this so a zero length vector will be
returned. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getResNorms (   self,
  args 
)

getResNorms(self) -> std::vector<(Teuchos::ScalarTraits<(double)>::magnitudeType,std::allocator<(Teuchos::ScalarTraits<(double)>::magnitudeType)>)>

std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType>
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::getResNorms()

Get the current residual norms.

Block Krylov-Schur cannot provide this so a zero length vector will be
returned. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getResNorms (   self,
  args 
)

getResNorms(self) -> std::vector<(Teuchos::ScalarTraits<(double)>::magnitudeType,std::allocator<(Teuchos::ScalarTraits<(double)>::magnitudeType)>)>

std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType>
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::getResNorms()

Get the current residual norms.

Block Krylov-Schur cannot provide this so a zero length vector will be
returned. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getRitzIndex (   self,
  args 
)

getRitzIndex(self) -> VectorInt

std::vector<int> Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::getRitzIndex()

Get the Ritz index vector.

A vector of length not exceeding the maximum dimension of the subspace
containing the index vector for the Ritz values and Ritz vectors, if
they are computed. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getRitzIndex (   self,
  args 
)

getRitzIndex(self) -> VectorInt

std::vector<int> Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::getRitzIndex()

Get the Ritz index vector.

A vector of length not exceeding the maximum dimension of the subspace
containing the index vector for the Ritz values and Ritz vectors, if
they are computed. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getRitzRes2Norms (   self,
  args 
)

getRitzRes2Norms(self) -> std::vector<(Teuchos::ScalarTraits<(double)>::magnitudeType,std::allocator<(Teuchos::ScalarTraits<(double)>::magnitudeType)>)>

std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType>
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::getRitzRes2Norms()

Get the current Ritz residual 2-norms.

A vector of length blockSize containing the 2-norms of the Ritz
residuals. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getRitzRes2Norms (   self,
  args 
)

getRitzRes2Norms(self) -> std::vector<(Teuchos::ScalarTraits<(double)>::magnitudeType,std::allocator<(Teuchos::ScalarTraits<(double)>::magnitudeType)>)>

std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType>
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::getRitzRes2Norms()

Get the current Ritz residual 2-norms.

A vector of length blockSize containing the 2-norms of the Ritz
residuals. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getRitzValues (   self,
  args 
)

getRitzValues(self) -> VectorValueDouble

std::vector<Value<ScalarType> > Anasazi::BlockKrylovSchur< ScalarType,
MV, OP >::getRitzValues()

Get the Ritz values.

A vector of length not exceeding the maximum dimension of the subspace
containing the Ritz values from the most recent Schur form update.

To see if the returned Ritz values are current, call
isRitzValsCurrent(). 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getRitzValues (   self,
  args 
)

getRitzValues(self) -> VectorValueDouble

std::vector<Value<ScalarType> > Anasazi::BlockKrylovSchur< ScalarType,
MV, OP >::getRitzValues()

Get the Ritz values.

A vector of length not exceeding the maximum dimension of the subspace
containing the Ritz values from the most recent Schur form update.

To see if the returned Ritz values are current, call
isRitzValsCurrent(). 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getRitzVectors (   self,
  args 
)

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

Teuchos::RCP<const MV> Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::getRitzVectors()

Get the Ritz vectors.

A multivector of columns not exceeding the maximum dimension of the
subspace containing the Ritz vectors from the most recent call to
computeRitzVectors().

To see if the returned Ritz vectors are current, call
isRitzVecsCurrent(). 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getRitzVectors (   self,
  args 
)

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

Teuchos::RCP<const MV> Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::getRitzVectors()

Get the Ritz vectors.

A multivector of columns not exceeding the maximum dimension of the
subspace containing the Ritz vectors from the most recent call to
computeRitzVectors().

To see if the returned Ritz vectors are current, call
isRitzVecsCurrent(). 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getState (   self,
  args 
)

getState(self) -> Anasazi::BlockKrylovSchurState<(double,Epetra_MultiVector)>

BlockKrylovSchurState<ScalarType,MV> Anasazi::BlockKrylovSchur<
ScalarType, MV, OP >::getState() const

Get the current state of the eigensolver.

The data is only valid if isInitialized() == true.

A BlockKrylovSchurState object containing const pointers to the
current solver state. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getState (   self,
  args 
)

getState(self) -> Anasazi::BlockKrylovSchurState<(double,Epetra_MultiVector)>

BlockKrylovSchurState<ScalarType,MV> Anasazi::BlockKrylovSchur<
ScalarType, MV, OP >::getState() const

Get the current state of the eigensolver.

The data is only valid if isInitialized() == true.

A BlockKrylovSchurState object containing const pointers to the
current solver state. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getStatusTest (   self,
  args 
)

getStatusTest(self) -> Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)>

Teuchos::RCP< StatusTest< ScalarType, MV, OP > >
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::getStatusTest() const

Get the current StatusTest used by the solver. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getStatusTest (   self,
  args 
)

getStatusTest(self) -> Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)>

Teuchos::RCP< StatusTest< ScalarType, MV, OP > >
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::getStatusTest() const

Get the current StatusTest used by the solver. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getStepSize (   self,
  args 
)

getStepSize(self) -> int

int
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::getStepSize() const

Get the step size. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::getStepSize (   self,
  args 
)

getStepSize(self) -> int

int
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::getStepSize() const

Get the step size. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::initialize (   self,
  args 
)

initialize(self, Anasazi::BlockKrylovSchurState<(double,Epetra_MultiVector)> state)
initialize(self)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::initialize()

Initialize the solver with the initial vectors from the eigenproblem
or random data. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::initialize (   self,
  args 
)

initialize(self, Anasazi::BlockKrylovSchurState<(double,Epetra_MultiVector)> state)
initialize(self)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::initialize()

Initialize the solver with the initial vectors from the eigenproblem
or random data. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::isInitialized (   self,
  args 
)

isInitialized(self) -> bool

bool
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::isInitialized() const

Indicates whether the solver has been initialized or not.

bool indicating the state of the solver.

If isInitialized() == true: the first getCurSubspaceDim() vectors of V
are orthogonal to auxiliary vectors and have orthonormal columns

the principal Hessenberg submatrix of of H contains the Hessenberg
matrix associated with V 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::isInitialized (   self,
  args 
)

isInitialized(self) -> bool

bool
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::isInitialized() const

Indicates whether the solver has been initialized or not.

bool indicating the state of the solver.

If isInitialized() == true: the first getCurSubspaceDim() vectors of V
are orthogonal to auxiliary vectors and have orthonormal columns

the principal Hessenberg submatrix of of H contains the Hessenberg
matrix associated with V 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::isRitzValsCurrent (   self,
  args 
)

isRitzValsCurrent(self) -> bool

bool Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::isRitzValsCurrent() const

Get the status of the Ritz values currently stored in the eigensolver.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::isRitzValsCurrent (   self,
  args 
)

isRitzValsCurrent(self) -> bool

bool Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::isRitzValsCurrent() const

Get the status of the Ritz values currently stored in the eigensolver.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::isRitzVecsCurrent (   self,
  args 
)

isRitzVecsCurrent(self) -> bool

bool Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::isRitzVecsCurrent() const

Get the status of the Ritz vectors currently stored in the
eigensolver. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::isRitzVecsCurrent (   self,
  args 
)

isRitzVecsCurrent(self) -> bool

bool Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::isRitzVecsCurrent() const

Get the status of the Ritz vectors currently stored in the
eigensolver. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::isSchurCurrent (   self,
  args 
)

isSchurCurrent(self) -> bool

bool Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::isSchurCurrent()
const

Get the status of the Schur form currently stored in the eigensolver.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::isSchurCurrent (   self,
  args 
)

isSchurCurrent(self) -> bool

bool Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::isSchurCurrent()
const

Get the status of the Schur form currently stored in the eigensolver.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::iterate (   self,
  args 
)

iterate(self)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::iterate()

This method performs Block Krylov-Schur iterations until the status
test indicates the need to stop or an error occurs (in which case, an
exception is thrown).

iterate() will first determine whether the solver is inintialized; if
not, it will call initialize() using default arguments. After
initialization, the solver performs Block Krylov-Schur iterations
until the status test evaluates as Passed, at which point the method
returns to the caller.

The Block Krylov-Schur iteration proceeds as follows: The operator
problem->getOperator() is applied to the newest blockSize vectors in
the Krylov basis.

The resulting vectors are orthogonalized against the auxiliary vectors
and the previous basis vectors, and made orthonormal.

The Hessenberg matrix is updated.

If we have performed stepSize iterations since the last update, update
the Ritz values and Ritz residuals.

The status test is queried at the beginning of the iteration.

Possible exceptions thrown include the BlockKrylovSchurOrthoFailure.

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::iterate (   self,
  args 
)

iterate(self)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::iterate()

This method performs Block Krylov-Schur iterations until the status
test indicates the need to stop or an error occurs (in which case, an
exception is thrown).

iterate() will first determine whether the solver is inintialized; if
not, it will call initialize() using default arguments. After
initialization, the solver performs Block Krylov-Schur iterations
until the status test evaluates as Passed, at which point the method
returns to the caller.

The Block Krylov-Schur iteration proceeds as follows: The operator
problem->getOperator() is applied to the newest blockSize vectors in
the Krylov basis.

The resulting vectors are orthogonalized against the auxiliary vectors
and the previous basis vectors, and made orthonormal.

The Hessenberg matrix is updated.

If we have performed stepSize iterations since the last update, update
the Ritz values and Ritz residuals.

The status test is queried at the beginning of the iteration.

Possible exceptions thrown include the BlockKrylovSchurOrthoFailure.

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::resetNumIters (   self,
  args 
)

resetNumIters(self)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::resetNumIters()

Reset the iteration count. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::resetNumIters (   self,
  args 
)

resetNumIters(self)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::resetNumIters()

Reset the iteration count. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

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

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

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::setAuxVecs(const
Teuchos::Array< Teuchos::RCP< const MV > > &auxvecs)

Set the auxiliary vectors for the solver.

Because the current Krylov subspace cannot be assumed orthogonal to
the new auxiliary vectors, a call to setAuxVecs() will reset the
solver to the uninitialized state. This happens only in the case where
the new auxiliary vectors have a combined dimension of greater than
zero.

In order to preserve the current state, the user will need to extract
it from the solver using getState(), orthogonalize it against the new
auxiliary vectors, and reinitialize using initialize(). 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

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

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

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::setAuxVecs(const
Teuchos::Array< Teuchos::RCP< const MV > > &auxvecs)

Set the auxiliary vectors for the solver.

Because the current Krylov subspace cannot be assumed orthogonal to
the new auxiliary vectors, a call to setAuxVecs() will reset the
solver to the uninitialized state. This happens only in the case where
the new auxiliary vectors have a combined dimension of greater than
zero.

In order to preserve the current state, the user will need to extract
it from the solver using getState(), orthogonalize it against the new
auxiliary vectors, and reinitialize using initialize(). 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::setBlockSize (   self,
  args 
)

setBlockSize(self, int blockSize)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::setBlockSize(int
blockSize)

Set the blocksize. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::setBlockSize (   self,
  args 
)

setBlockSize(self, int blockSize)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::setBlockSize(int
blockSize)

Set the blocksize. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::setNumRitzVectors (   self,
  args 
)

setNumRitzVectors(self, int numRitzVecs)

void Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::setNumRitzVectors(int numRitzVecs)

Set the number of Ritz vectors to compute. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::setNumRitzVectors (   self,
  args 
)

setNumRitzVectors(self, int numRitzVecs)

void Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::setNumRitzVectors(int numRitzVecs)

Set the number of Ritz vectors to compute. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::setSize (   self,
  args 
)

setSize(self, int blockSize, int numBlocks)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::setSize(int
blockSize, int numBlocks)

Set the blocksize and number of blocks to be used by the iterative
solver in solving this eigenproblem.

Changing either the block size or the number of blocks will reset the
solver to an uninitialized state. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::setSize (   self,
  args 
)

setSize(self, int blockSize, int numBlocks)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::setSize(int
blockSize, int numBlocks)

Set the blocksize and number of blocks to be used by the iterative
solver in solving this eigenproblem.

Changing either the block size or the number of blocks will reset the
solver to an uninitialized state. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::setStatusTest (   self,
  args 
)

setStatusTest(self, Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)> test)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::setStatusTest(Teuchos::RCP< StatusTest< ScalarType, MV, OP > >
test)

Set a new StatusTest for the solver. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::setStatusTest (   self,
  args 
)

setStatusTest(self, Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)> test)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP
>::setStatusTest(Teuchos::RCP< StatusTest< ScalarType, MV, OP > >
test)

Set a new StatusTest for the solver. 

Reimplemented from PyTrilinos::Anasazi::EigensolverEpetra.

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::setStepSize (   self,
  args 
)

setStepSize(self, int stepSize)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::setStepSize(int
stepSize)

Set the step size. 

def PyTrilinos::Anasazi::BlockKrylovSchurEpetra::setStepSize (   self,
  args 
)

setStepSize(self, int stepSize)

void
Anasazi::BlockKrylovSchur< ScalarType, MV, OP >::setStepSize(int
stepSize)

Set the step size. 


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

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