timer_tree.h

/*  ______________________________________________________________________
 *
 *  ExaDG - High-Order Discontinuous Galerkin for the Exa-Scale
 *
 *  Copyright (C) 2021 by the ExaDG authors
 *
 *  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 INCLUDE_EXADG_UTILITIES_TIMER_TREE_H_
#define INCLUDE_EXADG_UTILITIES_TIMER_TREE_H_
 
// C++
#include <memory>
#include <string>
#include <vector>
 
// deal.II
#include <deal.II/base/conditional_ostream.h>
 
namespace ExaDG
{
class TimerTree
{
public:
  TimerTree();
 
  void
  clear();
 
  void
  insert(std::vector<std::string> const ids, double const wall_time);
 
  void
  insert(std::vector<std::string>   ids,
         std::shared_ptr<TimerTree> sub_tree,
         std::string const          new_name = "");
 
  void
  print_plain(dealii::ConditionalOStream const & pcout) const;
 
  void
  print_level(dealii::ConditionalOStream const & pcout, unsigned int const level) const;
 
  unsigned int
  get_max_level() const;
 
private:
  void
  copy_from(std::shared_ptr<TimerTree> other);
 
  std::vector<std::string>
  erase_first(std::vector<std::string> const & in) const;
 
  double
  get_average_wall_time() const;
 
  unsigned int
  get_length() const;
 
  void
  do_print_plain(dealii::ConditionalOStream const & pcout,
                 unsigned int const                 offset,
                 unsigned int const                 length) const;
 
  void
  do_print_level(dealii::ConditionalOStream const & pcout,
                 unsigned int const                 level,
                 unsigned int const                 offset,
                 unsigned int const                 length) const;
 
  void
  print_name(dealii::ConditionalOStream const & pcout,
             unsigned int const                 offset,
             unsigned int const                 length,
             bool const                         new_line) const;
 
  void
  print_own(dealii::ConditionalOStream const & pcout,
            unsigned int const                 offset,
            unsigned int const                 length,
            bool const                         relative = false,
            double const                       ref_time = -1.0) const;
 
  void
  print_direct_children(dealii::ConditionalOStream const & pcout,
                        unsigned int const                 offset,
                        unsigned int const                 length,
                        bool const                         relative = false,
                        double const                       ref_time = -1.0) const;
 
  std::string id;
 
  struct Data
  {
    Data() : wall_time(0.0)
    {
    }
 
    double wall_time;
  };
 
  std::shared_ptr<Data> data;
 
  std::vector<std::shared_ptr<TimerTree>> sub_trees;
 
  static unsigned int const offset_per_level = 2;
  static unsigned int const precision        = 2;
};
} // namespace ExaDG
 
 
#endif /* INCLUDE_EXADG_UTILITIES_TIMER_TREE_H_ */