MueLu_VerboseObject.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//        MueLu: A package for multigrid based preconditioning
//
// Copyright 2012 NTESS and the MueLu contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef MUELU_VERBOSEOBJECT_HPP
#define MUELU_VERBOSEOBJECT_HPP

#include "Teuchos_FancyOStream.hpp"  // for FancyOStream
#include "Teuchos_RCPDecl.hpp"       // for RCP
#include "Teuchos_VerboseObject.hpp"

#include "MueLu_VerbosityLevel.hpp"

namespace MueLu {

class VerboseObject : public Teuchos::VerboseObject<VerboseObject> {
 public:

  VerboseObject();

  virtual ~VerboseObject();

  VerbLevel GetVerbLevel() const;

  void SetVerbLevel(const VerbLevel verbLevel);

  int GetProcRankVerbose() const;

  int SetProcRankVerbose(int procRank) const;

  bool IsPrint(MsgType type, int thisProcRankOnly = -1) const;

  Teuchos::FancyOStream& GetOStream(MsgType type, int thisProcRankOnly = 0) const;

  Teuchos::FancyOStream& GetBlackHole() const;

  static void SetMueLuOStream(const Teuchos::RCP<Teuchos::FancyOStream>& mueluOStream);

  static void SetMueLuOFileStream(const std::string& filename);

  static Teuchos::RCP<Teuchos::FancyOStream> GetMueLuOStream();



  static void SetDefaultVerbLevel(const VerbLevel defaultVerbLevel);

  static VerbLevel GetDefaultVerbLevel();


 private:
  VerbLevel verbLevel_;
  mutable int procRank_;
  int numProcs_;

  static Teuchos::RCP<Teuchos::FancyOStream> mueluOutputStream_;
  static Teuchos::RCP<Teuchos::FancyOStream> blackHole_;

  static VerbLevel globalVerbLevel_;
};  // class VerboseObject

}  // namespace MueLu

#define MUELU_VERBOSECLASS_SHORT
#endif  // MUELU_VERBOSEOBJECT_HPP