The Kokkos class responsible for allocating and storing Kokkos material properties. More...

#include <KokkosMaterialPropertyStorage.h>

Inheritance diagram for Moose::Kokkos::MaterialPropertyStorage:

Public Member Functions
	MaterialPropertyStorage (MaterialPropertyRegistry &registry, FEProblemBase &problem)
	Constructor. More...

MaterialPropertyBase &	addKokkosProperty (const std::string &prop_name, const std::type_info &type, const unsigned int state, const ::MaterialBase *declarer, std::shared_ptr< MaterialPropertyBase > shell)
	Add a material property. More...

MaterialPropertyBase &	addKokkosPropertyState (const std::string &prop_name, const unsigned int state, std::shared_ptr< MaterialPropertyBase > shell)
	Add an old/older material property. More...

MaterialPropertyBase &	declareKokkosProperty (const std::string &prop_name, const std::type_info &type, const ::MaterialBase *declarer, const std::vector< unsigned int > &dims, const bool bnd, std::shared_ptr< MaterialPropertyBase > shell)
	Declare a material property. More...

MaterialPropertyBase &	getKokkosProperty (std::string prop_name, unsigned int state=0)
	Get a material property. More...

bool	haveKokkosProperty (std::string prop_name, unsigned int state=0)
	Get whether a material property exists. More...

void	registerLoadStore (std::type_index type, PropertyStore store, PropertyLoad load)
	Register the load/store functions. More...

void	allocateKokkosProperties ()
	Allocate all the material property data storages. More...

void	shift ()
	Shift current, old, and older material property data storages. More...

void	copy ()
	Copy current material properties to old and older. More...

Static Public Member Functions
static MaterialPropertyStorage &	cast (::MaterialPropertyStorage &storage)
	Cast the reference of a Kokkos material property storage from the base type to the actual type. More...

Protected Types
typedef HashMap< const Elem *, HashMap< unsigned int, MaterialProperties > >	PropsType
	Accessible type of the stored material property data. More...

Protected Member Functions
void	prolongStatefulProps (processor_id_type pid, const std::vector< std::vector< QpMap >> &refinement_map, const libMesh::QBase &qrule, const libMesh::QBase &qrule_face, MaterialPropertyStorage &parent_material_props, const THREAD_ID tid, const Elem &elem, const int input_parent_side, const int input_child, const int input_child_side)
	Creates storage for newly created elements from mesh Adaptivity. More...

void	updateStatefulPropsForPRefinement (const processor_id_type pid, const std::vector< QpMap > &p_refinement_map, const libMesh::QBase &qrule, const libMesh::QBase &qrule_face, const THREAD_ID tid, const Elem &elem, const int input_side)
	Based on the p-refinement flag of `elem`, either prolong (for refinement) or restrict (for coarsening) the stateful material property data. More...

void	restrictStatefulProps (const std::vector< std::pair< unsigned int, QpMap >> &coarsening_map, const std::vector< const Elem *> &coarsened_element_children, const libMesh::QBase &qrule, const libMesh::QBase &qrule_face, const THREAD_ID tid, const Elem &elem, int input_side=-1)
	Creates storage for newly created elements from mesh Adaptivity. More...

void	initStatefulProps (const THREAD_ID tid, const std::vector< std::shared_ptr< MaterialBase >> &mats, const unsigned int n_qpoints, const Elem &elem, const unsigned int side=0)
	Initialize stateful material properties. More...

void	copy (const THREAD_ID tid, const Elem &elem_to, const Elem &elem_from, unsigned int side, unsigned int n_qpoints)
	Copy material properties from elem_from to elem_to. More...

void	copy (const THREAD_ID tid, const Elem elem_to, const Elem elem_from, unsigned int side, unsigned int n_qpoints)
	Copy material properties from elem_from to elem_to. More...

void	swap (const THREAD_ID tid, const Elem &elem, unsigned int side)
	Swap (shallow copy) material properties in MaterialData and MaterialPropertyStorage Thread safe. More...

void	swapBack (const THREAD_ID tid, const Elem &elem, unsigned int side)
	Swap (shallow copy) material properties in MaterialPropertyStorage and MaterialDat Thread safe. More...

bool	hasStatefulProperties () const

bool	hasOlderProperties () const

bool	hasProperty (const std::string &prop_name) const

unsigned int	addProperty (const std::string &prop_name, const std::type_info &type, const unsigned int state, const MaterialBase *const declarer)
	Adds a property with the name `prop_name`, type `type`, and state `state` (0 = current, 1 = old, etc) More...

const std::vector< unsigned int > &	statefulProps () const

const MaterialPropertyRegistry &	getMaterialPropertyRegistry () const

std::optional< std::string >	queryStatefulPropName (const unsigned int id) const

void	eraseProperty (const Elem *elem)
	Remove the property storage and element pointer from internal data structures Use this when elements are deleted so we don't end up with invalid elem pointers (for e.g. More...

unsigned int	maxState () const

unsigned int	numStates () const

libMesh::IntRange< unsigned int >	stateIndexRange () const

libMesh::IntRange< unsigned int >	statefulIndexRange () const

const MaterialData &	getMaterialData (const THREAD_ID tid) const

MaterialData &	getMaterialData (const THREAD_ID tid)

const std::set< const MooseObject * > &	getConsumers (Moose::MaterialDataType type) const

void	addConsumer (Moose::MaterialDataType type, const MooseObject *object)
	Add `object` as the consumer of storage of type `type`. More...

void	setRecovering ()
	Sets the loading of stateful material properties to recover. More...

void	setRestartInPlace ()
	Sets the loading of stateful material properties in place. More...

const PropRecord &	getPropRecord (const unsigned int id) const
	Get the property record associated with the material with id `id`. More...

bool	isRestoredProperty (const std::string &name) const

void	sizeProps (MaterialProperties &mp, unsigned int size)


const PropsType &	props (const unsigned int state=0) const
	Access methods to the stored material property data with the given state `state`. More...

const MaterialProperties &	props (const Elem *elem, unsigned int side, const unsigned int state=0) const

MaterialProperties &	setProps (const Elem *elem, unsigned int side, const unsigned int state=0)

Protected Attributes
FEProblemBase &	_problem
	Reference to the problem. More...

