Belos Package Browser (Single Doxygen Collection) Development
Private Attributes
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>

Inheritance diagram for Belos::OutputManager< ScalarType >:
Inheritance graph
[legend]

List of all members.

Private Attributes

int vb_
Teuchos::RCP< std::ostream > myOS_
Teuchos::oblackholestream myBHS_
bool iPrint_

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)
 @ name Print methods

Undefined methods

 OutputManager (const OutputManager< ScalarType > &OM)
 Copy constructor.
OutputManager< ScalarType > & operator= (const OutputManager< ScalarType > &OM)
 Assignment operator.

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 73 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 154 of file BelosOutputManager.hpp.

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

Destructor.

Definition at line 84 of file BelosOutputManager.hpp.

template<class ScalarType>
Belos::OutputManager< ScalarType >::OutputManager ( const OutputManager< ScalarType > &  OM) [private]

Copy constructor.


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 91 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 94 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 102 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 111 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 122 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 172 of file BelosOutputManager.hpp.

template<class ScalarType>
OutputManager<ScalarType>& Belos::OutputManager< ScalarType >::operator= ( const OutputManager< ScalarType > &  OM) [private]

Assignment operator.


Member Data Documentation

template<class ScalarType>
int Belos::OutputManager< ScalarType >::vb_ [private]

Definition at line 147 of file BelosOutputManager.hpp.

template<class ScalarType>
Teuchos::RCP<std::ostream> Belos::OutputManager< ScalarType >::myOS_ [private]

Definition at line 148 of file BelosOutputManager.hpp.

template<class ScalarType>
Teuchos::oblackholestream Belos::OutputManager< ScalarType >::myBHS_ [private]

Definition at line 149 of file BelosOutputManager.hpp.

template<class ScalarType>
bool Belos::OutputManager< ScalarType >::iPrint_ [private]

Definition at line 150 of file BelosOutputManager.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines