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

StatusTest implementation that does nothing but outputting. More...

#include <BelosStatusTestOutputter.hpp>

Inheritance diagram for Belos::StatusTestOutputter< ScalarType, MV, OP >:

Inheritance graph
[legend]
List of all members.

Constructors/initializers/accessors

typedef Teuchos::RefCountPtr<
StatusTestResNorm_t
resNormStatusTest_ptr_t
typedef Teuchos::RefCountPtr<
OutputManager< ScalarType > > 
outputManager_ptr_t
void outputFrequency (const int &outputFrequency)
 Set the number of iterations skipped between outputting. A value <=0 means no outputting.
const int & outputFrequency () const
void outputMaxResOnly (const bool &outputMaxResOnly)
 Determine if only max residual is printed or not for active RHS.
const bool & outputMaxResOnly () const
void resString (const std::string &resString)
 Determine if only max residual is printed or not for active RHS.
const std::string & resString () const
void set_resNormStatusTest (const Teuchos::RefCountPtr< StatusTestResNorm_t > &resNormStatusTest)
 Set the residual norm status test object [Required].
Teuchos::RefCountPtr< StatusTestResNorm_tget_resNormStatusTest () const
StatusTestResNorm_tresNormStatusTest ()
const StatusTestResNorm_tresNormStatusTest () const
void set_outputManager (const Teuchos::RefCountPtr< OutputManager< ScalarType > > &outputManager)
 Set the output manager [Required].
Teuchos::RefCountPtr< OutputManager<
ScalarType > > 
get_outputManager () const
OutputManager< ScalarType > & outputManager ()
const OutputManager< ScalarType > & outputManager () const
 StatusTestOutputter (const int outputFrequency=-1, const bool outputMaxResOnly=true, const std::string &resString="||A*x-b||/||b||")
 

Public Types

Public types
typedef Teuchos::ScalarTraits<
ScalarType > 
ST
 
typedef ST::magnitudeType MagnitudeType
 
typedef StatusTestResNorm<
ScalarType, MV, OP > 
StatusTestResNorm_t
 

Public Member Functions

Overridden from StatusTests
StatusType CheckStatus (IterativeSolver< ScalarType, MV, OP > *iSolver)
 .
StatusType GetStatus () const
 .
void Reset ()
 .
bool ResidualVectorRequired () const
 .
ostream & Print (ostream &os, int indent) const
 .

Detailed Description

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

StatusTest implementation that does nothing but outputting.

ToDo: Finish documentation.

Definition at line 52 of file BelosStatusTestOutputter.hpp.


Member Typedef Documentation

template<class ScalarType, class MV, class OP>
typedef Teuchos::ScalarTraits<ScalarType> Belos::StatusTestOutputter< ScalarType, MV, OP >::ST
 

Definition at line 59 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
typedef ST::magnitudeType Belos::StatusTestOutputter< ScalarType, MV, OP >::MagnitudeType
 

Definition at line 61 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
typedef StatusTestResNorm<ScalarType,MV,OP> Belos::StatusTestOutputter< ScalarType, MV, OP >::StatusTestResNorm_t
 

Definition at line 63 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
typedef Teuchos::RefCountPtr< StatusTestResNorm_t > Belos::StatusTestOutputter< ScalarType, MV, OP >::resNormStatusTest_ptr_t
 

Definition at line 79 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
typedef Teuchos::RefCountPtr< OutputManager<ScalarType> > Belos::StatusTestOutputter< ScalarType, MV, OP >::outputManager_ptr_t
 

Definition at line 83 of file BelosStatusTestOutputter.hpp.


Constructor & Destructor Documentation

template<class ScalarType, class MV, class OP>
Belos::StatusTestOutputter< ScalarType, MV, OP >::StatusTestOutputter const int  outputFrequency = -1,
const bool  outputMaxResOnly = true,
const std::string &  resString = "||A*x-b||/||b||"
 

Definition at line 124 of file BelosStatusTestOutputter.hpp.


Member Function Documentation