std::array< PropsType, MaterialData::max_state+1 >	_storage
	The actual storage. More...

std::vector< std::optional< PropRecord > >	_prop_records
	Property records indexed by property id (may be null) More...

std::vector< unsigned int >	_stateful_prop_id_to_prop_id
	the vector of stateful property ids (the vector index is the map to stateful prop_id) More...

std::map< Moose::MaterialDataType, std::set< const MooseObject * > >	_consumers
	The consumers of this storage. More...

Private Member Functions
friend	void ::dataStore (std::ostream &, MaterialPropertyStorage &, void *)

friend	void ::dataLoad (std::istream &, MaterialPropertyStorage &, void *)

Private Attributes
std::unordered_map< std::string, std::shared_ptr< MaterialPropertyBase > >	_kokkos_props [MaterialData::max_state+1]
	Material properties. More...

std::unordered_map< std::string, Moose::Kokkos::PropRecord >	_kokkos_prop_records
	Record of each material property. More...

Static Private Attributes
static std::unordered_map< std::type_index, PropertyStore >	_store_functions
	Function pointer maps for load/store. More...

static std::unordered_map< std::type_index, PropertyLoad >	_load_functions

Detailed Description

The Kokkos class responsible for allocating and storing Kokkos material properties.

Definition at line 29 of file KokkosMaterialPropertyStorage.h.

Member Typedef Documentation

◆ PropsType

typedef HashMap<const Elem *, HashMap<unsigned int, MaterialProperties> > MaterialPropertyStorage::PropsType

inherited

Accessible type of the stored material property data.

This probably should have been returned as a proxy class; only access it via foo[elem][side] and maybe we'll be able to refactor it in the future without breaking your code.

Definition at line 255 of file MaterialPropertyStorage.h.

Constructor & Destructor Documentation

◆ MaterialPropertyStorage()

Moose::Kokkos::MaterialPropertyStorage::MaterialPropertyStorage	(	MaterialPropertyRegistry &	registry,
		FEProblemBase &	problem
	)

Constructor.

Member Function Documentation

◆ addConsumer()

void MaterialPropertyStorage::addConsumer	(	Moose::MaterialDataType	type,
		const MooseObject *	object
	)

inlineinherited

Add object as the consumer of storage of type type.

Definition at line 342 of file MaterialPropertyStorage.h.

Referenced by FEProblemBase::getMaterialData().

   {
     _consumers[type].insert(object);
   }

◆ addKokkosProperty()

MaterialPropertyBase& Moose::Kokkos::MaterialPropertyStorage::addKokkosProperty	(	const std::string &	prop_name,
		const std::type_info &	type,
		const unsigned int	state,
		const ::MaterialBase *	declarer,
		std::shared_ptr< MaterialPropertyBase >	shell
	)

Add a material property.

Parameters

prop_name	The property name
type	The property data type
state	The property state
declarer	The Kokkos material declaring the property, nullptr if simply reserving the property
shell	The managed pointer containing the instance of the property

Returns: The material property

◆ addKokkosPropertyState()

MaterialPropertyBase& Moose::Kokkos::MaterialPropertyStorage::addKokkosPropertyState	(	const std::string &	prop_name,
		const unsigned int	state,
		std::shared_ptr< MaterialPropertyBase >	shell
	)

Add an old/older material property.

Parameters

prop_name	The property name
state	The property state
shell	The managed pointer containing the

Returns: The material property

◆ addProperty()

unsigned int MaterialPropertyStorage::addProperty	(	const std::string &	prop_name,
		const std::type_info &	type,
		const unsigned int	state,
		const MaterialBase *const	declarer
	)

inherited

Adds a property with the name prop_name, type type, and state state (0 = current, 1 = old, etc)

This is idempotent - calling multiple times with the same name will provide the same id and works fine.

declarer should be specified by the object declaring the property if it is being declared.

Definition at line 493 of file MaterialPropertyStorage.C.

Referenced by MaterialData::addPropertyHelper().

 {
   if (state > MaterialData::max_state)
     mooseError("Material property state of ",
                state,
                " is not supported. Max state supported: ",
                MaterialData::max_state);
 
   // Increment state as needed
   if (maxState() < state)
     _max_state = state;
 
   // Register the property
   const auto prop_id = _registry.addOrGetID(prop_name, {});
 
   // Instantiate the record if needed
   if (_prop_records.size() < _registry.size())
     _prop_records.resize(_registry.size());
   if (!_prop_records[prop_id])
     _prop_records[prop_id] = PropRecord();
 
   // Fill the record
   auto & record = *_prop_records[prop_id];
   record.type = type.name();
   if (declarer)
     record.declarers.emplace(declarer->typeAndName());
   record.state = std::max(state, record.state);
 
   // Keep track of stateful props by quick access
   if (state > 0 && std::find(_stateful_prop_id_to_prop_id.begin(),
                              _stateful_prop_id_to_prop_id.end(),
                              prop_id) == _stateful_prop_id_to_prop_id.end())
   {
     _stateful_prop_id_to_prop_id.push_back(prop_id);
     record.stateful_id = _stateful_prop_id_to_prop_id.size() - 1;
   }
 
   return prop_id;
 }

◆ allocateKokkosProperties()

void Moose::Kokkos::MaterialPropertyStorage::allocateKokkosProperties ( )

Allocate all the material property data storages.

◆ cast()

static MaterialPropertyStorage& Moose::Kokkos::MaterialPropertyStorage::cast ( ::MaterialPropertyStorage & storage )

static

Cast the reference of a Kokkos material property storage from the base type to the actual type.

Parameters

storage The Kokkos material property storage as the reference of the base type

Returns: The Kokkos material property storage as the reference of the actual type

◆ copy() [1/3]

void Moose::Kokkos::MaterialPropertyStorage::copy ( )

Copy current material properties to old and older.

◆ copy() [2/3]

void MaterialPropertyStorage::copy	(	const THREAD_ID	tid,
		const Elem &	elem_to,
		const Elem &	elem_from,
		unsigned int	side,
		unsigned int	n_qpoints
	)

inherited

Copy material properties from elem_from to elem_to.

Thread safe.

WARNING: This is not capable of copying material data to/from elements on other processors. It only works if both elem_to and elem_from are both on the local processor. We can't currently check to ensure that they're on processor here because this isn't a ParallelObject.

