www.mooseframework.org
PercentChangePostprocessor.C
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
15 
16 template <>
19 {
21  params.addRequiredParam<PostprocessorName>(
22  "postprocessor", "The name of the postprocessor used for exit criterion");
23  return params;
24 }
25 
27  : GeneralPostprocessor(parameters),
28  _postprocessor(getPostprocessorValue("postprocessor")),
29  _postprocessor_old(getPostprocessorValueOld("postprocessor"))
30 {
31  mooseDeprecated("PercentChangePostprocessor is deprecated: instead, ",
32  "please use ChangeOverTimestepPostprocessor using the parameter ",
33  "'compute_relative_change' set to 'true'");
34 }
35 
36 void
38 {
39 }
40 
41 void
43 {
44 }
45 
46 Real
48 {
49  return std::fabs((std::fabs(_postprocessor) - std::fabs(_postprocessor_old)) *
50  std::pow(std::fabs(_postprocessor), -1));
51 }
PercentChangePostprocessor(const InputParameters &parameters)
const PostprocessorValue & _postprocessor
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< GeneralPostprocessor >()
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
virtual void execute() override
Execute method.
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...
InputParameters validParams< PercentChangePostprocessor >()
virtual Real getValue() override
This will get called to actually grab the final value the postprocessor has calculated.
void mooseDeprecated(Args &&...args) const
Definition: MooseObject.h:95
const PostprocessorValue & _postprocessor_old
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.