MueLu  Version of the Day
MueLu_VerboseObject.cpp
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 #include "MueLu_VerboseObject.hpp"
47 
48 #ifdef HAVE_MPI
49 #include <mpi.h>
50 #endif
51 
52 #include <Teuchos_VerboseObject.hpp>
53 
54 #include "MueLu_ConfigDefs.hpp"
55 #include "MueLu_VerbosityLevel.hpp"
56 #include "MueLu_Exceptions.hpp"
57 
58 namespace MueLu {
59 
61  verbLevel_(NotSpecified), // = use global verbose level by default
62  numProcs_(0)
63  {
64  // Note: using MPI_COMM_RANK is bad idea (because a subcommunicator may be used to run MueLu)
65  // Belos have the same problem in the class BelosOutputManager.
66  //
67  // How to fix this: the FancyOStream provides setProcRankAndSize() to change the proc rank info used by setOutputToRootOnly().
68  // Adding a method FancyOStream::getProcRank() would be enough. And it makes sense to use the info that come from the stream configuration.
69  //
70  // Documentation: after the patch, it migh be nice to add to the documentation (Teuchos and MueLu)
71  // that users of subcommunicators have to setup the output stream (of Teuchos::VerboseObject) separately.
72  procRank_ = 0;
73 #ifdef HAVE_MPI
74  int mpiStarted = 0; MPI_Initialized(&mpiStarted);
75  if (mpiStarted) {
76  MPI_Comm_rank(MPI_COMM_WORLD, &procRank_);
77  MPI_Comm_size(MPI_COMM_WORLD, &numProcs_);
78  }
79 #endif
80 
81  // When Teuchos::VerboseObject is constructed, its default OStream is set to output only to processor 0.
82  // We have another machinery in place to decide when to output, so by default we want to always print.
83  static RCP<Teuchos::FancyOStream> defaultOStream;
84  if (defaultOStream.get() == NULL) {
85  defaultOStream = Teuchos::fancyOStream(rcpFromRef(std::cout));
86  defaultOStream->setOutputToRootOnly(-1);
87 
88  setDefaultOStream(defaultOStream);
89  }
90  }
91 
93 
96  }
97 
98  void VerboseObject::SetVerbLevel(const VerbLevel verbLevel) {
99  verbLevel_ = verbLevel;
100  }
101 
103  return procRank_;
104  }
105 
106  int VerboseObject::SetProcRankVerbose(int procRank) const {
107  int oldRank = procRank_;
108  procRank_ = procRank;
109  getOStream()->setProcRankAndSize(procRank_, numProcs_);
110 
111  return oldRank;
112  }
113 
114  bool VerboseObject::IsPrint(MsgType type, int thisProcRankOnly) const {
115  return ((type & GetVerbLevel()) && (thisProcRankOnly < 0 || procRank_ == thisProcRankOnly));
116  }
117 
118  Teuchos::FancyOStream & VerboseObject::GetOStream(MsgType type, int thisProcRankOnly) const {
119  if (!IsPrint(type, thisProcRankOnly))
120  return *blackHole_;
121 
123  if (!(type & ((Extreme | Test) ^ Warnings)))
124  os << "\n******* WARNING *******" << std::endl;
125 
126  return os;
127  }
128 
130  return *blackHole_;
131  }
132 
133  void VerboseObject::SetDefaultVerbLevel(const VerbLevel defaultVerbLevel) {
135  "MueLu::VerboseObject::GetVerbLevel(): global verbose level cannot be 'NotSpecified'.");
136  globalVerbLevel_ = defaultVerbLevel;
137  }
138 
140  return globalVerbLevel_;
141  }
142 
144  defaultOStream->setOutputToRootOnly(-1);
145  setDefaultOStream(defaultOStream);
146  }
147 
149  return getDefaultOStream();
150  }
151 
152  VerbLevel VerboseObject::globalVerbLevel_ = High; // Default global verbose level.
153 
155 
156 } // namespace MueLu
static void SetDefaultOStream(const Teuchos::RCP< Teuchos::FancyOStream > &defaultOStream)
Teuchos::FancyOStream & GetOStream(MsgType type, int thisProcRankOnly=0) const
Get an output stream for outputting the input message type.
void SetVerbLevel(const VerbLevel verbLevel)
Set the verbosity level of this object.
static void SetDefaultVerbLevel(const VerbLevel defaultVerbLevel)
Set the default (global) verbosity level.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
static void setDefaultOStream(const RCP< FancyOStream > &defaultOStream)
virtual RCP< FancyOStream > getOStream() const
Namespace for MueLu classes and methods.
static VerbLevel GetDefaultVerbLevel()
Get the default (global) verbosity level.
bool IsPrint(MsgType type, int thisProcRankOnly=-1) const
Find out whether we need to print out information for a specific message type.
Print skeleton for the run, i.e. factory calls and used parameters.
int SetProcRankVerbose(int procRank) const
Set proc rank used for printing.
T * get() const
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
virtual ~VerboseObject()
Destructor.
Teuchos::FancyOStream & GetBlackHole() const
int GetProcRankVerbose() const
Get proc rank used for printing. Do not use this information for any other purpose.
static RCP< FancyOStream > getDefaultOStream()
basic_FancyOStream & setOutputToRootOnly(const int rootRank)
VerbLevel verbLevel_
Verbose level specific to &#39;this&#39;.
VerbLevel GetVerbLevel() const
Get the verbosity level.
Exception throws to report errors in the internal logical of the program.
Print all warning messages.
static VerbLevel globalVerbLevel_
Global verbose level. This verbose level is used when the verbose level of the object is not specifie...
static Teuchos::RCP< Teuchos::FancyOStream > GetDefaultOStream()
static Teuchos::RCP< Teuchos::FancyOStream > blackHole_