https://mooseframework.inl.gov
ADDirichletBC.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 "ADDirichletBC.h"
11 
13 
16 {
18  params.addRequiredParam<Real>("value", "Value of the BC");
19  params.declareControllable("value");
20  params.addClassDescription("Imposes the essential boundary condition $u=g$, where $g$ "
21  "is a constant, controllable value.");
22  return params;
23 }
24 
26  : ADDirichletBCBaseTempl<Real>(parameters), _value(getParam<Real>("value"))
27 {
28 }
29 
30 ADReal
32 {
33  return _value;
34 }
static InputParameters validParams()
Definition: ADDirichletBC.C:15
Base class for automatic differentiation Dirichlet BCs.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
DualNumber< Real, DNDerivativeType, true > ADReal
Definition: ADRealForward.h:47
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...
Boundary condition of a Dirichlet type.
Definition: ADDirichletBC.h:19
registerMooseObject("MooseApp", ADDirichletBC)
ADDirichletBC(const InputParameters &parameters)
Definition: ADDirichletBC.C:25
virtual ADReal computeQpValue() override
Compute the value of the Dirichlet BC at the current quadrature point.
Definition: ADDirichletBC.C:31
const Real & _value
The value for this BC.
Definition: ADDirichletBC.h:30
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
static InputParameters validParams()
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...
void declareControllable(const std::string &name, std::set< ExecFlagType > execute_flags={})
Declare the given parameters as controllable.