https://mooseframework.inl.gov
Loading...
Searching...
No Matches
RelativeDifferencePostprocessor.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
11
13
16{
18
19 params.addRequiredParam<PostprocessorName>("value1", "First post-processor");
20 params.addRequiredParam<PostprocessorName>("value2",
21 "Second post-processor, base for relative difference");
22
23 params.addClassDescription("Computes the absolute value of the relative "
24 "difference between 2 post-processor values.");
25
26 return params;
27}
28
30 : GeneralPostprocessor(parameters),
31 _value1(getPostprocessorValue("value1")),
32 _value2(getPostprocessorValue("value2"))
33{
34}
35
36void
40
41void
45
48{
49 if (MooseUtils::absoluteFuzzyEqual(_value2, 0))
50 return std::abs(_value1 - _value2);
51 else
52 return std::abs((_value1 - _value2) / _value2);
53}
Real PostprocessorValue
various MOOSE typedefs
Definition MooseTypes.h:230
registerMooseObject("MooseApp", RelativeDifferencePostprocessor)
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 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.
Computes the absolute value of the relative difference between 2 post-processor values.
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
RelativeDifferencePostprocessor(const InputParameters &parameters)
const PostprocessorValue & _value2
second post-processor value, used as base in relative difference
virtual void execute() override
Execute method.
const PostprocessorValue & _value1
first post-processor value
virtual PostprocessorValue getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.