https://mooseframework.inl.gov
ADRobinBC.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 "ADRobinBC.h"
11 
12 registerMooseObject("MooseApp", ADRobinBC);
13 
16 {
18  params.addClassDescription("Imposes the Robin integrated boundary condition "
19  "$\\frac{\\partial u}{\\partial n}=u$.");
20  params.addParam<Real>(
21  "coefficient", 1.0, "Coefficient multiplier for the Robin boundary condition term.");
22  return params;
23 }
24 
26  : ADIntegratedBC(parameters), _coef(getParam<Real>("coefficient"))
27 {
28 }
29 
30 ADReal
32 {
33  return _coef * _test[_i][_qp] * _u[_qp];
34 }
const ADTemplateVariableValue< T > & _u
the values of the unknown variable this BC is acting on
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
unsigned int _i
i-th, j-th index for enumerating test and shape functions
DualNumber< Real, DNDerivativeType, true > ADReal
Definition: ADRealForward.h:47
static InputParameters validParams()
unsigned int _qp
quadrature point index
ADRobinBC(const InputParameters &parameters)
Definition: ADRobinBC.C:25
Base class for deriving any boundary condition of a integrated type.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const ADTemplateVariableTestValue< T > & _test
test function values (in QPs)
registerMooseObject("MooseApp", ADRobinBC)
const Real _coef
Coefficient to be applied to the Robin boundary condition.
Definition: ADRobinBC.h:25
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 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...
static InputParameters validParams()
Definition: ADRobinBC.C:15
ADReal computeQpResidual() override
Compute this IntegratedBC&#39;s contribution to the residual at the current quadrature point...
Definition: ADRobinBC.C:31