www.mooseframework.org
FunctionAux.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 FUNCTIONAUX_H
16 #define FUNCTIONAUX_H
17 
18 #include "AuxKernel.h"
19 
20 // Forward Declarations
21 class FunctionAux;
22 class Function;
23 
24 template <>
26 
30 class FunctionAux : public AuxKernel
31 {
32 public:
38 
39 protected:
40  virtual Real computeValue() override;
41 
44 };
45 
46 #endif // FUNCTIONAUX_H
Base class for function objects.
Definition: Function.h:46
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
virtual Real computeValue() override
Definition: FunctionAux.C:35
Function & _func
Function being used to compute the value of this kernel.
Definition: FunctionAux.h:43
Function auxiliary value.
Definition: FunctionAux.h:30
Base class for creating new auxiliary kernels and auxiliary boundary conditions.
Definition: AuxKernel.h:51
FunctionAux(const InputParameters &parameters)
Factory constructor, takes parameters so that all derived classes can be built using the same constru...
Definition: FunctionAux.C:29
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
InputParameters validParams< FunctionAux >()
Definition: FunctionAux.C:20