https://mooseframework.inl.gov
Loading...
Searching...
No Matches
ScalePostprocessor.C
Go to the documentation of this file.
1//* This file is part of the MOOSE framework
2//* https://mooseframework.inl.gov
3//*
4//* All rights reserved, see COPYRIGHT for full restrictions
5//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6//*
7//* Licensed under LGPL 2.1, please see LICENSE for details
8//* https://www.gnu.org/licenses/lgpl-2.1.html
9
10#include "ScalePostprocessor.h"
11
13
16{
18 params.addRequiredParam<PostprocessorName>("value", "The postprocessor to be scaled");
19 params.addParam<Real>("scaling_factor", 1.0, "The scaling factor");
20
21 params.addClassDescription("Scales a post-processor by a value");
22
23 return params;
24}
25
27 : GeneralPostprocessor(parameters),
28 _value(getPostprocessorValue("value")),
29 _scaling_factor(getParam<Real>("scaling_factor"))
30{
31}
32
Real PostprocessorValue
various MOOSE typedefs
Definition MooseTypes.h:230
registerMooseObject("MooseApp", ScalePostprocessor)
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
static InputParameters validParams()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an optional parameter and a documentation string to the InputParameters object.
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump.
Scale a postprocessor.
ScalePostprocessor(const InputParameters &parameters)
const PostprocessorValue & _value
static InputParameters validParams()
virtual PostprocessorValue getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.