www.mooseframework.org
VariableResidual.h
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 /****************************************************************/
14 
15 #ifndef VARIABLERESIDUAL_H
16 #define VARIABLERESIDUAL_H
17 
18 #include "GeneralPostprocessor.h"
19 
20 // Forward Declarations
21 class VariableResidual;
22 
23 template <>
25 
27 {
28 public:
30 
31  virtual void initialize() override;
32  virtual void execute() override;
33 
34  virtual PostprocessorValue getValue() override;
35 
36 protected:
41 };
42 
43 #endif // VARIABLERESIDUAL_H
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Class for stuff related to variables.
Definition: MooseVariable.h:43
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
InputParameters validParams< VariableResidual >()
VariableResidual(const InputParameters &parameters)
Real PostprocessorValue
MOOSE typedefs.
Definition: MooseTypes.h:73
MooseVariable & _var
MOOSE variable we compute the residual for.
virtual PostprocessorValue getValue() override
This will get called to actually grab the final value the postprocessor has calculated.
virtual void execute() override
Execute method.
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
Real _var_residual
The residual of the variable.