www.mooseframework.org
ConstantFunction.h
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 #ifndef CONSTANTFUNCTION_H
16 #define CONSTANTFUNCTION_H
17 
18 #include "Function.h"
19 
20 class ConstantFunction;
21 
22 template <>
24 
28 class ConstantFunction : public Function
29 {
30 public:
32 
33  virtual Real value(Real t, const Point & p) override;
34 
35 protected:
36  const Real & _value;
37 };
38 
39 #endif
const Real & _value
Class that represents constant function.
Base class for function objects.
Definition: Function.h:46
ConstantFunction(const InputParameters &parameters)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< ConstantFunction >()
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
virtual Real value(Real t, const Point &p) override
Override this to evaluate the scalar function at point (t,x,y,z), by default this returns zero...