IndexableProperty< T, is_ad > Class Template Reference

IndexableProperty is a helper (proxy) object to obtain a scalar component from a material property. More...

#include <IndexableProperty.h>

Public Member Functions
	IndexableProperty (T *host, const std::string &property_param="property", const std::string &component_param="component")
GenericReal< is_ad >	operator[] (int qp) const
	get the selected component value for the given quadrature point
void	check () const
	integrity check

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
void	checkComponents (unsigned int components) const

Protected Attributes
T *	_host
	pointer to the host object
const std::string &	_property_param
	name of the input parameter containing the material property name
const std::string &	_property_name
	name of the coupled material property (for error reporting)
const std::string &	_component_param
	name of the input parameter containing the component index
const std::vector< unsigned int >	_component
	Index of the selected scalar component of the material property.
const GenericOptionalMaterialProperty< Real, is_ad > &	_property_real
	only one of those pointers will be non-null and pointing to the selected property
const GenericOptionalMaterialProperty< std::vector< Real >, is_ad > &	_property_std_vector
const GenericOptionalMaterialProperty< RealVectorValue, is_ad > &	_property_real_vector_value
const GenericOptionalMaterialProperty< RankTwoTensor, is_ad > &	_property_rank_two_tensor
const GenericOptionalMaterialProperty< RankThreeTensor, is_ad > &	_property_rank_three_tensor
const GenericOptionalMaterialProperty< RankFourTensor, is_ad > &	_property_rank_four_tensor

Detailed Description

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

IndexableProperty is a helper (proxy) object to obtain a scalar component from a material property.

Use it in objects that process a scalar quantity instead of a Real material property to allow the user to supply any material property of a type from the list below along with a component index parameter to select a scalar component from the property value.

Definition at line 23 of file IndexableProperty.h.

Constructor & Destructor Documentation

IndexableProperty()

template<typename T , bool is_ad>

IndexableProperty< T, is_ad >::IndexableProperty	(	T *	host,
		const std::string &	property_param = "property",
		const std::string &	component_param = "component"
	)

Definition at line 80 of file IndexableProperty.h.

  : _host(host),
    _property_param(property_param),
    _property_name(_host->template getParam<MaterialPropertyName>(_property_param)),
    _component_param(component_param),
    _component(host->template getParam<std::vector<unsigned int>>(_component_param)),
    _property_real(
        _host->template getGenericOptionalMaterialProperty<Real, is_ad>(_property_param)),
    _property_std_vector(
        _host->template getGenericOptionalMaterialProperty<std::vector<Real>, is_ad>(
            _property_param)),
    _property_real_vector_value(
        _host->template getGenericOptionalMaterialProperty<RealVectorValue, is_ad>(
            _property_param)),
    _property_rank_two_tensor(
        _host->template getGenericOptionalMaterialProperty<RankTwoTensor, is_ad>(_property_param)),
    _property_rank_three_tensor(
        _host->template getGenericOptionalMaterialProperty<RankThreeTensor, is_ad>(
            _property_param)),
    _property_rank_four_tensor(
        _host->template getGenericOptionalMaterialProperty<RankFourTensor, is_ad>(_property_param))
{
}

Member Function Documentation

check()

template<typename T , bool is_ad>

void IndexableProperty< T, is_ad >::check

(

)

const

integrity check

Definition at line 128 of file IndexableProperty.h.

{
  if (_property_real)
    checkComponents(0);
  else if (_property_std_vector)
    checkComponents(1);
  else if (_property_real_vector_value)
    checkComponents(1);
  else if (_property_rank_two_tensor)
    checkComponents(2);
  else if (_property_rank_three_tensor)
    checkComponents(3);
  else if (_property_rank_four_tensor)
    checkComponents(4);
  else
    _host->mooseError("The ",
                      is_ad ? "AD" : "non-AD",
                      " material property '",
                      _property_name,
                      "' does not exist");
}

Referenced by NodalPatchRecoveryMaterialProperty::initialSetup().

checkComponents()

template<typename T , bool is_ad>

void IndexableProperty< T, is_ad >::checkComponents ( unsigned int  components ) const

protected

Definition at line 152 of file IndexableProperty.h.

{
  if (_component.size() != components)
    _host->mooseError("Material property '",
                      _property_name,
                      "' is ",
                      components,
                      "-dimensional, but an index vector of size ",
                      _component.size(),
                      " was supplied to select a component. It looks like you were expecting the "
                      "material property to have a different type.");
}

