Moose::Kokkos::Scalar< T, typename > Class Template Reference

The Kokkos wrapper class that can hold the reference of an arithmetic scalar variable. More...

#include <KokkosScalar.h>

Inheritance diagram for Moose::Kokkos::Scalar< T, typename >:

Public Types
using	value_type = T

Public Member Functions
	Scalar (T &value)
	Constructor. More...
	Scalar (const Scalar &object)
	Copy constructor. More...
auto &	operator= (const Scalar &value)
	Assign a scalar value to the underlying host reference. More...
template<typename U >
auto	operator= (const U &value) -> decltype(std::declval< T &>()=value, std::declval< Scalar &>())
	Assign an arithmetic value to the underlying host reference. More...
KOKKOS_SCALAR_FUNCTION auto	operator+ () const -> decltype(+std::declval< const T &>())
	Get the positive value of the scalar. More...
KOKKOS_SCALAR_FUNCTION auto	operator- () const -> decltype(-std::declval< const T &>())
	Get the negated value of the scalar. More...
template<typename U >
auto	operator+= (const U &value) -> decltype(std::declval< T &>()+=value, std::declval< Scalar &>())
	Add another value to the underlying host reference. More...
template<typename U >
auto	operator-= (const U &value) -> decltype(std::declval< T &>() -=value, std::declval< Scalar &>())
	Subtract another value from the underlying host reference. More...
template<typename U >
auto	operator*= (const U &value) -> decltype(std::declval< T &>() *=value, std::declval< Scalar &>())
	Multiply the underlying host reference by another value. More...
template<typename U >
auto	operator/= (const U &value) -> decltype(std::declval< T &>()/=value, std::declval< Scalar &>())
	Divide the underlying host reference by another value. More...
template<typename U >
auto	operator%= (const U &value) -> decltype(std::declval< T &>() %=value, std::declval< Scalar &>())
	Assign the remainder after division by another value to the underlying host reference. More...
template<typename U = T>
auto	operator++ () -> decltype(++std::declval< U &>(), std::declval< Scalar &>())
	Prefix increment the underlying host reference. More...
template<typename U = T>
auto	operator++ (int) -> decltype(std::declval< U &>()++)
	Postfix increment the underlying host reference. More...
template<typename U = T>
auto	operator-- () -> decltype(--std::declval< U &>(), std::declval< Scalar &>())
	Prefix decrement the underlying host reference. More...
template<typename U = T>
auto	operator-- (int) -> decltype(std::declval< U &>() --)
	Postfix decrement the underlying host reference. More...
template<typename U >
KOKKOS_SCALAR_FUNCTION auto	operator+ (const U &value) const -> decltype(std::declval< const T &>()+value)
	Add another value to this scalar. More...
template<typename U >
KOKKOS_SCALAR_FUNCTION auto	operator- (const U &value) const -> decltype(std::declval< const T &>() - value)
	Subtract another value from this scalar. More...
template<typename U >
KOKKOS_SCALAR_FUNCTION auto	operator* (const U &value) const -> decltype(std::declval< const T &>() *value)
	Multiply this scalar by another value. More...
template<typename U >
KOKKOS_SCALAR_FUNCTION auto	operator/ (const U &value) const -> decltype(std::declval< const T &>()/value)
	Divide this scalar by another value. More...
template<typename U >
KOKKOS_SCALAR_FUNCTION auto	operator% (const U &value) const -> decltype(std::declval< const T &>() % value)
	Get the remainder after division by another value. More...
KOKKOS_FUNCTION	operator const T & () const
	Get the const reference of the stored variable. More...
	operator const T & () const
	Get the const reference of the stored host reference. More...
KOKKOS_FUNCTION const T &	operator* () const
	Get the const reference of the stored variable. More...
T &	operator* ()
	Get the writeable reference of the stored host reference. More...
KOKKOS_FUNCTION const T *	operator-> () const
	Get the const pointer to the stored variable. More...
const T *	operator-> () const
	Get the const pointer of the stored host reference. More...
