FunctionInterface.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* 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 "MooseObject.h"
#include "InputParameters.h"

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

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

namespace Moose
{
class FunctionBase;
}

#ifdef MOOSE_KOKKOS_ENABLED
namespace Moose::Kokkos
{
class Function;
}
#endif

template <typename T>
InputParameters validParams();

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

#ifdef MOOSE_KOKKOS_ENABLED

  FunctionInterface(const FunctionInterface & object, const Moose::Kokkos::FunctorCopy & key);
#endif

  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;

#ifdef MOOSE_KOKKOS_ENABLED

  Moose::Kokkos::Function getKokkosFunction(const std::string & name) const;

  Moose::Kokkos::Function getKokkosFunctionByName(const FunctionName & name) const;

  template <typename T>
  const T & getKokkosFunction(const std::string & name) const;

  template <typename T>
  const T & getKokkosFunctionByName(const FunctionName & name) const;

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

  bool hasKokkosFunctionByName(const FunctionName & name) const;
#endif

private:
#ifdef MOOSE_KOKKOS_ENABLED
  const Moose::FunctionBase * getKokkosFunctionByNameHelper(const FunctionName & name) const;

  const MooseObject & _fni_object;
#endif

  const InputParameters & _fni_params;

  FEProblemBase & _fni_feproblem;

  const THREAD_ID _fni_tid;
};

#ifdef MOOSE_KOKKOS_ENABLED
template <typename T>
const T &
FunctionInterface::getKokkosFunction(const std::string & name) const
{
  return getKokkosFunctionByName<T>(_fni_params.get<FunctionName>(name));
}

template <typename T>
const T &
FunctionInterface::getKokkosFunctionByName(const FunctionName & name) const
{
  auto function = dynamic_cast<const T *>(getKokkosFunctionByNameHelper(name));

  if (!function)
    _fni_object.mooseError(
        "Kokkos function '", name, "' is not of type '", MooseUtils::prettyCppType<T>(), "'");

  return *function;
}
#endif