PerfGraphInterface.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#include "PerfGraphInterface.h"
#include "PerfGraphRegistry.h"

#include "MooseApp.h"

InputParameters
PerfGraphInterface::validParams()
{
  InputParameters params = emptyInputParameters();
  return params;
}

PerfGraphInterface::PerfGraphInterface(const MooseObject * moose_object)
  : _pg_moose_app(*moose_object->parameters().getCheckedPointerParam<MooseApp *>(
        "_moose_app", "PerfGraphInterface is unable to retrieve the MooseApp pointer!")),
    _prefix(moose_object->type())
{
}

PerfGraphInterface::PerfGraphInterface(const MooseObject * moose_object, const std::string prefix)
  : _pg_moose_app(*moose_object->parameters().getCheckedPointerParam<MooseApp *>(
        "_moose_app", "PerfGraphInterface is unable to retrieve the MooseApp pointer!")),
    _prefix(prefix)
{
}

PerfGraphInterface::PerfGraphInterface(MooseApp & moose_app, const std::string prefix)
  : _pg_moose_app(moose_app), _prefix(prefix)
{
}

PerfGraphInterface::PerfGraphInterface(PerfGraph & perf_graph, const std::string prefix)
  : _pg_moose_app(perf_graph.mooseApp()), _prefix(prefix)
{
}

std::string
PerfGraphInterface::timedSectionName(const std::string & section_name) const
{
  return _prefix.empty() ? "" : (_prefix + "::") + section_name;
}

PerfID
PerfGraphInterface::registerTimedSection(const std::string & section_name,
                                         const unsigned int level) const
{
  const auto timed_section_name = timedSectionName(section_name);
  if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
    return moose::internal::getPerfGraphRegistry().registerSection(timed_section_name, level);
  else
    return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
}

PerfID
PerfGraphInterface::registerTimedSection(const std::string & section_name,
                                         const unsigned int level,
                                         const std::string & live_message,
                                         const bool print_dots) const
{
  const auto timed_section_name = timedSectionName(section_name);
  if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
    return moose::internal::getPerfGraphRegistry().registerSection(
        timedSectionName(section_name), level, live_message, print_dots);
  else
    return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
}

PerfGraph &
PerfGraphInterface::perfGraph()
{
  return _pg_moose_app.perfGraph();
}