FunctionInterface.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "MooseTypes.h"
#include "InputParameters.h"

#define usingFunctionInterfaceMembers                                                              \
  using FunctionInterface::getFunction;                                                            \
  using FunctionInterface::getFunctionByName

// Forward declarations
class Function;
class FEProblemBase;
class Function;
class InputParameters;
class MooseObject;

template <typename T>
InputParameters validParams();

class FunctionInterface
{
public:
  FunctionInterface(const MooseObject * moose_object);

  static InputParameters validParams();

  const Function & getFunction(const std::string & name) const;

  const Function & getFunctionByName(const FunctionName & name) const;

  bool hasFunction(const std::string & param_name) const;

  bool hasFunctionByName(const FunctionName & name) const;

private:
  const InputParameters & _fni_params;

  FEProblemBase & _fni_feproblem;

  const THREAD_ID _fni_tid;
};