www.mooseframework.org
NeumannBC.C
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #include "NeumannBC.h"
16 
17 template <>
20 {
22  params.addParam<Real>("value", 0.0, "The value of the gradient on the boundary.");
23  params.declareControllable("value");
24  params.addClassDescription("Imposes the integrated boundary condition "
25  "$\\frac{\\partial u}{\\partial n}=h$, "
26  "where $h$ is a constant, controllable value.");
27  return params;
28 }
29 
31  : IntegratedBC(parameters), _value(getParam<Real>("value"))
32 {
33 }
34 
35 Real
37 {
38  return -_test[_i][_qp] * _value;
39 }
const VariableTestValue & _test
test function values (in QPs)
Definition: IntegratedBC.h:105
InputParameters validParams< IntegratedBC >()
Definition: IntegratedBC.C:28
virtual Real computeQpResidual() override
Definition: NeumannBC.C:36
NeumannBC(const InputParameters &parameters)
Factory constructor, takes parameters so that all derived classes can be built using the same constru...
Definition: NeumannBC.C:30
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Base class for deriving any boundary condition of a integrated type.
Definition: IntegratedBC.h:33
void declareControllable(const std::string &name)
Declare the given parameters as controllable.
unsigned int _qp
quadrature point index
Definition: IntegratedBC.h:83
InputParameters validParams< NeumannBC >()
Definition: NeumannBC.C:19
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 option parameter and a documentation string to the InputParameters object...
unsigned int _i
i-th, j-th index for enumerating test and shape functions
Definition: IntegratedBC.h:93
const Real & _value
Value of grad(u) on the boundary.
Definition: NeumannBC.h:42