Inheritance diagram for PyTrilinos.Anasazi.StatusTestResNormEpetra:

Collaboration diagram for PyTrilinos.Anasazi.StatusTestResNormEpetra:

Public Member Functions
def	__init__
def	checkStatus
def	getStatus
def	whichVecs
def	howMany
def	setQuorum
def	getQuorum
def	setTolerance
def	getTolerance
def	setWhichNorm
def	getWhichNorm
def	setScale
def	getScale
def	reset
def	clearStatus
Public Attributes
	this
Static Public Attributes
	RES_ORTH = _Anasazi.StatusTestResNormEpetra_RES_ORTH
	RES_2NORM = _Anasazi.StatusTestResNormEpetra_RES_2NORM
	RITZRES_2NORM = _Anasazi.StatusTestResNormEpetra_RITZRES_2NORM

Detailed Description

A status test for testing the norm of the eigenvectors residuals.

StatusTestResNorm was designed to be used as a test for convergence.
The tester compares the norms of the residual vectors against a user
specified tolerance.

In addition to specifying the tolerance, the user may specify: the
norm to be used: 2-norm or OrthoManager::norm() or
Eigensolver::getRitzRes2Norms()

the scale: absolute or relative to magnitude of Ritz value

the quorum: the number of vectors required for the test to evaluate as
::Passed.

C++ includes: AnasaziStatusTestResNorm.hpp

Constructor & Destructor Documentation

def PyTrilinos.Anasazi.StatusTestResNormEpetra.__init__	(	self,
		args
	)

__init__(Anasazi::StatusTestResNorm<(double,Epetra_MultiVector,Epetra_Operator)> self, Teuchos::ScalarTraits< double >::magnitudeType tol, int quorum=-1, Anasazi::StatusTestResNorm< double,Epetra_MultiVector,Epetra_Operator >::ResType whichNorm=Anasazi::StatusTestResNorm< double,Epetra_MultiVector,Epetra_Operator >::RES_ORTH, 
    bool scaled=True, 
    bool throwExceptionOnNaN=True) -> StatusTestResNormEpetra

Anasazi::StatusTestResNorm< ScalarType, MV, OP
>::StatusTestResNorm(typename Teuchos::ScalarTraits< ScalarType
>::magnitudeType tol, int quorum=-1, ResType whichNorm=RES_ORTH, bool
scaled=true, bool throwExceptionOnNaN=true)

Constructor.

Member Function Documentation

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

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

TestStatus Anasazi::StatusTestResNorm< ScalarType, MV, OP
>::checkStatus(Eigensolver< ScalarType, MV, OP > *solver)

Check status as defined by test.

TestStatus indicating whether the test passed or failed.

Reimplemented from PyTrilinos.Anasazi.StatusTestEpetra.

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

clearStatus(StatusTestResNormEpetra self)

void
Anasazi::StatusTestResNorm< ScalarType, MV, OP >::clearStatus()

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

def PyTrilinos.Anasazi.StatusTestResNormEpetra.getQuorum	(	self,
		args
	)

getQuorum(StatusTestResNormEpetra self) -> int

int
Anasazi::StatusTestResNorm< ScalarType, MV, OP >::getQuorum() const

Get quorum.

def PyTrilinos.Anasazi.StatusTestResNormEpetra.getScale	(	self,
		args
	)

getScale(StatusTestResNormEpetra self) -> bool

bool
Anasazi::StatusTestResNorm< ScalarType, MV, OP >::getScale()

Returns true if the test scales the norms by the eigenvalue estimates
(relative scale).

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

getStatus(StatusTestResNormEpetra self) -> Anasazi::TestStatus

TestStatus Anasazi::StatusTestResNorm< ScalarType, MV, OP
>::getStatus() const

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

Reimplemented from PyTrilinos.Anasazi.StatusTestEpetra.

def PyTrilinos.Anasazi.StatusTestResNormEpetra.getTolerance	(	self,
		args
	)

getTolerance(StatusTestResNormEpetra self) -> Teuchos::ScalarTraits< double >::magnitudeType

Teuchos::ScalarTraits<ScalarType>::magnitudeType
Anasazi::StatusTestResNorm< ScalarType, MV, OP >::getTolerance()

Get tolerance.

def PyTrilinos.Anasazi.StatusTestResNormEpetra.getWhichNorm	(	self,
		args
	)

getWhichNorm(StatusTestResNormEpetra self) -> Anasazi::StatusTestResNorm< double,Epetra_MultiVector,Epetra_Operator >::ResType

ResType Anasazi::StatusTestResNorm< ScalarType, MV, OP
>::getWhichNorm()

Return the residual norm used by the status test.

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

howMany(StatusTestResNormEpetra self) -> int

int
Anasazi::StatusTestResNorm< ScalarType, MV, OP >::howMany() const

Get the number of vectors that passed the test.

Reimplemented from PyTrilinos.Anasazi.StatusTestEpetra.

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

reset(StatusTestResNormEpetra self)

void
Anasazi::StatusTestResNorm< ScalarType, MV, OP >::reset()

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

def PyTrilinos.Anasazi.StatusTestResNormEpetra.setQuorum	(	self,
		args
	)

setQuorum(StatusTestResNormEpetra self, int quorum)

void
Anasazi::StatusTestResNorm< ScalarType, MV, OP >::setQuorum(int
quorum)

Set quorum.

Setting quorum to -1 signifies that all residuals from the solver must
meet the tolerance. This also resets the test status to ::Undefined.

def PyTrilinos.Anasazi.StatusTestResNormEpetra.setScale	(	self,
		args
	)

setScale(StatusTestResNormEpetra self, bool relscale)

void
Anasazi::StatusTestResNorm< ScalarType, MV, OP >::setScale(bool
relscale)

Instruct test to scale norms by eigenvalue estimates (relative scale).
This also resets the test status to ::Undefined.

def PyTrilinos.Anasazi.StatusTestResNormEpetra.setTolerance	(	self,
		args
	)

setTolerance(StatusTestResNormEpetra self, Teuchos::ScalarTraits< double >::magnitudeType tol)

void
Anasazi::StatusTestResNorm< ScalarType, MV, OP
>::setTolerance(typename Teuchos::ScalarTraits< ScalarType
>::magnitudeType tol)

Set tolerance. This also resets the test status to ::Undefined.

def PyTrilinos.Anasazi.StatusTestResNormEpetra.setWhichNorm	(	self,
		args
	)

setWhichNorm(StatusTestResNormEpetra self, Anasazi::StatusTestResNorm< double,Epetra_MultiVector,Epetra_Operator >::ResType whichNorm)

void
Anasazi::StatusTestResNorm< ScalarType, MV, OP >::setWhichNorm(ResType
whichNorm)

Set the residual norm to be used by the status test.

This also resets the test status to ::Undefined.

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

whichVecs(StatusTestResNormEpetra self) -> VectorInt

std::vector<int> Anasazi::StatusTestResNorm< ScalarType, MV, OP
>::whichVecs() const

Get the indices for the vectors that passed the test.

Reimplemented from PyTrilinos.Anasazi.StatusTestEpetra.

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

Anasazi.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation