www.mooseframework.org
FunctionAux.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 "FunctionAux.h"
11 #include "Function.h"
12 
13 registerMooseObject("MooseApp", FunctionAux);
14 
15 template <>
18 {
20  params.addClassDescription("Auxiliary Kernel that creates and updates a field variable by "
21  "sampling a function through space and time.");
22  params.addRequiredParam<FunctionName>("function", "The function to use as the value");
23  return params;
24 }
25 
27  : AuxKernel(parameters), _func(getFunction("function"))
28 {
29 }
30 
31 Real
33 {
34  if (isNodal())
35  return _func.value(_t, *_current_node);
36  else
37  return _func.value(_t, _q_point[_qp]);
38 }
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", FunctionAux)
const Node *const & _current_node
Current node (valid only for nodal kernels)
Definition: AuxKernel.h:213
InputParameters validParams< FunctionAux >()
Definition: FunctionAux.C:17
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...
virtual Real computeValue() override
Compute and return the value of the aux variable.
Definition: FunctionAux.C:32
InputParameters validParams< AuxKernel >()
Definition: AuxKernel.C:25
Function & _func
Function being used to compute the value of this kernel.
Definition: FunctionAux.h:37
Function auxiliary value.
Definition: FunctionAux.h:24
bool isNodal()
Nodal or elemental kernel?
Definition: AuxKernel.h:84
FunctionAux(const InputParameters &parameters)
Factory constructor, takes parameters so that all derived classes can be built using the same constru...
Definition: FunctionAux.C:26
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...
Base class for creating new auxiliary kernels and auxiliary boundary conditions.
Definition: AuxKernel.h:33
const MooseArray< Point > & _q_point
Dimension of the problem being solved.
Definition: AuxKernel.h:195