www.mooseframework.org
include
postprocessors
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
class
VariableResidual
:
public
GeneralPostprocessor
15
{
16
public
:
17
static
InputParameters
validParams
();
18
19
VariableResidual
(
const
InputParameters
&
parameters
);
20
21
virtual
void
initialize
()
override
;
22
virtual
void
execute
()
override
;
23
24
virtual
PostprocessorValue
getValue
()
const override
;
25
26
protected
:
28
MooseVariableFEBase
&
_var
;
30
Real
_var_residual
;
31
};
VariableResidual::initialize
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Definition:
VariableResidual.C:43
VariableResidual
Definition:
VariableResidual.h:14
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition:
InputParameters.h:63
MooseVariableFieldBase
This class provides an interface for common operations on field variables of both FE and FV types wit...
Definition:
MooseVariableFieldBase.h:29
GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition:
GeneralPostprocessor.h:21
VariableResidual::_var
MooseVariableFEBase & _var
MOOSE variable we compute the residual for.
Definition:
VariableResidual.h:28
VariableResidual::validParams
static InputParameters validParams()
Definition:
VariableResidual.C:22
VariableResidual::VariableResidual
VariableResidual(const InputParameters ¶meters)
Definition:
VariableResidual.C:33
PostprocessorValue
Real PostprocessorValue
various MOOSE typedefs
Definition:
MooseTypes.h:191
VariableResidual::getValue
virtual PostprocessorValue getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
Definition:
VariableResidual.C:56
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
VariableResidual::execute
virtual void execute() override
Execute method.
Definition:
VariableResidual.C:49
GeneralPostprocessor.h
MooseBaseParameterInterface::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition:
MooseBaseParameterInterface.h:62
VariableResidual::_var_residual
Real _var_residual
The residual of the variable.
Definition:
VariableResidual.h:30
Generated on Wed Mar 27 2024 17:44:37 for www.mooseframework.org by
1.8.14