template<class ScalarType, class MV, class OP>
void Belos::StatusTestOutputter< ScalarType, MV, OP >::outputFrequency const int &  outputFrequency  )  [inline]
 

Set the number of iterations skipped between outputting. A value <=0 means no outputting.

Definition at line 70 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
const int& Belos::StatusTestOutputter< ScalarType, MV, OP >::outputFrequency  )  const [inline]
 

Definition at line 70 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
void Belos::StatusTestOutputter< ScalarType, MV, OP >::outputMaxResOnly const bool &  outputMaxResOnly  )  [inline]
 

Determine if only max residual is printed or not for active RHS.

Definition at line 73 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
const bool& Belos::StatusTestOutputter< ScalarType, MV, OP >::outputMaxResOnly  )  const [inline]
 

Definition at line 73 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
void Belos::StatusTestOutputter< ScalarType, MV, OP >::resString const std::string &  resString  )  [inline]
 

Determine if only max residual is printed or not for active RHS.

Definition at line 76 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
const std::string& Belos::StatusTestOutputter< ScalarType, MV, OP >::resString  )  const [inline]
 

Definition at line 76 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
void Belos::StatusTestOutputter< ScalarType, MV, OP >::set_resNormStatusTest const Teuchos::RefCountPtr< StatusTestResNorm_t > &  resNormStatusTest  )  [inline]
 

Set the residual norm status test object [Required].

Definition at line 79 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RefCountPtr< StatusTestResNorm_t > Belos::StatusTestOutputter< ScalarType, MV, OP >::get_resNormStatusTest  )  const [inline]
 

Definition at line 79 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
StatusTestResNorm_t& Belos::StatusTestOutputter< ScalarType, MV, OP >::resNormStatusTest  )  [inline]
 

Definition at line 79 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
const StatusTestResNorm_t& Belos::StatusTestOutputter< ScalarType, MV, OP >::resNormStatusTest  )  const [inline]
 

Definition at line 79 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
void Belos::StatusTestOutputter< ScalarType, MV, OP >::set_outputManager const Teuchos::RefCountPtr< OutputManager< ScalarType > > &  outputManager  )  [inline]
 

Set the output manager [Required].

Definition at line 83 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RefCountPtr< OutputManager<ScalarType> > Belos::StatusTestOutputter< ScalarType, MV, OP >::get_outputManager  )  const [inline]
 

Definition at line 83 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
OutputManager<ScalarType>& Belos::StatusTestOutputter< ScalarType, MV, OP >::outputManager  )  [inline]
 

Definition at line 83 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
const OutputManager<ScalarType>& Belos::StatusTestOutputter< ScalarType, MV, OP >::outputManager  )  const [inline]
 

Definition at line 83 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
StatusType Belos::StatusTestOutputter< ScalarType, MV, OP >::CheckStatus IterativeSolver< ScalarType, MV, OP > *  iSolver  )  [virtual]
 

.

Implements Belos::StatusTest< ScalarType, MV, OP >.

Definition at line 139 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
StatusType Belos::StatusTestOutputter< ScalarType, MV, OP >::GetStatus  )  const [virtual]
 

.

Implements Belos::StatusTest< ScalarType, MV, OP >.

Definition at line 201 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
void Belos::StatusTestOutputter< ScalarType, MV, OP >::Reset  )  [virtual]
 

.

Implements Belos::StatusTest< ScalarType, MV, OP >.

Definition at line 207 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::StatusTestOutputter< ScalarType, MV, OP >::ResidualVectorRequired  )  const [virtual]
 

.

Implements Belos::StatusTest< ScalarType, MV, OP >.

Definition at line 215 of file BelosStatusTestOutputter.hpp.

template<class ScalarType, class MV, class OP>
ostream & Belos::StatusTestOutputter< ScalarType, MV, OP >::Print ostream &  os,
int  indent
const [virtual]
 

.

Implements Belos::StatusTest< ScalarType, MV, OP >.

Definition at line 221 of file BelosStatusTestOutputter.hpp.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:30:13 2008 for Belos by doxygen 1.3.9.1