https://mooseframework.inl.gov
ADPenaltyDirichletBC.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 "ADPenaltyDirichletBC.h"
11 
13 
16 {
18  params.addRequiredParam<Real>("penalty", "Penalty scalar");
19  params.addParam<Real>("value", 0.0, "Boundary value of the variable");
20  params.declareControllable("value");
21  params.addClassDescription("Enforces a Dirichlet boundary condition "
22  "in a weak sense by penalizing differences between the current "
23  "solution and the Dirichlet data.");
24  return params;
25 }
26 
28  : ADIntegratedBC(parameters), _p(getParam<Real>("penalty")), _v(getParam<Real>("value"))
29 {
30 }
31 
32 ADReal
34 {
35  return _p * _test[_i][_qp] * (-_v + _u[_qp]);
36 }
const ADTemplateVariableValue< T > & _u
the values of the unknown variable this BC is acting on
const Real _p
Penalty value.
virtual ADReal computeQpResidual() override
Compute this IntegratedBC&#39;s contribution to the residual at the current quadrature point...
ADPenaltyDirichletBC(const InputParameters &parameters)
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()
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...
unsigned int _qp
quadrature point index
const Real & _v
Value of u on the boundary.
Base class for deriving any boundary condition of a integrated type.
static InputParameters validParams()
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const ADTemplateVariableTestValue< T > & _test
test function values (in QPs)
registerMooseObject("MooseApp", ADPenaltyDirichletBC)
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...
void declareControllable(const std::string &name, std::set< ExecFlagType > execute_flags={})
Declare the given parameters as controllable.
Weakly enforce a Dirichlet BC using a penalty term.