operator[]()

template<typename T , bool is_ad>

GenericReal< is_ad > IndexableProperty< T, is_ad >::operator[]

(

int

qp

)

const

get the selected component value for the given quadrature point

Definition at line 108 of file IndexableProperty.h.

{
  if (_property_real)
    return _property_real[qp];
  if (_property_std_vector)
    return _property_std_vector[qp][_component[0]];
  if (_property_real_vector_value)
    return _property_real_vector_value[qp](_component[0]);
  if (_property_rank_two_tensor)
    return _property_rank_two_tensor[qp](_component[0], _component[1]);
  if (_property_rank_three_tensor)
    return _property_rank_three_tensor[qp](_component[0], _component[1], _component[2]);
  if (_property_rank_four_tensor)
    return _property_rank_four_tensor[qp](
        _component[0], _component[1], _component[2], _component[3]);
  _host->mooseError("internal error in IndexableProperty");
}

validParams()

template<typename T , bool is_ad>

InputParameters IndexableProperty< T, is_ad >::validParams ( )

static

Definition at line 66 of file IndexableProperty.h.

{
  auto params = T::validParams();
  params.template addRequiredParam<MaterialPropertyName>("property",
                                                         "The name of the material property");
  params.template addParam<std::vector<unsigned int>>(
      "component",
      {},
      "Index vector of the scalar component to extract from "
      "the material property (empty for scalar properties)");
  return params;
}

Referenced by SideIntegralMaterialPropertyTempl< is_ad >::validParams(), and NodalPatchRecoveryMaterialProperty::validParams().

Member Data Documentation

_component

template<typename T , bool is_ad>

const std::vector<unsigned int> IndexableProperty< T, is_ad >::_component

protected

Index of the selected scalar component of the material property.

Definition at line 52 of file IndexableProperty.h.

_component_param

template<typename T , bool is_ad>

const std::string& IndexableProperty< T, is_ad >::_component_param

protected

name of the input parameter containing the component index

Definition at line 49 of file IndexableProperty.h.

_host

template<typename T , bool is_ad>

T* IndexableProperty< T, is_ad >::_host

protected

pointer to the host object

Definition at line 42 of file IndexableProperty.h.

_property_name

template<typename T , bool is_ad>

const std::string& IndexableProperty< T, is_ad >::_property_name

protected

name of the coupled material property (for error reporting)

Definition at line 47 of file IndexableProperty.h.

_property_param

template<typename T , bool is_ad>

const std::string& IndexableProperty< T, is_ad >::_property_param

protected

name of the input parameter containing the material property name

Definition at line 45 of file IndexableProperty.h.

_property_rank_four_tensor

template<typename T , bool is_ad>

const GenericOptionalMaterialProperty<RankFourTensor, is_ad>& IndexableProperty< T, is_ad >::_property_rank_four_tensor

protected

Definition at line 60 of file IndexableProperty.h.

_property_rank_three_tensor

template<typename T , bool is_ad>

const GenericOptionalMaterialProperty<RankThreeTensor, is_ad>& IndexableProperty< T, is_ad >::_property_rank_three_tensor

protected

Definition at line 59 of file IndexableProperty.h.

_property_rank_two_tensor

template<typename T , bool is_ad>

const GenericOptionalMaterialProperty<RankTwoTensor, is_ad>& IndexableProperty< T, is_ad >::_property_rank_two_tensor

protected

Definition at line 58 of file IndexableProperty.h.

_property_real

template<typename T , bool is_ad>

const GenericOptionalMaterialProperty<Real, is_ad>& IndexableProperty< T, is_ad >::_property_real

protected

only one of those pointers will be non-null and pointing to the selected property

Definition at line 55 of file IndexableProperty.h.

_property_real_vector_value

template<typename T , bool is_ad>

const GenericOptionalMaterialProperty<RealVectorValue, is_ad>& IndexableProperty< T, is_ad >::_property_real_vector_value

protected

Definition at line 57 of file IndexableProperty.h.

_property_std_vector

template<typename T , bool is_ad>

const GenericOptionalMaterialProperty<std::vector<Real>, is_ad>& IndexableProperty< T, is_ad >::_property_std_vector

protected

Definition at line 56 of file IndexableProperty.h.

---

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

• include/utils/IndexableProperty.h