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...

template<unsigned int D>
	MaterialProperty (const MaterialProperty< T, D > &other)=delete
	Prevent initializing with properties of different rank. More...

auto &	operator= (const MaterialProperty< T, dimension > &property)
	Shallow copy another property. More...

KOKKOS_FUNCTION	operator bool () const
	Get whether this property is valid. 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 Mesh &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...

const std::string &	name () const
	Get the property name. More...

const std::string &	type () const
	Get the data type. More...

unsigned int	dim () const
	Get the dimension. More...

unsigned int	dimSize (SubdomainID subdomain, unsigned int i) const
	Get the size of a dimension. 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...

Array< PropertyConstantOption >	_constant_option
	Whether this property is constant over element or subdomain in each subdomain. 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 239 of file KokkosMaterialPropertyDecl.h.

Constructor & Destructor Documentation

◆ MaterialProperty() [1/4]

template<typename T, unsigned int dimension = 0>

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

default

Default constructor.

◆ MaterialProperty() [2/4]

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 32 of file KokkosMaterialProperty.h.

 {
   _default = true;
   _value = value;
 }

◆ MaterialProperty() [3/4]

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 39 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;
 }

◆ MaterialProperty() [4/4]

template<typename T, unsigned int dimension = 0>

template<unsigned int D>

Moose::Kokkos::MaterialProperty< T, dimension >::MaterialProperty ( const MaterialProperty< T, D > & other )

delete

Prevent initializing with properties of different rank.

Member Function Documentation

◆ allocate()

template<typename T , unsigned int dimension>

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

overridevirtual

Allocate the data storage.

Parameters

