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

The Kokkos material property class. More...

#include <KokkosMaterialPropertyDecl.h>

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

Public Member Functions
	MaterialProperty ()=default
	Default constructor. More...
	MaterialProperty (const T &value)
	Constructor for default property. More...
	MaterialProperty (const MaterialProperty< T, dimension > &property)
	Copy constructor The reference material properties are held by the material property storage, and the user deals with the clones of them. More...
auto &	operator= (const MaterialProperty< T, dimension > &property)
	Shallow copy another property. More...
KOKKOS_FUNCTION MaterialPropertyValue< T, dimension >	operator() (const Datum &datum, const unsigned int qp) const
	Get the property values of a quadrature point. More...
virtual std::type_index	propertyType () override
	Get the property type index for load/store functions. More...
virtual void	init (const PropRecord &record, const StorageKey &key) override
	Initialize this property. More...
virtual void	allocate (const MooseMesh &mesh, const Assembly &assembly, const std::set< SubdomainID > &subdomains, const bool bnd, StorageKey) override
	Allocate the data storage. More...
virtual void	copy (const MaterialPropertyBase &prop, StorageKey) override
	Deep copy another property. More...
virtual void	swap (MaterialPropertyBase &prop, StorageKey) override
	Swap with another property. More...
unsigned int	id () const
	Get the property ID. More...
std::string	name () const
	Get the property name. More...
std::string	type () const
	Get the data type. More...
unsigned int	dim () const
	Get the dimension. More...
unsigned int	dim (unsigned int i) const
	Get the size of a dimension. More...
KOKKOS_FUNCTION	operator bool () const
	Get whether this property is valid. More...

Protected Attributes
const PropRecord *	_record = nullptr
	Pointer to the record of this property. More...
unsigned int	_id = libMesh::invalid_uint
	Property ID. More...
bool	_default = false
	Flag whether this property has a default value. More...

Private Member Functions
void	shallowCopy (const MaterialProperty< T, dimension > &property)
	Shallow copy another property. More...

Private Attributes
const MaterialProperty< T, dimension > *	_reference = nullptr
	Pointer to the reference property. More...
Array< Array< T, dimension+1 > >	_data
	Data storage. More...
T	_value
	Default value. More...

Friends
class	MaterialPropertyValueBase< T, dimension >
void	propertyStore (std::ostream &, void *)
void	propertyLoad (std::istream &, void *)

Detailed Description

template<typename T, unsigned int dimension = 0>
class Moose::Kokkos::MaterialProperty< T, dimension >

The Kokkos material property class.

Definition at line 194 of file KokkosMaterialPropertyDecl.h.

Constructor & Destructor Documentation

MaterialProperty() [1/3]

template<typename T, unsigned int dimension = 0>

Moose::Kokkos::MaterialProperty< T, dimension >::MaterialProperty ( )

default

Default constructor.

MaterialProperty() [2/3]

template<typename T , unsigned int dimension>

MaterialProperty< T, dimension >::MaterialProperty

(

const T &

value

)

Constructor for default property.

Parameters

value

The default value

Definition at line 35 of file KokkosMaterialProperty.h.

{
  _default = true;
  _value = value;
}

MaterialProperty() [3/3]

template<typename T , unsigned int dimension>

MaterialProperty< T, dimension >::MaterialProperty

(

const MaterialProperty< T, dimension > &

property

)

Copy constructor The reference material properties are held by the material property storage, and the user deals with the clones of them.

The reference material properties also hold the arrays for storing the property values (_data), and the user accesses the arrays through their shallow copies in the clones. As a result, if the reference material properties reallocate their arrays, the shallow copies of arrays in the clones will lose synchronization. Thus, the clones also hold the pointers to their reference material properties and shallow copy them in the copy constructor, so that the arrays are always synchronized with those in the reference material properties during parallel dispatch.

Definition at line 42 of file KokkosMaterialProperty.h.

{
  // If reference exists, copy the reference property
  // Reference can be nullptr if the property is a default or optional property
  const auto & prop = property._reference ? *property._reference : property;

  shallowCopy(prop);

  _reference = property._reference;
}

Member Function Documentation

allocate()

template<typename T , unsigned int dimension>

void MaterialProperty< T, dimension >::allocate ( const MooseMesh &  mesh, const Assembly &  assembly, const std::set< SubdomainID > &  subdomains, const bool  bnd, StorageKey    )

overridevirtual

Allocate the data storage.

Parameters

mesh	The MOOSE mesh
assembly	The Kokkos assembly
subdomains	The MOOSE subdomain IDs
bnd	Whether this property is a face property

Implements Moose::Kokkos::MaterialPropertyBase.

Definition at line 113 of file KokkosMaterialProperty.h.

