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 ()
 Default constructor.
 OutputManager (int myID, int vbLevel=Belos::Errors, int printID=0, const Teuchos::RefCountPtr< ostream > &os=Teuchos::rcp(&std::cout, false))
 Basic constructor.
virtual ~OutputManager ()
 Destructor.
Set methods
void SetOStream (const Teuchos::RefCountPtr< ostream > &os)
 Set the output stream for this manager.
void SetVerbosity (int vbLevel)
 Set the verbosity level for this manager.
Get methods
Teuchos::RefCountPtr< 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.
bool isVerbosityAndPrint (MsgType type) const
 Find out whether this processor needs to print out information for this message type.
bool doPrint (void) const
 Find out whether information can be outputted through this 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 doPrint( int vbLevel ) will inform the solver if it is supposed to output the information corresponding to the verbosity level (vbLevel ).

Author:
Michael Heroux and Heidi Thornquist

Definition at line 54 of file BelosOutputManager.hpp.


Constructor & Destructor Documentation

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

Default constructor.

Definition at line 130 of file BelosOutputManager.hpp.

template<class ScalarType>
Belos::OutputManager< ScalarType >::OutputManager int  myID,
int  vbLevel = Belos::Errors,
int  printID = 0,
const Teuchos::RefCountPtr< 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 68 of file BelosOutputManager.hpp.


Member Function Documentation

template<class ScalarType>
void Belos::OutputManager< ScalarType >::SetOStream const Teuchos::RefCountPtr< ostream > &  os  )  [inline]
 

Set the output stream for this manager.

Definition at line 75 of file BelosOutputManager.hpp.

template<class ScalarType>
void Belos::OutputManager< ScalarType >::SetVerbosity int  vbLevel  )  [inline]
 

Set the verbosity level for this manager.

Definition at line 78 of file BelosOutputManager.hpp.

template<class ScalarType>
Teuchos::RefCountPtr<ostream> Belos::OutputManager< ScalarType >::GetOStream  )  [inline]
 

Get the output stream for this manager.

Definition at line 86 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 97 of file BelosOutputManager.hpp.

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

Find out whether this processor needs to print out information for this message type.

This method is used by the solver to determine whether this output stream has been selected to output the information for this message type.

Definition at line 103 of file BelosOutputManager.hpp.

template<class ScalarType>
bool Belos::OutputManager< ScalarType >::doPrint void   )  const [inline]
 

Find out whether information can be outputted through this output stream.

Definition at line 106 of file BelosOutputManager.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