PyTrilinos.Anasazi.StatusTestEpetra Class Reference

Inheritance diagram for PyTrilinos.Anasazi.StatusTestEpetra:

Collaboration diagram for PyTrilinos.Anasazi.StatusTestEpetra:

List of all members.

Public Member Functions
def	__init__
def	checkStatus
def	getStatus
def	whichVecs
def	howMany
def	reset
def	clearStatus

---

Detailed Description

A pure virtual class for defining the status tests for the ::Anasazi
iterative solvers.

StatusTest is an interface that can be implemented to create
convergence tests for all Anasazi solvers. Almost any kind of test can
be expressed using this mechanism, including composite tests (see
StatusTestCombo).

C++ includes: AnasaziStatusTestDecl.hpp 

---

Member Function Documentation

def PyTrilinos.Anasazi.StatusTestEpetra.checkStatus	(		self,
			args
	)

checkStatus(StatusTestEpetra self, EigensolverEpetra solver) -> Anasazi::TestStatus

virtual
TestStatus Anasazi::StatusTest< ScalarType, MV, OP
>::checkStatus(Eigensolver< ScalarType, MV, OP > *solver)=0

Check status as defined by test.

TestStatus indicating whether the test passed or failed. 

Reimplemented in PyTrilinos.Anasazi.StatusTestResNormEpetra, PyTrilinos.Anasazi.StatusTestOutputEpetra, PyTrilinos.Anasazi.StatusTestMaxItersEpetra, and PyTrilinos.Anasazi.StatusTestComboEpetra.

def PyTrilinos.Anasazi.StatusTestEpetra.clearStatus	(		self,
			args
	)

clearStatus(StatusTestEpetra self)

virtual void
Anasazi::StatusTest< ScalarType, MV, OP >::clearStatus()=0

Clears the results of the last status test.

This should be distinguished from the reset() method, as it only
clears the cached result from the last status test, so that a call to
getStatus() will return ::Undefined. This is necessary for the SEQOR
and SEQAND tests in the StatusTestCombo class, which may short circuit
and not evaluate all of the StatusTests contained in them. 

Reimplemented in PyTrilinos.Anasazi.StatusTestResNormEpetra, PyTrilinos.Anasazi.StatusTestOutputEpetra, PyTrilinos.Anasazi.StatusTestMaxItersEpetra, and PyTrilinos.Anasazi.StatusTestComboEpetra.

def PyTrilinos.Anasazi.StatusTestEpetra.getStatus	(		self,
			args
	)

getStatus(StatusTestEpetra self) -> Anasazi::TestStatus

virtual
TestStatus Anasazi::StatusTest< ScalarType, MV, OP >::getStatus()
const =0

Return the result of the most recent checkStatus call, or undefined if
it has not been run. 

Reimplemented in PyTrilinos.Anasazi.StatusTestResNormEpetra, PyTrilinos.Anasazi.StatusTestOutputEpetra, PyTrilinos.Anasazi.StatusTestMaxItersEpetra, and PyTrilinos.Anasazi.StatusTestComboEpetra.

def PyTrilinos.Anasazi.StatusTestEpetra.howMany	(		self,
			args
	)

howMany(StatusTestEpetra self) -> int

virtual int
Anasazi::StatusTest< ScalarType, MV, OP >::howMany() const =0

Get the number of vectors that passed the test. 

Reimplemented in PyTrilinos.Anasazi.StatusTestResNormEpetra, PyTrilinos.Anasazi.StatusTestOutputEpetra, PyTrilinos.Anasazi.StatusTestMaxItersEpetra, and PyTrilinos.Anasazi.StatusTestComboEpetra.

def PyTrilinos.Anasazi.StatusTestEpetra.reset	(		self,
			args
	)

reset(StatusTestEpetra self)

virtual void
Anasazi::StatusTest< ScalarType, MV, OP >::reset()=0

Informs the status test that it should reset its internal
configuration to the uninitialized state.

This is necessary for the case when the status test is being reused by
another solver or for another eigenvalue problem. The status test may
have information that pertains to a particular problem or solver
state. The internal information will be reset back to the
uninitialized state. The user specified information that the
convergence test uses will remain. 

Reimplemented in PyTrilinos.Anasazi.StatusTestResNormEpetra, PyTrilinos.Anasazi.StatusTestOutputEpetra, PyTrilinos.Anasazi.StatusTestMaxItersEpetra, and PyTrilinos.Anasazi.StatusTestComboEpetra.

def PyTrilinos.Anasazi.StatusTestEpetra.whichVecs	(		self,
			args
	)

whichVecs(StatusTestEpetra self) -> VectorInt

virtual
std::vector<int> Anasazi::StatusTest< ScalarType, MV, OP
>::whichVecs() const =0

Get the indices for the vectors that passed the test. 

Reimplemented in PyTrilinos.Anasazi.StatusTestResNormEpetra, PyTrilinos.Anasazi.StatusTestOutputEpetra, PyTrilinos.Anasazi.StatusTestMaxItersEpetra, and PyTrilinos.Anasazi.StatusTestComboEpetra.

---

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

• Anasazi.py