Parameters

tid	The thread ID
elem_to	Element to copy data to
elem_from	Element to copy data from
side	Side number (elemental material properties have this equal to zero)
n_qpoints	number of quadrature points to work with

Definition at line 436 of file MaterialPropertyStorage.C.

Referenced by MaterialData::copy().

 {
   copy(tid, &elem_to, &elem_from, side, n_qpoints);
 }

◆ copy() [3/3]

void MaterialPropertyStorage::copy	(	const THREAD_ID	tid,
		const Elem *	elem_to,
		const Elem *	elem_from,
		unsigned int	side,
		unsigned int	n_qpoints
	)

inherited

Copy material properties from elem_from to elem_to.

Similar to the other method but using pointers to elements instead of references.

Parameters

tid	The thread ID
elem_to	Pointer to the element to copy data to
elem_from	Pointer to the element to copy data from
side	Side number (elemental material properties have this equal to zero)
n_qpoints	number of quadrature points to work with

Definition at line 446 of file MaterialPropertyStorage.C.

 {
   auto to_props = initProps(tid, elem_to, side, n_qpoints);
 
   for (const auto state : stateIndexRange())
   {
     const auto & from_props = props(elem_from, side, state);
     for (const auto i : index_range(_stateful_prop_id_to_prop_id))
       for (const auto qp : make_range(n_qpoints))
         (*to_props[state])[i].qpCopy(qp, from_props[i], qp);
   }
 }

◆ declareKokkosProperty()

MaterialPropertyBase& Moose::Kokkos::MaterialPropertyStorage::declareKokkosProperty	(	const std::string &	prop_name,
		const std::type_info &	type,
		const ::MaterialBase *	declarer,
		const std::vector< unsigned int > &	dims,
		const bool	bnd,
		std::shared_ptr< MaterialPropertyBase >	shell
	)

Declare a material property.

Parameters

prop_name	The property name
type	The property data type
declarer	The Kokkos material declaring the property, nullptr if simply reserving the
dims	The vector containing the size of each dimension
bnd	Whether the property is a face property
shell	The managed pointer containing the instance of the property

Returns: The material property

◆ eraseProperty()

void MaterialPropertyStorage::eraseProperty ( const Elem * elem )

inherited

Remove the property storage and element pointer from internal data structures Use this when elements are deleted so we don't end up with invalid elem pointers (for e.g.

stateful properties) hanging around in our data structures

Definition at line 76 of file MaterialPropertyStorage.C.

Referenced by MaterialData::eraseProperty(), and FEProblemBase::meshChanged().

 {
   for (const auto state : stateIndexRange())
     setProps(state).erase(elem);
 }

◆ getConsumers()

const std::set< const MooseObject * > & MaterialPropertyStorage::getConsumers ( Moose::MaterialDataType type ) const

inherited

Returns: The consumers of storage of type type

Definition at line 108 of file MaterialPropertyStorage.C.

Referenced by FEProblemBase::getMaterialPropertyStorageConsumers().

 {
   static const std::set<const MooseObject *> empty;
 
   const auto it = _consumers.find(type);
 
   if (it != _consumers.end())
     return it->second;
 
   return empty;
 }

◆ getKokkosProperty()

MaterialPropertyBase& Moose::Kokkos::MaterialPropertyStorage::getKokkosProperty	(	std::string	prop_name,
		unsigned int	state = `0`
	)

Get a material property.

Parameters

prop_name	The property name
state	The property state

Returns: The material property

◆ getMaterialData() [1/2]

const MaterialData& MaterialPropertyStorage::getMaterialData ( const THREAD_ID tid ) const

inlineinherited

Returns: The MaterialData for thread tid

Definition at line 331 of file MaterialPropertyStorage.h.

Referenced by FEProblemBase::getMaterialData(), ComputeMaterialsObjectThread::onBoundary(), ComputeMaterialsObjectThread::onElement(), ComputeMaterialsObjectThread::onInterface(), ComputeMaterialsObjectThread::onInternalSide(), FEProblemBase::reinitMaterials(), FEProblemBase::reinitMaterialsBoundary(), FEProblemBase::reinitMaterialsFace(), FEProblemBase::reinitMaterialsInterface(), FEProblemBase::reinitMaterialsNeighbor(), FEProblemBase::swapBackMaterials(), FEProblemBase::swapBackMaterialsFace(), and FEProblemBase::swapBackMaterialsNeighbor().

331 { return _material_data[tid]; }

MaterialPropertyStorage::_material_data

std::vector< MaterialData > _material_data

The threaded material data.

Definition: MaterialPropertyStorage.h:448

◆ getMaterialData() [2/2]

MaterialData& MaterialPropertyStorage::getMaterialData ( const THREAD_ID tid )

inlineinherited

Definition at line 332 of file MaterialPropertyStorage.h.

332 { return _material_data[tid]; }

MaterialPropertyStorage::_material_data

std::vector< MaterialData > _material_data

The threaded material data.

Definition: MaterialPropertyStorage.h:448

◆ getMaterialPropertyRegistry()

const MaterialPropertyRegistry& MaterialPropertyStorage::getMaterialPropertyRegistry ( ) const

inlineinherited

Definition at line 285 of file MaterialPropertyStorage.h.

Referenced by dataLoad(), dataStore(), and MaterialData::getPropertyId().

285 { return _registry; }

MaterialPropertyStorage::_registry

MaterialPropertyRegistry & _registry

Shared registry (across storage objects) for property names and IDs.

Definition: MaterialPropertyStorage.h:445

◆ getPropRecord()

const MaterialPropertyStorage::PropRecord & MaterialPropertyStorage::getPropRecord ( const unsigned int id ) const

inherited

Get the property record associated with the material with id id.

Definition at line 90 of file MaterialPropertyStorage.C.

Referenced by dataLoad(), MaterialData::getMaxStateRequested(), MaterialPropertyStorage::initStatefulProps(), and MaterialPropertyStorage::isRestoredProperty().

 {
   mooseAssert(_prop_records.size() > id, "Invalid ID");
   auto & prop_record_ptr = _prop_records[id];
   mooseAssert(prop_record_ptr, "Not initialized");
   return *prop_record_ptr;
 }

◆ hasOlderProperties()

