www.mooseframework.org
PresetBC.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 "PresetBC.h"
16 
17 template <>
20 {
22  p.addRequiredParam<Real>("value", "Value of the BC");
23  p.declareControllable("value");
25  "Similar to DirichletBC except the value is applied before the solve begins");
26  return p;
27 }
28 
30  : PresetNodalBC(parameters), _value(getParam<Real>("value"))
31 {
32 }
33 
34 Real
36 {
37  return _value;
38 }
const Real & _value
Definition: PresetBC.h:36
InputParameters validParams< PresetBC >()
Definition: PresetBC.C:19
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
virtual Real computeQpValue() override
Definition: PresetBC.C:35
InputParameters validParams< NodalBC >()
Definition: NodalBC.C:23
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...
void declareControllable(const std::string &name)
Declare the given parameters as controllable.
PresetBC(const InputParameters &parameters)
Definition: PresetBC.C:29
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...