www.mooseframework.org
VectorDirichletBC.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 "VectorDirichletBC.h"
11 
14  LagrangeVecDirichletBC,
15  "05/01/2019 00:01",
17 
20 {
22  params.addRequiredParam<RealVectorValue>("values",
23  "The values the components must take on the boundary");
24  params.declareControllable("values");
25  params.addClassDescription(
26  "Imposes the essential boundary condition $\\vec{u}=\\vec{g}$, where $\\vec{g}$ "
27  "are constant, controllable values.");
28  return params;
29 }
30 
32  : VectorNodalBC(parameters), _values(getParam<RealVectorValue>("values"))
33 {
34 }
35 
38 {
39  return _u - _values;
40 }
const RealVectorValue & _u
Value of the unknown variable this BC is acting on.
Definition: VectorNodalBC.h:41
static InputParameters validParams()
Definition: VectorNodalBC.C:18
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
VectorDirichletBC(const InputParameters &parameters)
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...
const RealVectorValue & _values
The value for this BC.
Base class for deriving any boundary condition that works at nodes on vector variables.
Definition: VectorNodalBC.h:18
registerMooseObjectRenamed("MooseApp", LagrangeVecDirichletBC, "05/01/2019 00:01", VectorDirichletBC)
virtual RealVectorValue computeQpResidual() override
Boundary condition of a Dirichlet type.
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...
static InputParameters validParams()
registerMooseObject("MooseApp", VectorDirichletBC)
void declareControllable(const std::string &name, std::set< ExecFlagType > execute_flags={})
Declare the given parameters as controllable.