Belos::OutputManager< ScalarType > Class Template Reference

Belos's basic output manager for sending information of select verbosity levels to the appropriate output stream. More...

#include <BelosOutputManager.hpp>

List of all members.

Public Member Functions

Constructors/Destructor
 OutputManager (int vb=Belos::Errors, const Teuchos::RCP< std::ostream > &os=Teuchos::rcp(&std::cout, false))
 Basic constructor.
virtual ~OutputManager ()
 Destructor.
Set methods
void setOStream (const Teuchos::RCP< std::ostream > &os)
 Set the output stream for this manager.
void setVerbosity (int vb)
 Set the verbosity level for this manager.
Get methods
std::ostream & stream (MsgType type)
 Get an output stream for outputting the input message type.
Teuchos::RCP< std::ostream > getOStream ()
 Get the output stream for this manager.
Query methods
bool isVerbosity (MsgType type) const
 Find out whether we need to print out information for this message type.
void print (MsgType type, const std::string output)
 Send some output of a specified message type to the output stream.


Detailed Description

template<class ScalarType>
class Belos::OutputManager< ScalarType >

Belos's basic output manager for sending information of select verbosity levels to the appropriate output stream.

This output manager will remove the need for the solver or linear problem to know any information about the required output. Calling isVerbosity( MsgType vb ) will inform the solver if it is supposed to output the information corresponding to the verbosity type (vb ).

Author:
Michael Heroux and Heidi Thornquist

Definition at line 59 of file BelosOutputManager.hpp.


Constructor & Destructor Documentation

template<class ScalarType>
Belos::OutputManager< ScalarType >::OutputManager ( int  vb = Belos::Errors,
const Teuchos::RCP< std::ostream > &  os = Teuchos::rcp(&std::cout, false) 
)

Basic constructor.

Definition at line 140 of file BelosOutputManager.hpp.

template<class ScalarType>
virtual Belos::OutputManager< ScalarType >::~OutputManager (  )  [inline, virtual]

Destructor.

Definition at line 70 of file BelosOutputManager.hpp.


Member Function Documentation

template<class ScalarType>
void Belos::OutputManager< ScalarType >::setOStream ( const Teuchos::RCP< std::ostream > &  os  )  [inline]

Set the output stream for this manager.

Definition at line 77 of file BelosOutputManager.hpp.

template<class ScalarType>
void Belos::OutputManager< ScalarType >::setVerbosity ( int  vb  )  [inline]

Set the verbosity level for this manager.

Definition at line 80 of file BelosOutputManager.hpp.

template<class ScalarType>
std::ostream& Belos::OutputManager< ScalarType >::stream ( MsgType  type  )  [inline]

Get an output stream for outputting the input message type.

Definition at line 88 of file BelosOutputManager.hpp.

template<class ScalarType>
Teuchos::RCP<std::ostream> Belos::OutputManager< ScalarType >::getOStream (  )  [inline]

Get the output stream for this manager.

Definition at line 97 of file BelosOutputManager.hpp.

template<class ScalarType>
bool Belos::OutputManager< ScalarType >::isVerbosity ( MsgType  type  )  const [inline]

Find out whether we need to print out information for this message type.

This method is used by the solver to determine whether computations are necessary for this message type.

Definition at line 108 of file BelosOutputManager.hpp.

template<class ScalarType>
void Belos::OutputManager< ScalarType >::print ( MsgType  type,
const std::string  output 
)

Send some output of a specified message type to the output stream.

Definition at line 158 of file BelosOutputManager.hpp.


The documentation for this class was generated from the following file:
Generated on Wed May 12 21:45:53 2010 for Belos by  doxygen 1.4.7