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

#include <DerivativeMaterialInterface.h>

Inheritance diagram for MaterialProperty< T >:

Public Member Functions
	MaterialProperty (bool use_ad=false)
	Explicitly declare a public constructor because we made the copy constructor private. More...

virtual	~MaterialProperty ()

const std::vector< MooseADWrapper< T > > &	get () const

std::vector< MooseADWrapper< T > > &	set ()

virtual std::string	type () override
	String identifying the type of parameter stored. More...

virtual PropertyValue *	init (int size) override
	Clone this value. More...

virtual void	resize (int n) override
	Resizes the property to the size n. More...

virtual unsigned int	size () const override

T &	operator[] (const unsigned int i)
	Get element i out of the array as a writeable reference. More...

const T &	operator[] (const unsigned int i) const
	Get element i out of the array as a ready-only reference. More...

virtual void	swap (PropertyValue *rhs) override

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

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

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

void	copyDualNumberToValue (const unsigned int i) override
	copy the value portion (not the derivatives) of the DualNumber<Real> version of the material property to the Real version for the specified quadrature point More...

void	markAD (bool use_ad) override
	Mark whether this property is in AD mode. This method is necessary for switching the state after swapping material properties during stateful material calculations. More...

Protected Attributes
bool	_use_ad
	Whether this property was declared as AD. More...

std::vector< MooseADWrapper< T > >	_value
	Stored parameter value. More...

Private Member Functions
	MaterialProperty (const MaterialProperty< T > &)
	private copy constructor to avoid shallow copying of material properties More...

MaterialProperty< T > &	operator= (const MaterialProperty< T > &)
	private assignment operator to avoid shallow copying of material properties More...

Detailed Description

template<typename T>
class MaterialProperty< T >

Concrete definition of a parameter value for a specified type.

Definition at line 25 of file DerivativeMaterialInterface.h.

Constructor & Destructor Documentation

◆ MaterialProperty() [1/2]

template<typename T>

MaterialProperty< T >::MaterialProperty ( bool use_ad = false )

inline

Explicitly declare a public constructor because we made the copy constructor private.

Definition at line 105 of file MaterialProperty.h.

                                         : PropertyValue(), _use_ad(use_ad)
   { /* */
   }

◆ ~MaterialProperty()

template<typename T>

virtual MaterialProperty< T >::~MaterialProperty ( )

inlinevirtual

Definition at line 109 of file MaterialProperty.h.

109 {}

◆ MaterialProperty() [2/2]

template<typename T>

MaterialProperty< T >::MaterialProperty ( const MaterialProperty< T > & )

inlineprivate

private copy constructor to avoid shallow copying of material properties

Definition at line 183 of file MaterialProperty.h.

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

Member Function Documentation

◆ copyDualNumberToValue()

template<typename T>

void MaterialProperty< T >::copyDualNumberToValue ( const unsigned int i )

inlineoverridevirtual

copy the value portion (not the derivatives) of the DualNumber<Real> version of the material property to the Real version for the specified quadrature point

Implements PropertyValue.

Definition at line 177 of file MaterialProperty.h.

177 { _value[i].synchronizeToVal(); }

◆ get()

template<typename T>

const std::vector<MooseADWrapper<T> >& MaterialProperty< T >::get ( ) const

inline

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

Definition at line 114 of file MaterialProperty.h.

114 { return _value; }

◆ init()

template<typename T >

PropertyValue * MaterialProperty< T >::init ( int size )

inlineoverridevirtual

Clone this value.

Useful in copy-construction.

Implements PropertyValue.

Definition at line 220 of file MaterialProperty.h.

 {
   return _init_helper(size, this, static_cast<T *>(0), _use_ad);
 }

◆ load()

template<typename T >

void MaterialProperty< T >::load ( std::istream & stream )

inlineoverridevirtual

Load the property from a binary stream.

Implements PropertyValue.

Definition at line 265 of file MaterialProperty.h.

 {
   for (unsigned int i = 0; i < size(); i++)
     loadHelper(stream, _value[i], NULL);
 }

◆ markAD()

template<typename T >

void MaterialProperty< T >::markAD ( bool use_ad )

inlineoverridevirtual

Mark whether this property is in AD mode. This method is necessary for switching the state after swapping material properties during stateful material calculations.

Implements PropertyValue.

Definition at line 206 of file MaterialProperty.h.

 {
   _use_ad = use_ad;
 }

◆ operator=()

template<typename T>

MaterialProperty<T>& MaterialProperty< T >::operator= ( const MaterialProperty< T > & )

inlineprivate

private assignment operator to avoid shallow copying of material properties

