https://mooseframework.inl.gov
FunctionElementIntegralUserObject.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 
11 #include "Function.h"
12 
14 
17 {
19  params.addClassDescription("Computes a volume integral of a function.");
20  params.addRequiredParam<FunctionName>("function", "The function that this object operates on");
21  return params;
22 }
23 
25  const InputParameters & parameters)
26  : ElementIntegralUserObject(parameters), _function(getFunction("function"))
27 {
28 }
29 
30 Real
32 {
33  return _function.value(_t, _q_point[_qp]);
34 }
const MooseArray< Point > & _q_point
This postprocessor computes a volume integral of the specified variable.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
registerMooseObject("MooseApp", FunctionElementIntegralUserObject)
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...
static InputParameters validParams()
This user object computes a volume integral of a specified function.
const Function & _function
Function to integrate.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
FunctionElementIntegralUserObject(const InputParameters &parameters)
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...
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:44