MueLu_MutuallyExclusiveTime.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_MUTUALLYEXCLUSIVETIME_HPP
#define MUELU_MUTUALLYEXCLUSIVETIME_HPP
 
#include <string>
#include <stack>
#include "Teuchos_RCPDecl.hpp"  // for RCP
 
// types for explicit instantiation
#include "MueLu_FactoryBase_fwd.hpp"
#include "MueLu_Level_fwd.hpp"
#include "MueLu_BaseClass.hpp"
 
namespace MueLu {

template <class TagName>
class MutuallyExclusiveTime : public BaseClass {
 public:


  MutuallyExclusiveTime(const std::string& name, bool startFlag = false);

  ~MutuallyExclusiveTime();

  void start(bool reset = false);



  double stop();

  void pause();

 
  void resume();



 
  bool isRunning();
 
  bool isPaused();


  // Note: this function is provided by the timer class, not by a monitor (!= Teuchos)
  static RCP<MutuallyExclusiveTime<TagName> > getNewTimer(const std::string& name);

  void incrementNumCalls();

  std::string name_;

  static void PrintParentChildPairs();
 
 private:
  MutuallyExclusiveTime(RCP<Teuchos::Time> timer);
 
  // MutuallyExclusiveTime() { }

  RCP<Teuchos::Time> timer_;
  bool isPaused_;

  // - empty when no active timer
  // - head is the active timer
  // - other timers are timers paused to enforce the mutually exclusive property of the timer set.
  static std::stack<MutuallyExclusiveTime<TagName>*> timerStack_;
  // static std::map<std::string,std::string> myParent_;

  void TopOfTheStack();
 
  // TODO: test integrity of the stack:
  //  Head = running or paused
  //  Other timers of the stack = paused
};
 
extern template class MutuallyExclusiveTime<FactoryBase>;
extern template class MutuallyExclusiveTime<Level>;
extern template class MutuallyExclusiveTime<BaseClass>;
 
}  // namespace MueLu
 
#endif  // MUELU_MUTUALLYEXCLUSIVETIME_HPP