Definition at line 189 of file MaterialProperty.h.

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

◆ operator[]() [1/2]

template<typename T>

T& MaterialProperty< T >::operator[] ( const unsigned int i )

inline

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

Definition at line 141 of file MaterialProperty.h.

141 { return _value[i].value(); }

◆ operator[]() [2/2]

template<typename T>

const T& MaterialProperty< T >::operator[] ( const unsigned int i ) const

inline

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

Definition at line 146 of file MaterialProperty.h.

146 { return _value[i].value(); }

◆ qpCopy()

template<typename T >

void MaterialProperty< T >::qpCopy	(	const unsigned int	to_qp,
		PropertyValue *	rhs,
		const unsigned int	from_qp
	)

inlineoverridevirtual

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 247 of file MaterialProperty.h.

 {
   mooseAssert(rhs != NULL, "Assigning NULL?");
   _value[to_qp] = cast_ptr<const MaterialProperty<T> *>(rhs)->_value[from_qp];
 }

◆ resize()

template<typename T >

void MaterialProperty< T >::resize ( int n )

inlineoverridevirtual

Resizes the property to the size n.

Implements PropertyValue.

Definition at line 227 of file MaterialProperty.h.

 {
   auto diff = n - static_cast<int>(_value.size());
   if (diff < 0)
     _value.erase(_value.end() + diff, _value.end());
   else
     for (decltype(diff) i = 0; i < diff; ++i)
       _value.emplace_back(MooseADWrapper<T>());
 }

Referenced by _init_helper(), MaterialPropertyInterface::getZeroMaterialProperty(), and MaterialBase::getZeroMaterialProperty().

◆ set()

template<typename T>

std::vector<MooseADWrapper<T> >& MaterialProperty< T >::set ( )

inline

Returns: a writable reference to the parameter value.

Definition at line 119 of file MaterialProperty.h.

119 { return _value; }

◆ size()

template<typename T>

virtual unsigned int MaterialProperty< T >::size ( ) const

inlineoverridevirtual

Implements PropertyValue.

Definition at line 136 of file MaterialProperty.h.

136 { return _value.size(); }

Referenced by MaterialPropertyInterface::getZeroMaterialProperty(), MaterialBase::getZeroMaterialProperty(), and MooseUtils::MaterialPropertyStorageDump().

◆ store()

template<typename T >

void MaterialProperty< T >::store ( std::ostream & stream )

inlineoverridevirtual

Store the property into a binary stream.

Implements PropertyValue.

Definition at line 257 of file MaterialProperty.h.

 {
   for (unsigned int i = 0; i < size(); i++)
     storeHelper(stream, _value[i], NULL);
 }

◆ swap()

template<typename T >

void MaterialProperty< T >::swap ( PropertyValue * rhs )

inlineoverridevirtual

Implements PropertyValue.

Definition at line 239 of file MaterialProperty.h.

 {
   mooseAssert(rhs != NULL, "Assigning NULL?");
   _value.swap(cast_ptr<MaterialProperty<T> *>(rhs)->_value);
 }

◆ type()

template<typename T >

std::string MaterialProperty< T >::type ( )

inlineoverridevirtual

String identifying the type of parameter stored.

Implements PropertyValue.

Definition at line 213 of file MaterialProperty.h.

 {
   return typeid(T).name();
 }

Member Data Documentation

◆ _use_ad

template<typename T>

bool MaterialProperty< T >::_use_ad

protected

Whether this property was declared as AD.

Definition at line 196 of file MaterialProperty.h.

◆ _value

template<typename T>

std::vector<MooseADWrapper<T> > MaterialProperty< T >::_value

protected

Stored parameter value.

Definition at line 198 of file MaterialProperty.h.

Referenced by MaterialProperty< Real >::copyDualNumberToValue(), MaterialProperty< Real >::get(), MaterialProperty< Real >::operator[](), ADMaterialPropertyObject< T >::operator[](), MaterialProperty< Real >::set(), and MaterialProperty< Real >::size().

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

include/materials/DerivativeMaterialInterface.h
include/materials/MaterialProperty.h

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

template<typename T> class MaterialProperty< T >

Constructor & Destructor Documentation

◆ MaterialProperty() [1/2]

◆ ~MaterialProperty()

◆ MaterialProperty() [2/2]

Member Function Documentation

◆ copyDualNumberToValue()

◆ get()

◆ init()

◆ load()

◆ markAD()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ qpCopy()

◆ resize()

◆ set()

◆ size()

◆ store()

◆ swap()

◆ type()

Member Data Documentation

◆ _use_ad

◆ _value

template<typename T>
class MaterialProperty< T >