www.mooseframework.org
FunctionPresetBC.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 "FunctionPresetBC.h"
11 #include "Function.h"
12 
14 
15 template <>
18 {
20  params.addRequiredParam<FunctionName>("function", "The forcing function.");
21  params.addClassDescription(
22  "The same as FunctionDirichletBC except the value is applied before the solve begins");
23  return params;
24 }
25 
27  : PresetNodalBC(parameters), _func(getFunction("function"))
28 {
29 }
30 
31 Real
33 {
34  return _func.value(_t, *_current_node);
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:38
const Node *const & _current_node
current node being processed
Definition: NodalBC.h:44
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Function & _func
Function being used for evaluation of this BC.
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...
InputParameters validParams< FunctionPresetBC >()
virtual Real computeQpValue() override
Evaluate the function at the current quadrature point and timestep.
Defines a boundary condition that forces the value to be a user specified function at the boundary...
Base class for nodal BCs that (pre)set the solution vector entries.
Definition: PresetNodalBC.h:22
InputParameters validParams< PresetNodalBC >()
Definition: PresetNodalBC.C:19
FunctionPresetBC(const InputParameters &parameters)
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...
registerMooseObject("MooseApp", FunctionPresetBC)