www.mooseframework.org
FunctionInterface.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #include "MooseTypes.h"
13 
14 #define usingFunctionInterfaceMembers \
15  using FunctionInterface::getFunction; \
16  using FunctionInterface::getFunctionByName
17 
18 // Forward declarations
19 class Function;
20 class FEProblemBase;
21 class FunctionInterface;
22 class Function;
23 class InputParameters;
24 class MooseObject;
25 
26 template <typename T>
28 
29 template <>
31 
39 {
40 public:
47  FunctionInterface(const MooseObject * moose_object);
48 
54  Function & getFunction(const std::string & name);
55 
61  Function & getFunctionByName(const FunctionName & name);
62 
63 private:
66 
69 
72 };
73 
Base class for function objects.
Definition: Function.h:40
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:42
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()
This is the templated validParams() function that every MooseObject-derived class is required to spec...
unsigned int THREAD_ID
Definition: MooseTypes.h:161