Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
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 <BelosIteration.hpp>

Public Member Functions

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

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 32 of file BelosIteration.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 123 of file BelosOutputManager.hpp.

template<class ScalarType >
virtual Belos::OutputManager< ScalarType >::~OutputManager ( )
inlinevirtual

Destructor.

Definition at line 53 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 60 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 63 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 71 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 80 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 91 of file BelosOutputManager.hpp.

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

@ name Print methods

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

Definition at line 141 of file BelosOutputManager.hpp.


The documentation for this class was generated from the following files:

Generated on Tue Jul 23 2024 09:24:23 for Belos by doxygen 1.8.5