www.mooseframework.org
DirichletBC.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 "DirichletBC.h"
11 
12 registerMooseObject("MooseApp", DirichletBC);
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  : DirichletBCBase(parameters), _value(getParam<Real>("value"))
27 {
28 }
29 
30 Real
32 {
33  return _value;
34 }
virtual Real computeQpValue() override
Compute the value of the DirichletBC at the current quadrature point.
Definition: DirichletBC.C:31
Base boundary condition of a Dirichlet type.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
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: DirichletBC.h:19
static InputParameters validParams()
Definition: DirichletBC.C:15
static InputParameters validParams()
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
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...
registerMooseObject("MooseApp", DirichletBC)
void declareControllable(const std::string &name, std::set< ExecFlagType > execute_flags={})
Declare the given parameters as controllable.
const Real & _value
The value for this BC.
Definition: DirichletBC.h:30
DirichletBC(const InputParameters &parameters)
Definition: DirichletBC.C:25