MueLu_MutuallyExclusiveTime.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//        MueLu: A package for multigrid based preconditioning
//                  Copyright 2012 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact
//                    Jonathan Hu       (jhu@sandia.gov)
//                    Andrey Prokopenko (aprokop@sandia.gov)
//                    Ray Tuminaro      (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @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