FunctionInterface Class Reference

Interface for objects that need to use functions. More...

#include <FunctionInterface.h>

Inheritance diagram for FunctionInterface:

Public Member Functions
	FunctionInterface (const MooseObject *moose_object)
	FunctionInterface (const FunctionInterface &object, const Moose::Kokkos::FunctorCopy &key)
	Special constructor used for Kokkos functor copy during parallel dispatch. More...
const Function &	getFunction (const std::string &name) const
	Get a function with a given name. More...
const Function &	getFunctionByName (const FunctionName &name) const
	Get a function with a given name. More...
bool	hasFunction (const std::string &param_name) const
	Determine if the function exists. More...
bool	hasFunctionByName (const FunctionName &name) const
	Determine if the function exists. More...
Moose::Kokkos::Function	getKokkosFunction (const std::string &name) const
	Get a Kokkos function of an abstract type with a given name Calling this function will error out currently if Kokkos was configured with GPU. More...
Moose::Kokkos::Function	getKokkosFunctionByName (const FunctionName &name) const
	Get a Kokkos function of an abstract type with a given name Calling this function will error out currently if Kokkos was configured with GPU. More...
template<typename T >
const T &	getKokkosFunction (const std::string &name) const
	Get a Kokkos function of a concrete type with a given name. More...
template<typename T >
const T &	getKokkosFunctionByName (const FunctionName &name) const
	Get a Kokkos function of a concrete type with a given name. More...
bool	hasKokkosFunction (const std::string &param_name) const
	Determine if the Kokkos function exists. More...
bool	hasKokkosFunctionByName (const FunctionName &name) const
	Determine if the Kokkos function exists. More...

Static Public Member Functions
static InputParameters	validParams ()

Private Member Functions
const Moose::FunctionBase *	getKokkosFunctionByNameHelper (const FunctionName &name) const
	Helper function to retrieve a Kokkos function. More...

Private Attributes
const MooseObject &	_fni_object
	Reference to the object. More...
const InputParameters &	_fni_params
	Parameters of the object with this interface. More...
FEProblemBase &	_fni_feproblem
	Reference to FEProblemBase instance. More...
const THREAD_ID	_fni_tid
	Thread ID. More...

Detailed Description

Interface for objects that need to use functions.

Inherit from this class at a very low level to make the getFunction method available.

Definition at line 46 of file FunctionInterface.h.

Constructor & Destructor Documentation

FunctionInterface() [1/2]

FunctionInterface::FunctionInterface

(

const MooseObject *

moose_object

)

Definition at line 22 of file FunctionInterface.C.

  :
#ifdef MOOSE_KOKKOS_ENABLED
    _fni_object(*moose_object),
#endif
    _fni_params(moose_object->parameters()),
    _fni_feproblem(*_fni_params.getCheckedPointerParam<FEProblemBase *>("_fe_problem_base")),
    _fni_tid(_fni_params.have_parameter<THREAD_ID>("_tid") ? _fni_params.get<THREAD_ID>("_tid") : 0)
{
}

FunctionInterface() [2/2]

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

Special constructor used for Kokkos functor copy during parallel dispatch.

Member Function Documentation

getFunction()

const Function & FunctionInterface::getFunction

(

const std::string &

name

)

const

Get a function with a given name.

Parameters

name	The name of the parameter key of the function to retrieve

Returns

The function with name associated with the parameter 'name'

Definition at line 34 of file FunctionInterface.C.

Referenced by FunctionDT::FunctionDT(), and Output::Output().

{
  return getFunctionByName(_fni_params.get<FunctionName>(name));
}

getFunctionByName()

const Function & FunctionInterface::getFunctionByName

(

const FunctionName &

name

)

const

Get a function with a given name.

Parameters

name	The name of the function to retrieve

Returns

The function with name 'name'

Definition at line 40 of file FunctionInterface.C.

