MaterialProperties Class Reference

#include <MaterialProperty.h>

Inheritance diagram for MaterialProperties:

Classes
class	WriteKey

Public Types
using	values_type = typename std::vector< std::unique_ptr< PropertyValue > >
using	iterator = DereferenceIterator< typename values_type::iterator >
using	const_iterator = DereferenceIterator< typename values_type::const_iterator >

Public Member Functions
void	resizeItems (const std::size_t n_qpoints, const WriteKey)
	Resize items in this array, i.e.
void	resize (const std::size_t size, const WriteKey)
void	setPointer (const std::size_t i, std::unique_ptr< PropertyValue > &&ptr, const WriteKey)
std::size_t	size () const
bool	empty () const
bool	hasValue (const std::size_t i) const
iterator	begin ()
	Begin and end iterators to the underlying data.
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
const PropertyValue &	operator[] (const std::size_t i) const
PropertyValue &	operator[] (const std::size_t i)
const PropertyValue *	queryValue (const std::size_t i) const
PropertyValue *	queryValue (const std::size_t i)

Protected Member Functions
void	setPointer (const std::size_t i, std::unique_ptr< PropertyValue > &&ptr)
	Sets the underlying unique_ptr at index i to ptr.
PropertyValue &	addPointer (std::unique_ptr< PropertyValue > &&ptr)
	Adds the given object in ptr to the storage.
void	resize (const std::size_t size)
	Resizes the underlying vector.
void	clear ()
	Clears the underlying vector.

Private Member Functions
const std::unique_ptr< PropertyValue > &	pointerValue (const std::size_t i) const
	Returns a read-only reference to the underlying unique pointer at index i.
std::unique_ptr< PropertyValue > &	pointerValue (const std::size_t i)
	Returns a reference to the underlying unique pointer at index i.

Private Attributes
values_type	_values
	The underlying data.

Detailed Description

Definition at line 390 of file MaterialProperty.h.

Member Typedef Documentation

const_iterator

using UniqueStorage< PropertyValue >::const_iterator = DereferenceIterator<typename values_type::const_iterator>

inherited

Definition at line 72 of file UniqueStorage.h.

iterator

using UniqueStorage< PropertyValue >::iterator = DereferenceIterator<typename values_type::iterator>

inherited

Definition at line 71 of file UniqueStorage.h.

values_type

using UniqueStorage< PropertyValue >::values_type = typename std::vector<std::unique_ptr<PropertyValue > >

inherited

Definition at line 70 of file UniqueStorage.h.

Member Function Documentation

addPointer()

PropertyValue & UniqueStorage< PropertyValue >::addPointer ( std::unique_ptr< PropertyValue > &&  ptr )

inlineprotectedinherited

Adds the given object in ptr to the storage.

Definition at line 153 of file UniqueStorage.h.

  {
    mooseAssert(ptr, "Null object");
    return *_values.emplace_back(std::move(ptr));
  }

begin() [1/2]

iterator UniqueStorage< PropertyValue >::begin ( )

inlineinherited

Begin and end iterators to the underlying data.

Note that dereferencing these iterators may lead to an assertion or the dereference of a nullptr whether or not the underlying data is initialized.

Definition at line 82 of file UniqueStorage.h.

{ return iterator(_values.begin()); }

begin() [2/2]

const_iterator UniqueStorage< PropertyValue >::begin ( ) const

inlineinherited

Definition at line 84 of file UniqueStorage.h.

{ return const_iterator(_values.begin()); }

clear()

void UniqueStorage< PropertyValue >::clear ( )

inlineprotectedinherited

Clears the underlying vector.

Definition at line 167 of file UniqueStorage.h.

{ _values.clear(); }

empty()

bool UniqueStorage< PropertyValue >::empty ( ) const

inlineinherited

Returns

Whether or not the underlying storage is empty.

Definition at line 116 of file UniqueStorage.h.

{ return _values.empty(); }

end() [1/2]

iterator UniqueStorage< PropertyValue >::end ( )

inlineinherited

Definition at line 83 of file UniqueStorage.h.

{ return iterator(_values.end()); }

end() [2/2]

const_iterator UniqueStorage< PropertyValue >::end ( ) const

inlineinherited

Definition at line 85 of file UniqueStorage.h.

{ return const_iterator(_values.end()); }

hasValue()

bool UniqueStorage< PropertyValue >::hasValue ( const std::size_t  i ) const

inlineinherited

Returns

whether or not the underlying object at index is initialized

Definition at line 121 of file UniqueStorage.h.

{ return pointerValue(i) != nullptr; }

operator[]() [1/2]

