Inheritance diagram for PyTrilinos.Anasazi.StatusTestOutputEpetra:

Collaboration diagram for PyTrilinos.Anasazi.StatusTestOutputEpetra:

Public Member Functions
def	__init__
def	checkStatus
def	getStatus
def	whichVecs
def	howMany
def	setChild
def	getChild
def	reset
def	clearStatus
Public Attributes
	this

Detailed Description

A special StatusTest for printing other status tests.

StatusTestOutput is a wrapper around another StatusTest that calls
StatusTest::print() on the underlying object on calls to
StatusTestOutput::checkStatus(). The frequency and occasion of the
printing can be dictated according to some parameters passed to
StatusTestOutput::StatusTestOutput().

C++ includes: AnasaziStatusTestOutput.hpp

Constructor & Destructor Documentation

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

__init__(Anasazi::StatusTestOutput<(double,Epetra_MultiVector,Epetra_Operator)> self, Teuchos::RCP< Anasazi::OutputManager< double > > const & printer, Teuchos::RCP< Anasazi::StatusTest< double,Epetra_MultiVector,Epetra_Operator > > test, 
    int mod=1, 
    int printStates=Passed) -> StatusTestOutputEpetra

Anasazi::StatusTestOutput< ScalarType, MV, OP
>::StatusTestOutput(const Teuchos::RCP< OutputManager< ScalarType > >
&printer, Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test, int
mod=1, int printStates=Passed)

Constructor.

The StatusTestOutput requires an OutputManager for printing the
underlying StatusTest on calls to checkStatus(), as well as an
underlying StatusTest.

StatusTestOutput can be initialized with a null pointer for argument
test. However, calling checkStatus() with a null child pointer will
result in a StatusTestError exception being thrown. See checkStatus()
for more information.

The last two parameters, described below, in addition to the verbosity
level of the OutputManager, control when printing is called. When both
the mod criterion and the printStates criterion are satisfied, the
status test will be printed to the OutputManager with ::MsgType of
::StatusTestDetails.

Parameters:
-----------

mod:  A positive number describes how often the output should be
printed. On every call to checkStatus(), an internal counter is
incremented. Printing may only occur when this counter is congruent to
zero modulo mod. Default: 1 (attempt to print on every call to
checkStatus())

printStates:  A combination of ::TestStatus values for which the
output may be printed. Default: ::Passed (attempt to print whenever
checkStatus() will return ::Passed)

Member Function Documentation

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

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

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

Check and return status of underlying StatusTest.

This method calls checkStatus() on the StatusTest object passed in the
constructor. If appropriate, the method will follow this call with a
call to print() on the underlying object, using the OutputManager
passed via the constructor with verbosity level ::StatusTestDetails.

The internal counter will be incremented during this call, but only
after performing the tests to decide whether or not to print the
underlying StatusTest. This way, the very first call to checkStatus()
following initialization or reset() will enable the underlying
StatusTest to be printed, regardless of the mod parameter, as the
current number of calls will be zero.

If the specified Teuchos::RCP for the child class is Teuchos::null,
then calling checkStatus() will result in a StatusTestError exception
being thrown.

::TestStatus indicating whether the underlying test passed or failed.

Reimplemented from PyTrilinos.Anasazi.StatusTestEpetra.

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

clearStatus(StatusTestOutputEpetra self)

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

Clears the results of the last status test. This resets the cached
state to an ::Undefined state and calls clearStatus() on the
underlying test.

Reimplemented from PyTrilinos.Anasazi.StatusTestEpetra.

def PyTrilinos.Anasazi.StatusTestOutputEpetra.getChild	(	self,
		args
	)

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

Teuchos::RCP<StatusTest<ScalarType,MV,OP> > Anasazi::StatusTestOutput<
ScalarType, MV, OP >::getChild() const

Get child test.

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

getStatus(StatusTestOutputEpetra self) -> Anasazi::TestStatus

TestStatus Anasazi::StatusTestOutput< 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.StatusTestOutputEpetra.howMany	(	self,
		args
	)

howMany(StatusTestOutputEpetra self) -> int

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

Get the number of vectors that passed the test.

Reimplemented from PyTrilinos.Anasazi.StatusTestEpetra.

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

reset(StatusTestOutputEpetra self)

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

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

This resets the cached state to an ::Undefined state and calls reset()
on the underlying test. It also resets the counter for the number of
calls to checkStatus().

Reimplemented from PyTrilinos.Anasazi.StatusTestEpetra.

def PyTrilinos.Anasazi.StatusTestOutputEpetra.setChild	(	self,
		args
	)

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

void
Anasazi::StatusTestOutput< ScalarType, MV, OP
>::setChild(Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test)

Set child test.

This also resets the test status to ::Undefined.

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

whichVecs(StatusTestOutputEpetra self) -> VectorInt

std::vector<int> Anasazi::StatusTestOutput< 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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation