libMesh::Kokkos::vector_ref< ViewType > Class Template Reference

Non-owning handle to one vector entry of a Kokkos storage view. More...

#include <kokkos_linalg_base.h>

Public Types
using	view_type = ViewType
using	value_type = detail::vector_view_value_t< ViewType >

Public Member Functions
LIBMESH_DEVICE_INLINE	vector_ref (ViewType view, const unsigned int index)
	Constructs a reference to entry index of view.
LIBMESH_DEVICE_INLINE decltype(auto)	operator() (const unsigned int component) const
LIBMESH_DEVICE_INLINE decltype(auto)	operator() (const unsigned int component)
template<typename RightVector >
LIBMESH_DEVICE_INLINE void	assign (const RightVector &right)
	Assigns right 's components to the referenced entry.
template<typename RightVector >
LIBMESH_DEVICE_INLINE void	add (const RightVector &right)
	Adds right to the referenced entry, in place.
template<typename RightVector >
LIBMESH_DEVICE_INLINE void	add_scaled (const RightVector &right, const value_type &factor)
	Adds factor times right to the referenced entry, in place.
template<typename RightVector >
LIBMESH_DEVICE_INLINE void	subtract (const RightVector &right)
	Subtracts right from the referenced entry, in place.
template<typename RightVector >
LIBMESH_DEVICE_INLINE void	subtract_scaled (const RightVector &right, const value_type &factor)
	Subtracts factor times right from the referenced entry, in place.
LIBMESH_DEVICE_INLINE void	zero ()
	Sets every component of the referenced entry to zero.
template<typename RightVector >
LIBMESH_DEVICE_INLINE auto	contract (const RightVector &right) const
LIBMESH_DEVICE_INLINE auto	norm () const
LIBMESH_DEVICE_INLINE auto	norm_sq () const
LIBMESH_DEVICE_INLINE auto	l1_norm () const
LIBMESH_DEVICE_INLINE bool	is_zero () const
LIBMESH_DEVICE_INLINE auto	unit () const
template<typename RightVector >
LIBMESH_DEVICE_INLINE auto	cross (const RightVector &right) const
LIBMESH_DEVICE_INLINE unsigned int	index () const

Private Attributes
ViewType	_view
unsigned int	_index

Detailed Description

template<typename ViewType>
class libMesh::Kokkos::vector_ref< ViewType >

Non-owning handle to one vector entry of a Kokkos storage view.

A vector_ref pairs a view with an entry index and exposes the entry's components through operator(), so it can be used wherever a vector-like object is expected. Component writes go directly to the underlying view; the arithmetic methods below (defined out-of-line in kokkos_vector_ops.h) either update the view in place or return owning results, mirroring the TypeVector interface.

Refs are cheap to construct and copy (a view handle plus an index) and are intended to be created on the fly inside kernels via make_vector_ref().

Definition at line 193 of file kokkos_linalg_base.h.

Member Typedef Documentation

value_type

template<typename ViewType >

using libMesh::Kokkos::vector_ref< ViewType >::value_type = detail::vector_view_value_t<ViewType>

Definition at line 198 of file kokkos_linalg_base.h.

view_type

template<typename ViewType >

using libMesh::Kokkos::vector_ref< ViewType >::view_type = ViewType

Definition at line 197 of file kokkos_linalg_base.h.

Constructor & Destructor Documentation

vector_ref()

template<typename ViewType >

LIBMESH_DEVICE_INLINE libMesh::Kokkos::vector_ref< ViewType >::vector_ref ( ViewType  view, const unsigned int  index  )

inline

Constructs a reference to entry index of view.

Definition at line 204 of file kokkos_linalg_base.h.

: _view(view), _index(index) {}

Member Function Documentation

add()

template<typename ViewType >

template<typename RightVector >

LIBMESH_DEVICE_INLINE void libMesh::Kokkos::vector_ref< ViewType >::add

(

const RightVector &

right

)

Adds right to the referenced entry, in place.

Definition at line 409 of file kokkos_vector_ops.h.

