www.mooseframework.org
DifferencePostprocessor.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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 
11 
13 
16 {
18  params.addRequiredParam<PostprocessorName>("value1", "First value");
19  params.addRequiredParam<PostprocessorName>("value2", "Second value");
20  params.addClassDescription("Computes the difference between two postprocessors");
21  return params;
22 }
23 
25  : GeneralPostprocessor(parameters),
26  _value1(getPostprocessorValue("value1")),
27  _value2(getPostprocessorValue("value2"))
28 {
29 }
30 
31 void
33 {
34 }
35 
36 void
38 {
39 }
40 
43 {
44  return _value1 - _value2;
45 }
virtual PostprocessorValue getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
Computes the difference between two postprocessors.
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
const PostprocessorValue & _value2
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
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...
static InputParameters validParams()
DifferencePostprocessor(const InputParameters &parameters)
Real PostprocessorValue
various MOOSE typedefs
Definition: MooseTypes.h:191
registerMooseObject("MooseApp", DifferencePostprocessor)
const PostprocessorValue & _value1
static InputParameters validParams()
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...
virtual void execute() override
Execute method.