https://mooseframework.inl.gov
Loading...
Searching...
No Matches
ADFunctionDirichletBC.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
11#include "Function.h"
12
13#include "libmesh/node.h"
14
16
19{
21 params.addClassDescription("Imposes the essential boundary condition $u=g$, where $g$ "
22 "is calculated by a function.");
23 params.addParam<FunctionName>("function", 0, "The function describing the Dirichlet condition");
24 return params;
25}
26
28 : ADDirichletBCBaseTempl<Real>(parameters), _function(getFunction("function"))
29{
30}
31
registerMooseObject("MooseApp", ADFunctionDirichletBC)
DualNumber< Real, DNDerivativeType, true > ADReal
Base class for automatic differentiation Dirichlet BCs.
static InputParameters validParams()
Boundary condition of a Dirichlet type.
static InputParameters validParams()
const Function & _function
The function describing the Dirichlet condition.
virtual ADReal computeQpValue() override
Compute the value of the Dirichlet BC at the current quadrature point.
ADFunctionDirichletBC(const InputParameters &parameters)
const Node *const & _current_node
current node being processed
Definition ADNodalBC.h:42
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:30
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an optional parameter and a documentation string to the InputParameters object.
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.