PropertyValue & UniqueStorage< PropertyValue >::operator[] ( const std::size_t  i )

inlineinherited

Definition at line 103 of file UniqueStorage.h.

{ return const_cast<T &>(std::as_const(*this)[i]); }

operator[]() [2/2]

const PropertyValue & UniqueStorage< PropertyValue >::operator[] ( const std::size_t  i ) const

inlineinherited

Returns

A reference to the underlying data at index i.

Note that the underlying data may not necessarily be initialized, in which case this will throw an assertion or dereference a nullptr.

You can check whether or not the underlying data is initialized with hasValue(i).

Definition at line 98 of file UniqueStorage.h.

  {
    mooseAssert(hasValue(i), "Null object");
    return *pointerValue(i);
  }

pointerValue() [1/2]

std::unique_ptr< PropertyValue > & UniqueStorage< PropertyValue >::pointerValue ( const std::size_t  i )

inlineprivateinherited

Returns a reference to the underlying unique pointer at index i.

Definition at line 183 of file UniqueStorage.h.

  {
    return const_cast<std::unique_ptr<T> &>(std::as_const(*this).pointerValue(i));
  }

pointerValue() [2/2]

const std::unique_ptr< PropertyValue > & UniqueStorage< PropertyValue >::pointerValue ( const std::size_t  i ) const

inlineprivateinherited

Returns a read-only reference to the underlying unique pointer at index i.

Definition at line 174 of file UniqueStorage.h.

  {
    mooseAssert(size() > i, "Invalid size");
    return _values[i];
  }

queryValue() [1/2]

PropertyValue * UniqueStorage< PropertyValue >::queryValue ( const std::size_t  i )

inlineinherited

Definition at line 131 of file UniqueStorage.h.

  {
    return const_cast<T *>(std::as_const(*this).queryValue(i));
  }

queryValue() [2/2]

const PropertyValue * UniqueStorage< PropertyValue >::queryValue ( const std::size_t  i ) const

inlineinherited

Returns

A pointer to the underlying data at index i

The pointer will be nullptr if !hasValue(i), that is, if the unique_ptr at index i is not initialized

Definition at line 130 of file UniqueStorage.h.

{ return pointerValue(i).get(); }

resize() [1/2]

void UniqueStorage< PropertyValue >::resize ( const std::size_t  size )

inlineprotectedinherited

Resizes the underlying vector.

Definition at line 162 of file UniqueStorage.h.

{ _values.resize(size); }

resize() [2/2]

void MaterialProperties::resize ( const std::size_t  size, const WriteKey    )

inline

Definition at line 415 of file MaterialProperty.h.

  {
    UniqueStorage<PropertyValue>::resize(size);
  }

Referenced by MaterialPropertyStorage::initProps().

resizeItems()

void MaterialProperties::resizeItems ( const std::size_t  n_qpoints, const WriteKey    )

inline

Resize items in this array, i.e.

the number of values needed in PropertyValue array

Parameters

n_qpoints

The number of values needed to store (equals the the number of quadrature points per mesh element)

Definition at line 408 of file MaterialProperty.h.

  {
    for (const auto i : index_range(*this))
      if (auto value = queryValue(i))
        value->resize(n_qpoints);
  }

Referenced by MaterialData::resize().

setPointer() [1/2]

void UniqueStorage< PropertyValue >::setPointer ( const std::size_t  i, std::unique_ptr< PropertyValue > &&  ptr  )

inlineprotectedinherited

Sets the underlying unique_ptr at index i to ptr.

This can be used to construct objects in the storage, i.e., setPointer(0, std::make_unique<T>(...));

Definition at line 144 of file UniqueStorage.h.

  {
    mooseAssert(size() > i, "Invalid size");
    _values[i] = std::move(ptr);
  }

setPointer() [2/2]

void MaterialProperties::setPointer ( const std::size_t  i, std::unique_ptr< PropertyValue > &&  ptr, const WriteKey    )

inline

Definition at line 420 of file MaterialProperty.h.

  {
    return UniqueStorage<PropertyValue>::setPointer(i, std::move(ptr));
  }

size()

std::size_t UniqueStorage< PropertyValue >::size ( ) const

inlineinherited

Returns

The size of the underlying storage.

Note that this is not necessarily the size of constructed objects, as underlying objects could be uninitialized

Definition at line 112 of file UniqueStorage.h.

{ return _values.size(); }

Member Data Documentation

_values

values_type UniqueStorage< PropertyValue >::_values

privateinherited

The underlying data.

Definition at line 192 of file UniqueStorage.h.

---

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

• include/materials/MaterialProperty.h