https://mooseframework.inl.gov
FunctionDirichletBC.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
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 "FunctionDirichletBC.h"
11 #include "Function.h"
12 
14 
17 {
19  params.addRequiredParam<FunctionName>("function", "The forcing function.");
20  params.addClassDescription(
21  "Imposes the essential boundary condition $u=g(t,\\vec{x})$, where $g$ "
22  "is a (possibly) time and space-dependent MOOSE Function.");
23  return params;
24 }
25 
27  : DirichletBCBase(parameters), _func(getFunction("function"))
28 {
29 }
30 
31 Real
33 {
34  return _func.value(_t, *_current_node);
35 }
const Node *const & _current_node
current node being processed
Definition: NodalBC.h:41
Base boundary condition of a Dirichlet type.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
static InputParameters validParams()
virtual Real computeQpValue() override
Compute the value of the DirichletBC at the current quadrature point.
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...
Defines a boundary condition that forces the value to be a user specified function at the boundary...
const Function & _func
The function being used for evaluation.
FunctionDirichletBC(const InputParameters &parameters)
static InputParameters validParams()
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
registerMooseObject("MooseApp", FunctionDirichletBC)
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...
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:44