T *	operator-> ()
	Get the writeable pointer of the stored host reference. More...
template<typename... Args>
KOKKOS_FUNCTION auto	operator() (Args &&... args) const -> decltype(auto)
	Forward arguments to the stored variable's const operator() depending on the architecture this function is being called on. More...
template<typename... Args>
auto	operator() (Args &&... args) const -> decltype(auto)
	Forward arguments to the stored host reference's const operator() More...
template<typename... Args>
auto	operator() (Args &&... args) -> decltype(auto)
	Forward arguments to the stored host reference's operator() More...
	operator T& ()
	Get the writeable reference of the stored host reference. More...

Protected Attributes
T &	_reference
	Writeable host reference of the variable. More...
const T	_copy
	Device copy of the variable. More...

Private Member Functions
KOKKOS_SCALAR_FUNCTION const T &	value () const

Detailed Description

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>
class Moose::Kokkos::Scalar< T, typename >

The Kokkos wrapper class that can hold the reference of an arithmetic scalar variable.

Definition at line 30 of file KokkosScalar.h.

Member Typedef Documentation

value_type

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

using Moose::Kokkos::Scalar< T, typename >::value_type = T

Definition at line 33 of file KokkosScalar.h.

Constructor & Destructor Documentation

Scalar() [1/2]

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

Moose::Kokkos::Scalar< T, typename >::Scalar ( T &  value )

inline

Constructor.

Parameters

value

The writeable reference of the arithmetic scalar variable to store

Definition at line 39 of file KokkosScalar.h.

: ReferenceWrapper<T>(value) {}

Scalar() [2/2]

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

Moose::Kokkos::Scalar< T, typename >::Scalar ( const Scalar< T, typename > &  object )

inline

Copy constructor.

Definition at line 43 of file KokkosScalar.h.

: ReferenceWrapper<T>(object) {}

Member Function Documentation

operator const T &() [1/2]

template<typename T>

KOKKOS_FUNCTION Moose::Kokkos::ReferenceWrapper< T >::operator const T & ( ) const

inlineinherited

Get the const reference of the stored variable.

Returns

The const reference of the stored variable depending on the architecture this function is being called on

Definition at line 53 of file KokkosReferenceWrapper.h.

  {
    KOKKOS_IF_ON_HOST(return _reference;)

    return _copy;
  }

operator const T &() [2/2]

template<typename T>

Moose::Kokkos::ReferenceWrapper< T >::operator const T & ( ) const

inlineinherited

Get the const reference of the stored host reference.

Returns

The const reference of the stored host reference

Definition at line 98 of file KokkosReferenceWrapper.h.

{ return _reference; }

operator T&()

template<typename T>

Moose::Kokkos::ReferenceWrapper< T >::operator T & ( )

inlineinherited

Get the writeable reference of the stored host reference.

Returns

The writeable reference of the stored host reference

Definition at line 123 of file KokkosReferenceWrapper.h.

{ return _reference; }

operator%()

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U >

KOKKOS_SCALAR_FUNCTION auto Moose::Kokkos::Scalar< T, typename >::operator% ( const U &  value ) const -> decltype(std::declval<const T &>() % value)

inline

Get the remainder after division by another value.

Parameters

value

The divisor value

Returns

The remainder

Definition at line 236 of file KokkosScalar.h.

  {
    return this->value() % value;
  }

operator%=()

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U >

auto Moose::Kokkos::Scalar< T, typename >::operator%= ( const U &  value ) -> decltype(std::declval<T &>() %= value, std::declval<Scalar &>())

inline

Assign the remainder after division by another value to the underlying host reference.

Parameters

value

The divisor value

Definition at line 137 of file KokkosScalar.h.

  {
    this->_reference %= value;

    return *this;
  }

operator()() [1/3]

template<typename T>

template<typename... Args>

KOKKOS_FUNCTION auto Moose::Kokkos::ReferenceWrapper< T >::operator() ( Args &&...  args ) const -> decltype(auto)

