Belos::StatusTestOutputFactory< ScalarType, MV, OP > Class Template Reference

A factory class for generating StatusTestOutput objects. More...

#include <BelosStatusTestOutputFactory.hpp>

List of all members.

Public Member Functions

Constructors/destructors
 StatusTestOutputFactory (int outputStyle)
 Constructor.
virtual ~StatusTestOutputFactory ()
 Destructor.
Creation Methods
Teuchos::RCP< StatusTestOutput<
ScalarType, MV, OP > > 
create (const Teuchos::RCP< OutputManager< ScalarType > > &printer, Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test, int mod, int printStates)
 Create the StatusTestOutput object specified by the outputStyle.


Detailed Description

template<class ScalarType, class MV, class OP>
class Belos::StatusTestOutputFactory< ScalarType, MV, OP >

A factory class for generating StatusTestOutput objects.

StatusTestOutputFactory provides a generic interface for generating StatusTestOutput objects that any solver manager can use. This factory removes the logic for selecting which StatusTestOutput class needs to be used from the solver managers. It also hides the generation of new StatusTestOutput classes from the solver managers.

Definition at line 56 of file BelosStatusTestOutputFactory.hpp.


Constructor & Destructor Documentation

template<class ScalarType, class MV, class OP>
Belos::StatusTestOutputFactory< ScalarType, MV, OP >::StatusTestOutputFactory ( int  outputStyle  )  [inline]

Constructor.

The StatusTestOutputFactory generates a StatusTestOutput object that provides a particular style of output, decided by the Belos::OutputType enumeration.

Parameters:
[in] outputStyle A OutputType value which defines the style of output requested by the user.

Definition at line 69 of file BelosStatusTestOutputFactory.hpp.

template<class ScalarType, class MV, class OP>
virtual Belos::StatusTestOutputFactory< ScalarType, MV, OP >::~StatusTestOutputFactory (  )  [inline, virtual]

Destructor.

Definition at line 74 of file BelosStatusTestOutputFactory.hpp.


Member Function Documentation

template<class ScalarType, class MV, class OP>
Teuchos::RCP<StatusTestOutput<ScalarType,MV,OP> > Belos::StatusTestOutputFactory< ScalarType, MV, OP >::create ( const Teuchos::RCP< OutputManager< ScalarType > > &  printer,
Teuchos::RCP< StatusTest< ScalarType, MV, OP > >  test,
int  mod,
int  printStates 
) [inline]

Create the StatusTestOutput object specified by the outputStyle.

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

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:
[in] 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())
[in] printStates A combination of StatusType values for which the output may be printed. Default: Passed (attempt to print whenever checkStatus() will return Passed)

Definition at line 95 of file BelosStatusTestOutputFactory.hpp.


The documentation for this class was generated from the following file:
Generated on Tue Jul 13 09:27:04 2010 for Belos by  doxygen 1.4.7