Referenced by ArrayBodyForce::ArrayBodyForce(), ArrayFunctionIC::ArrayFunctionIC(), CompositeFunction::CompositeFunction(), FunctionArrayAux::FunctionArrayAux(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC::FunctionScalarIC(), GenericFunctionMaterialTempl< is_ad >::GenericFunctionMaterialTempl(), GenericFunctionRankTwoTensorTempl< is_ad >::GenericFunctionRankTwoTensorTempl(), GenericFunctionVectorMaterialTempl< is_ad >::GenericFunctionVectorMaterialTempl(), getFunction(), LinearCombinationFunction::LinearCombinationFunction(), LineFunctionSampler::LineFunctionSampler(), and PiecewiseFunction::PiecewiseFunction().

{
  return _fni_feproblem.getFunction(name, _fni_tid);
}

getKokkosFunction() [1/2]

Moose::Kokkos::Function FunctionInterface::getKokkosFunction

(

const std::string &

name

)

const

Get a Kokkos function of an abstract type with a given name Calling this function will error out currently if Kokkos was configured with GPU.

Parameters

name	The name of the parameter key of the Kokkos function to retrieve

Returns

The copy of the Kokkos function of the abstract type with name associated with the parameter 'name'

getKokkosFunction() [2/2]

template<typename T >

const T & FunctionInterface::getKokkosFunction

(

const std::string &

name

)

const

Get a Kokkos function of a concrete type with a given name.

Template Parameters

T	The Kokkos function type

Parameters

name	The name of the parameter key of the Kokkos function to retrieve

Returns

The reference of the Kokkos function of the concrete type with name associated with the parameter 'name'. Always store it in a reference wrapper if to be used on GPU.

Definition at line 165 of file FunctionInterface.h.

{
  return getKokkosFunctionByName<T>(_fni_params.get<FunctionName>(name));
}

getKokkosFunctionByName() [1/2]

Moose::Kokkos::Function FunctionInterface::getKokkosFunctionByName

(

const FunctionName &

name

)

const

Get a Kokkos function of an abstract type with a given name Calling this function will error out currently if Kokkos was configured with GPU.

Parameters

name	The name of the Kokkos function to retrieve

Returns

The copy of the Kokkos function of the abstract type with name 'name'

getKokkosFunctionByName() [2/2]

template<typename T >

const T & FunctionInterface::getKokkosFunctionByName

(

const FunctionName &

name

)

const

Get a Kokkos function of a concrete type with a given name.

Template Parameters

T	The Kokkos function type

Parameters

name	The name of the Kokkos function to retrieve

Returns

The reference of the Kokkos function of the concrete type with name 'name'. Always store it in a reference wrapper if to be used on GPU.

Definition at line 172 of file FunctionInterface.h.

{
  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;
}

getKokkosFunctionByNameHelper()

const Moose::FunctionBase* FunctionInterface::getKokkosFunctionByNameHelper ( const FunctionName &  name ) const

private

Helper function to retrieve a Kokkos function.

Referenced by getKokkosFunctionByName().

hasFunction()

bool FunctionInterface::hasFunction

(

const std::string &

param_name

)

const

Determine if the function exists.

Parameters

param_name	The name of the function parameter
index	The index of the function

Returns

True if the function exists

Definition at line 46 of file FunctionInterface.C.

{
  return hasFunctionByName(_fni_params.get<FunctionName>(param_name));
}

hasFunctionByName()

bool FunctionInterface::hasFunctionByName

(

const FunctionName &

name

)

const

Determine if the function exists.

Parameters

name	The name of the function

Returns

True if the function exists

Definition at line 52 of file FunctionInterface.C.

Referenced by hasFunction().

{
  return _fni_feproblem.hasFunction(name, _fni_tid);
}

hasKokkosFunction()

bool FunctionInterface::hasKokkosFunction

(

const std::string &

param_name

)

const

Determine if the Kokkos function exists.

Parameters

param_name	The name of the Kokkos function parameter
index	The index of the Kokkos function

Returns

True if the Kokkos function exists

hasKokkosFunctionByName()

bool FunctionInterface::hasKokkosFunctionByName

(

const FunctionName &

name

)

const

Determine if the Kokkos function exists.

Parameters

name	The name of the Kokkos function

Returns

True if the Kokkos function exists

validParams()

InputParameters FunctionInterface::validParams ( )

static

Definition at line 17 of file FunctionInterface.C.

Referenced by MFEMObject::validParams(), Control::validParams(), and FVInterfaceKernel::validParams().

{
  return emptyInputParameters();
}

Member Data Documentation

_fni_feproblem

FEProblemBase& FunctionInterface::_fni_feproblem

private

Reference to FEProblemBase instance.

Definition at line 156 of file FunctionInterface.h.

Referenced by getFunctionByName(), and hasFunctionByName().

_fni_object

const MooseObject& FunctionInterface::_fni_object

private

Reference to the object.

Definition at line 149 of file FunctionInterface.h.

Referenced by getKokkosFunctionByName().

_fni_params

const InputParameters& FunctionInterface::_fni_params

private

Parameters of the object with this interface.

Definition at line 153 of file FunctionInterface.h.

Referenced by getFunction(), getKokkosFunction(), and hasFunction().

_fni_tid

const THREAD_ID FunctionInterface::_fni_tid

private

Thread ID.

Definition at line 159 of file FunctionInterface.h.

Referenced by getFunctionByName(), and hasFunctionByName().

---

The documentation for this class was generated from the following files:

• include/functions/FunctionInterface.h
• src/functions/FunctionInterface.C