Concrete definition of a parameter value for a specified type. More...

#include <MaterialProperty.h>

Inheritance diagram for MaterialPropertyBase< T, is_ad >:

Public Types
typedef Moose::GenericType< T, is_ad >	value_type

typedef unsigned int	id_type
	The type for a material property ID.

Public Member Functions
	MaterialPropertyBase (const PropertyValue::id_type id)

bool	isAD () const override final

const MooseArray< Moose::GenericType< T, is_ad > > &	get () const

MooseArray< Moose::GenericType< T, is_ad > > &	set ()

virtual const std::string &	type () const override final
	String identifying the type of parameter stored.

virtual void	resize (const std::size_t size) override final
	Resizes the property to the size n.

virtual unsigned int	size () const override final

Moose::GenericType< T, is_ad > &	operator[] (const unsigned int i)
	Get element i out of the array as a writeable reference.

const Moose::GenericType< T, is_ad > &	operator[] (const unsigned int i) const
	Get element i out of the array as a ready-only reference.

virtual void	qpCopy (const unsigned int to_qp, const PropertyValue &rhs, const unsigned int from_qp) override final
	Copy the value of a Property from one specific to a specific qp in this Property.

virtual void	store (std::ostream &stream) override final
	Store the property into a binary stream.

virtual void	load (std::istream &stream) override final
	Load the property from a binary stream.

virtual void	swap (PropertyValue &rhs) override final

const std::type_info &	typeID () const override final

virtual std::unique_ptr< PropertyValue >	clone (const std::size_t size) const override final

id_type	id () const

Static Public Attributes
static constexpr id_type	invalid_property_id = std::numeric_limits<id_type>::max() - 1
	The material property ID for an invalid property We only have this because there are a few cases where folks want to instantiate their own fake materials, and we should at least force them to be consistent.

Protected Attributes
MooseArray< Moose::GenericType< T, is_ad > >	_value
	Stored parameter value.

const id_type	_id
	The material property ID.

Private Member Functions
	MaterialPropertyBase (const MaterialPropertyBase< T, is_ad > &)
	private copy constructor to avoid shallow copying of material properties

MaterialPropertyBase< T, is_ad > &	operator= (const MaterialPropertyBase< T, is_ad > &)
	private assignment operator to avoid shallow copying of material properties

Detailed Description

template<typename T, bool is_ad>
class MaterialPropertyBase< T, is_ad >

Concrete definition of a parameter value for a specified type.

Definition at line 109 of file MaterialProperty.h.

Member Typedef Documentation

◆ id_type

typedef unsigned int PropertyValue::id_type

inherited

The type for a material property ID.

Definition at line 41 of file MaterialProperty.h.

◆ value_type

template<typename T , bool is_ad>

typedef Moose::GenericType<T, is_ad> MaterialPropertyBase< T, is_ad >::value_type

Definition at line 112 of file MaterialProperty.h.

Constructor & Destructor Documentation

◆ MaterialPropertyBase() [1/2]

template<typename T , bool is_ad>

MaterialPropertyBase< T, is_ad >::MaterialPropertyBase ( const PropertyValue::id_type id )

inline

Definition at line 114 of file MaterialProperty.h.

114: PropertyValue(id) {}

PropertyValue

Abstract definition of a property value.

Definition MaterialProperty.h:38

◆ MaterialPropertyBase() [2/2]

template<typename T , bool is_ad>

MaterialPropertyBase< T, is_ad >::MaterialPropertyBase ( const MaterialPropertyBase< T, is_ad > & )

inlineprivate

private copy constructor to avoid shallow copying of material properties

Definition at line 186 of file MaterialProperty.h.

  {
    mooseError("Material properties must be assigned to references (missing '&')");
  }

Member Function Documentation

◆ clone()

template<typename T , bool is_ad>

std::unique_ptr< PropertyValue > MaterialPropertyBase< T, is_ad >::clone ( const std::size_t size ) const

finaloverridevirtual

Returns: A clone of this property.

Note that this will only ever return a non-AD clone, even if this property is an AD property. This is on purpose; whenever we need clones, it's for older states in which we don't store derivatives beacuse it's too expensive.

Implements PropertyValue.

Definition at line 331 of file MaterialProperty.h.

{
  auto prop = std::make_unique<MaterialProperty<T>>(this->id());
  if (size)
    prop->resize(size);
  return prop;
}

◆ get()

template<typename T , bool is_ad>

const MooseArray< Moose::GenericType< T, is_ad > > & MaterialPropertyBase< T, is_ad >::get ( ) const

