Proxy for accessing MaterialPropertyStorage. More...

#include <MaterialData.h>

Classes
class	XFEMKey
	Key that provides access to only the XFEM class. More...

Public Member Functions
	MaterialData (MaterialPropertyStorage &storage, const THREAD_ID tid)

void	resize (unsigned int n_qpoints)
	Resize the data to hold properties for n_qpoints quadrature points.

unsigned int	nQPoints () const
	Returns the number of quadrature points the material properties support/hold.

void	copy (const Elem &elem_to, const Elem &elem_from, unsigned int side)
	copy material properties from one element to another

void	swap (const Elem &elem, unsigned int side=0)
	material properties for given element (and possible side)

template<typename MatContainer >
void	reinit (const MatContainer &mats)
	Reinit material properties for given element (and possible side)

void	reset (const std::vector< std::shared_ptr< MaterialBase > > &mats)
	Calls the reset method of Materials to ensure that they are in a proper state.

void	swapBack (const Elem &elem, unsigned int side=0)
	material properties for given element (and possible side)

const MaterialProperties &	props (const unsigned int state=0) const
	{

MaterialProperties &	props (const unsigned int state=0)

template<typename T , bool is_ad>
bool	haveGenericProperty (const std::string &prop_name) const

template<typename T >
bool	haveProperty (const std::string &prop_name) const
	Returns true if the regular material property exists - defined by any material.

template<typename T >
bool	haveADProperty (const std::string &prop_name) const
	Returns true if the AD material property exists - defined by any material.

template<typename T , unsigned int dimension>
bool	haveKokkosProperty (const std::string &prop_name) const
	Get whether a Kokkos material property exists.

template<typename T , bool is_ad = false>
GenericMaterialProperty< T, is_ad > &	getProperty (const std::string &prop_name, const unsigned int state, const MooseObject &requestor)
	Retrieves a material property.

template<typename T , bool is_ad>
GenericMaterialProperty< T, is_ad > &	declareProperty (const std::string &prop_name, const MooseObject &requestor)
	Declares a material property.

template<typename T , unsigned int dimension, unsigned int state>
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosProperty (const std::string &prop_name)
	Get a Kokkos material property.

template<typename T , unsigned int dimension>
Moose::Kokkos::MaterialProperty< T, dimension >	declareKokkosProperty (const std::string &prop_name, const std::vector< unsigned int > &dims, const MaterialBase *declarer, const bool bnd, const bool on_demand, const Moose::Kokkos::PropertyConstantOption constant_option)
	Declare a Kokkos material property.

bool	isSwapped () const
	Returns true if the stateful material is in a swapped state.

const MaterialPropertyStorage &	getMaterialPropertyStorage () const
	Provide read-only access to the underlying MaterialPropertyStorage object.

MaterialPropertyStorage &	getMaterialPropertyStorageForXFEM (const XFEMKey)
	Provide write-only access to the underlying MaterialPropertyStorage object JUST FOR XFEM.

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

unsigned int	getPropertyId (const std::string &prop_name) const
	Wrapper for MaterialStorage::getPropertyId.

void	onlyResizeIfSmaller (bool flag)
	Set _resize_only_if_smaller to perform a non-destructive resize.

bool	isOnlyResizeIfSmaller () const
	Check value of _resize_only_if_smaller.

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

Static Public Attributes
static constexpr unsigned int	max_state = 2
	The max time state supported (2 = older)

Private Member Functions
unsigned int	addPropertyHelper (const std::string &prop_name, const std::type_info &type, const unsigned int state, const MaterialBase *const declarer)

template<typename T , bool is_ad, bool declare>
GenericMaterialProperty< T, is_ad > &	getPropertyHelper (const std::string &prop_name, const unsigned int state, const MooseObject &requestor)

Moose::Kokkos::MaterialPropertyBase &	addKokkosPropertyHelper (const std::string &prop_name, const std::type_info &type, const unsigned int state, std::shared_ptr< Moose::Kokkos::MaterialPropertyBase > shell)
	Helper function for adding a Kokkos material property.

Moose::Kokkos::MaterialPropertyBase &	declareKokkosPropertyHelper (const std::string &prop_name, const std::type_info &type, const MaterialBase *declarer, const std::vector< unsigned int > &dims, const bool bnd, const bool on_demand, const Moose::Kokkos::PropertyConstantOption constant_option, std::shared_ptr< Moose::Kokkos::MaterialPropertyBase > shell)
	Helper function for declaring a Kokkos material property.

Moose::Kokkos::MaterialPropertyBase &	getKokkosPropertyHelper (const std::string &prop_name, const unsigned int state=0, std::shared_ptr< Moose::Kokkos::MaterialPropertyBase > shell=nullptr) const
	Helper function for getting a Kokkos material property.

bool	haveKokkosPropertyHelper (const std::string &prop_name) const
	Helper function for checking whether a Kokkos material property exists.

void	kokkosRegisterLoadStoreHelper (std::type_index type, Moose::Kokkos::PropertyStore store, Moose::Kokkos::PropertyLoad load)
	Helper function to register load/store functions of a Kokkos material property to the Kokkos material property storage.

const MaterialBase &	castRequestorToDeclarer (const MooseObject &requestor) const
	Helper for casting `requestor` to a MaterialBase in addPropertyHelper() (templated)

unsigned int	getMaxStateRequested (const unsigned int prop_id) const
	maximum state id requested for a property

Static Private Member Functions
static void	mooseErrorHelper (const MooseObject &object, const std::string_view &error)

Private Attributes
MaterialPropertyStorage &	_storage
	Reference to the MaterialStorage class.

const THREAD_ID	_tid
	The thread id.

unsigned int	_n_qpoints
	Number of quadrature points.

std::array< MaterialProperties, max_state+1 >	_props
	The underlying property data.

bool	_swapped
	Status of storage swapping (calling swap sets this to true; swapBack sets it to false)

bool	_resize_only_if_smaller
	Use non-destructive resize of material data (calling resize() will not reduce size).

Detailed Description

Proxy for accessing MaterialPropertyStorage.

MaterialData stores the values associated with a particular material object

Definition at line 37 of file MaterialData.h.

Constructor & Destructor Documentation

◆ MaterialData()

MaterialData::MaterialData	(	MaterialPropertyStorage &	storage,
		const THREAD_ID	tid
	)

Definition at line 15 of file MaterialData.C.

  : _storage(storage), _tid(tid), _n_qpoints(0), _swapped(false), _resize_only_if_smaller(false)
{
}

Member Function Documentation

◆ addKokkosPropertyHelper()

Moose::Kokkos::MaterialPropertyBase & MaterialData::addKokkosPropertyHelper	(	const std::string &	prop_name,
		const std::type_info &	type,
		const unsigned int	state,
		std::shared_ptr< Moose::Kokkos::MaterialPropertyBase >	shell
	)

private

Helper function for adding a Kokkos material property.

Parameters

prop_name	The property name
type	The property data type
state	The property state
shell	The managed pointer containing the instance of the property

Returns: The Kokkos material property

Referenced by getKokkosProperty().

◆ addPropertyHelper()

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

private

Definition at line 92 of file MaterialData.C.

{
  return _storage.addProperty(prop_name, type, state, declarer);
}

Referenced by getPropertyHelper().

◆ castRequestorToDeclarer()

const MaterialBase & MaterialData::castRequestorToDeclarer ( const MooseObject & requestor ) const

private

Helper for casting requestor to a MaterialBase in addPropertyHelper() (templated)

Definition at line 101 of file MaterialData.C.

{
  const auto declarer = dynamic_cast<const MaterialBase *>(&requestor);
  mooseAssert(declarer, "Not a MaterialBase");
  return *declarer;
}

Referenced by getPropertyHelper().

◆ copy()

void MaterialData::copy	(	const Elem &	elem_to,
		const Elem &	elem_from,
		unsigned int	side
	)

copy material properties from one element to another

Definition at line 35 of file MaterialData.C.

{
  _storage.copy(_tid, &elem_to, &elem_from, side, nQPoints());
}

◆ declareKokkosProperty()

template<typename T , unsigned int dimension>

Moose::Kokkos::MaterialProperty< T, dimension > MaterialData::declareKokkosProperty	(	const std::string &	prop_name,
		const std::vector< unsigned int > &	dims,
		const MaterialBase *	declarer,
		const bool	bnd,
		const bool	on_demand,
		const Moose::Kokkos::PropertyConstantOption	constant_option
	)

Declare a Kokkos material property.

Template Parameters

T	The property data type
dimension	The property dimension

Parameters

prop_name	The property name
dims	The vector containing the size of each dimension
declarer	The Kokkos material declaring the property
bnd	Whether the property is a face property
on_demand	Whether the property is an on-demand property
constant_option	Whether the property is constant on element or subdomain

Returns: The Kokkos material property

Definition at line 503 of file MaterialData.h.

{
  auto shell = std::make_shared<Moose::Kokkos::MaterialProperty<T, dimension>>();
 
  auto & prop_base = declareKokkosPropertyHelper(
      prop_name, typeid(T), declarer, dims, bnd, on_demand, constant_option, shell);
  auto prop_cast = dynamic_cast<Moose::Kokkos::MaterialProperty<T, dimension> *>(&prop_base);
 
  if (!prop_cast)
    mooseError("The declared ",
               dimension,
               "D Kokkos material property '",
               prop_name,
               "' of type '",
               MooseUtils::prettyCppType<T>(),
               "' was already declared or requested as a ",
               prop_base.dim(),
               "D property of type '",
               prop_base.type(),
               "'.");
 
  return *prop_cast;
}

Referenced by Moose::Kokkos::MaterialBase::declareKokkosPropertyInternal().

◆ declareKokkosPropertyHelper()

Moose::Kokkos::MaterialPropertyBase & MaterialData::declareKokkosPropertyHelper	(	const std::string &	prop_name,
		const std::type_info &	type,
		const MaterialBase *	declarer,
		const std::vector< unsigned int > &	dims,
		const bool	bnd,
		const bool	on_demand,
		const Moose::Kokkos::PropertyConstantOption	constant_option,
		std::shared_ptr< Moose::Kokkos::MaterialPropertyBase >	shell
	)

private

Helper function for declaring a Kokkos material property.

Parameters

prop_name	The property name
type	The property data type
declarer	The Kokkos material declaring the property
dims	The vector containing the size of each dimension
bnd	Whether the property is a face property
on_demand	Whether the property is an on-demand property
constant_option	Whether the property is constant on element or subdomain
shell	The managed pointer containing the instance of the property

Returns: The Kokkos material property

Referenced by declareKokkosProperty().

◆ declareProperty()

template<typename T , bool is_ad>

GenericMaterialProperty< T, is_ad > & MaterialData::declareProperty	(	const std::string &	prop_name,
		const MooseObject &	requestor
	)

inline

Declares a material property.

Template Parameters

T	The type of the property
is_ad	Whether or not the property is AD

Parameters

prop_name	The name of the property
requestor	The MooseObject declaring the property

Returns: The property for the supplied type and name

Definition at line 142 of file MaterialData.h.

  {
    return getPropertyHelper<T, is_ad, true>(prop_name, 0, requestor);
  }

Referenced by MaterialBase::declareGenericPropertyByName().

◆ eraseProperty()

void MaterialData::eraseProperty ( const Elem * elem )

Remove the property storage and element pointer from MaterialPropertyStorage 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 86 of file MaterialData.C.

{
  _storage.eraseProperty(elem);
}

◆ getKokkosProperty()

template<typename T , unsigned int dimension, unsigned int state>

Moose::Kokkos::MaterialProperty< T, dimension > MaterialData::getKokkosProperty ( const std::string & prop_name )

Get a Kokkos material property.

Template Parameters

T	The property data type
dimension	The property dimension
state	The property state

Parameters

prop_name The property name

Returns: The Kokkos material property

Definition at line 463 of file MaterialData.h.

{
  // Reserve the storages for the property up to the requested state
  // If the storages were already reserved, it will do nothing
  for (unsigned int s = 0; s <= state; ++s)
  {
    auto shell = std::make_shared<Moose::Kokkos::MaterialProperty<T, dimension>>();
 
    addKokkosPropertyHelper(prop_name, typeid(T), state, shell);
 
    // Only instantiate load and store functions for stateful properties to avoid requiring users
    // to provide custom dataLoad and dataStore for non-trivially-copyable types that are never
    // used as stateful properties
    if constexpr (state > 0)
      kokkosRegisterLoadStoreHelper(shell->propertyType(),
                                    Moose::Kokkos::propertyStore<T, dimension>,
                                    Moose::Kokkos::propertyLoad<T, dimension>);
  }
 
  auto & prop_base = getKokkosPropertyHelper(prop_name, state, nullptr);
  auto prop_cast = dynamic_cast<Moose::Kokkos::MaterialProperty<T, dimension> *>(&prop_base);
 
  if (!prop_cast)
    mooseError("The requested ",
               dimension,
               "D Kokkos material property '",
               prop_name,
               "' of type '",
               MooseUtils::prettyCppType<T>(),
               "' was already declared or requested as a ",
               prop_base.dim(),
               "D property of type '",
               prop_base.type(),
               "'.");
 
  return *prop_cast;
}

Referenced by MaterialPropertyInterface::getKokkosBlockMaterialProperty(), and MaterialPropertyInterface::getKokkosMaterialPropertyByName().

◆ getKokkosPropertyHelper()

Moose::Kokkos::MaterialPropertyBase & MaterialData::getKokkosPropertyHelper	(	const std::string &	prop_name,
		const unsigned int	state = `0`,
		std::shared_ptr< Moose::Kokkos::MaterialPropertyBase >	shell = `nullptr`
	)		const

private

Helper function for getting a Kokkos material property.

Parameters

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

Returns: The Kokkos material property

Referenced by getKokkosProperty(), and haveKokkosProperty().

◆ getMaterialPropertyStorage()

const MaterialPropertyStorage & MaterialData::getMaterialPropertyStorage ( ) const

inline

Provide read-only access to the underlying MaterialPropertyStorage object.

Definition at line 190 of file MaterialData.h.

190{ return _storage; }

Referenced by MaterialBase::hasRestoredProperties(), and MaterialBase::initStatefulProperties().

◆ getMaterialPropertyStorageForXFEM()

MaterialPropertyStorage & MaterialData::getMaterialPropertyStorageForXFEM ( const XFEMKey )

inline

Provide write-only access to the underlying MaterialPropertyStorage object JUST FOR XFEM.

This should be removed. To be clear - you should not ever expect to have write access to this data. It just turned out that XFEM got away with it when we were storing things as pointers instead of smart pointers...

These dirty reasons are why this method is named so egregiously.

Definition at line 211 of file MaterialData.h.

211{ return _storage; }

◆ getMaxStateRequested()

unsigned int MaterialData::getMaxStateRequested ( const unsigned int prop_id ) const

private

maximum state id requested for a property

Definition at line 109 of file MaterialData.C.

{
  return _storage.getPropRecord(prop_id).state;
}

Referenced by getPropertyHelper().

◆ getProperty()

template<typename T , bool is_ad = false>

GenericMaterialProperty< T, is_ad > & MaterialData::getProperty	(	const std::string &	prop_name,
		const unsigned int	state,
		const MooseObject &	requestor
	)

inline

Retrieves a material property.

Template Parameters

T	The type of the property
is_ad	Whether or not the property is AD

Parameters

prop_name	The name of the property
state	The time state (0 = current, 1 = old, etc; defaults to 0)
requestor	The MooseObject requesting the property

Returns: The property for the supplied type and name

Definition at line 127 of file MaterialData.h.

  {
    return getPropertyHelper<T, is_ad, false>(prop_name, state, requestor);
  }

Referenced by MaterialPropertyInterface::getBlockMaterialProperty(), MaterialPropertyInterface::getGenericMaterialPropertyByName(), and MaterialBase::getGenericZeroMaterialPropertyByName().

◆ getPropertyHelper()

template<typename T , bool is_ad, bool declare>

GenericMaterialProperty< T, is_ad > & MaterialData::getPropertyHelper	(	const std::string &	prop_name,
		const unsigned int	state,
		const MooseObject &	requestor
	)

private

Definition at line 386 of file MaterialData.h.

{
  if constexpr (is_ad)
    mooseAssert(state == 0, "Cannot request/declare AD properties for states other than zero");
  if constexpr (declare)
    mooseAssert(state == 0, "Cannot declare properties for states other than zero");
 
  // Register/get the ID of the property
  const auto prop_id = addPropertyHelper(
      prop_name, typeid(T), state, declare ? &castRequestorToDeclarer(requestor) : nullptr);
  const auto size = prop_id + 1;
 
  // Initialize the states that we need
  for (const auto state_i : make_range(getMaxStateRequested(prop_id) + 1))
  {
    auto & entry = props(state_i);
    if (entry.size() < size)
      entry.resize(size, {});
    // if we are not declaring the property we initialize only what we need (the requested state)
    if (!entry.hasValue(prop_id) && (declare || state_i == state))
    {
      if (state_i == 0)
        entry.setPointer(
            prop_id, std::move(std::make_unique<GenericMaterialProperty<T, is_ad>>(prop_id)), {});
      else
        entry.setPointer(prop_id, std::move(std::make_unique<MaterialProperty<T>>(prop_id)), {});
    }
  }
 
  // Should be available now
  auto & base_prop = props(state)[prop_id];
 
  // In the event that this property was already declared/requested, make sure
  // that the types are consistent
  auto prop = dynamic_cast<GenericMaterialProperty<T, is_ad> *>(&base_prop);
  if (!prop)
  {
    constexpr std::string_view action = declare ? "declared" : "requested";
    constexpr auto is_ad_to_str = [](const bool is_ad_bool)
    { return std::string_view(is_ad_bool ? "AD" : "non-AD"); };
    constexpr std::string_view ad_type = is_ad_to_str(is_ad);
 
    std::stringstream error;
    error << "The " << action << " " << ad_type << " "
          << "material property '" + prop_name + "' of type '" << MooseUtils::prettyCppType<T>()
          << "'\nis already retrieved or declared as a " << is_ad_to_str(base_prop.isAD())
          << " property of type '" << base_prop.type() << "'.";
    mooseErrorHelper(requestor, error.str());
  }
 
  return *prop;
}

◆ getPropertyId()

unsigned int MaterialData::getPropertyId ( const std::string & prop_name ) const

Wrapper for MaterialStorage::getPropertyId.

Allows classes with a MaterialData object (i.e. MaterialPropertyInterface) to access material property IDs.

Parameters

prop_name The name of the material property

Returns: An unsigned int corresponding to the property ID of the passed in prop_name

Definition at line 80 of file MaterialData.C.

{
  return _storage.getMaterialPropertyRegistry().getID(prop_name);
}

Referenced by MaterialPropertyInterface::getBlockMaterialProperty(), MaterialPropertyInterface::getGenericMaterialPropertyByName(), MaterialPropertyInterface::getKokkosBlockMaterialProperty(), MaterialPropertyInterface::getKokkosMaterialPropertyByName(), haveGenericProperty(), and MaterialBase::registerPropName().

◆ hasProperty()

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

Returns: Whether or not a property exists with the name name

Definition at line 74 of file MaterialData.C.

{
  return _storage.hasProperty(prop_name);
}

Referenced by haveGenericProperty().

◆ haveADProperty()

template<typename T >

bool MaterialData::haveADProperty ( const std::string & prop_name ) const

inline

Returns true if the AD material property exists - defined by any material.

Definition at line 100 of file MaterialData.h.

  {
    return haveGenericProperty<T, true>(prop_name);
  }

Referenced by MaterialPropertyInterface::hasADMaterialPropertyByName(), and MaterialOutputAction::hasADProperty().

◆ haveGenericProperty()

template<typename T , bool is_ad>

bool MaterialData::haveGenericProperty ( const std::string & prop_name ) const

inline

Definition at line 370 of file MaterialData.h.

{
  if (!hasProperty(prop_name))
    return false;
 
  const auto prop_id = getPropertyId(prop_name);
  // the property id exists, but the property was not created in this instance of the material type
  if (prop_id >= props(0).size())
    return false;
 
  const PropertyValue * const base_prop = props(0).queryValue(prop_id);
  return dynamic_cast<const GenericMaterialProperty<T, is_ad> *>(base_prop) != nullptr;
}

Referenced by BlockRestrictable::hasBlockMaterialProperty(), and BoundaryRestrictable::hasBoundaryMaterialProperty().

◆ haveKokkosProperty()

template<typename T , unsigned int dimension>

bool MaterialData::haveKokkosProperty ( const std::string & prop_name ) const

Get whether a Kokkos material property exists.

Template Parameters

T	The property data type
dimension	The property dimension

Parameters

prop_name The property name

Returns: Whether the Kokkos material property exists

Definition at line 452 of file MaterialData.h.

{
  if (!haveKokkosPropertyHelper(prop_name))
    return false;
 
  auto & prop = getKokkosPropertyHelper(prop_name);
  return dynamic_cast<Moose::Kokkos::MaterialProperty<T, dimension> *>(&prop) != nullptr;
}

Referenced by MaterialPropertyInterface::hasKokkosMaterialPropertyByName().

◆ haveKokkosPropertyHelper()

bool MaterialData::haveKokkosPropertyHelper ( const std::string & prop_name ) const

private

Helper function for checking whether a Kokkos material property exists.

Parameters

prop_name The property name

Returns: Whether the Kokkos material property exists

Referenced by haveKokkosProperty().

◆ haveProperty()

template<typename T >

bool MaterialData::haveProperty ( const std::string & prop_name ) const

inline

Returns true if the regular material property exists - defined by any material.

Definition at line 93 of file MaterialData.h.

  {
    return haveGenericProperty<T, false>(prop_name);
  }

Referenced by MaterialPropertyInterface::hasMaterialPropertyByName(), and MaterialOutputAction::hasProperty().

◆ isOnlyResizeIfSmaller()

bool MaterialData::isOnlyResizeIfSmaller ( ) const

inline

Check value of _resize_only_if_smaller.

Definition at line 237 of file MaterialData.h.

237{ return _resize_only_if_smaller; };

◆ isSwapped()

bool MaterialData::isSwapped ( ) const

inline

Returns true if the stateful material is in a swapped state.

Definition at line 185 of file MaterialData.h.

185{ return _swapped; }

Referenced by swap(), and swapBack().

◆ kokkosRegisterLoadStoreHelper()

void MaterialData::kokkosRegisterLoadStoreHelper	(	std::type_index	type,
		Moose::Kokkos::PropertyStore	store,
		Moose::Kokkos::PropertyLoad	load
	)

private

Helper function to register load/store functions of a Kokkos material property to the Kokkos material property storage.

Parameters

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

Referenced by getKokkosProperty().

◆ mooseErrorHelper()

void MaterialData::mooseErrorHelper	(	const MooseObject &	object,
		const std::string_view &	error
	)

staticprivate

Definition at line 68 of file MaterialData.C.

{
  object.mooseError(error);
}

Referenced by getPropertyHelper().

◆ nQPoints()

unsigned int MaterialData::nQPoints ( ) const

inline

Returns the number of quadrature points the material properties support/hold.

Definition at line 54 of file MaterialData.h.

54{ return _n_qpoints; }

Referenced by copy(), and resize().

◆ onlyResizeIfSmaller()

void MaterialData::onlyResizeIfSmaller ( bool flag )

inline

Set _resize_only_if_smaller to perform a non-destructive resize.

Setting this flag to true means that resize(n) will not decrease the size of _props if n is smaller than the size of the material data object.

Definition at line 232 of file MaterialData.h.

232{ _resize_only_if_smaller = flag; };

◆ props() [1/2]

MaterialProperties & MaterialData::props ( const unsigned int state = 0 )

inline

Definition at line 362 of file MaterialData.h.

{
  mooseAssert(_props.size() > state, "Invalid state");
  return _props[state];
}

◆ props() [2/2]

const MaterialProperties & MaterialData::props ( const unsigned int state = 0 ) const

inline

{

Returns: The properties for the state state (defaults to zero).

This should NEVER be used to modify the size of these objects.

Definition at line 355 of file MaterialData.h.

{
  mooseAssert(_props.size() > state, "Invalid state");
  return _props[state];
}

Referenced by Material::computeProperties(), getPropertyHelper(), haveGenericProperty(), resize(), and Material::subdomainSetup().

◆ reinit()

template<typename MatContainer >

void MaterialData::reinit ( const MatContainer & mats )

Reinit material properties for given element (and possible side)

Parameters

mats	The material objects for which to compute properties
execute_stateful	Whether to execute material objects that have stateful properties. This should be `false` when for example executing material objects for mortar contexts in which stateful properties don't make sense

Definition at line 443 of file MaterialData.h.

{
  for (const auto & mat : mats)
    mat->computeProperties();
}

◆ reset()

void MaterialData::reset ( const std::vector< std::shared_ptr< MaterialBase > > & mats )

Calls the reset method of Materials to ensure that they are in a proper state.

Definition at line 51 of file MaterialData.C.

{
  for (const auto & mat : mats)
    mat->resetProperties();
}

◆ resize()

void MaterialData::resize ( unsigned int n_qpoints )

Resize the data to hold properties for n_qpoints quadrature points.

Definition at line 21 of file MaterialData.C.

{
  if (n_qpoints == nQPoints())
    return;
 
  if (_resize_only_if_smaller && n_qpoints < nQPoints())
    return;
 
  for (const auto state : _storage.stateIndexRange())
    props(state).resizeItems(n_qpoints, {});
  _n_qpoints = n_qpoints;
}

Referenced by ComputeMaterialsObjectThread::onBoundary(), ComputeMaterialsObjectThread::onElement(), ComputeMaterialsObjectThread::onInterface(), ComputeMaterialsObjectThread::onInternalSide(), FEProblemBase::reinitMaterials(), FEProblemBase::reinitMaterialsBoundary(), FEProblemBase::reinitMaterialsFace(), FEProblemBase::reinitMaterialsFaceOnBoundary(), FEProblemBase::reinitMaterialsInterface(), FEProblemBase::reinitMaterialsNeighbor(), and FEProblemBase::resizeMaterialData().

◆ swap()

void MaterialData::swap	(	const Elem &	elem,
		unsigned int	side = `0`
	)

material properties for given element (and possible side)

Definition at line 41 of file MaterialData.C.

{
  if (!_storage.hasStatefulProperties() || isSwapped())
    return;
 
  _storage.swap(_tid, elem, side);
  _swapped = true;
}

◆ swapBack()

void MaterialData::swapBack	(	const Elem &	elem,
		unsigned int	side = `0`
	)

material properties for given element (and possible side)

Definition at line 58 of file MaterialData.C.

{
  if (isSwapped() && _storage.hasStatefulProperties())
  {
    _storage.swapBack(_tid, elem, side);
    _swapped = false;
  }
}

Referenced by FEProblemBase::swapBackMaterials(), FEProblemBase::swapBackMaterialsFace(), and FEProblemBase::swapBackMaterialsNeighbor().

Member Data Documentation

◆ _n_qpoints

unsigned int MaterialData::_n_qpoints

private

Number of quadrature points.

Definition at line 254 of file MaterialData.h.

Referenced by nQPoints(), and resize().

◆ _props

std::array<MaterialProperties, max_state + 1> MaterialData::_props

private

The underlying property data.

Definition at line 257 of file MaterialData.h.

Referenced by props(), and props().

◆ _resize_only_if_smaller

bool MaterialData::_resize_only_if_smaller

private

Use non-destructive resize of material data (calling resize() will not reduce size).

Default is false (normal resize behaviour)

Definition at line 348 of file MaterialData.h.

Referenced by isOnlyResizeIfSmaller(), onlyResizeIfSmaller(), and resize().

◆ _storage

MaterialPropertyStorage& MaterialData::_storage

private

Reference to the MaterialStorage class.

Definition at line 248 of file MaterialData.h.

Referenced by addPropertyHelper(), copy(), eraseProperty(), getMaterialPropertyStorage(), getMaterialPropertyStorageForXFEM(), getMaxStateRequested(), getPropertyId(), hasProperty(), resize(), swap(), and swapBack().

◆ _swapped

bool MaterialData::_swapped

private

Status of storage swapping (calling swap sets this to true; swapBack sets it to false)

Definition at line 344 of file MaterialData.h.

Referenced by isSwapped(), swap(), and swapBack().

◆ _tid

const THREAD_ID MaterialData::_tid

private

The thread id.

Definition at line 251 of file MaterialData.h.

Referenced by copy(), swap(), and swapBack().

◆ max_state

constexpr unsigned int MaterialData::max_state = 2

staticconstexpr

The max time state supported (2 = older)

Definition at line 43 of file MaterialData.h.

Referenced by MaterialPropertyStorage::addProperty().

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

include/materials/MaterialData.h
src/materials/MaterialData.C

Classes

Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MaterialData()

Member Function Documentation

◆ addKokkosPropertyHelper()

◆ addPropertyHelper()

◆ castRequestorToDeclarer()

◆ copy()

◆ declareKokkosProperty()

◆ declareKokkosPropertyHelper()

◆ declareProperty()

◆ eraseProperty()

◆ getKokkosProperty()

◆ getKokkosPropertyHelper()

◆ getMaterialPropertyStorage()

◆ getMaterialPropertyStorageForXFEM()

◆ getMaxStateRequested()

◆ getProperty()

◆ getPropertyHelper()

◆ getPropertyId()

◆ hasProperty()

◆ haveADProperty()

◆ haveGenericProperty()

◆ haveKokkosProperty()

◆ haveKokkosPropertyHelper()

◆ haveProperty()

◆ isOnlyResizeIfSmaller()

◆ isSwapped()

◆ kokkosRegisterLoadStoreHelper()

◆ mooseErrorHelper()

◆ nQPoints()

◆ onlyResizeIfSmaller()

◆ props() [1/2]

◆ props() [2/2]

◆ reinit()

◆ reset()

◆ resize()

◆ swap()

◆ swapBack()

Member Data Documentation

◆ _n_qpoints

◆ _props

◆ _resize_only_if_smaller

◆ _storage

◆ _swapped

◆ _tid

◆ max_state