inlineinherited

Forward arguments to the stored variable's const operator() depending on the architecture this function is being called on.

Parameters

args	The variadic arguments to be forwarded

Definition at line 87 of file KokkosReferenceWrapper.h.

  {
    KOKKOS_IF_ON_HOST(return _reference(std::forward<Args>(args)...);)

    return _copy(std::forward<Args>(args)...);
  }

operator()() [2/3]

template<typename T>

template<typename... Args>

auto Moose::Kokkos::ReferenceWrapper< T >::operator() ( Args &&...  args ) const -> decltype(auto)

inlineinherited

Forward arguments to the stored host reference's const operator()

Parameters

args	The variadic arguments to be forwarded

Definition at line 114 of file KokkosReferenceWrapper.h.

  {
    return _reference(std::forward<Args>(args)...);
  }

operator()() [3/3]

template<typename T>

template<typename... Args>

auto Moose::Kokkos::ReferenceWrapper< T >::operator() ( Args &&...  args ) -> decltype(auto)

inlineinherited

Forward arguments to the stored host reference's operator()

Parameters

args	The variadic arguments to be forwarded

Definition at line 139 of file KokkosReferenceWrapper.h.

  {
    return _reference(std::forward<Args>(args)...);
  }

operator*() [1/3]

template<typename T>

KOKKOS_FUNCTION const T& Moose::Kokkos::ReferenceWrapper< T >::operator* ( ) const

inlineinherited

Get the const reference of the stored variable.

Returns

The const reference of the stored variable depending on the architecture this function is being called on

Definition at line 64 of file KokkosReferenceWrapper.h.

  {
    KOKKOS_IF_ON_HOST(return _reference;)

    return _copy;
  }

operator*() [2/3]

template<typename T>

T& Moose::Kokkos::ReferenceWrapper< T >::operator* ( )

inlineinherited

Get the writeable reference of the stored host reference.

Returns

The writeable reference of the stored host reference

Definition at line 128 of file KokkosReferenceWrapper.h.

{ return _reference; }

operator*() [3/3]

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U >

KOKKOS_SCALAR_FUNCTION auto Moose::Kokkos::Scalar< T, typename >::operator* ( const U &  value ) const -> decltype(std::declval<const T &>() * value)

inline

Multiply this scalar by another value.

Parameters

value

The value to multiply by

Returns

The product

Definition at line 214 of file KokkosScalar.h.

  {
    return this->value() * value;
  }

operator*=()

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U >

auto Moose::Kokkos::Scalar< T, typename >::operator*= ( const U &  value ) -> decltype(std::declval<T &>() *= value, std::declval<Scalar &>())

inline

Multiply the underlying host reference by another value.

Parameters

value

The value to multiply by

Definition at line 113 of file KokkosScalar.h.

  {
    this->_reference *= value;

    return *this;
  }

operator+() [1/2]

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

KOKKOS_SCALAR_FUNCTION auto Moose::Kokkos::Scalar< T, typename >::operator+ ( ) const -> decltype(+std::declval<const T &>())

inline

Get the positive value of the scalar.

Returns

The positive scalar value

Definition at line 71 of file KokkosScalar.h.

  {
    return +value();
  }

operator+() [2/2]

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U >

KOKKOS_SCALAR_FUNCTION auto Moose::Kokkos::Scalar< T, typename >::operator+ ( const U &  value ) const -> decltype(std::declval<const T &>() + value)

inline

Add another value to this scalar.

Parameters

value

The value to add

Returns

The sum

Definition at line 192 of file KokkosScalar.h.

  {
    return this->value() + value;
  }

operator++() [1/2]

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U = T>

auto Moose::Kokkos::Scalar< T, typename >::operator++ ( ) -> decltype(++std::declval<U &>(), std::declval<Scalar &>())

inline

Prefix increment the underlying host reference.

Returns

This scalar wrapper

Definition at line 150 of file KokkosScalar.h.

  {
    ++this->_reference;

    return *this;
  }

