ScalePostprocessor.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 "ScalePostprocessor.h"

registerMooseObject("MooseApp", ScalePostprocessor);

InputParameters
ScalePostprocessor::validParams()
{
  InputParameters params = GeneralPostprocessor::validParams();
  params.addRequiredParam<PostprocessorName>("value", "The postprocessor to be scaled");
  params.addParam<Real>("scaling_factor", 1.0, "The scaling factor");

  params.addClassDescription("Scales a post-processor by a value");

  return params;
}

ScalePostprocessor::ScalePostprocessor(const InputParameters & parameters)
  : GeneralPostprocessor(parameters),
    _value(getPostprocessorValue("value")),
    _scaling_factor(getParam<Real>("scaling_factor"))
{
}

PostprocessorValue
ScalePostprocessor::getValue() const
{
  return _scaling_factor * _value;
}