Receiver.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 "Receiver.h"
 
registerMooseObject("MooseApp", Receiver);
 
InputParameters
Receiver::validParams()
{
  InputParameters params = GeneralPostprocessor::validParams();
  params.addParam<Real>("default", 0, "The default value");
  params.addParam<bool>(
      "initialize_old", true, "Initialize the old postprocessor value with the default value");
 
  params.addClassDescription("Reports the value stored in this processor, which is usually filled "
                             "in by another object. The Receiver does not compute its own value.");
  return params;
}
 
Receiver::Receiver(const InputParameters & params)
  : GeneralPostprocessor(params),
    _initialize_old(getParam<bool>("initialize_old")),
    _my_value(getPostprocessorValueByName(name()))
{
  const PostprocessorReporterName r_name(name());
  auto & write_data = _fe_problem.getReporterData(ReporterData::WriteKey());
 
  // Request that we need the old and older time values for this Receiver
  write_data.needReporterTimeIndex<PostprocessorValue>(r_name, 2);
 
  // Initialize values
  const Real & value = getParam<Real>("default");
  write_data.setReporterValue<PostprocessorValue>(r_name, value, 0);
  if (_initialize_old)
  {
    write_data.setReporterValue<PostprocessorValue>(r_name, value, 1);
    write_data.setReporterValue<PostprocessorValue>(r_name, value, 2);
  }
}
 
Real
Receiver::getValue() const
{
  // Return the stored value (references stored value in getPostprocessorData)
  return _my_value;
}