www.mooseframework.org
MooseParsedVectorFunction.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 MOOSEPARSEDVECTORFUNCTION_H
16 #define MOOSEPARSEDVECTORFUNCTION_H
17 
18 // MOOSE includes
19 #include "Function.h"
21 
22 // Forward decleratrions
24 
25 template <>
27 
33 {
34 public:
40 
41  virtual RealVectorValue vectorValue(Real t, const Point & p) override;
42 
43  virtual RealGradient gradient(Real t, const Point & p) override;
44 
45  virtual void initialSetup() override;
46 
47 protected:
49  std::string _vector_value;
50 };
51 
52 #endif // MOOSEPARSEDVECTORFUNCTION_H
RealVectorValue RealGradient
Definition: Assembly.h:43
Base class for function objects.
Definition: Function.h:46
virtual void initialSetup() override
Gets called at the beginning of the simulation before this object is asked to do its job...
Adds user facing parameters for parsed function.
VectorValue< Real > RealVectorValue
Definition: Assembly.h:40
virtual RealVectorValue vectorValue(Real t, const Point &p) override
Override this to evaluate the vector function at a point (t,x,y,z), by default this returns a zero ve...
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
std::string _vector_value
Storage for gradient input function(s), in format ready for libMesh.
virtual RealGradient gradient(Real t, const Point &p) override
Function objects can optionally provide a gradient at a point.
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
MooseParsedVectorFunction(const InputParameters &parameters)
Class constructor.
InputParameters validParams< MooseParsedVectorFunction >()
This class is similar to ParsedFunction except it returns a vector function.