www.mooseframework.org
UserForcingFunctionNodalKernel.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 
11 
12 #include "Function.h"
13 
15 
16 template <>
19 {
21  params.addRequiredParam<FunctionName>("function", "The forcing function");
22  return params;
23 }
24 
26  : NodalKernel(parameters), _func(getFunction("function"))
27 {
28 }
29 
30 Real
32 {
33  return -_func.value(_t, (*_current_node));
34 }
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
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< NodalKernel >()
Definition: NodalKernel.C:19
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 computeQpResidual() override
The user can override this function to compute the residual at a node.
Represents the rate in a simple ODE of du/dt = f.
registerMooseObject("MooseApp", UserForcingFunctionNodalKernel)
const Node *const & _current_node
current node being processed
Definition: NodalKernel.h:148
UserForcingFunctionNodalKernel(const InputParameters &parameters)
Constructor grabs the Function.
Base class for creating new types of boundary conditions.
Definition: NodalKernel.h:48
InputParameters validParams< UserForcingFunctionNodalKernel >()