{
  if (!_data.isAlloc())
    _data.create(mesh.meshSubdomains().size());

  for (const auto subdomain : subdomains)
  {
    auto sid = mesh.getKokkosMesh()->getContiguousSubdomainID(subdomain);

    std::vector<dof_id_type> n;

    for (unsigned int i = 0; i < dimension; ++i)
      n.push_back(_record->dims[i]);

    n.push_back(bnd ? assembly.getNumFaceQps(sid) : assembly.getNumQps(sid));

    if (!_data[sid].isAlloc())
      _data[sid].createDevice(n);
  }

  _data.copyToDevice();
}

copy()

template<typename T , unsigned int dimension>

void MaterialProperty< T, dimension >::copy ( const MaterialPropertyBase &  prop, StorageKey    )

overridevirtual

Deep copy another property.

Parameters

prop	The property to copy

Implements Moose::Kokkos::MaterialPropertyBase.

Definition at line 74 of file KokkosMaterialProperty.h.

{
  auto prop_cast = dynamic_cast<const MaterialProperty<T, dimension> *>(&prop);

  mooseAssert(prop_cast, "The property to copy should be of the same type and dimension.");

  for (const auto i : index_range(prop_cast->_data))
    if (prop_cast->_data[i].isAlloc())
      _data[i].deepCopy(prop_cast->_data[i]);

  _data.copyToDevice();
}

dim() [1/2]

unsigned int Moose::Kokkos::MaterialPropertyBase::dim ( ) const

inlineinherited

Get the dimension.

Returns

The dimension

Definition at line 107 of file KokkosMaterialPropertyDecl.h.

Referenced by Moose::Kokkos::MaterialPropertyBase::dim().

{ return _record->dims.size(); }

dim() [2/2]

unsigned int Moose::Kokkos::MaterialPropertyBase::dim ( unsigned int  i ) const

inlineinherited

Get the size of a dimension.

Parameters

i	The dimension index

Returns

The size of the dimension

Definition at line 113 of file KokkosMaterialPropertyDecl.h.

  {
    if (i >= dim())
      mooseError("Cannot query the size of ",
                 i,
                 "-th dimension for the ",
                 dim(),
                 "D material property '",
                 name(),
                 "'.");

    return _record->dims.at(i);
  }

id()

unsigned int Moose::Kokkos::MaterialPropertyBase::id ( ) const

inlineinherited

Get the property ID.

Returns

The property ID assigned by the MOOSE registry

Definition at line 92 of file KokkosMaterialPropertyDecl.h.

{ return _id; }

init()

template<typename T , unsigned int dimension>

void MaterialProperty< T, dimension >::init ( const PropRecord &  record, const StorageKey &    )

overridevirtual

Initialize this property.

Parameters

record

The record of this property

Reimplemented from Moose::Kokkos::MaterialPropertyBase.

Definition at line 64 of file KokkosMaterialProperty.h.

{
  MaterialPropertyBase::init(record, key);

  _reference = this;
}

name()

std::string Moose::Kokkos::MaterialPropertyBase::name ( ) const

inlineinherited

Get the property name.

Returns

The property name

Definition at line 97 of file KokkosMaterialPropertyDecl.h.

Referenced by Moose::Kokkos::MaterialPropertyBase::dim().

{ return _record->name; }

operator bool()

KOKKOS_FUNCTION Moose::Kokkos::MaterialPropertyBase::operator bool ( ) const

inlineinherited

Get whether this property is valid.

Returns

Whether this property is valid

Definition at line 167 of file KokkosMaterialPropertyDecl.h.

{ return _id != libMesh::invalid_uint || _default; }

operator()()

template<typename T , unsigned int dimension>

KOKKOS_FUNCTION MaterialPropertyValue< T, dimension > MaterialProperty< T, dimension >::operator()	(	const Datum &	datum,
		const unsigned int	qp
	)		const

Get the property values of a quadrature point.

Parameters

datum	The Datum object of the current thread
qp	The local quadrature point index

Returns

The MaterialPropertyValue object that provides access to the property values

Definition at line 142 of file KokkosMaterialProperty.h.

{
  return MaterialPropertyValue<T, dimension>(*this, datum, qp);
}

operator=()

template<typename T , unsigned int dimension>

auto & MaterialProperty< T, dimension >::operator=

(

const MaterialProperty< T, dimension > &

property

)

Shallow copy another property.

Parameters

property

The property to be shallow copied

Definition at line 55 of file KokkosMaterialProperty.h.

{
  shallowCopy(property);

  return *this;
}

propertyType()

template<typename T, unsigned int dimension = 0>

virtual std::type_index Moose::Kokkos::MaterialProperty< T, dimension >::propertyType ( )

inlineoverridevirtual

