MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_VerboseObject.hpp
Go to the documentation of this file.
1// @HEADER
2//
3// ***********************************************************************
4//
5// MueLu: A package for multigrid based preconditioning
6// Copyright 2012 Sandia Corporation
7//
8// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9// the U.S. Government retains certain rights in this software.
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17//
18// 2. Redistributions in binary form must reproduce the above copyright
19// notice, this list of conditions and the following disclaimer in the
20// documentation and/or other materials provided with the distribution.
21//
22// 3. Neither the name of the Corporation nor the names of the
23// contributors may be used to endorse or promote products derived from
24// this software without specific prior written permission.
25//
26// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37//
38// Questions? Contact
39// Jonathan Hu (jhu@sandia.gov)
40// Andrey Prokopenko (aprokop@sandia.gov)
41// Ray Tuminaro (rstumin@sandia.gov)
42//
43// ***********************************************************************
44//
45// @HEADER
46#ifndef MUELU_VERBOSEOBJECT_HPP
47#define MUELU_VERBOSEOBJECT_HPP
48
49#include "Teuchos_FancyOStream.hpp" // for FancyOStream
50#include "Teuchos_RCPDecl.hpp" // for RCP
51#include "Teuchos_VerboseObject.hpp"
52
54
55namespace MueLu {
56
79 class VerboseObject : public Teuchos::VerboseObject<VerboseObject> {
80 public:
81
83
85
87 virtual ~VerboseObject();
89
94 VerbLevel GetVerbLevel() const;
95
97 void SetVerbLevel(const VerbLevel verbLevel);
98
100 int GetProcRankVerbose() const;
101
103 int SetProcRankVerbose(int procRank) const;
104
109 bool IsPrint(MsgType type, int thisProcRankOnly = -1) const;
110
112 Teuchos::FancyOStream & GetOStream(MsgType type, int thisProcRankOnly = 0) const;
113
114 Teuchos::FancyOStream & GetBlackHole() const;
115
116 static void SetMueLuOStream(const Teuchos::RCP<Teuchos::FancyOStream> &mueluOStream);
117
118 static void SetMueLuOFileStream(const std::string& filename);
119
120 static Teuchos::RCP<Teuchos::FancyOStream> GetMueLuOStream();
121
123
124
126 static void SetDefaultVerbLevel(const VerbLevel defaultVerbLevel);
127
130
132
133 private:
136 mutable
139
140 static Teuchos::RCP<Teuchos::FancyOStream> mueluOutputStream_;
141 static Teuchos::RCP<Teuchos::FancyOStream> blackHole_;
142
145 }; // class VerboseObject
146
147} // namespace MueLu
148
149#define MUELU_VERBOSECLASS_SHORT
150#endif // MUELU_VERBOSEOBJECT_HPP
Verbose class for MueLu classes.
Teuchos::FancyOStream & GetOStream(MsgType type, int thisProcRankOnly=0) const
Get an output stream for outputting the input message type.
VerbLevel GetVerbLevel() const
Get the verbosity level.
int SetProcRankVerbose(int procRank) const
Set proc rank used for printing.
VerbLevel verbLevel_
Verbose level specific to 'this'.
static Teuchos::RCP< Teuchos::FancyOStream > blackHole_
static VerbLevel GetDefaultVerbLevel()
Get the default (global) verbosity level.
static Teuchos::RCP< Teuchos::FancyOStream > GetMueLuOStream()
void SetVerbLevel(const VerbLevel verbLevel)
Set the verbosity level of this object.
bool IsPrint(MsgType type, int thisProcRankOnly=-1) const
Find out whether we need to print out information for a specific message type.
static Teuchos::RCP< Teuchos::FancyOStream > mueluOutputStream_
static void SetMueLuOStream(const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)
static VerbLevel globalVerbLevel_
Global verbose level. This verbose level is used when the verbose level of the object is not specifie...
Teuchos::FancyOStream & GetBlackHole() const
static void SetDefaultVerbLevel(const VerbLevel defaultVerbLevel)
Set the default (global) verbosity level.
virtual ~VerboseObject()
Destructor.
static void SetMueLuOFileStream(const std::string &filename)
int GetProcRankVerbose() const
Get proc rank used for printing. Do not use this information for any other purpose.
Namespace for MueLu classes and methods.