{
  libMesh::Kokkos::operator+=(*this, right);
}

References libMesh::Kokkos::operator+=().

add_scaled()

template<typename ViewType >

template<typename RightVector >

LIBMESH_DEVICE_INLINE void libMesh::Kokkos::vector_ref< ViewType >::add_scaled	(	const RightVector &	right,
		const value_type &	factor
	)

Adds factor times right to the referenced entry, in place.

Definition at line 417 of file kokkos_vector_ops.h.

{
  detail::update_vector_components(*this, right, factor);
}

References libMesh::Kokkos::detail::update_vector_components().

assign()

template<typename ViewType >

template<typename RightVector >

LIBMESH_DEVICE_INLINE void libMesh::Kokkos::vector_ref< ViewType >::assign

(

const RightVector &

right

)

Assigns right 's components to the referenced entry.

Definition at line 401 of file kokkos_vector_ops.h.

{
  detail::assign_vector_components(*this, right);
}

References libMesh::Kokkos::detail::assign_vector_components().

contract()

template<typename ViewType >

template<typename RightVector >

LIBMESH_DEVICE_INLINE auto libMesh::Kokkos::vector_ref< ViewType >::contract

(

const RightVector &

right

)

const

Returns

The dot product of the referenced entry with right.

Definition at line 448 of file kokkos_vector_ops.h.

{
  return libMesh::Kokkos::contract(*this, right);
}

References libMesh::Kokkos::contract().

cross()

template<typename ViewType >

template<typename RightVector >

LIBMESH_DEVICE_INLINE auto libMesh::Kokkos::vector_ref< ViewType >::cross

(

const RightVector &

right

)

const

Returns

The cross product of the referenced entry with right, as an owning vector.

Definition at line 510 of file kokkos_vector_ops.h.

{
  return vector_cross(*this, right);
}

References libMesh::Kokkos::vector_cross().

index()

template<typename ViewType >

LIBMESH_DEVICE_INLINE unsigned int libMesh::Kokkos::vector_ref< ViewType >::index ( ) const

inline

Returns

The index of the entry this ref addresses within its view.

Definition at line 320 of file kokkos_linalg_base.h.

  {
    return _index;
  }

References libMesh::Kokkos::vector_ref< ViewType >::_index.

is_zero()

template<typename ViewType >

LIBMESH_DEVICE_INLINE bool libMesh::Kokkos::vector_ref< ViewType >::is_zero

(

)

const

Returns

true if every component of the referenced entry is exactly zero, false otherwise.

Definition at line 491 of file kokkos_vector_ops.h.

{
  for (unsigned int component = 0; component < LIBMESH_DIM; ++component)
    if ((*this)(component) != value_type(0))
      return false;
 
  return true;
}

l1_norm()

template<typename ViewType >

LIBMESH_DEVICE_INLINE auto libMesh::Kokkos::vector_ref< ViewType >::l1_norm

(

)

const

Returns

The l1-norm of the referenced entry, i.e. the sum of the absolute values of the components.

Definition at line 477 of file kokkos_vector_ops.h.

{
  using std::abs;
  using norm_type = detail::remove_cvref_t<decltype(abs((*this)(0)))>;
 
  norm_type sum = norm_type(0);
  for (unsigned int component = 0; component < LIBMESH_DIM; ++component)
    sum += abs((*this)(component));
 
  return sum;
}

norm()

template<typename ViewType >

LIBMESH_DEVICE_INLINE auto libMesh::Kokkos::vector_ref< ViewType >::norm

(

)

const

Returns

The magnitude of the referenced entry, i.e. the square-root of the sum of the elements squared.

Definition at line 455 of file kokkos_vector_ops.h.

{
  using std::sqrt;
  return sqrt(this->norm_sq());
}

norm_sq()

template<typename ViewType >

LIBMESH_DEVICE_INLINE auto libMesh::Kokkos::vector_ref< ViewType >::norm_sq

(

)

const

Returns

The magnitude squared of the referenced entry.

Definition at line 463 of file kokkos_vector_ops.h.

