https://mooseframework.inl.gov
Loading...
Searching...
No Matches
ElementL2ErrorFunctionAux.C
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// MOOSE includes
12#include "Function.h"
13
15
18{
20 params.addClassDescription("A class for computing the element-wise L^2 (Euclidean) error between "
21 "a function and a coupled variable.");
22 params.addRequiredParam<FunctionName>("function", "Function representing the exact solution");
23 return params;
24}
25
27 : ElementLpNormAux(parameters), _func(getFunction("function"))
28{
29}
30
31Real
registerMooseObject("MooseApp", ElementL2ErrorFunctionAux)
const MooseArray< Point > & _q_point
Active quadrature points.
Definition AuxKernel.h:125
unsigned int _qp
Quadrature point index.
Definition AuxKernel.h:155
A class for computing the element-wise L^2 error (actually L^p error, if you set the value of p to so...
const Function & _func
Function representing the exact solution.
static InputParameters validParams()
virtual Real computeValue() override
Returns the difference between the solution variable and the exact solution Function.
ElementL2ErrorFunctionAux(const InputParameters &parameters)
Class constructor.
Compute an elemental field variable (single value per element) equal to the Lp-norm of a coupled Vari...
static InputParameters validParams()
const VariableValue & _coupled_var
A reference to the variable to compute the norm of.
virtual Real value(Real t, const Point &p) const
Override this to evaluate the scalar function at point (t,x,y,z), by default this returns zero,...
Definition Function.C:30
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
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...
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.