www.mooseframework.org
FunctionDirichletBC.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 "FunctionDirichletBC.h"
11 #include "Function.h"
12 
14 
16 
19 {
21  params.addRequiredParam<FunctionName>("function", "The forcing function.");
22  params.addClassDescription(
23  "Imposes the essential boundary condition $u=g(t,\\vec{x})$, where $g$ "
24  "is a (possibly) time and space-dependent MOOSE Function.");
25  return params;
26 }
27 
29  : DirichletBCBase(parameters), _func(getFunction("function"))
30 {
31 }
32 
33 Real
35 {
36  return _func.value(_t, *_current_node);
37 }
FunctionDirichletBC::computeQpValue
virtual Real computeQpValue() override
Compute the value of the DirichletBC at the current quadrature point.
Definition: FunctionDirichletBC.C:34
Function::value
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:39
FunctionDirichletBC
Defines a boundary condition that forces the value to be a user specified function at the boundary.
Definition: FunctionDirichletBC.h:25
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition: InputParameters.h:53
FunctionDirichletBC.h
NodalBC::_current_node
const Node *const & _current_node
current node being processed
Definition: NodalBC.h:46
DirichletBCBase
Base boundary condition of a Dirichlet type.
Definition: DirichletBCBase.h:22
TransientInterface::_t
Real & _t
Time.
Definition: TransientInterface.h:58
InputParameters::addClassDescription
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.
Definition: InputParameters.C:70
FunctionDirichletBC::validParams
static InputParameters validParams()
Definition: FunctionDirichletBC.C:18
Function.h
FunctionDirichletBC::FunctionDirichletBC
FunctionDirichletBC(const InputParameters &parameters)
Definition: FunctionDirichletBC.C:28
defineLegacyParams
defineLegacyParams(FunctionDirichletBC)
registerMooseObject
registerMooseObject("MooseApp", FunctionDirichletBC)
InputParameters::addRequiredParam
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...
Definition: InputParameters.h:1176
FunctionDirichletBC::_func
const Function & _func
The function being used for evaluation.
Definition: FunctionDirichletBC.h:36
DirichletBCBase::validParams
static InputParameters validParams()
Definition: DirichletBCBase.C:15