www.mooseframework.org
ConstantScalarAux.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 "ConstantScalarAux.h"
16 
17 template <>
20 {
22  params.addRequiredParam<Real>("value", "The value to be set to the scalar variable.");
23  params.declareControllable("value");
24  return params;
25 }
26 
28  : AuxScalarKernel(parameters), _value(getParam<Real>("value"))
29 {
30 }
31 
32 Real
34 {
35  return _value;
36 }
ConstantScalarAux(const InputParameters &parameters)
virtual Real computeValue() override
Compute the value of this kernel.
InputParameters validParams< ConstantScalarAux >()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
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...
Base class for making kernels that work on auxiliary scalar variables.
void declareControllable(const std::string &name)
Declare the given parameters as controllable.
InputParameters validParams< AuxScalarKernel >()