inline

Returns: a read-only reference to the parameter value.

Definition at line 121 of file MaterialProperty.h.

121{ return _value; }

MaterialPropertyBase::_value

MooseArray< Moose::GenericType< T, is_ad > > _value

Stored parameter value.

Definition MaterialProperty.h:199

◆ id()

id_type PropertyValue::id ( ) const

inlineinherited

Returns: The ID of the underlying material property

Definition at line 55 of file MaterialProperty.h.

55{ return _id; }

PropertyValue::_id

const id_type _id

The material property ID.

Definition MaterialProperty.h:101

Referenced by MaterialPropertyBase< T, is_ad >::swap().

◆ isAD()

template<typename T , bool is_ad>

bool MaterialPropertyBase< T, is_ad >::isAD ( ) const

inlinefinaloverridevirtual

Implements PropertyValue.

Definition at line 116 of file MaterialProperty.h.

116{ return is_ad; }

◆ load()

template<typename T , bool is_ad>

void MaterialPropertyBase< T, is_ad >::load ( std::istream & stream )

inlinefinaloverridevirtual

Load the property from a binary stream.

Implements PropertyValue.

Definition at line 281 of file MaterialProperty.h.

{
  for (const auto i : index_range(_value))
    loadHelper(stream, _value[i], nullptr);
}

◆ operator=()

template<typename T , bool is_ad>

MaterialPropertyBase< T, is_ad > & MaterialPropertyBase< T, is_ad >::operator= ( const MaterialPropertyBase< T, is_ad > & )

inlineprivate

private assignment operator to avoid shallow copying of material properties

Definition at line 192 of file MaterialProperty.h.

  {
    mooseError("Material properties must be assigned to references (missing '&')");
  }

◆ operator[]() [1/2]

template<typename T , bool is_ad>

Moose::GenericType< T, is_ad > & MaterialPropertyBase< T, is_ad >::operator[] ( const unsigned int i )

inline

Get element i out of the array as a writeable reference.

Definition at line 143 of file MaterialProperty.h.

143{ return _value[i]; }

◆ operator[]() [2/2]

template<typename T , bool is_ad>

const Moose::GenericType< T, is_ad > & MaterialPropertyBase< T, is_ad >::operator[] ( const unsigned int i ) const

inline

Get element i out of the array as a ready-only reference.

Definition at line 148 of file MaterialProperty.h.

148{ return _value[i]; }

◆ qpCopy()

template<typename T , bool is_ad>

void MaterialPropertyBase< T, is_ad >::qpCopy	(	const unsigned int	to_qp,
		const PropertyValue &	rhs,
		const unsigned int	from_qp
	)

inlinefinaloverridevirtual

Copy the value of a Property from one specific to a specific qp in this Property.

Parameters

to_qp	The quadrature point in this Property that you want to copy to.
rhs	The Property you want to copy from.
from_qp	The quadrature point in rhs you want to copy from.

Implements PropertyValue.

Definition at line 257 of file MaterialProperty.h.

{
  // If we're the same
  if (rhs.isAD() == is_ad)
    _value[to_qp] =
        libMesh::cast_ptr<const MaterialPropertyBase<T, is_ad> *>(&rhs)->_value[from_qp];
  else
    moose::internal::rawValueEqualityHelper(
        _value[to_qp],
        (*libMesh::cast_ptr<const MaterialPropertyBase<T, !is_ad> *>(&rhs))[from_qp]);
}

◆ resize()

template<typename T , bool is_ad>

void MaterialPropertyBase< T, is_ad >::resize ( const std::size_t size )

inlinefinaloverridevirtual

Resizes the property to the size n.

Implements PropertyValue.

Definition at line 250 of file MaterialProperty.h.

{
  _value.template resize</*value_initalize=*/true>(size);
}

◆ set()

template<typename T , bool is_ad>

MooseArray< Moose::GenericType< T, is_ad > > & MaterialPropertyBase< T, is_ad >::set ( )

inline

Returns: a writable reference to the parameter value.

Definition at line 126 of file MaterialProperty.h.

126{ return _value; }

◆ size()

template<typename T , bool is_ad>

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

inlinefinaloverridevirtual

Implements PropertyValue.

Definition at line 138 of file MaterialProperty.h.

138{ return _value.size(); }

MooseArray::size

unsigned int size() const

The number of elements that can currently be stored in the array.

Definition MooseArray.h:259

◆ store()

template<typename T , bool is_ad>

