www.mooseframework.org
Residual.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 RESIDUAL_H
16 #define RESIDUAL_H
17 
18 #include "GeneralPostprocessor.h"
19 
20 // Forward Declarations
21 class Residual;
22 
23 template <>
25 
27 {
28 public:
30 
31  virtual void initialize() override {}
32  virtual void execute() override {}
33 
37  virtual Real getValue() override;
38 
39 protected:
41 };
42 
43 #endif // RESIDUAL_H
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< Residual >()
Definition: Residual.C:23
virtual Real getValue() override
This will return the final nonlinear residual.
Definition: Residual.C:41
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:37
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Definition: Residual.h:31
Residual(const InputParameters &parameters)
Definition: Residual.C:35
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
MooseEnum _residual_type
Definition: Residual.h:40
virtual void execute() override
Execute method.
Definition: Residual.h:32