bool MaterialPropertyStorage::hasOlderProperties ( ) const

inlineinherited

Returns: a Boolean indicating whether or not this material has older properties declared

Definition at line 246 of file MaterialPropertyStorage.h.

246 { return maxState() > 1; }

MaterialPropertyStorage::maxState

unsigned int maxState() const

Definition: MaterialPropertyStorage.h:302

◆ hasProperty()

bool MaterialPropertyStorage::hasProperty ( const std::string & prop_name ) const

inlineinherited

Definition at line 267 of file MaterialPropertyStorage.h.

Referenced by MaterialData::hasProperty().

267 { return _registry.hasProperty(prop_name); }

MaterialPropertyRegistry::hasProperty

bool hasProperty(const std::string &name) const

Definition: MaterialPropertyRegistry.h:32

MaterialPropertyStorage::_registry

MaterialPropertyRegistry & _registry

Shared registry (across storage objects) for property names and IDs.

Definition: MaterialPropertyStorage.h:445

◆ hasStatefulProperties()

bool MaterialPropertyStorage::hasStatefulProperties ( ) const

inlineinherited

Returns: a Boolean indicating whether stateful properties exist on this material

Definition at line 241 of file MaterialPropertyStorage.h.

Referenced by FEProblemBase::addAnyRedistributers(), FEProblemBase::advanceState(), FEProblemBase::checkProblemIntegrity(), FEProblemBase::initialSetup(), FEProblemBase::meshChanged(), ProjectMaterialProperties::onBoundary(), MaterialPropertyStorage::shift(), MaterialData::swap(), and MaterialData::swapBack().

241 { return maxState() > 0; }

MaterialPropertyStorage::maxState

unsigned int maxState() const

Definition: MaterialPropertyStorage.h:302

◆ haveKokkosProperty()

bool Moose::Kokkos::MaterialPropertyStorage::haveKokkosProperty	(	std::string	prop_name,
		unsigned int	state = `0`
	)

Get whether a material property exists.

Parameters

prop_name	The property name
state	The property state

Returns: Whether the material property exists

◆ initStatefulProps()

void MaterialPropertyStorage::initStatefulProps	(	const THREAD_ID	tid,
		const std::vector< std::shared_ptr< MaterialBase >> &	mats,
		const unsigned int	n_qpoints,
		const Elem &	elem,
		const unsigned int	side = `0`
	)

inherited

Initialize stateful material properties.

Parameters

tid	The thread ID
mats	Materials that will compute the initial values
n_qpoints	Number of quadrature points
elem	Element we are on
side	Side of the element 'elem' (0 for volumetric material properties)

If restartable stateful information is available, this will load from restart instead of calling initStatefulProperties()

Definition at line 285 of file MaterialPropertyStorage.C.

Referenced by ComputeMaterialsObjectThread::onBoundary(), ComputeMaterialsObjectThread::onElement(), ComputeMaterialsObjectThread::onInterface(), and ComputeMaterialsObjectThread::onInternalSide().

 {
   // Material -> stateful properties that need to be restarted for said material
   // We need this because we need to initialize everything in dependency the dependency ordering
   // as given in mats, which means that we can't just do these all up front
   std::unordered_map<const MaterialBase *,
                      std::vector<std::pair<unsigned int, std::vector<std::stringstream> *>>>
       materials_to_restart;
   // Find the entry in the restartable data (binary data waiting to be restarted)
   // for this [elem, side], if any
   RestartableMapType::mapped_type * restartable_entry = nullptr;
   if (_restartable_map.size())
     if (auto it = _restartable_map.find(std::make_pair(&elem, side)); it != _restartable_map.end())
       restartable_entry = &it->second;
 
   // The stateful objects that we're going to initialize. This is needed for materials that are
   // passed in as mat that are not stateful, who we don't want to call initStatefulProperties() on.
   // We unfortunately can only determine this here due to block/boundary restriction, which is
   // not known without mapping property -> material
   std::vector<MaterialBase *> stateful_mats;
   // The stateful IDs that we need to copy back
   std::vector<unsigned int> stateful_ids_to_copy;
 
 #ifndef NDEBUG
   // All of the stateful IDs; used to make sure that we're not supplying one property
   // across multiple materials
   std::set<unsigned int> stateful_ids;
 #endif
 
   // Work through all of the materials that we were passed to figure out which ones are stateful
   // that we need to initialize, and also to figure out which ones we need to restart
   for (const auto & mat : mats)
   {
     // For keeping track of this material in stateful_mats
     bool stateful = false;
 
     // Check each material that was declared
     for (const auto id : mat->getSuppliedPropIDs())
     {
       const auto & record = getPropRecord(id);
       if (record.stateful())
       {
         const auto stateful_id = record.stateful_id;
         stateful = true;
 
 #ifndef NDEBUG
         const auto it_inserted_pair = stateful_ids.insert(stateful_id);
         mooseAssert(it_inserted_pair.second,
                     "Material property '" + _registry.getName(id) +
                         "' supplied by multiple materials at the same point");
 #endif
 
         bool restarting = false;
         // We have restartable data for this [elem, side]; see if we have it for this prop
         if (restartable_entry)
         {
           if (auto id_datum_pair_it = restartable_entry->find(stateful_id);
               id_datum_pair_it != restartable_entry->end())
           {
             restarting = true;
             materials_to_restart[mat.get()].emplace_back(stateful_id, &id_datum_pair_it->second);
           }
         }
 
         if (!restarting)
           stateful_ids_to_copy.push_back(record.stateful_id);
       }
     }
 
     if (stateful || mat->forceStatefulInit())
       stateful_mats.push_back(mat.get());
   }
 
   // This currently initializes all of the stateful properties for this [elem, side],
   // even though we didn't necessarily need to init all of them. Future work?
   auto props = initProps(tid, &elem, side, n_qpoints);
 
   // Whether or not we have swapped material data from _storage to _material_data
   // When we're initializing from initStatefulProperties, the MaterialBase objects
   // need to be able to access the data in _material_data. When we're initalizing
   // from restart, we need to be able to access from _storage.
   bool swapped = false;
 
   // Initialize properties
   for (auto mat : stateful_mats)
   {
     const auto materials_to_restart_find = materials_to_restart.find(mat);
     const bool restart = materials_to_restart_find != materials_to_restart.end();
 
     if (!restart || mat->forceStatefulInit())
     {
       // Need stateful _material_data in the material to store
       if (!swapped)
       {
         swap(tid, elem, side);
         swapped = true;
       }
 
       mat->initStatefulProperties(n_qpoints);
     }
 
     if (restart)
     {
       // Need data in _storage
       if (swapped)
       {
         swapBack(tid, elem, side);
         swapped = false;
       }
 
       // Load from the cached binary backup into place
       for (auto & [stateful_id, datum_ptr] : materials_to_restart_find->second)
         for (const auto state : index_range(*datum_ptr))
         {
           (*datum_ptr)[state].seekg(0, std::ios::beg);
           dataLoad((*datum_ptr)[state], (*props[state])[stateful_id], nullptr);
         }
     }
   }
 
   // Done with accessing from _material_data
   if (swapped)
     swapBack(tid, elem, side);
 
   // Copy to older states as needed, only for non-restarted data
   for (const auto stateful_id : stateful_ids_to_copy)
     for (const auto state : statefulIndexRange())
       for (const auto qp : make_range(n_qpoints))
         (*props[state])[stateful_id].qpCopy(qp, (*props[0])[stateful_id], qp);
 }

