Timer.h

Go to the documentation of this file.

/***************************************************************************
 *  ThunderEgg, a library for solvers on adaptively refined block-structured
 *  Cartesian grids.
 *
 *  Copyright (c) 2017-2021 Scott Aiton
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 ***************************************************************************/
 
#ifndef THUNDEREGG_TIMER_H
#define THUNDEREGG_TIMER_H
 
#include <ThunderEgg/Communicator.h>
#include <ThunderEgg/RuntimeError.h>
#include <ThunderEgg/tpl/json.hpp>
#include <list>
#include <map>
#include <ostream>
#include <string>
namespace ThunderEgg {
class Timer
{
private:
  Communicator comm;
  class Timing;
  std::unique_ptr<Timing> root;
  std::list<std::reference_wrapper<Timing>> stack;
  std::map<int, tpl::nlohmann::json> domains;
 
public:
  explicit Timer(const Communicator& comm);
  ~Timer();
  void start(const std::string& name);
  void stop(const std::string& name);
  void addDomain(int domain_id, tpl::nlohmann::json domain);
  void startDomainTiming(int domain_id, const std::string& name);
  void stopDomainTiming(int domain_id, const std::string& name);
  void startPatchTiming(int patch_id, int domain_id, const std::string& name);
  void stopPatchTiming(int patch_id, int domain_id, const std::string& name);
  void addIntInfo(const std::string& name, int info);
  void addDoubleInfo(const std::string& name, double info);
  friend std::ostream& operator<<(std::ostream& os, const Timer& timer);
  friend void to_json(tpl::nlohmann::json& j, const Timer& timer);
  void saveToFile(const std::string& filename) const;
};
} // namespace ThunderEgg
#endif