www.mooseframework.org
AnalyticalIndicator.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 #include "AnalyticalIndicator.h"
11 #include "Function.h"
12 
14 
15 template <>
18 {
20  params.addRequiredParam<FunctionName>("function", "The analytic solution to compare against");
21  params.addClassDescription(
22  "Compute the difference between an unknown variable and an analytical solution.");
23  return params;
24 }
25 
27  : ElementIntegralIndicator(parameters), _func(getFunction("function"))
28 {
29 }
30 
31 Real
33 {
34  Real diff = _u[_qp] - _func.value(_t, _q_point[_qp]);
35  return diff * diff;
36 }
AnalyticalIndicator(const InputParameters &parameters)
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
registerMooseObject("MooseApp", AnalyticalIndicator)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
virtual Real computeQpIntegral() override
InputParameters validParams< AnalyticalIndicator >()
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...
unsigned int _qp
const MooseArray< Point > & _q_point
const VariableValue & _u
Holds the solution at current quadrature points.
InputParameters validParams< ElementIntegralIndicator >()