◆ isRestoredProperty()

bool MaterialPropertyStorage::isRestoredProperty ( const std::string & name ) const

inherited

Returns: Whether or not the material property with name name was restored

Definition at line 99 of file MaterialPropertyStorage.C.

Referenced by dataLoad().

 {
   const auto & record = getPropRecord(_registry.getID(name));
   if (!record.stateful())
     mooseAssert(!record.restored, "Stateful properties should not be restored");
   return record.restored;
 }

◆ maxState()

unsigned int MaterialPropertyStorage::maxState ( ) const

inlineinherited

Returns: The current maximum stored state (0 = none, 1 = old, 2 = older)

Definition at line 302 of file MaterialPropertyStorage.h.

Referenced by MaterialPropertyStorage::addProperty(), MaterialPropertyStorage::hasOlderProperties(), MaterialPropertyStorage::hasStatefulProperties(), MaterialPropertyStorage::numStates(), and MaterialPropertyStorage::shift().

   {
     mooseAssert(_max_state < _storage.size(), "Too big");
     return _max_state;
   }

◆ numStates()

unsigned int MaterialPropertyStorage::numStates ( ) const

inlineinherited

Returns: The number of stored states (2 = up to old, 3 = up to older)

Definition at line 310 of file MaterialPropertyStorage.h.

Referenced by dataLoad(), dataStore(), MaterialPropertyStorage::initProps(), MaterialPropertyStorage::statefulIndexRange(), and MaterialPropertyStorage::stateIndexRange().

310 { return maxState() + 1; }

MaterialPropertyStorage::maxState

unsigned int maxState() const

Definition: MaterialPropertyStorage.h:302

◆ prolongStatefulProps()

void MaterialPropertyStorage::prolongStatefulProps	(	processor_id_type	pid,
		const std::vector< std::vector< QpMap >> &	refinement_map,
		const libMesh::QBase &	qrule,
		const libMesh::QBase &	qrule_face,
		MaterialPropertyStorage &	parent_material_props,
		const THREAD_ID	tid,
		const Elem &	elem,
		const int	input_parent_side,
		const int	input_child,
		const int	input_child_side
	)

inherited

Creates storage for newly created elements from mesh Adaptivity.

Also, copies values from the parent qps to the new children.

Note - call this on the MaterialPropertyStorage object for the children that you want to project to. ie, if you are trying to project to the sides of the children, then call this on the boundary MaterialPropertyStorage. Pass in the parent MaterialPropertyStorage you are projecting from. ie the volume one if you are projecting to "internal" child element faces.

There are 3 cases here:

Volume to volume (parent_side = -1, child = -1, child_side = -1) Call on volume MaterialPropertyStorage and pass volume MaterialPropertyStorage for parent_material_props
Parent side to child side (parent_side = 0+, child = -1, child_side = 0+) where parent_side == child_side Call on boundary MaterialPropertyStorage and pass boundary MaterialPropertyStorage for parent_material_props
Child side to parent volume (parent_side = -1, child = 0+, child_side = 0+) Call on boundary MaterialPropertyStorage and pass volume MaterialPropertyStorage for parent_material_props

Parameters

pid	- processor id of children to prolong to
refinement_map	- 2D array of QpMap objects
qrule	The current quadrature rule
qrule_face	The current face qrule
parent_material_props	The place to pull parent material property values from
tid	The thread ID
elem	The parent element that was just refined
input_parent_side	- the side of the parent for which material properties are prolonged
input_child	- the number of the child
input_child_side	- the side on the child where material properties will be prolonged

Definition at line 166 of file MaterialPropertyStorage.C.

Referenced by ProjectMaterialProperties::onBoundary(), ProjectMaterialProperties::onElement(), and ProjectMaterialProperties::onInternalSide().

 {
   mooseAssert(input_child != -1 || input_parent_side == input_child_side, "Invalid inputs!");
 
   unsigned int n_qpoints = 0;
 
   // If we passed in -1 for these then we really need to store properties at 0
   unsigned int parent_side = input_parent_side == -1 ? 0 : input_parent_side;
   unsigned int child_side = input_child_side == -1 ? 0 : input_child_side;
 
   if (input_child_side == -1) // Not doing side projection (ie, doing volume projection)
     n_qpoints = qrule.n_points();
   else
     n_qpoints = qrule_face.n_points();
 
   _material_data[tid].resize(n_qpoints);
 
   unsigned int n_children = elem.n_children();
 
   std::vector<unsigned int> children;
 
   if (input_child != -1) // Passed in a child explicitly
     children.push_back(input_child);
   else
   {
     children.resize(n_children);
     for (unsigned int child = 0; child < n_children; child++)
       children[child] = child;
   }
 
   for (const auto & child : children)
   {
     // If we're not projecting an internal child side, but we are projecting sides, see if this
     // child is on that side
     if (input_child == -1 && input_child_side != -1 && !elem.is_child_on_side(child, parent_side))
       continue;
 
     const Elem * child_elem = elem.child_ptr(child);
 
     // If it's not a local child then it'll be prolonged where it is
     // local
     if (child_elem->processor_id() != pid)
       continue;
 
     mooseAssert(child < refinement_map.size(), "Refinement_map vector not initialized");
     const std::vector<QpMap> & child_map = refinement_map[child];
 
     auto child_props = initProps(tid, child_elem, child_side, n_qpoints);
 
     for (const auto state : stateIndexRange())
     {
       const auto & parent_props = parent_material_props.props(&elem, parent_side, state);
       for (const auto i : index_range(_stateful_prop_id_to_prop_id))
         for (const auto qp : index_range(refinement_map[child]))
           (*child_props[state])[i].qpCopy(qp, parent_props[i], child_map[qp]._to);
     }
   }
 }

