MueLu_Monitor.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_MONITOR_HPP
#define MUELU_MONITOR_HPP

#include <string>
#include <algorithm>                 // for swap
#include <ostream>                   // for basic_ostream, operator<<, etc
#include "Teuchos_FancyOStream.hpp"  // for OSTab, FancyOStream
#include "Teuchos_RCPDecl.hpp"       // for RCP
#include "Teuchos_RCP.hpp"           // for RCP::RCP<T>, RCP::operator=, etc
#include "Teuchos_Utils.hpp"         // for Utils
#include "MueLu_VerbosityLevel.hpp"  // for MsgType, MsgType::Runtime0, etc
#include "MueLu_BaseClass.hpp"
#include "MueLu_FactoryBase_fwd.hpp"
#include "MueLu_Level.hpp"
#include "MueLu_TimeMonitor.hpp"

namespace MueLu {

struct FormattingHelper {
  static std::string getColonLabel(const std::string& label) {
    if (label != "")
      return label + ": ";
    else
      return "";
  }
};

class PrintMonitor : public BaseClass {
 public:
  PrintMonitor(const BaseClass& object, const std::string& msg, MsgType msgLevel = Runtime0);
  ~PrintMonitor();

 private:
  PrintMonitor();

  bool tabbed;
  const BaseClass& object_;
};

class Monitor : public BaseClass {
 public:
  Monitor(const BaseClass& object, const std::string& msg, MsgType msgLevel = Runtime0, MsgType timerLevel = Timings0);

  Monitor(const BaseClass& object, const std::string& msg, const std::string& label, MsgType msgLevel = Runtime0, MsgType timerLevel = Timings0);

  virtual ~Monitor();

 private:
  PrintMonitor printMonitor_;
  TimeMonitor timerMonitor_;
};

//---------------------------------------------------------------------------------------------------

class SubMonitor : public BaseClass {
 public:
  SubMonitor(const BaseClass& object, const std::string& msg, MsgType msgLevel = Runtime1, MsgType timerLevel = Timings1);

  SubMonitor(const BaseClass& object, const std::string& msg, const std::string& label, MsgType msgLevel = Runtime1, MsgType timerLevel = Timings1);

  ~SubMonitor();

 private:
  PrintMonitor printMonitor_;
  TimeMonitor timerMonitor_;
};

//---------------------------------------------------------------------------------------------------

class FactoryMonitor : public Monitor {
 public:
  static int timerIdentifier_;

  FactoryMonitor(const BaseClass& object, const std::string& msg, int levelID, MsgType msgLevel = static_cast<MsgType>(Test | Runtime0), MsgType timerLevel = Timings0);

  FactoryMonitor(const BaseClass& object, const std::string& msg, const Level& level, MsgType msgLevel = static_cast<MsgType>(Test | Runtime0), MsgType timerLevel = Timings0);

  ~FactoryMonitor();

 private:
  RCP<TimeMonitor> levelTimeMonitor_;
  MutuallyExclusiveTimeMonitor<FactoryBase> timerMonitorExclusive_;
  RCP<MutuallyExclusiveTimeMonitor<Level> > levelTimeMonitorExclusive_;
};

//---------------------------------------------------------------------------------------------------

class SubFactoryMonitor : public SubMonitor {
 public:
  SubFactoryMonitor(const BaseClass& object, const std::string& msg, int levelID, MsgType msgLevel = Runtime1, MsgType timerLevel = Timings1);

  SubFactoryMonitor(const BaseClass& object, const std::string& msg, const Level& level, MsgType msgLevel = Runtime1, MsgType timerLevel = Timings1);

  ~SubFactoryMonitor();

 private:
  RCP<TimeMonitor> levelTimeMonitor_;
};

}  // namespace MueLu

#endif  // MUELU_MONITOR_HPP