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

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

#include <kokkos_linalg_base.h>

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

Public Member Functions
LIBMESH_DEVICE_INLINE	tensor_ref (ViewType view, const unsigned int index)
	Constructs a reference to entry index of view.
LIBMESH_DEVICE_INLINE decltype(auto)	operator() (const unsigned int row, const unsigned int col) const
LIBMESH_DEVICE_INLINE decltype(auto)	operator() (const unsigned int row, const unsigned int col)
template<typename RightTensor >
LIBMESH_DEVICE_INLINE void	assign (const RightTensor &right)
	Assigns right 's components to the referenced entry.
template<typename RightTensor >
LIBMESH_DEVICE_INLINE void	add (const RightTensor &right)
	Adds right to the referenced entry, in place.
template<typename RightTensor >
LIBMESH_DEVICE_INLINE void	add_scaled (const RightTensor &right, const value_type &factor)
	Adds factor times right to the referenced entry, in place.
template<typename RightTensor >
LIBMESH_DEVICE_INLINE void	subtract (const RightTensor &right)
	Subtracts right from the referenced entry, in place.
template<typename RightTensor >
LIBMESH_DEVICE_INLINE void	subtract_scaled (const RightTensor &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 RightTensor >
LIBMESH_DEVICE_INLINE auto	contract (const RightTensor &right) const
LIBMESH_DEVICE_INLINE auto	norm () const
LIBMESH_DEVICE_INLINE auto	norm_sq () const
LIBMESH_DEVICE_INLINE bool	is_zero () const
LIBMESH_DEVICE_INLINE auto	transpose () const
LIBMESH_DEVICE_INLINE auto	det (const unsigned int dim=LIBMESH_DIM) const
LIBMESH_DEVICE_INLINE auto	tr () const
LIBMESH_DEVICE_INLINE auto	inverse (const unsigned int dim=LIBMESH_DIM) const
template<typename VectorLike , typename ResultVector >
LIBMESH_DEVICE_INLINE void	solve (const VectorLike &b, ResultVector &x) const
	Solves the linear system (*this)x = b for x, via the explicit inverse.
LIBMESH_DEVICE_INLINE auto	row (const unsigned int i) const
LIBMESH_DEVICE_INLINE auto	column (const unsigned int i) const
template<typename VectorLike >
LIBMESH_DEVICE_INLINE auto	left_multiply (const VectorLike &v) const
LIBMESH_DEVICE_INLINE unsigned int	index () const

Private Attributes
ViewType	_view
unsigned int	_index

Detailed Description

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

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

The tensor analogue of vector_ref: it pairs a view with an entry index, exposes the entry's components through operator()(row,col), and provides the TypeTensor-like arithmetic methods below (defined out-of-line in kokkos_tensor_ops.h). Component writes go directly to the underlying view.

Definition at line 340 of file kokkos_linalg_base.h.

Member Typedef Documentation

value_type

template<typename ViewType >

using libMesh::Kokkos::tensor_ref< ViewType >::value_type = detail::tensor_view_value_t<ViewType>

Definition at line 345 of file kokkos_linalg_base.h.

view_type

template<typename ViewType >

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

Definition at line 344 of file kokkos_linalg_base.h.

Constructor & Destructor Documentation

tensor_ref()

template<typename ViewType >

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

inline

Constructs a reference to entry index of view.

Definition at line 351 of file kokkos_linalg_base.h.

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

Member Function Documentation

add()

template<typename ViewType >

template<typename RightTensor >

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

(

const RightTensor &

right

)

Adds right to the referenced entry, in place.

Definition at line 623 of file kokkos_tensor_ops.h.

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

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

add_scaled()

template<typename ViewType >

template<typename RightTensor >

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

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

Definition at line 631 of file kokkos_tensor_ops.h.

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

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

assign()

template<typename ViewType >

template<typename RightTensor >

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

(

const RightTensor &

right

)

Assigns right 's components to the referenced entry.

Definition at line 615 of file kokkos_tensor_ops.h.

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

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

column()

template<typename ViewType >

LIBMESH_DEVICE_INLINE auto libMesh::Kokkos::tensor_ref< ViewType >::column

(

const unsigned int

i

)

const

Returns

Column i of the referenced entry, as an owning vector.

Definition at line 750 of file kokkos_tensor_ops.h.

{
  return libMesh::Kokkos::column(*this, i);
}

References libMesh::Kokkos::column().

contract()

template<typename ViewType >

template<typename RightTensor >

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

(

const RightTensor &

right

)

const

Returns

The full contraction (sum of componentwise products) of the referenced entry with right.

Definition at line 662 of file kokkos_tensor_ops.h.

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

References libMesh::Kokkos::contract().

det()

template<typename ViewType >

LIBMESH_DEVICE_INLINE auto libMesh::Kokkos::tensor_ref< ViewType >::det

(

const unsigned int

dim = LIBMESH_DIM

)

const

Returns

The determinant of the leading dim x dim block of the referenced entry.

Definition at line 711 of file kokkos_tensor_ops.h.

{
  return detail::leading_determinant(*this, dim);
}

References dim, and libMesh::Kokkos::detail::leading_determinant().

index()

template<typename ViewType >

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

inline

Returns

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

Definition at line 499 of file kokkos_linalg_base.h.

  {
    return _index;
  }

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

inverse()

template<typename ViewType >

LIBMESH_DEVICE_INLINE auto libMesh::Kokkos::tensor_ref< ViewType >::inverse

(

const unsigned int

dim = LIBMESH_DIM

)

const

Returns

The inverse of the leading dim x dim block of the referenced entry, as an owning tensor.

Definition at line 725 of file kokkos_tensor_ops.h.

{
  return libMesh::Kokkos::inverse(*this, dim);
}

References dim, and libMesh::Kokkos::inverse().

is_zero()

template<typename ViewType >

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

(

)

const

Returns

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

Definition at line 692 of file kokkos_tensor_ops.h.

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

References libMesh::Kokkos::row().

left_multiply()

template<typename ViewType >

template<typename VectorLike >

LIBMESH_DEVICE_INLINE auto libMesh::Kokkos::tensor_ref< ViewType >::left_multiply

(

const VectorLike &

v

)

const

Returns

The vector-tensor product v * (*this), as an owning vector.

Definition at line 758 of file kokkos_tensor_ops.h.

{
  return v * *this;
}

norm()

template<typename ViewType >

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

(

)

const

Returns

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

Definition at line 669 of file kokkos_tensor_ops.h.

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

norm_sq()

template<typename ViewType >

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

(

)

const

Returns

The Frobenius norm squared of the referenced entry.

Definition at line 677 of file kokkos_tensor_ops.h.

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

References libMesh::TensorTools::norm_sq(), and libMesh::Kokkos::row().

operator()() [1/2]

template<typename ViewType >

LIBMESH_DEVICE_INLINE decltype(auto) libMesh::Kokkos::tensor_ref< ViewType >::operator() ( const unsigned int  row, const unsigned int  col  )

inline

Definition at line 365 of file kokkos_linalg_base.h.

  {
    return _view(_index, row, col);
  }

References libMesh::Kokkos::tensor_ref< ViewType >::_index, libMesh::Kokkos::tensor_ref< ViewType >::_view, and libMesh::Kokkos::tensor_ref< ViewType >::row().

operator()() [2/2]

template<typename ViewType >

LIBMESH_DEVICE_INLINE decltype(auto) libMesh::Kokkos::tensor_ref< ViewType >::operator() ( const unsigned int  row, const unsigned int  col  ) const

inline

Returns

A reference to the (row, col) component of the referenced entry, writable under the same shallow-constness rules as vector_ref::operator().

Definition at line 359 of file kokkos_linalg_base.h.

  {
    return _view(_index, row, col);
  }

References libMesh::Kokkos::tensor_ref< ViewType >::_index, libMesh::Kokkos::tensor_ref< ViewType >::_view, and libMesh::Kokkos::tensor_ref< ViewType >::row().

row()

template<typename ViewType >

LIBMESH_DEVICE_INLINE auto libMesh::Kokkos::tensor_ref< ViewType >::row

(

const unsigned int

i

)

const

Returns

Row i of the referenced entry, as an owning vector.

Definition at line 743 of file kokkos_tensor_ops.h.

{
  return libMesh::Kokkos::row(*this, i);
}

References libMesh::Kokkos::row().

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

solve()

template<typename ViewType >

template<typename VectorLike , typename ResultVector >

LIBMESH_DEVICE_INLINE void libMesh::Kokkos::tensor_ref< ViewType >::solve	(	const VectorLike &	b,
		ResultVector &	x
	)		const

Solves the linear system (*this)x = b for x, via the explicit inverse.

Definition at line 733 of file kokkos_tensor_ops.h.

{
  const auto solution =
    detail::multiply_tensor_vector<vector_semantic_type_t<ResultVector>>(this->inverse(), b);
  for (unsigned int component = 0; component < LIBMESH_DIM; ++component)
    x(component) = solution(component);
}

References b, and libMesh::Kokkos::inverse().

subtract()

template<typename ViewType >

template<typename RightTensor >

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

(

const RightTensor &

right

)

Subtracts right from the referenced entry, in place.

Definition at line 639 of file kokkos_tensor_ops.h.

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

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

subtract_scaled()

template<typename ViewType >

template<typename RightTensor >

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

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

Definition at line 647 of file kokkos_tensor_ops.h.

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

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

tr()

template<typename ViewType >

LIBMESH_DEVICE_INLINE auto libMesh::Kokkos::tensor_ref< ViewType >::tr

(

)

const

Returns

The trace of the referenced entry.

Definition at line 718 of file kokkos_tensor_ops.h.

{
  return detail::tensor_trace(*this);
}

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

transpose()

template<typename ViewType >

LIBMESH_DEVICE_INLINE auto libMesh::Kokkos::tensor_ref< ViewType >::transpose

(

)

const

Returns

The transpose of the referenced entry, as an owning tensor.

Definition at line 704 of file kokkos_tensor_ops.h.

{
  return libMesh::Kokkos::transpose(*this);
}

References libMesh::Kokkos::transpose().

zero()

template<typename ViewType >

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

(

)

Sets every component of the referenced entry to zero.

Definition at line 654 of file kokkos_tensor_ops.h.

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

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

Member Data Documentation

_index

template<typename ViewType >

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

private

Definition at line 506 of file kokkos_linalg_base.h.

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

_view

template<typename ViewType >

ViewType libMesh::Kokkos::tensor_ref< ViewType >::_view

private

Definition at line 505 of file kokkos_linalg_base.h.

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

---

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

• include/gpu/kokkos_linalg_base.h
• include/gpu/kokkos_tensor_ops.h