www.mooseframework.org
UserForcingFunction.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 "UserForcingFunction.h"
11 #include "Function.h"
12 
13 registerMooseObjectRenamed("MooseApp", UserForcingFunction, "04/01/2018 00:00", BodyForce);
14 
15 template <>
18 {
19  return validParams<BodyForce>();
20 }
21 
23 {
24  mooseDeprecated("UserForcingFunction has been replaced by BodyForce.");
25 }
26 
27 Real
29 {
30  mooseDeprecated("This method is a legacy method from UserForcingFunction, please update your "
31  "code to use the BodyForce object and the _function member variable instead.");
32  return _function.value(_t, _q_point[_qp]);
33 }
This kernel implements a generic functional body force term: $ - c f $.
Definition: BodyForce.h:29
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
InputParameters validParams< UserForcingFunction >()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
registerMooseObjectRenamed("MooseApp", UserForcingFunction, "04/01/2018 00:00", BodyForce)
UserForcingFunction(const InputParameters &parameters)
InputParameters validParams< BodyForce >()
Definition: BodyForce.C:19
void mooseDeprecated(Args &&... args) const
Definition: MooseObject.h:161
Deprecated, use BodyForce.
const MooseArray< Point > & _q_point
The physical location of the element&#39;s quadrature Points, indexed by _qp.
Definition: KernelBase.h:153
Function & _function
Optional function value.
Definition: BodyForce.h:41
unsigned int _qp
The current quadrature point index.
Definition: KernelBase.h:150