www.mooseframework.org
VariableResidual.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 VariableResidual;
16 
17 template <>
19 
21 {
22 public:
24 
26 
27  virtual void initialize() override;
28  virtual void execute() override;
29 
30  virtual PostprocessorValue getValue() override;
31 
32 protected:
37 };
38 
MooseVariableFEBase
Definition: MooseVariableFEBase.h:27
VariableResidual::VariableResidual
VariableResidual(const InputParameters &parameters)
Definition: VariableResidual.C:34
VariableResidual::execute
virtual void execute() override
Execute method.
Definition: VariableResidual.C:50
MooseObject::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:76
VariableResidual::_var_residual
Real _var_residual
The residual of the variable.
Definition: VariableResidual.h:36
VariableResidual::getValue
virtual PostprocessorValue getValue() override
This will get called to actually grab the final value the postprocessor has calculated.
Definition: VariableResidual.C:57
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition: InputParameters.h:53
PostprocessorValue
Real PostprocessorValue
MOOSE typedefs.
Definition: MooseTypes.h:189
GeneralPostprocessor.h
GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition: GeneralPostprocessor.h:27
VariableResidual
Definition: VariableResidual.h:20
VariableResidual::initialize
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Definition: VariableResidual.C:44
validParams< VariableResidual >
InputParameters validParams< VariableResidual >()
VariableResidual::validParams
static InputParameters validParams()
Definition: VariableResidual.C:24
VariableResidual::_var
MooseVariableFEBase & _var
MOOSE variable we compute the residual for.
Definition: VariableResidual.h:34