Anasazi  Version of the Day
AnasaziOutputManager.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Anasazi: Block Eigensolvers Package
5 // Copyright 2004 Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef ANASAZI_OUTPUT_MANAGER_HPP
43 #define ANASAZI_OUTPUT_MANAGER_HPP
44 
49 #include "AnasaziConfigDefs.hpp"
50 #include "AnasaziTypes.hpp"
51 
61 namespace Anasazi {
62 
63 template <class ScalarType>
65 
66  public:
67 
69 
70 
72  OutputManager( int vb = Anasazi::Errors ) : vb_(vb) {};
73 
75  virtual ~OutputManager() {};
77 
79 
80 
82  virtual void setVerbosity( int vb ) { vb_ = vb; }
83 
85  virtual int getVerbosity( ) const { return vb_; }
86 
88 
90 
91 
93 
96  virtual bool isVerbosity( MsgType type ) const = 0;
97 
99  virtual void print( MsgType type, const std::string output ) = 0;
100 
102  virtual std::ostream &stream( MsgType type ) = 0;
103 
105 
106  private:
107 
109 
110 
113 
116 
118 
119  protected:
120  int vb_;
121 };
122 
123 } // end Anasazi namespace
124 
125 #endif
126 
127 // end of file AnasaziOutputManager.hpp
virtual bool isVerbosity(MsgType type) const =0
Find out whether we need to print out information for this message type.
OutputManager(int vb=Anasazi::Errors)
Default constructor.
virtual void setVerbosity(int vb)
Set the message output types for this manager.
Namespace Anasazi contains the classes, structs, enums and utilities used by the Anasazi package...
Output managers remove the need for the eigensolver to know any information about the required output...
virtual void print(MsgType type, const std::string output)=0
Send output to the output manager.
Anasazi header file which uses auto-configuration information to include necessary C++ headers...
virtual int getVerbosity() const
Get the message output types for this manager.
virtual ~OutputManager()
Destructor.
Types and exceptions used within Anasazi solvers and interfaces.
MsgType
Enumerated list of available message types recognized by the eigensolvers.
virtual std::ostream & stream(MsgType type)=0
Create a stream for outputting to.