www.mooseframework.org
MooseParsedFunction.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 MOOSEPARSEDFUNCTION_H
16 #define MOOSEPARSEDFUNCTION_H
17 
18 // MOOSE includes
19 #include "Function.h"
21 
22 // Forward declarations
24 
25 template <>
27 
37 {
38 public:
44 
52  virtual Real value(Real t, const Point & pt) override;
53 
58  virtual RealGradient gradient(Real t, const Point & p) override;
59 
67  virtual Real timeDerivative(Real t, const Point & p) override;
68 
73  virtual RealVectorValue vectorValue(Real t, const Point & p) override;
74 
78  virtual void initialSetup() override;
79 
80 protected:
82  std::string _value;
83 
84  friend class ParsedFunctionTest;
85 };
86 #endif // MOOSEPARSEDFUNCTION_H
RealVectorValue RealGradient
Definition: Assembly.h:43
Base class for function objects.
Definition: Function.h:46
Adds user facing parameters for parsed function.
VectorValue< Real > RealVectorValue
Definition: Assembly.h:40
MooseParsedFunction(const InputParameters &parameters)
Created from MooseSystem via the FunctionFactory.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
This class is used to evaluate symbolic equations passed in to Moose through the input file...
virtual void initialSetup() override
Creates the parsed function.
virtual RealVectorValue vectorValue(Real t, const Point &p) override
Method invalid for ParsedGradFunction.
virtual Real value(Real t, const Point &pt) override
Evaluate the equation at the given location.
virtual Real timeDerivative(Real t, const Point &p) override
Evaluate the time derivative of the function.
InputParameters validParams< MooseParsedFunction >()
std::string _value
The function defined by the user.
friend class ParsedFunctionTest
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
virtual RealGradient gradient(Real t, const Point &p) override
Evaluate the gradient of the function.