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 
17 {
18  return BodyForce::validParams();
19 }
20 
22 {
23  mooseDeprecated("UserForcingFunction has been replaced by BodyForce.");
24 }
25 
26 Real
28 {
29  mooseDeprecated("This method is a legacy method from UserForcingFunction, please update your "
30  "code to use the BodyForce object and the _function member variable instead.");
31  return _function.value(_t, _q_point[_qp]);
32 }
static InputParameters validParams()
Definition: BodyForce.C:21
void mooseDeprecated(Args &&... args) const
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)
const Function & _function
Optional function value.
Definition: BodyForce.h:39
static InputParameters validParams()
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
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:41
Deprecated, use BodyForce.
This kernel implements a generic functional body force term: $ - c f $.
Definition: BodyForce.h:25
const MooseArray< Point > & _q_point
The physical location of the element&#39;s quadrature Points, indexed by _qp.
Definition: KernelBase.h:45
unsigned int _qp
The current quadrature point index.
Definition: KernelBase.h:42