www.mooseframework.org
FunctionNeumannBC.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 "FunctionNeumannBC.h"
11 #include "Function.h"
12 
14 
15 template <>
18 {
20  params.addRequiredParam<FunctionName>("function", "The function.");
21  params.addClassDescription("Imposes the integrated boundary condition "
22  "$\\frac{\\partial u}{\\partial n}=h(t,\\vec{x})$, "
23  "where $h$ is a (possibly) time and space-dependent MOOSE Function.");
24  return params;
25 }
26 
28  : IntegratedBC(parameters), _func(getFunction("function"))
29 {
30 }
31 
32 Real
34 {
35  return -_test[_i][_qp] * _func.value(_t, _q_point[_qp]);
36 }
const VariableTestValue & _test
test function values (in QPs)
Definition: IntegratedBC.h:68
virtual Real value(Real t, const Point &p)
Override this to evaluate the scalar function at point (t,x,y,z), by default this returns zero...
Definition: Function.C:38
InputParameters validParams< IntegratedBC >()
Definition: IntegratedBC.C:23
InputParameters validParams< FunctionNeumannBC >()
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
Boundary condition of a Neumann style whose value is computed by a user-defined function.
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 MooseArray< Point > & _q_point
active quadrature points
Base class for deriving any boundary condition of a integrated type.
Definition: IntegratedBC.h:24
Function & _func
The function being used for setting the value.
FunctionNeumannBC(const InputParameters &parameters)
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...
virtual Real computeQpResidual() override
method for computing the residual at quadrature points
registerMooseObject("MooseApp", FunctionNeumannBC)