www.mooseframework.org
ElementL2ErrorFunctionAux.C
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 // MOOSE includes
12 #include "Function.h"
13 
15 
16 template <>
19 {
21  params.addClassDescription("A class for computing the element-wise L^2 (Euclidean) error between "
22  "a function and a coupled variable.");
23  params.addRequiredParam<FunctionName>("function", "Function representing the exact solution");
24  return params;
25 }
26 
28  : ElementLpNormAux(parameters), _func(getFunction("function"))
29 {
30 }
31 
32 Real
34 {
35  return _func.value(_t, _q_point[_qp]) - _coupled_var[_qp];
36 }
registerMooseObject("MooseApp", ElementL2ErrorFunctionAux)
virtual Real value(Real t, const Point &p)
Override this to evaluate the scalar function at point (t,x,y,z), by default this returns zero...
Definition: Function.C:38
Compute an elemental field variable (single value per element) equal to the Lp-norm of a coupled Vari...
virtual Real computeValue() override
Returns the difference between the solution variable and the exact solution Function.
A class for computing the element-wise L^2 error (actually L^p error, if you set the value of p to so...
InputParameters validParams< ElementLpNormAux >()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
const VariableValue & _coupled_var
A reference to the variable to compute the norm of.
ElementL2ErrorFunctionAux(const InputParameters &parameters)
Class constructor.
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
Function & _func
Function representing the exact solution.
InputParameters validParams< ElementL2ErrorFunctionAux >()
unsigned int _qp
Quadrature point index.
Definition: AuxKernel.h:219
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
const MooseArray< Point > & _q_point
Dimension of the problem being solved.
Definition: AuxKernel.h:195