Moose::Kokkos::FunctionWrapperDevice< Object > Class Template Reference

Device function wrapper class that provides polymorphic interfaces for a function. More...

#include <KokkosFunctionWrapper.h>

Inheritance diagram for Moose::Kokkos::FunctionWrapperDevice< Object >:

Public Member Functions
KOKKOS_FUNCTION	FunctionWrapperDevice ()
	Constructor.
KOKKOS_FUNCTION Real	value (Real t, Real3 p) const KOKKOS_OVERRIDE
KOKKOS_FUNCTION Real3	vectorValue (Real t, Real3 p) const KOKKOS_OVERRIDE
KOKKOS_FUNCTION Real3	gradient (Real t, Real3 p) const KOKKOS_OVERRIDE
KOKKOS_FUNCTION Real3	curl (Real t, Real3 p) const KOKKOS_OVERRIDE
KOKKOS_FUNCTION Real	div (Real t, Real3 p) const KOKKOS_OVERRIDE
KOKKOS_FUNCTION Real	timeDerivative (Real t, Real3 p) const KOKKOS_OVERRIDE
KOKKOS_FUNCTION Real	timeIntegral (Real t1, Real t2, Real3 p) const KOKKOS_OVERRIDE
KOKKOS_FUNCTION Real	integral () const KOKKOS_OVERRIDE
KOKKOS_FUNCTION Real	average () const KOKKOS_OVERRIDE

Protected Attributes
Object *	_function = nullptr
	Pointer to the function on device.

Friends
class	FunctionWrapperHost< Object >

Detailed Description

template<typename Object>
class Moose::Kokkos::FunctionWrapperDevice< Object >

Device function wrapper class that provides polymorphic interfaces for a function.

The function itself is a static object and does not have any virtual method. Instead, the device wrapper defines the virtual shims and forwards the calls to the static methods of the stored function.

Template Parameters

Object

The function class type

Definition at line 96 of file KokkosFunctionWrapper.h.

Constructor & Destructor Documentation

FunctionWrapperDevice()

template<typename Object >

KOKKOS_FUNCTION Moose::Kokkos::FunctionWrapperDevice< Object >::FunctionWrapperDevice ( )

inline

Constructor.

Definition at line 104 of file KokkosFunctionWrapper.h.

{}

Member Function Documentation

average()

template<typename Object >

KOKKOS_FUNCTION Real Moose::Kokkos::FunctionWrapperDevice< Object >::average ( ) const

inline

Definition at line 132 of file KokkosFunctionWrapper.h.

{ return _function->average(); }

curl()

template<typename Object >

KOKKOS_FUNCTION Real3 Moose::Kokkos::FunctionWrapperDevice< Object >::curl ( Real  t, Real3  p  ) const

inline

Definition at line 118 of file KokkosFunctionWrapper.h.

  {
    return _function->curl(t, p);
  }

div()

template<typename Object >

KOKKOS_FUNCTION Real Moose::Kokkos::FunctionWrapperDevice< Object >::div ( Real  t, Real3  p  ) const

inline

Definition at line 122 of file KokkosFunctionWrapper.h.

{ return _function->div(t, p); }

gradient()

template<typename Object >

KOKKOS_FUNCTION Real3 Moose::Kokkos::FunctionWrapperDevice< Object >::gradient ( Real  t, Real3  p  ) const

inline

Definition at line 114 of file KokkosFunctionWrapper.h.

  {
    return _function->gradient(t, p);
  }

integral()

template<typename Object >

KOKKOS_FUNCTION Real Moose::Kokkos::FunctionWrapperDevice< Object >::integral ( ) const

inline

Definition at line 131 of file KokkosFunctionWrapper.h.

{ return _function->integral(); }

timeDerivative()

template<typename Object >

KOKKOS_FUNCTION Real Moose::Kokkos::FunctionWrapperDevice< Object >::timeDerivative ( Real  t, Real3  p  ) const

inline

Definition at line 123 of file KokkosFunctionWrapper.h.

  {
    return _function->timeDerivative(t, p);
  }

timeIntegral()

template<typename Object >

KOKKOS_FUNCTION Real Moose::Kokkos::FunctionWrapperDevice< Object >::timeIntegral ( Real  t1, Real  t2, Real3  p  ) const

inline

Definition at line 127 of file KokkosFunctionWrapper.h.

  {
    return _function->timeIntegral(t1, t2, p);
  }

value()

template<typename Object >

KOKKOS_FUNCTION Real Moose::Kokkos::FunctionWrapperDevice< Object >::value ( Real  t, Real3  p  ) const

inline

Definition at line 106 of file KokkosFunctionWrapper.h.

  {
    return _function->value(t, p);
  }

vectorValue()

template<typename Object >

KOKKOS_FUNCTION Real3 Moose::Kokkos::FunctionWrapperDevice< Object >::vectorValue ( Real  t, Real3  p  ) const

inline

Definition at line 110 of file KokkosFunctionWrapper.h.

  {
    return _function->vectorValue(t, p);
  }

Friends And Related Symbol Documentation

FunctionWrapperHost< Object >

template<typename Object >

friend class FunctionWrapperHost< Object >

friend

Definition at line 81 of file KokkosFunctionWrapper.h.

Member Data Documentation

_function

template<typename Object >

Object* Moose::Kokkos::FunctionWrapperDevice< Object >::_function = nullptr

protected

Pointer to the function on device.

Definition at line 138 of file KokkosFunctionWrapper.h.

Referenced by Moose::Kokkos::FunctionWrapperDevice< Object >::average(), Moose::Kokkos::FunctionWrapperDevice< Object >::curl(), Moose::Kokkos::FunctionWrapperDevice< Object >::div(), Moose::Kokkos::FunctionWrapperDevice< Object >::gradient(), Moose::Kokkos::FunctionWrapperDevice< Object >::integral(), Moose::Kokkos::FunctionWrapperDevice< Object >::timeDerivative(), Moose::Kokkos::FunctionWrapperDevice< Object >::timeIntegral(), Moose::Kokkos::FunctionWrapperDevice< Object >::value(), and Moose::Kokkos::FunctionWrapperDevice< Object >::vectorValue().

---

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

• include/kokkos/functions/KokkosFunctionWrapper.h