www.mooseframework.org
UserForcingFunction.C
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #include "UserForcingFunction.h"
16 #include "Function.h"
17 
18 template <>
21 {
22  return validParams<BodyForce>();
23 }
24 
26 {
27  mooseDeprecated("UserForcingFunction has been replaced by BodyForce.");
28 }
29 
30 Real
32 {
33  mooseDeprecated("This method is a legacy method from UserForcingFunction, please update your "
34  "code to use the BodyForce object and the _function member variable instead.");
35  return _function.value(_t, _q_point[_qp]);
36 }
This kernel implements a generic functional body force term: $ - c f $.
Definition: BodyForce.h:35
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:43
InputParameters validParams< UserForcingFunction >()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
UserForcingFunction(const InputParameters &parameters)
InputParameters validParams< BodyForce >()
Definition: BodyForce.C:22
void mooseDeprecated(Args &&...args) const
Definition: MooseObject.h:95
const MooseArray< Point > & _q_point
The physical location of the element&#39;s quadrature Points, indexed by _qp.
Definition: KernelBase.h:134
Function & _function
Optional function value.
Definition: BodyForce.h:47
unsigned int _qp
The current quadrature point index.
Definition: KernelBase.h:131