PerformanceData.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 "PerformanceData.h"
 
#include "FEProblem.h"
#include "SubProblem.h"
 
registerMooseObjectReplaced("MooseApp", PerformanceData, "02/01/2019 00:00", PerfGraphData);
 
defineLegacyParams(PerformanceData);
 
InputParameters
PerformanceData::validParams()
{
  InputParameters params = GeneralPostprocessor::validParams();
 
  MooseEnum column_options("n_calls total_time average_time total_time_with_sub "
                           "average_time_with_sub percent_of_active_time "
                           "percent_of_active_time_with_sub",
                           "total_time_with_sub");
  params.addParam<MooseEnum>(
      "column", column_options, "The column you want the value of (Default: total_time_with_sub).");
 
  MooseEnum common_categories("Application Execution Output Setup Utility", "Execution", true);
  params.addParam<MooseEnum>("category", common_categories, "The category for the event");
 
  MooseEnum common_events("ACTIVE ALIVE solve() compute_residual() compute_jacobian()", "", true);
  params.addRequiredParam<MooseEnum>(
      "event",
      common_events,
      "The name or \"label\" of the event. Must match event name exactly "
      "including parenthesis if applicable. (\"ALIVE\" and \"ACTIVE\" are "
      "also valid events, category and column are ignored for these "
      "cases).");
 
  params.addClassDescription("Provides programmatic access to Performance Log Data");
  return params;
}
 
PerformanceData::PerformanceData(const InputParameters & parameters)
  : GeneralPostprocessor(parameters),
    _column(getParam<MooseEnum>("column").getEnum<PerfLogCols>()),
    _category(getParam<MooseEnum>("category")),
    _event(getParam<MooseEnum>("event"))
{
  // Notify the OutputWarehouse that logging has been requested
  _app.getOutputWarehouse().setLoggingRequested();
}
 
Real
PerformanceData::getValue()
{
  if (_event == "ALIVE")
    return Moose::perf_log.get_elapsed_time();
 
  Real total_time = Moose::perf_log.get_active_time();
  if (_event == "ACTIVE")
    return total_time;
 
  PerfData perf_data = Moose::perf_log.get_perf_data(_event, _category);
  if (perf_data.count == 0)
    return 0.0;
 
  switch (_column)
  {
    case N_CALLS:
      return perf_data.count;
    case TOTAL_TIME:
      return perf_data.tot_time;
    case AVERAGE_TIME:
      return perf_data.tot_time / static_cast<double>(perf_data.count);
    case TOTAL_TIME_WITH_SUB:
      return perf_data.tot_time_incl_sub;
    case AVERAGE_TIME_WITH_SUB:
      return perf_data.tot_time_incl_sub / static_cast<double>(perf_data.count);
    case PERCENT_OF_ACTIVE_TIME:
      return (total_time != 0.) ? perf_data.tot_time / total_time * 100. : 0.;
    case PERCENT_OF_ACTIVE_TIME_WITH_SUB:
      return (total_time != 0.) ? perf_data.tot_time_incl_sub / total_time * 100. : 0.;
    default:
      mooseError("Invalid column!");
  }
 
  return 0;
}