Moose::Kokkos::MaterialPropertyValueBase< T, dimension > Class Template Reference

The Kokkos wrapper class for accessing the material property values of a single quadrature point. More...

#include <KokkosMaterialPropertyDecl.h>

Inheritance diagram for Moose::Kokkos::MaterialPropertyValueBase< T, dimension >:

Public Member Functions
KOKKOS_FUNCTION	MaterialPropertyValueBase (const MaterialProperty< T, dimension > &property, const Datum &datum, const unsigned int qp)
	Constructor. More...
KOKKOS_FUNCTION dof_id_type	n (unsigned int dim) const
	Get the size of a dimension. More...

Protected Attributes
const dof_id_type	_idx
	Index into the property data storage. More...
Array< T, dimension+1 > const *	_data
	Pointer to the property data storage. More...
const T &	_value
	Default value. More...

Detailed Description

template<typename T, unsigned int dimension>
class Moose::Kokkos::MaterialPropertyValueBase< T, dimension >

The Kokkos wrapper class for accessing the material property values of a single quadrature point.

The instances of this class are expected to be only created by the Kokkos material properties as temporary objects.

Definition at line 28 of file KokkosMaterialPropertyDecl.h.

Constructor & Destructor Documentation

MaterialPropertyValueBase()

template<typename T, unsigned int dimension>

KOKKOS_FUNCTION Moose::Kokkos::MaterialPropertyValueBase< T, dimension >::MaterialPropertyValueBase	(	const MaterialProperty< T, dimension > &	property,
		const Datum &	datum,
		const unsigned int	qp
	)

Constructor.

Parameters

property	The material property constructing this object
datum	The Datum object of the current thread
qp	The local quadrature point index

Definition at line 21 of file KokkosMaterialPropertyValue.h.

  : _idx(property._default ? libMesh::invalid_uint
                           : datum.propertyIdx(property._constant_option[datum.subdomain()], qp)),
    _data(property._default ? nullptr : &property._data[datum.subdomain()]),
    _value(property._value)
{
}

Member Function Documentation

n()

template<typename T, unsigned int dimension>

KOKKOS_FUNCTION dof_id_type Moose::Kokkos::MaterialPropertyValueBase< T, dimension >::n ( unsigned int  dim ) const

inline

Get the size of a dimension.

Parameters

dim	The dimension index

Returns

The size of the dimension

Definition at line 52 of file KokkosMaterialPropertyValueDecl.h.

{ return _data->n(dim); }

Member Data Documentation

_data

template<typename T, unsigned int dimension>

Array<T, dimension + 1> const* Moose::Kokkos::MaterialPropertyValueBase< T, dimension >::_data

protected

Pointer to the property data storage.

Definition at line 62 of file KokkosMaterialPropertyValueDecl.h.

Referenced by Moose::Kokkos::MaterialPropertyValueBase< T, 0 >::n(), Moose::Kokkos::MaterialPropertyValue< T, 0 >::operator const T &(), and Moose::Kokkos::MaterialPropertyValue< T, dimension >::operator()().

_idx

template<typename T, unsigned int dimension>

const dof_id_type Moose::Kokkos::MaterialPropertyValueBase< T, dimension >::_idx

protected

Index into the property data storage.

Definition at line 58 of file KokkosMaterialPropertyValueDecl.h.

Referenced by Moose::Kokkos::MaterialPropertyValue< T, 0 >::operator const T &(), Moose::Kokkos::MaterialPropertyValue< T, dimension >::operator()(), and Moose::Kokkos::MaterialPropertyValue< T, 0 >::operator=().

_value

template<typename T, unsigned int dimension>

const T& Moose::Kokkos::MaterialPropertyValueBase< T, dimension >::_value

protected

Default value.

Definition at line 66 of file KokkosMaterialPropertyValueDecl.h.

Referenced by Moose::Kokkos::MaterialPropertyValue< T, 0 >::operator const T &(), and Moose::Kokkos::MaterialPropertyValue< T, dimension >::operator()().

---

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

• include/kokkos/materials/KokkosMaterialPropertyDecl.h
• include/kokkos/materials/KokkosMaterialPropertyValueDecl.h
• include/kokkos/materials/KokkosMaterialPropertyValue.h