operator++() [2/2]

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U = T>

auto Moose::Kokkos::Scalar< T, typename >::operator++ ( int  ) -> decltype(std::declval<U &>()++)

inline

Postfix increment the underlying host reference.

Returns

The previous scalar value

Definition at line 161 of file KokkosScalar.h.

  {
    return this->_reference++;
  }

operator+=()

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U >

auto Moose::Kokkos::Scalar< T, typename >::operator+= ( const U &  value ) -> decltype(std::declval<T &>() += value, std::declval<Scalar &>())

inline

Add another value to the underlying host reference.

Parameters

value

The value to add

Definition at line 89 of file KokkosScalar.h.

  {
    this->_reference += value;

    return *this;
  }

operator-() [1/2]

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

KOKKOS_SCALAR_FUNCTION auto Moose::Kokkos::Scalar< T, typename >::operator- ( ) const -> decltype(-std::declval<const T &>())

inline

Get the negated value of the scalar.

Returns

The negated scalar value

Definition at line 79 of file KokkosScalar.h.

  {
    return -value();
  }

operator-() [2/2]

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U >

KOKKOS_SCALAR_FUNCTION auto Moose::Kokkos::Scalar< T, typename >::operator- ( const U &  value ) const -> decltype(std::declval<const T &>() - value)

inline

Subtract another value from this scalar.

Parameters

value

The value to subtract

Returns

The difference

Definition at line 203 of file KokkosScalar.h.

  {
    return this->value() - value;
  }

operator--() [1/2]

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U = T>

auto Moose::Kokkos::Scalar< T, typename >::operator-- ( ) -> decltype(--std::declval<U &>(), std::declval<Scalar &>())

inline

Prefix decrement the underlying host reference.

Returns

This scalar wrapper

Definition at line 170 of file KokkosScalar.h.

  {
    --this->_reference;

    return *this;
  }

operator--() [2/2]

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U = T>

auto Moose::Kokkos::Scalar< T, typename >::operator-- ( int  ) -> decltype(std::declval<U &>()--)

inline

Postfix decrement the underlying host reference.

Returns

The previous scalar value

Definition at line 181 of file KokkosScalar.h.

  {
    return this->_reference--;
  }

operator-=()

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U >

auto Moose::Kokkos::Scalar< T, typename >::operator-= ( const U &  value ) -> decltype(std::declval<T &>() -= value, std::declval<Scalar &>())

inline

Subtract another value from the underlying host reference.

Parameters

value

The value to subtract

Definition at line 101 of file KokkosScalar.h.

  {
    this->_reference -= value;

    return *this;
  }

operator->() [1/3]

template<typename T>

KOKKOS_FUNCTION const T* Moose::Kokkos::ReferenceWrapper< T >::operator-> ( ) const

inlineinherited

Get the const pointer to the stored variable.

Returns

The const pointer to the stored variable depending on the architecture this function is being called on

Definition at line 75 of file KokkosReferenceWrapper.h.

  {
    KOKKOS_IF_ON_HOST(return &_reference;)

    return &_copy;
  }

operator->() [2/3]

template<typename T>

const T* Moose::Kokkos::ReferenceWrapper< T >::operator-> ( ) const

inlineinherited

Get the const pointer of the stored host reference.

Returns

The const pointer to the stored host reference

Definition at line 108 of file KokkosReferenceWrapper.h.

{ return &_reference; }

operator->() [3/3]

template<typename T>

T* Moose::Kokkos::ReferenceWrapper< T >::operator-> ( )

inlineinherited

Get the writeable pointer of the stored host reference.

Returns

The writeable pointer to the stored host reference

Definition at line 133 of file KokkosReferenceWrapper.h.

{ return &_reference; }

operator/()

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U >

KOKKOS_SCALAR_FUNCTION auto Moose::Kokkos::Scalar< T, typename >::operator/ ( const U &  value ) const -> decltype(std::declval<const T &>() / value)

inline

Divide this scalar by another value.

Parameters

