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