www.mooseframework.org
LinearCombinationFunction.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 LINEARCOMBINATIONFUNCTION_H
16 #define LINEARCOMBINATIONFUNCTION_H
17 
18 #include "Function.h"
19 #include "FunctionInterface.h"
20 
22 
23 template <>
25 
30 {
31 public:
33 
34  virtual Real value(Real t, const Point & pt) override;
35  virtual RealVectorValue vectorValue(Real t, const Point & p) override;
36  virtual RealGradient gradient(Real t, const Point & p) override;
37 
38 private:
39  std::vector<Real> _w;
40 
41  std::vector<Function *> _f;
42 };
43 
44 #endif // LINEARCOMBINATIONFUNCTION_H
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...
Sum_over_i (w_i * functions_i)
RealVectorValue RealGradient
Definition: Assembly.h:43
Base class for function objects.
Definition: Function.h:46
VectorValue< Real > RealVectorValue
Definition: Assembly.h:40
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
LinearCombinationFunction(const InputParameters &parameters)
InputParameters validParams< LinearCombinationFunction >()
virtual RealGradient gradient(Real t, const Point &p) override
Function objects can optionally provide a gradient at a point.
virtual Real value(Real t, const Point &pt) override
Override this to evaluate the scalar function at point (t,x,y,z), by default this returns zero...
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
std::vector< Function * > _f
Interface for objects that need to use functions.