https://mooseframework.inl.gov
include
postprocessors
Residual.h
Go to the documentation of this file.
1
//* This file is part of the MOOSE framework
2
//* https://mooseframework.inl.gov
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
class
Residual
:
public
GeneralPostprocessor
15
{
16
public
:
17
static
InputParameters
validParams
();
18
19
Residual
(
const
InputParameters
&
parameters
);
20
21
virtual
void
initialize
()
override
{}
22
virtual
void
execute
()
override
{}
23
27
virtual
Real
getValue
()
const override
;
28
29
protected
:
30
MooseEnum
_residual_type
;
31
};
Residual
Definition:
Residual.h:14
Residual::validParams
static InputParameters validParams()
Definition:
Residual.C:19
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition:
InputParameters.h:66
GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition:
GeneralPostprocessor.h:21
Residual::getValue
virtual Real getValue() const override
This will return the final nonlinear residual.
Definition:
Residual.C:39
MooseEnum
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition:
MooseEnum.h:33
Residual::initialize
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Definition:
Residual.h:21
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
GeneralPostprocessor.h
Residual::Residual
Residual(const InputParameters ¶meters)
Definition:
Residual.C:29
MooseBaseParameterInterface::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition:
MooseBaseParameterInterface.h:62
Residual::_residual_type
MooseEnum _residual_type
Definition:
Residual.h:30
Residual::execute
virtual void execute() override
Execute method.
Definition:
Residual.h:22
Generated on Thu Jul 17 2025 01:32:07 for https://mooseframework.inl.gov by
1.8.14