AccumulateReporter

Reporter which accumulates the value of a inputted reporter value over time into a vector reporter value of the same type.

Overview

AccumulateReporter gives the ability to accumulate reporter values over time and assigns it to a vector reporter value. Currently supported reporter value types:

int
Real (this covers Postprocessor System)
std::string
std::vector<int>
std::vector<Real> (this covers VectorPostprocessors System)
std::vector<std::string>

If more types need to be supported, they can easily be added by adding a line in the if statement in AccumulateReporter::declareLateValues():

void
AccumulateReporter::declareLateValues()
{
  const ReporterData & rdata = _fe_problem.getReporterData();
  for (const auto & rname : getParam<std::vector<ReporterName>>("reporters"))
  {
    if (!rdata.hasReporterValue(rname))
      paramError("reporters", "Reporter ", rname, " does not exist.");

    if (!declareAccumulateHelper<int>(rname) && !declareAccumulateHelper<Real>(rname) &&
        !declareAccumulateHelper<dof_id_type>(rname) &&
        !declareAccumulateHelper<std::string>(rname) &&
        !declareAccumulateHelper<std::vector<int>>(rname) &&
        !declareAccumulateHelper<std::vector<Real>>(rname) &&
        !declareAccumulateHelper<std::vector<std::string>>(rname) &&
        !declareAccumulateHelper<std::vector<dof_id_type>>(rname))
      paramError("reporters",
                 "Reporter value ",
                 rname,
                 " is of unsupported type ",
                 rdata.getReporterContextBase(rname).type(),
                 ".");
  }
}

note:Reporter names

The reporter names created by the AccumulateReporter match each of the accumulated reporters' names.

Input Parameters

reportersThe reporters to accumulate.
C++ Type:std::vector<ReporterName>
Controllable:No
Description:The reporters to accumulate.

Required Parameters

prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

Optional Parameters

allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object
use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

(../moose/framework/src/reporters/AccumulateReporter.C)

// 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 "AccumulateReporter.h"

registerMooseObject("MooseApp", AccumulateReporter);

InputParameters
AccumulateReporter::validParams()
{
  InputParameters params = GeneralReporter::validParams();
  params.addClassDescription("Reporter which accumulates the value of a inputted reporter value "
                             "over time into a vector reporter value of the same type.");
  params.addRequiredParam<std::vector<ReporterName>>("reporters", "The reporters to accumulate.");

  params.set<ExecFlagEnum>("execute_on") = {EXEC_INITIAL, EXEC_TIMESTEP_END};
  params.suppressParameter<ExecFlagEnum>("execute_on");
  return params;
}

AccumulateReporter::AccumulateReporter(const InputParameters & parameters)
  : GeneralReporter(parameters)
{
}

void
AccumulateReporter::declareLateValues()
{
  const ReporterData & rdata = _fe_problem.getReporterData();
  for (const auto & rname : getParam<std::vector<ReporterName>>("reporters"))
  {
    if (!rdata.hasReporterValue(rname))
      paramError("reporters", "Reporter ", rname, " does not exist.");

    if (!declareAccumulateHelper<int>(rname) && !declareAccumulateHelper<Real>(rname) &&
        !declareAccumulateHelper<dof_id_type>(rname) &&
        !declareAccumulateHelper<std::string>(rname) &&
        !declareAccumulateHelper<std::vector<int>>(rname) &&
        !declareAccumulateHelper<std::vector<Real>>(rname) &&
        !declareAccumulateHelper<std::vector<std::string>>(rname) &&
        !declareAccumulateHelper<std::vector<dof_id_type>>(rname))
      paramError("reporters",
                 "Reporter value ",
                 rname,
                 " is of unsupported type ",
                 rdata.getReporterContextBase(rname).type(),
                 ".");
  }
}

void
AccumulateReporter::execute()
{
  unsigned int ind = static_cast<unsigned int>(_t_step);
  for (auto & val : _accumulated_values)
    val->accumulate(ind);
}