mesh	The Kokkos 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 111 of file KokkosMaterialProperty.h.

 {
   if (!_data.isAlloc())
     _data.create(mesh.getNumSubdomains());
 
   if (!_constant_option.isAlloc())
   {
     _constant_option.create(mesh.getNumSubdomains());
     _constant_option = PropertyConstantOption::NONE;
   }
 
   for (const auto subdomain : subdomains)
   {
     auto sid = mesh.getContiguousSubdomainID(subdomain);
     auto constant_option = libmesh_map_find(_record->constant_option, subdomain);
 
     using index_type = typename std::remove_reference_t<decltype(_data[sid])>::unsigned_index_type;
 
     std::vector<index_type> n;
 
     for (unsigned int i = 0; i < dimension; ++i)
       n.push_back(libmesh_map_find(_record->dims, subdomain)[i]);
 
     if (constant_option == PropertyConstantOption::NONE)
       n.push_back(bnd ? assembly.getNumFaceQps(sid) : assembly.getNumQps(sid));
     else if (constant_option == PropertyConstantOption::ELEMENT)
       n.push_back(bnd ? assembly.getElemFacePropertySize(sid)
                       : mesh.getNumSubdomainLocalElements(subdomain));
     else
       n.push_back(1);
 
     if (!_data[sid].isAlloc())
       _data[sid].createDevice(n);
 
     _constant_option[sid] = constant_option;
   }
 
   _data.copyToDevice();
   _constant_option.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 71 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()

unsigned int MaterialPropertyBase< T, is_ad >::dim ( ) const

inlineinherited

Get the dimension.

Returns: The dimension

Definition at line 205 of file KokkosMaterialPropertyDecl.h.

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

 {
   if (!_record || !_record->dims.size())
     mooseError("Cannot get the dimension of an uninitialized or default material property.");
   else
     return _record->dims.begin()->second.size();
 }

◆ dimSize()

unsigned int MaterialPropertyBase< T, is_ad >::dimSize	(	SubdomainID	subdomain,
		unsigned int	i
	)		const

inlineinherited

Get the size of a dimension.

Parameters

subdomain	The MOOSE subdomain ID
i	The dimension index

Returns: The size of the dimension

Definition at line 214 of file KokkosMaterialPropertyDecl.h.

 {
   const unsigned int D = dim();
 
   if (i >= D)
     mooseError("Cannot get the size of ",
                i,
                "-th dimension for the ",
                D,
                "D material property '",
                name(),
                "'.");
 
   return libmesh_map_find(_record->dims, subdomain)[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 108 of file KokkosMaterialPropertyDecl.h.

108 { return _id; }

Moose::Kokkos::MaterialPropertyBase::_id

unsigned int _id

Property ID.

Definition: KokkosMaterialPropertyDecl.h:175

◆ 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 61 of file KokkosMaterialProperty.h.

 {
   MaterialPropertyBase::init(record, key);
 
   _reference = this;
 }

◆ name()

const std::string & MaterialPropertyBase< T, is_ad >::name ( ) const

inlineinherited

Get the property name.

Returns: The property name

Definition at line 187 of file KokkosMaterialPropertyDecl.h.

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

 {
   if (!_record)
     mooseError("Cannot get the name of an uninitialized or default material property.");
   else
     return _record->name;
 }

◆ operator bool()

template<typename T, unsigned int dimension = 0>

KOKKOS_FUNCTION Moose::Kokkos::MaterialProperty< T, dimension >::operator bool ( ) const

inline

Get whether this property is valid.

Returns: Whether this property is valid

Definition at line 280 of file KokkosMaterialPropertyDecl.h.

280 { return _data.isAlloc() || _default; }

Moose::Kokkos::MaterialProperty::_data

Array< Array< T, dimension+1 > > _data

Data storage.

Definition: KokkosMaterialPropertyDecl.h:325

Moose::Kokkos::MaterialPropertyBase::_default

bool _default

Flag whether this property has a default value.

Definition: KokkosMaterialPropertyDecl.h:179

◆ 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 158 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 52 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 292 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 97 of file KokkosMaterialProperty.h.

 {
   _record = property._record;
   _id = property._id;
   _default = property._default;
   _constant_option = property._constant_option;
 
   _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 86 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()

const std::string & MaterialPropertyBase< T, is_ad >::type ( ) const

inlineinherited

Get the data type.

Returns: The demangled data type name

Definition at line 196 of file KokkosMaterialPropertyDecl.h.

Referenced by Moose::Kokkos::MaterialProperty< Real >::propertyType().

 {
   if (!_record)
     mooseError("Cannot get the type of an uninitialized or default material property.");
   else
     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 331 of file KokkosMaterialPropertyDecl.h.

◆ propertyLoad

template<typename T, unsigned int dimension = 0>

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

friend

Definition at line 174 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 166 of file KokkosMaterialProperty.h.

 {
   auto property = static_cast<MaterialProperty<T, dimension> *>(prop);
 
   dataStore(stream, property->_data, nullptr);
 }

Member Data Documentation

◆ _constant_option

Array<PropertyConstantOption> Moose::Kokkos::MaterialPropertyBase::_constant_option

protectedinherited

Whether this property is constant over element or subdomain in each subdomain.

Definition at line 183 of file KokkosMaterialPropertyDecl.h.

◆ _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 325 of file KokkosMaterialPropertyDecl.h.

Referenced by Moose::Kokkos::MaterialProperty< Real >::operator bool().

◆ _default

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

protectedinherited

Flag whether this property has a default value.

Definition at line 179 of file KokkosMaterialPropertyDecl.h.

Referenced by Moose::Kokkos::MaterialProperty< Real >::operator bool().

◆ _id

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

protectedinherited

Property ID.

Definition at line 175 of file KokkosMaterialPropertyDecl.h.

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

◆ _record

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

protectedinherited

Pointer to the record of this property.

Definition at line 171 of file KokkosMaterialPropertyDecl.h.

Referenced by Moose::Kokkos::MaterialPropertyBase::dim(), Moose::Kokkos::MaterialPropertyBase::dimSize(), 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 321 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 329 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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

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

Constructor & Destructor Documentation

◆ MaterialProperty() [1/4]

◆ MaterialProperty() [2/4]

◆ MaterialProperty() [3/4]

◆ MaterialProperty() [4/4]

Member Function Documentation

◆ allocate()

◆ copy()

◆ dim()

◆ dimSize()

◆ id()

◆ init()

◆ name()

◆ operator bool()

◆ operator()()

◆ operator=()

◆ propertyType()

◆ shallowCopy()

◆ swap()

◆ type()

Friends And Related Function Documentation

◆ MaterialPropertyValueBase< T, dimension >

◆ propertyLoad

◆ propertyStore

Member Data Documentation

◆ _constant_option

◆ _data

◆ _default

◆ _id

◆ _record

◆ _reference

◆ _value

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