Moose::Kokkos::MaterialPropertyBase Class Reference

The base class for Kokkos material properties. More...

#include <KokkosMaterialPropertyDecl.h>

Inheritance diagram for Moose::Kokkos::MaterialPropertyBase:

Public Member Functions
	MaterialPropertyBase ()=default
	Default constructor. More...
virtual	~MaterialPropertyBase ()
	Desturctor. 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...
virtual std::type_index	propertyType ()=0
	Get the property type index for load/store functions. More...
virtual void	init (const PropRecord &record, const StorageKey &)
	Initialize this property. More...
virtual void	allocate (const MooseMesh &mesh, const Assembly &assembly, const std::set< SubdomainID > &subdomains, const bool bnd, StorageKey)=0
	Allocate the data storage. More...
virtual void	copy (const MaterialPropertyBase &prop, StorageKey)=0
	Deep copy another property. More...
virtual void	swap (MaterialPropertyBase &prop, StorageKey)=0
	Swap with another property. 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...

Detailed Description

The base class for Kokkos material properties.

Definition at line 76 of file KokkosMaterialPropertyDecl.h.

Constructor & Destructor Documentation

MaterialPropertyBase()

Moose::Kokkos::MaterialPropertyBase::MaterialPropertyBase ( )

default

Default constructor.

~MaterialPropertyBase()

virtual Moose::Kokkos::MaterialPropertyBase::~MaterialPropertyBase ( )

inlinevirtual

Desturctor.

Definition at line 86 of file KokkosMaterialPropertyDecl.h.

{}

Member Function Documentation

allocate()

virtual void Moose::Kokkos::MaterialPropertyBase::allocate ( const MooseMesh &  mesh, const Assembly &  assembly, const std::set< SubdomainID > &  subdomains, const bool  bnd, StorageKey    )

pure virtual

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

Implemented in Moose::Kokkos::MaterialProperty< T, dimension >, and Moose::Kokkos::MaterialProperty< Real >.

copy()

virtual void Moose::Kokkos::MaterialPropertyBase::copy ( const MaterialPropertyBase &  prop, StorageKey    )

pure virtual

Deep copy another property.

Parameters

prop	The property to copy

Implemented in Moose::Kokkos::MaterialProperty< T, dimension >, and Moose::Kokkos::MaterialProperty< Real >.

dim() [1/2]

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

inline

Get the dimension.

Returns

The dimension

Definition at line 107 of file KokkosMaterialPropertyDecl.h.

Referenced by dim().

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

dim() [2/2]

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

inline

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

inline

Get the property ID.

Returns

The property ID assigned by the MOOSE registry

Definition at line 92 of file KokkosMaterialPropertyDecl.h.

{ return _id; }

init()

void MaterialPropertyBase< T, is_ad >::init ( const PropRecord &  record, const StorageKey &    )

inlinevirtual

Initialize this property.

Parameters

record

The record of this property

Reimplemented in Moose::Kokkos::MaterialProperty< T, dimension >, and Moose::Kokkos::MaterialProperty< Real >.

Definition at line 28 of file KokkosMaterialProperty.h.

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

{
  _record = &record;
  _id = record.id;
}

name()

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

inline

Get the property name.

Returns

The property name

Definition at line 97 of file KokkosMaterialPropertyDecl.h.

Referenced by dim().

{ return _record->name; }

operator bool()

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

inline

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

propertyType()

virtual std::type_index Moose::Kokkos::MaterialPropertyBase::propertyType ( )

pure virtual

Get the property type index for load/store functions.

Returns

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

Implemented in Moose::Kokkos::MaterialProperty< T, dimension >, and Moose::Kokkos::MaterialProperty< Real >.

swap()

virtual void Moose::Kokkos::MaterialPropertyBase::swap ( MaterialPropertyBase &  prop, StorageKey    )

pure virtual

Swap with another property.

Parameters

prop	The property to swap

Implemented in Moose::Kokkos::MaterialProperty< T, dimension >, and Moose::Kokkos::MaterialProperty< Real >.

type()

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

inline

Get the data type.

Returns

The demangled data type name

Definition at line 102 of file KokkosMaterialPropertyDecl.h.

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

{ return _record->type; }

Member Data Documentation

_default

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

protected

Flag whether this property has a default value.

Definition at line 182 of file KokkosMaterialPropertyDecl.h.

Referenced by operator bool().

_id

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

protected

Property ID.

Definition at line 178 of file KokkosMaterialPropertyDecl.h.

Referenced by id(), init(), and operator bool().

_record

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

protected

Pointer to the record of this property.

Definition at line 174 of file KokkosMaterialPropertyDecl.h.

Referenced by dim(), init(), name(), and type().

---

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

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