www.mooseframework.org
Residual.h
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 
10 #pragma once
11 
12 #include "GeneralPostprocessor.h"
13 
14 // Forward Declarations
15 class Residual;
16 
17 template <>
19 
21 {
22 public:
24 
25  virtual void initialize() override {}
26  virtual void execute() override {}
27 
31  virtual Real getValue() override;
32 
33 protected:
35 };
36 
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:20
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:65
virtual Real getValue() override
This will return the final nonlinear residual.
Definition: Residual.C:38
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:31
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Definition: Residual.h:25
Residual(const InputParameters &parameters)
Definition: Residual.C:32
MooseEnum _residual_type
Definition: Residual.h:34
virtual void execute() override
Execute method.
Definition: Residual.h:26