◆ props() [1/2]

const MaterialPropertyStorage::PropsType & MaterialPropertyStorage::props ( const unsigned int state = 0 ) const

inlineinherited

Access methods to the stored material property data with the given state state.

Definition at line 474 of file MaterialPropertyStorage.h.

Referenced by MaterialPropertyStorage::copy(), MaterialPropertyStorage::initProps(), MaterialPropertyStorage::initStatefulProps(), MaterialPropertyStorage::prolongStatefulProps(), MaterialPropertyStorage::props(), MaterialPropertyStorage::restrictStatefulProps(), MaterialPropertyStorage::swap(), and MaterialPropertyStorage::swapBack().

 {
   mooseAssert(state < _storage.size(), "Invalid material property state " + std::to_string(state));
   return _storage[state];
 }

◆ props() [2/2]

const MaterialProperties & MaterialPropertyStorage::props	(	const Elem *	elem,
		unsigned int	side,
		const unsigned int	state = `0`
	)		const

inlineinherited

Definition at line 481 of file MaterialPropertyStorage.h.

 {
   const auto find_elem = props(state).find(elem);
   mooseAssert(find_elem != props(state).end(), "Material property does not have elem entry");
   const auto find_side = find_elem->second.find(side);
   mooseAssert(find_side != find_elem->second.end(), "Material property does not have side entry");
   return find_side->second;
 }

◆ queryStatefulPropName()

std::optional< std::string > MaterialPropertyStorage::queryStatefulPropName ( const unsigned int id ) const

inherited

Returns: The name of the stateful property with id id, if any.

Definition at line 68 of file MaterialPropertyStorage.C.

 {
   if (_prop_records.size() > id && _prop_records[id] && _prop_records[id]->stateful())
     return _registry.getName(id);
   return {};
 }

◆ registerLoadStore()

void Moose::Kokkos::MaterialPropertyStorage::registerLoadStore	(	std::type_index	type,
		PropertyStore	store,
		PropertyLoad	load
	)

Register the load/store functions.

Parameters

type	The property type index
store	The function pointer to the store function
load	The function pointer to the load function

◆ restrictStatefulProps()

void MaterialPropertyStorage::restrictStatefulProps	(	const std::vector< std::pair< unsigned int, QpMap >> &	coarsening_map,
		const std::vector< const Elem *> &	coarsened_element_children,
		const libMesh::QBase &	qrule,
		const libMesh::QBase &	qrule_face,
		const THREAD_ID	tid,
		const Elem &	elem,
		int	input_side = `-1`
	)

inherited

Creates storage for newly created elements from mesh Adaptivity.

Also, copies values from the children to the parent.

Parameters

coarsening_map	- map from unsigned ints to QpMap's
coarsened_element_children	- a pointer to a vector of coarsened element children
qrule	The current quadrature rule
qrule_face	The current face qrule
tid	The thread ID
elem	The parent element that was just refined
input_side	Side of the element 'elem' (0 for volumetric material properties)

Definition at line 236 of file MaterialPropertyStorage.C.

Referenced by ProjectMaterialProperties::onBoundary(), and ProjectMaterialProperties::onElement().

 {
   unsigned int side;
 
   bool doing_a_side = input_side != -1;
 
   unsigned int n_qpoints = 0;
 
   if (!doing_a_side)
   {
     side = 0; // Use 0 for the elem
     n_qpoints = qrule.n_points();
   }
   else
   {
     side = input_side;
     n_qpoints = qrule_face.n_points();
   }
 
   auto parent_props = initProps(tid, &elem, side, n_qpoints);
 
   // Copy from the child stateful properties
   for (const auto qp : index_range(coarsening_map))
   {
     const std::pair<unsigned int, QpMap> & qp_pair = coarsening_map[qp];
     unsigned int child = qp_pair.first;
 
     mooseAssert(child < coarsened_element_children.size(),
                 "Coarsened element children vector not initialized");
     const Elem * child_elem = coarsened_element_children[child];
     const QpMap & qp_map = qp_pair.second;
 
     for (const auto state : stateIndexRange())
     {
       const auto & child_props = props(child_elem, side, state);
       for (const auto i : index_range(_stateful_prop_id_to_prop_id))
         (*parent_props[state])[i].qpCopy(qp, child_props[i], qp_map._to);
     }
   }
 }

◆ setProps()

MaterialProperties & MaterialPropertyStorage::setProps	(	const Elem *	elem,
		unsigned int	side,
		const unsigned int	state = `0`
	)

inlineinherited

Definition at line 491 of file MaterialPropertyStorage.h.

Referenced by dataLoad(), dataStore(), MaterialPropertyStorage::eraseProperty(), MaterialPropertyStorage::initAndSetProps(), MaterialPropertyStorage::shift(), and MaterialPropertyStorage::swapBack().

 {
   return const_cast<MaterialProperties &>(std::as_const(*this).props(elem, side, state));
 }

◆ setRecovering()

void MaterialPropertyStorage::setRecovering ( )

inlineinherited

Sets the loading of stateful material properties to recover.

This enforces the requirement of one-to-one stateful material properties, disabling advanced restart of stateful properties

Definition at line 353 of file MaterialPropertyStorage.h.

353 { _recovering = true; }

MaterialPropertyStorage::_recovering

bool _recovering

Whether or not we're recovering; enforces a one-to-one mapping of stateful properties.

Definition: MaterialPropertyStorage.h:460

◆ setRestartInPlace()

void MaterialPropertyStorage::setRestartInPlace ( )

inherited

Sets the loading of stateful material properties in place.