value

The value to divide by

Returns

The quotient

Definition at line 225 of file KokkosScalar.h.

  {
    return this->value() / value;
  }

operator/=()

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U >

auto Moose::Kokkos::Scalar< T, typename >::operator/= ( const U &  value ) -> decltype(std::declval<T &>() /= value, std::declval<Scalar &>())

inline

Divide the underlying host reference by another value.

Parameters

value

The value to divide by

Definition at line 125 of file KokkosScalar.h.

  {
    this->_reference /= value;

    return *this;
  }

operator=() [1/2]

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

auto& Moose::Kokkos::Scalar< T, typename >::operator= ( const Scalar< T, typename > &  value )

inline

Assign a scalar value to the underlying host reference.

Parameters

value

The scalar value to be assigned

Definition at line 49 of file KokkosScalar.h.

  {
    this->_reference = static_cast<const T &>(value);

    return *this;
  }

operator=() [2/2]

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

template<typename U >

auto Moose::Kokkos::Scalar< T, typename >::operator= ( const U &  value ) -> decltype(std::declval<T &>() = value, std::declval<Scalar &>())

inline

Assign an arithmetic value to the underlying host reference.

Parameters

value

The scalar value to be assigned

Definition at line 60 of file KokkosScalar.h.

  {
    this->_reference = value;

    return *this;
  }

value()

template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

KOKKOS_SCALAR_FUNCTION const T& Moose::Kokkos::Scalar< T, typename >::value ( ) const

inlineprivate

Definition at line 243 of file KokkosScalar.h.

Referenced by Moose::Kokkos::Scalar< Real >::operator%(), Moose::Kokkos::Scalar< Real >::operator%=(), Moose::Kokkos::Scalar< Real >::operator*(), Moose::Kokkos::Scalar< Real >::operator*=(), Moose::Kokkos::Scalar< Real >::operator+(), Moose::Kokkos::Scalar< Real >::operator+=(), Moose::Kokkos::Scalar< Real >::operator-(), Moose::Kokkos::Scalar< Real >::operator-=(), Moose::Kokkos::Scalar< Real >::operator/(), Moose::Kokkos::Scalar< Real >::operator/=(), and Moose::Kokkos::Scalar< Real >::operator=().

{ return static_cast<const T &>(*this); }

Member Data Documentation

_copy

template<typename T>

const T Moose::Kokkos::ReferenceWrapper< T >::_copy

protectedinherited

Device copy of the variable.

Definition at line 152 of file KokkosReferenceWrapper.h.

Referenced by Moose::Kokkos::ReferenceWrapper< T >::operator const T &(), Moose::Kokkos::ReferenceWrapper< Real >::operator()(), Moose::Kokkos::ReferenceWrapper< Real >::operator*(), and Moose::Kokkos::ReferenceWrapper< Real >::operator->().

_reference

template<typename T>

T& Moose::Kokkos::ReferenceWrapper< T >::_reference

protectedinherited

Writeable host reference of the variable.

Definition at line 148 of file KokkosReferenceWrapper.h.

Referenced by Moose::Kokkos::ReferenceWrapper< T >::operator const T &(), Moose::Kokkos::ReferenceWrapper< T >::operator T&(), Moose::Kokkos::Scalar< Real >::operator%=(), Moose::Kokkos::ReferenceWrapper< Real >::operator()(), Moose::Kokkos::ReferenceWrapper< Real >::operator*(), Moose::Kokkos::Scalar< Real >::operator*=(), Moose::Kokkos::Scalar< Real >::operator++(), Moose::Kokkos::Scalar< Real >::operator+=(), Moose::Kokkos::Scalar< Real >::operator--(), Moose::Kokkos::Scalar< Real >::operator-=(), Moose::Kokkos::ReferenceWrapper< Real >::operator->(), Moose::Kokkos::Scalar< Real >::operator/=(), and Moose::Kokkos::Scalar< Real >::operator=().

---

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

• include/kokkos/base/KokkosScalar.h