www.mooseframework.org
FunctionInterface.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 FUNCTIONINTERFACE_H
16 #define FUNCTIONINTERFACE_H
17 
18 #include "MooseTypes.h"
19 
20 // Forward declarations
21 class Function;
22 class FEProblemBase;
23 class FunctionInterface;
24 class Function;
25 class InputParameters;
26 class MooseObject;
27 
28 template <typename T>
30 
31 template <>
33 
41 {
42 public:
49  FunctionInterface(const MooseObject * moose_object);
50 
56  Function & getFunction(const std::string & name);
57 
63  Function & getFunctionByName(const FunctionName & name);
64 
65 private:
68 
71 
74 };
75 
76 #endif // FUNCTIONINTERFACE_H
Base class for function objects.
Definition: Function.h:46
FunctionInterface(const MooseObject *moose_object)
Function & getFunction(const std::string &name)
Get a function with a given name.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
InputParameters validParams< FunctionInterface >()
Every object that can be built by the factory should be derived from this class.
Definition: MooseObject.h:36
FEProblemBase & _fni_feproblem
Reference to FEProblemBase instance.
const InputParameters & _fni_params
Parameters of the object with this interface.
Function & getFunctionByName(const FunctionName &name)
Get a function with a given name.
Interface for objects that need to use functions.
THREAD_ID _fni_tid
Thread ID.
InputParameters validParams()
unsigned int THREAD_ID
Definition: MooseTypes.h:79