On init, this cannot be set because we must first call initProps() to properly initialize the dynamic types within _storage. After the first sweep through with initProps(), we can then load the stateful props directly in place into _storage

Also clears _restartable_map, as it should no longer be needed

Definition at line 83 of file MaterialPropertyStorage.C.

 {
   _restart_in_place = true;
   _restartable_map.clear();
 }

◆ shift()

void Moose::Kokkos::MaterialPropertyStorage::shift ( )

Shift current, old, and older material property data storages.

Referenced by FEProblemBase::advanceState().

◆ sizeProps()

void MaterialPropertyStorage::sizeProps	(	MaterialProperties &	mp,
		unsigned int	size
	)

protectedinherited

◆ statefulIndexRange()

libMesh::IntRange<unsigned int> MaterialPropertyStorage::statefulIndexRange ( ) const

inlineinherited

Returns: A range over stateful states to be used in range-based for loops

Will be an empty range if there are no stateful states

Definition at line 323 of file MaterialPropertyStorage.h.

Referenced by MaterialPropertyStorage::initStatefulProps().

   {
     return libMesh::IntRange<unsigned int>(1, numStates());
   }

◆ statefulProps()

const std::vector<unsigned int>& MaterialPropertyStorage::statefulProps ( ) const

inlineinherited

Definition at line 283 of file MaterialPropertyStorage.h.

283 { return _stateful_prop_id_to_prop_id; }

MaterialPropertyStorage::_stateful_prop_id_to_prop_id

std::vector< unsigned int > _stateful_prop_id_to_prop_id

the vector of stateful property ids (the vector index is the map to stateful prop_id) ...

Definition: MaterialPropertyStorage.h:388

◆ stateIndexRange()

libMesh::IntRange<unsigned int> MaterialPropertyStorage::stateIndexRange ( ) const

inlineinherited

Returns: A range over states to be used in range-based for loops

Definition at line 314 of file MaterialPropertyStorage.h.

Referenced by MaterialPropertyStorage::copy(), dataStore(), MaterialPropertyStorage::eraseProperty(), MaterialPropertyStorage::initProps(), MaterialPropertyStorage::prolongStatefulProps(), MaterialData::resize(), MaterialPropertyStorage::restrictStatefulProps(), MaterialPropertyStorage::swap(), MaterialPropertyStorage::swapBack(), and MaterialPropertyStorage::updateStatefulPropsForPRefinement().

   {
     return libMesh::IntRange<unsigned int>(0, numStates());
   }

◆ swap()

void MaterialPropertyStorage::swap	(	const THREAD_ID	tid,
		const Elem &	elem,
		unsigned int	side
	)

inherited

Swap (shallow copy) material properties in MaterialData and MaterialPropertyStorage Thread safe.

Parameters

tid	The thread id
elem	Element id
side	Side number (elemental material properties have this equal to zero)

Definition at line 464 of file MaterialPropertyStorage.C.

Referenced by MaterialPropertyStorage::initStatefulProps(), and MaterialData::swap().

 {
   Threads::spin_mutex::scoped_lock lock(this->_spin_mtx);
 
   for (const auto state : stateIndexRange())
     shallowSwapData(_stateful_prop_id_to_prop_id,
                     _material_data[tid].props(state),
                     // Would be nice to make this setProps()
                     initAndSetProps(&elem, side, state));
 }

◆ swapBack()

void MaterialPropertyStorage::swapBack	(	const THREAD_ID	tid,
		const Elem &	elem,
		unsigned int	side
	)

inherited

Swap (shallow copy) material properties in MaterialPropertyStorage and MaterialDat Thread safe.

Parameters

tid	The thread id
elem	Element id
side	Side number (elemental material properties have this equal to zero)

Definition at line 476 of file MaterialPropertyStorage.C.

Referenced by MaterialPropertyStorage::initStatefulProps(), and MaterialData::swapBack().

 {
   Threads::spin_mutex::scoped_lock lock(this->_spin_mtx);
 
   for (const auto state : stateIndexRange())
     shallowSwapDataBack(_stateful_prop_id_to_prop_id,
                         setProps(&elem, side, state),
                         _material_data[tid].props(state));
 
   // Workaround for MOOSE difficulties in keeping materialless
   // elements (e.g. Lower D elements in Mortar code) materials
   for (const auto state : stateIndexRange())
     if (props(&elem, side, state).empty())
       setProps(state)[&elem].erase(side);
 }

◆ updateStatefulPropsForPRefinement()

void MaterialPropertyStorage::updateStatefulPropsForPRefinement	(	const processor_id_type	pid,
		const std::vector< QpMap > &	p_refinement_map,
		const libMesh::QBase &	qrule,
		const libMesh::QBase &	qrule_face,
		const THREAD_ID	tid,
		const Elem &	elem,
		const int	input_side
	)

inherited

Based on the p-refinement flag of elem, either prolong (for refinement) or restrict (for coarsening) the stateful material property data.

Parameters

pid	The rank returned by the mesh. This is used to assert that we are only prolonging/restricting for elements that our process owns
p_refinement_map	A map that describes, for each quadrature point on the current level which quadrature point on the previous level it is closest to
qrule	The volumetric quadrature rule
qrule_face	The face quadrature rule
tid	The thread ID
elem	The element that was just p-refined or coarsened that we are performing material property prolongation/restriction for
input_side	Which element side we are performing material property prolongation/restriction for. Pass in -1 for doing volumetric prolongation/restriction

Definition at line 121 of file MaterialPropertyStorage.C.