{
  // TensorTools::norm_sq handles complex-valued components correctly.
  using norm_type = detail::remove_cvref_t<decltype(libMesh::TensorTools::norm_sq((*this)(0)))>;
 
  norm_type sum = norm_type(0);
  for (unsigned int component = 0; component < LIBMESH_DIM; ++component)
    sum += libMesh::TensorTools::norm_sq((*this)(component));
 
  return sum;
}

References libMesh::TensorTools::norm_sq().

operator()() [1/2]

template<typename ViewType >

LIBMESH_DEVICE_INLINE decltype(auto) libMesh::Kokkos::vector_ref< ViewType >::operator() ( const unsigned int  component )

inline

Definition at line 220 of file kokkos_linalg_base.h.

  {
    return _view(_index, component);
  }

References libMesh::Kokkos::vector_ref< ViewType >::_index, and libMesh::Kokkos::vector_ref< ViewType >::_view.

operator()() [2/2]

template<typename ViewType >

LIBMESH_DEVICE_INLINE decltype(auto) libMesh::Kokkos::vector_ref< ViewType >::operator() ( const unsigned int  component ) const

inline

Returns

A reference to component component of the referenced entry. Writes through it land directly in the underlying view; since Kokkos view constness is shallow, even the const overload yields a writable reference when the view's data type is non-const.

Definition at line 214 of file kokkos_linalg_base.h.

  {
    return _view(_index, component);
  }

References libMesh::Kokkos::vector_ref< ViewType >::_index, and libMesh::Kokkos::vector_ref< ViewType >::_view.

subtract()

template<typename ViewType >

template<typename RightVector >

LIBMESH_DEVICE_INLINE void libMesh::Kokkos::vector_ref< ViewType >::subtract

(

const RightVector &

right

)

Subtracts right from the referenced entry, in place.

Definition at line 425 of file kokkos_vector_ops.h.

{
  libMesh::Kokkos::operator-=(*this, right);
}

References libMesh::Kokkos::operator-=().

subtract_scaled()

template<typename ViewType >

template<typename RightVector >

LIBMESH_DEVICE_INLINE void libMesh::Kokkos::vector_ref< ViewType >::subtract_scaled	(	const RightVector &	right,
		const value_type &	factor
	)

Subtracts factor times right from the referenced entry, in place.

Definition at line 433 of file kokkos_vector_ops.h.

{
  detail::update_vector_components(*this, right, -factor);
}

References libMesh::Kokkos::detail::update_vector_components().

unit()

template<typename ViewType >

LIBMESH_DEVICE_INLINE auto libMesh::Kokkos::vector_ref< ViewType >::unit

(

)

const

Returns

An owning unit vector in the direction of the referenced entry.

Definition at line 502 of file kokkos_vector_ops.h.

{
  return vector_unit(*this);
}

References libMesh::Kokkos::vector_unit().

zero()

template<typename ViewType >

LIBMESH_DEVICE_INLINE void libMesh::Kokkos::vector_ref< ViewType >::zero

(

)

Sets every component of the referenced entry to zero.

Definition at line 440 of file kokkos_vector_ops.h.

{
  detail::fill_vector_components(*this, value_type(0));
}

References libMesh::Kokkos::detail::fill_vector_components().

Member Data Documentation

_index

template<typename ViewType >

unsigned int libMesh::Kokkos::vector_ref< ViewType >::_index

private

Definition at line 327 of file kokkos_linalg_base.h.

Referenced by libMesh::Kokkos::vector_ref< ViewType >::index(), libMesh::Kokkos::vector_ref< ViewType >::operator()(), and libMesh::Kokkos::vector_ref< ViewType >::operator()().

_view

template<typename ViewType >

ViewType libMesh::Kokkos::vector_ref< ViewType >::_view

private

Definition at line 326 of file kokkos_linalg_base.h.

Referenced by libMesh::Kokkos::vector_ref< ViewType >::operator()(), and libMesh::Kokkos::vector_ref< ViewType >::operator()().

---

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

• include/gpu/kokkos_linalg_base.h
• include/gpu/kokkos_vector_ops.h