Get the property type index for load/store functions.

Returns

The property type index for the load/store function pointer map lookup

Implements Moose::Kokkos::MaterialPropertyBase.

Definition at line 236 of file KokkosMaterialPropertyDecl.h.

  {
    static const std::type_index type = typeid(*this);

    return type;
  }

shallowCopy()

template<typename T , unsigned int dimension>

void MaterialProperty< T, dimension >::shallowCopy ( const MaterialProperty< T, dimension > &  property )

private

Shallow copy another property.

Parameters

property

The property to be shallow copied

Definition at line 100 of file KokkosMaterialProperty.h.

{
  _record = property._record;
  _id = property._id;
  _default = property._default;

  _reference = property._reference;
  _data = property._data;
  _value = property._value;
}

swap()

template<typename T , unsigned int dimension>

void MaterialProperty< T, dimension >::swap ( MaterialPropertyBase &  prop, StorageKey    )

overridevirtual

Swap with another property.

Parameters

prop	The property to swap

Implements Moose::Kokkos::MaterialPropertyBase.

Definition at line 89 of file KokkosMaterialProperty.h.

{
  auto prop_cast = dynamic_cast<MaterialProperty<T, dimension> *>(&prop);

  mooseAssert(prop_cast, "The property to swap should be of the same type and dimension.");

  _data.swap(prop_cast->_data);
}

type()

std::string Moose::Kokkos::MaterialPropertyBase::type ( ) const

inlineinherited

Get the data type.

Returns

The demangled data type name

Definition at line 102 of file KokkosMaterialPropertyDecl.h.

Referenced by Moose::Kokkos::MaterialProperty< T, dimension >::propertyType().

{ return _record->type; }

Friends And Related Function Documentation

MaterialPropertyValueBase< T, dimension >

template<typename T, unsigned int dimension = 0>

friend class MaterialPropertyValueBase< T, dimension >

friend

Definition at line 275 of file KokkosMaterialPropertyDecl.h.

propertyLoad

template<typename T, unsigned int dimension = 0>

void propertyLoad ( std::istream &  , void *    )

friend

Definition at line 158 of file KokkosMaterialProperty.h.

{
  auto property = static_cast<MaterialProperty<T, dimension> *>(prop);

  dataLoad(stream, property->_data, nullptr);
}

propertyStore

template<typename T, unsigned int dimension = 0>

void propertyStore ( std::ostream &  , void *    )

friend

Definition at line 150 of file KokkosMaterialProperty.h.

{
  auto property = static_cast<MaterialProperty<T, dimension> *>(prop);

  dataStore(stream, property->_data, nullptr);
}

Member Data Documentation

_data

template<typename T, unsigned int dimension = 0>

Array<Array<T, dimension + 1> > Moose::Kokkos::MaterialProperty< T, dimension >::_data

private

Data storage.

Definition at line 269 of file KokkosMaterialPropertyDecl.h.

_default

bool Moose::Kokkos::MaterialPropertyBase::_default = false

protectedinherited

Flag whether this property has a default value.

Definition at line 182 of file KokkosMaterialPropertyDecl.h.

Referenced by Moose::Kokkos::MaterialPropertyBase::operator bool().

_id

unsigned int Moose::Kokkos::MaterialPropertyBase::_id = libMesh::invalid_uint

protectedinherited

Property ID.

Definition at line 178 of file KokkosMaterialPropertyDecl.h.

Referenced by Moose::Kokkos::MaterialPropertyBase::id(), Moose::Kokkos::MaterialPropertyBase::init(), and Moose::Kokkos::MaterialPropertyBase::operator bool().

_record

const PropRecord* Moose::Kokkos::MaterialPropertyBase::_record = nullptr

protectedinherited

Pointer to the record of this property.

Definition at line 174 of file KokkosMaterialPropertyDecl.h.

Referenced by Moose::Kokkos::MaterialPropertyBase::dim(), Moose::Kokkos::MaterialPropertyBase::init(), Moose::Kokkos::MaterialPropertyBase::name(), and Moose::Kokkos::MaterialPropertyBase::type().

_reference

template<typename T, unsigned int dimension = 0>

const MaterialProperty<T, dimension>* Moose::Kokkos::MaterialProperty< T, dimension >::_reference = nullptr

private

Pointer to the reference property.

Definition at line 265 of file KokkosMaterialPropertyDecl.h.

_value

template<typename T, unsigned int dimension = 0>

T Moose::Kokkos::MaterialProperty< T, dimension >::_value

private

Default value.

Definition at line 273 of file KokkosMaterialPropertyDecl.h.

---

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

• include/kokkos/materials/KokkosMaterialPropertyDecl.h
• include/kokkos/materials/KokkosMaterialProperty.h