Referenced by ProjectMaterialProperties::onBoundary(), and ProjectMaterialProperties::onElement().

 {
   unsigned int n_qpoints = 0;
 
   // If we passed in -1 for these then we really need to store properties at 0
   unsigned int side = input_side == -1 ? 0 : input_side;
 
   if (input_side == -1) // Not doing side projection (ie, doing volume projection)
     n_qpoints = qrule.n_points();
   else
     n_qpoints = qrule_face.n_points();
 
   _material_data[tid].resize(n_qpoints);
 
   mooseAssert(elem.active(), "We should be doing p-refinement on active elements only");
   mooseAssert(elem.processor_id() == pid, "Prolongation should be occurring locally");
   mooseAssert(p_refinement_map.size() == n_qpoints, "Refinement map not proper size");
 
   auto current_p_level_props = initProps(tid, &elem, side, n_qpoints);
 
   for (const auto state : stateIndexRange())
     for (const auto i : index_range(_stateful_prop_id_to_prop_id))
     {
       auto & current_p_level_prop = (*current_p_level_props[state])[i];
       // We need to clone this property in order to not overwrite the values we're going to be
       // reading from
       auto previous_p_level_prop = current_p_level_prop.clone(current_p_level_prop.size());
       // Cloning, despite its name, does not copy the data. Luckily since we are about to overwrite
       // all of the current_p_level_prop data, we can just swap its data over to our
       // previous_p_level_prop
       previous_p_level_prop->swap(current_p_level_prop);
       current_p_level_prop.resize(n_qpoints);
       for (const auto qp : index_range(p_refinement_map))
         current_p_level_prop.qpCopy(qp, *previous_p_level_prop, p_refinement_map[qp]._to);
     }
 }

◆ void ::dataLoad()

Moose::Kokkos::MaterialPropertyStorage::void ::dataLoad	(	std::istream &	,
		MaterialPropertyStorage &	,
		void *
	)

private

◆ void ::dataStore()

Moose::Kokkos::MaterialPropertyStorage::void ::dataStore	(	std::ostream &	,
		MaterialPropertyStorage &	,
		void *
	)

private

Member Data Documentation

◆ _consumers

std::map<Moose::MaterialDataType, std::set<const MooseObject *> > MaterialPropertyStorage::_consumers

protectedinherited

The consumers of this storage.

Definition at line 391 of file MaterialPropertyStorage.h.

Referenced by MaterialPropertyStorage::addConsumer(), and MaterialPropertyStorage::getConsumers().

◆ _kokkos_prop_records

std::unordered_map<std::string, Moose::Kokkos::PropRecord> Moose::Kokkos::MaterialPropertyStorage::_kokkos_prop_records

private

Record of each material property.

Definition at line 141 of file KokkosMaterialPropertyStorage.h.

◆ _kokkos_props

std::unordered_map<std::string, std::shared_ptr<MaterialPropertyBase> > Moose::Kokkos::MaterialPropertyStorage::_kokkos_props[MaterialData::max_state+1]

private

Material properties.

Definition at line 137 of file KokkosMaterialPropertyStorage.h.

◆ _load_functions

std::unordered_map<std::type_index, PropertyLoad> Moose::Kokkos::MaterialPropertyStorage::_load_functions

staticprivate

Definition at line 147 of file KokkosMaterialPropertyStorage.h.

◆ _problem

FEProblemBase& MaterialPropertyStorage::_problem

protectedinherited

Reference to the problem.

Definition at line 379 of file MaterialPropertyStorage.h.

◆ _prop_records

std::vector<std::optional<PropRecord> > MaterialPropertyStorage::_prop_records

protectedinherited

Property records indexed by property id (may be null)

Definition at line 385 of file MaterialPropertyStorage.h.

Referenced by MaterialPropertyStorage::addProperty(), dataLoad(), dataStore(), MaterialPropertyStorage::getPropRecord(), and MaterialPropertyStorage::queryStatefulPropName().

◆ _stateful_prop_id_to_prop_id

std::vector<unsigned int> MaterialPropertyStorage::_stateful_prop_id_to_prop_id

protectedinherited

the vector of stateful property ids (the vector index is the map to stateful prop_id)

Definition at line 388 of file MaterialPropertyStorage.h.

Referenced by MaterialPropertyStorage::addProperty(), MaterialPropertyStorage::copy(), dataLoad(), dataStore(), MaterialPropertyStorage::initProps(), MaterialPropertyStorage::prolongStatefulProps(), MaterialPropertyStorage::restrictStatefulProps(), MaterialPropertyStorage::statefulProps(), MaterialPropertyStorage::swap(), MaterialPropertyStorage::swapBack(), and MaterialPropertyStorage::updateStatefulPropsForPRefinement().

◆ _storage

std::array<PropsType, MaterialData::max_state + 1> MaterialPropertyStorage::_storage

protectedinherited

The actual storage.

Definition at line 382 of file MaterialPropertyStorage.h.

Referenced by MaterialPropertyStorage::maxState(), and MaterialPropertyStorage::props().

◆ _store_functions

std::unordered_map<std::type_index, PropertyStore> Moose::Kokkos::MaterialPropertyStorage::_store_functions

staticprivate

Function pointer maps for load/store.

{@

Definition at line 146 of file KokkosMaterialPropertyStorage.h.

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

include/kokkos/materials/KokkosMaterialPropertyStorage.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ PropsType

Constructor & Destructor Documentation

◆ MaterialPropertyStorage()

Member Function Documentation

◆ addConsumer()

◆ addKokkosProperty()

◆ addKokkosPropertyState()

◆ addProperty()

◆ allocateKokkosProperties()

◆ cast()

◆ copy() [1/3]

◆ copy() [2/3]

◆ copy() [3/3]

◆ declareKokkosProperty()

◆ eraseProperty()

◆ getConsumers()

◆ getKokkosProperty()

◆ getMaterialData() [1/2]

◆ getMaterialData() [2/2]

◆ getMaterialPropertyRegistry()

◆ getPropRecord()

◆ hasOlderProperties()

◆ hasProperty()

◆ hasStatefulProperties()

◆ haveKokkosProperty()

◆ initStatefulProps()

◆ isRestoredProperty()

◆ maxState()

◆ numStates()

◆ prolongStatefulProps()

◆ props() [1/2]

◆ props() [2/2]

◆ queryStatefulPropName()

◆ registerLoadStore()

◆ restrictStatefulProps()

◆ setProps()

◆ setRecovering()

◆ setRestartInPlace()

◆ shift()

◆ sizeProps()

◆ statefulIndexRange()

◆ statefulProps()

◆ stateIndexRange()

◆ swap()

◆ swapBack()

◆ updateStatefulPropsForPRefinement()

◆ void ::dataLoad()

◆ void ::dataStore()

Member Data Documentation

◆ _consumers

◆ _kokkos_prop_records

◆ _kokkos_props

◆ _load_functions

◆ _problem

◆ _prop_records

◆ _stateful_prop_id_to_prop_id

◆ _storage

◆ _store_functions