void MaterialPropertyBase< T, is_ad >::store ( std::ostream & stream )

inlinefinaloverridevirtual

Store the property into a binary stream.

Implements PropertyValue.

Definition at line 273 of file MaterialProperty.h.

{
  for (const auto i : index_range(_value))
    storeHelper(stream, _value[i], nullptr);
}

◆ swap()

template<typename T , bool is_ad>

void MaterialPropertyBase< T, is_ad >::swap ( PropertyValue & rhs )

inlinefinaloverridevirtual

Implements PropertyValue.

Definition at line 289 of file MaterialProperty.h.

{
  mooseAssert(this->id() == rhs.id(), "Inconsistent properties");
  mooseAssert(this->typeID() == rhs.typeID(), "Inconsistent types");
 
  // If we're the same
  if (rhs.isAD() == is_ad)
  {
    mooseAssert(dynamic_cast<decltype(this)>(&rhs), "Expected same type is not the same");
    this->_value.swap(libMesh::cast_ptr<decltype(this)>(&rhs)->_value);
    return;
  }
 
  // We may call this function when doing swap between MaterialData material properties (you can
  // think of these as the current element properties) and MaterialPropertyStorage material
  // properties (these are the stateful material properties that we store for *every* element). We
  // never store ADMaterialProperty in stateful storage (e.g. MaterialPropertyStorage) for memory
  // resource reasons; instead we keep a regular MaterialProperty version of it. Hence we do have a
  // need to exchange data between the AD and regular copies which we implement below. The below
  // is obviously not a swap, for which you cannot identify a giver and receiver. Instead the below
  // has a clear giver and receiver. The giver is the object passed in as the rhs. The receiver is
  // *this* object. This directionality, although not conceptually appropriate given the method
  // name, *is* appropriate to how this method is used in practice. See shallowCopyData and
  // shallowCopyDataBack in MaterialPropertyStorage.C
 
  auto * different_type_prop = libMesh::cast_ptr<MaterialPropertyBase<T, !is_ad> *>(&rhs);
 
  this->resize(different_type_prop->size());
  for (const auto qp : make_range(this->size()))
    moose::internal::rawValueEqualityHelper(this->_value[qp], (*different_type_prop)[qp]);
}

◆ type()

template<typename T , bool is_ad>

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

inlinefinaloverridevirtual

String identifying the type of parameter stored.

Implements PropertyValue.

Definition at line 242 of file MaterialProperty.h.

{
  static const std::string type_name = MooseUtils::prettyCppType<T>();
  return type_name;
}

◆ typeID()

template<typename T , bool is_ad>

const std::type_info & MaterialPropertyBase< T, is_ad >::typeID ( ) const

inlinefinaloverridevirtual

Returns: The type_info for the underlying stored type T

Implements PropertyValue.

Definition at line 323 of file MaterialProperty.h.

{
  static const auto & info = typeid(T);
  return info;
}

Member Data Documentation

◆ _id

const id_type PropertyValue::_id

protectedinherited

The material property ID.

Definition at line 101 of file MaterialProperty.h.

Referenced by PropertyValue::id().

◆ _value

template<typename T , bool is_ad>

MooseArray<Moose::GenericType<T, is_ad> > MaterialPropertyBase< T, is_ad >::_value

protected

Stored parameter value.

Definition at line 199 of file MaterialProperty.h.

Referenced by MaterialPropertyBase< T, is_ad >::get(), MaterialPropertyBase< T, is_ad >::operator[](), MaterialPropertyBase< T, is_ad >::operator[](), MaterialPropertyBase< T, is_ad >::set(), and MaterialPropertyBase< T, is_ad >::size().

◆ invalid_property_id

constexpr id_type PropertyValue::invalid_property_id = std::numeric_limits<id_type>::max() - 1

staticconstexprinherited

The material property ID for an invalid property We only have this because there are a few cases where folks want to instantiate their own fake materials, and we should at least force them to be consistent.

Definition at line 50 of file MaterialProperty.h.

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

include/materials/MaterialProperty.h

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ id_type

◆ value_type

Constructor & Destructor Documentation

◆ MaterialPropertyBase() [1/2]

◆ MaterialPropertyBase() [2/2]

Member Function Documentation

◆ clone()

◆ get()

◆ id()

◆ isAD()

◆ load()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ qpCopy()

◆ resize()

◆ set()

◆ size()

◆ store()

◆ swap()

◆ type()

◆ typeID()

Member Data Documentation

◆ _id

◆ _value

◆ invalid_property_id