ThreeMaterialPropertyInterface Class Reference

This interface is designed currently for DomainUserObject where material properties on element, face and neighboring face may all required. More...

#include <ThreeMaterialPropertyInterface.h>

Inheritance diagram for ThreeMaterialPropertyInterface:

Public Member Functions
	ThreeMaterialPropertyInterface (const MooseObject *moose_object, const std::set< SubdomainID > &blocks_ids, const std::set< BoundaryID > &boundary_ids)
template<typename T >
const MaterialProperty< T > &	getFaceMaterialProperty (const std::string &name)
	Retrieve the property deduced from the name name. More...
template<typename T >
const MaterialProperty< T > &	getFaceMaterialPropertyByName (const std::string &name)
	Retrieve the property named "name" without any deduction. More...
template<typename T >
const ADMaterialProperty< T > &	getFaceADMaterialProperty (const std::string &name)
	Retrieve the ADMaterialProperty named "name". More...
template<typename T >
const MaterialProperty< T > &	getFaceMaterialPropertyOld (const std::string &name)
template<typename T >
const MaterialProperty< T > &	getFaceMaterialPropertyOlder (const std::string &name)
template<typename T , bool is_ad>
const auto &	getGenericFaceMaterialProperty (const std::string &name)
	Retrieve the face material property whether AD or not. More...
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
	Retrieve the generic property named "name" for the specified material_data at state state. More...
template<typename T >
const MaterialProperty< T > &	getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
	Retrieve the property named "name" for the specified material_data. More...
template<typename T >
const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name, MaterialData &material_data)
	Retrieve the AD property named "name" for the specified material_data. More...
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
	Retrieve the old property deduced from the name name for the specified material_data. More...
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
	Retrieve the older property deduced from the name name for the specified material_data. More...
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
	Retrieve the generic property named "name" without any deduction for the specified material_data for state state. More...
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
	Retrieve the property named "name" without any deduction for the specified material_data. More...
template<typename T >
const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
	Retrieve the AD property named "name" without any deduction for the specified material_data. More...
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
	Retrieve the old property named name without any deduction for the specified material_data. More...
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
	Retrieve the older property named name without any deduction for the specified material_data. More...
template<typename T , unsigned int dimension = 0, unsigned int state = 0>
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyByName (const std::string &prop_name_in)
	Get a Kokkos material property by property name for any state. More...
template<typename T , unsigned int dimension = 0>
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOldByName (const std::string &prop_name)
	Get an old Kokkos material property by property name. More...
template<typename T , unsigned int dimension = 0>
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlderByName (const std::string &prop_name)
	Get an older Kokkos material property by property name. More...
template<typename T , unsigned int dimension = 0, unsigned int state = 0>
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialProperty (const std::string &name)
	Get a Kokkos material property for any state. More...
template<typename T , unsigned int dimension = 0>
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOld (const std::string &name)
	Get an old Kokkos material property. More...
template<typename T , unsigned int dimension = 0>
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlder (const std::string &name)
	Get an older Kokkos material property. More...
template<typename T >
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)
	Retrieve pointer to a material property with the mesh blocks where it is defined The name required by this method is the name defined in the input file. More...
template<typename T , unsigned int dimension = 0, unsigned int state = 0>
std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > >	getKokkosBlockMaterialProperty (const MaterialPropertyName &name)
	Retrieve a Kokkos material property with the mesh blocks where it is defined NOTE: This is not a drop-in replacement of getBlockMaterialProperty(). More...
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty (const std::string &name)
	Return a material property that is initialized to zero by default and does not need to (but can) be declared by another material. More...
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()
	Return a constant zero anonymous material property. More...
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialPropertyByName (const std::string &prop_name)
template<typename T , typename... Ts>
const MaterialProperty< T > &	getZeroMaterialProperty (Ts... args)
	for backwards compatibility More...
std::set< SubdomainID >	getMaterialPropertyBlocks (const std::string &name)
	Retrieve the block ids that the material property is defined. More...
std::vector< SubdomainName >	getMaterialPropertyBlockNames (const std::string &name)
	Retrieve the block names that the material property is defined. More...
std::set< BoundaryID >	getMaterialPropertyBoundaryIDs (const std::string &name)
	Retrieve the boundary ids that the material property is defined. More...
std::vector< BoundaryName >	getMaterialPropertyBoundaryNames (const std::string &name)
	Retrieve the boundary namess that the material property is defined. More...
void	checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
	Check if block and boundary restrictions of a given material are compatible with the current material. More...
std::unordered_map< SubdomainID, std::vector< MaterialBase * > >	buildRequiredMaterials (bool allow_stateful=true)
	get a map of MaterialBase pointers for all material objects that this object depends on for each block More...
void	statefulPropertiesAllowed (bool)
	Derived classes can declare whether or not they work with stateful material properties. More...
virtual bool	getMaterialPropertyCalled () const
	Returns true if getMaterialProperty() has been called, false otherwise. More...
virtual const std::unordered_set< unsigned int > &	getMatPropDependencies () const
	Retrieve the set of material properties that this object depends on. More...
virtual void	resolveOptionalProperties ()
	resolve all optional properties More...
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
	Retrieve the generic property named "prop_name" without any deduction for the specified material_data for state state. More...
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericNeighborMaterialProperty (const std::string &name, const unsigned int state=0)
	Retrieve the neighbor property deduced from the name name. More...
template<typename T >
const MaterialProperty< T > &	getNeighborMaterialProperty (const std::string &name, const unsigned int state=0)
template<typename T >
const ADMaterialProperty< T > &	getNeighborADMaterialProperty (const std::string &name)
template<typename T >
const MaterialProperty< T > &	getNeighborMaterialPropertyOld (const std::string &name)
template<typename T >
const MaterialProperty< T > &	getNeighborMaterialPropertyOlder (const std::string &name)
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericNeighborMaterialPropertyByName (const std::string &name, const unsigned int state=0)
	Retrieve the neighbor property named "name" without any deduction. More...
template<typename T >
const MaterialProperty< T > &	getNeighborMaterialPropertyByName (const std::string &name, const unsigned int state=0)
template<typename T >
const ADMaterialProperty< T > &	getNeighborADMaterialPropertyByName (const std::string &name)
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
	Retrieve reference to material property or one of it's old or older values. More...
template<typename T >
const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)
template<typename T >
const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
	Retrieve reference to material property or its old or older value The name required by this method is the name defined in the input file. More...
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
template<typename T >
const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)
template<typename T , bool is_ad>
const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
template<typename T >
const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
template<typename T >
const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)
template<typename T >
const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)
template<typename T >
const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)
MaterialBase &	getMaterial (const std::string &name)
	Return a MaterialBase reference - usable for computing directly. More...
MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)
template<typename T >
bool	hasMaterialProperty (const std::string &name)
	Check if the material property exists. More...
template<typename T >
bool	hasMaterialPropertyByName (const std::string &name)
template<typename T >
bool	hasADMaterialProperty (const std::string &name)
template<typename T >
bool	hasADMaterialPropertyByName (const std::string &name)
template<typename T , unsigned int dimension = 0>
bool	hasKokkosMaterialProperty (const std::string &name)
template<typename T , unsigned int dimension = 0>
bool	hasKokkosMaterialPropertyByName (const std::string &name)
template<typename T , bool is_ad>
bool	hasGenericMaterialProperty (const std::string &name)
	generic hasMaterialProperty helper More...
template<typename T , bool is_ad>
bool	hasGenericMaterialPropertyByName (const std::string &name)

Static Public Member Functions
static InputParameters	validParams ()

Static Public Attributes
static constexpr PropertyValue::id_type	default_property_id
	The material property ID for a default (parsed from input) property. More...
static constexpr PropertyValue::id_type	zero_property_id = PropertyValue::invalid_property_id - 2
	The material property ID for a zero property. More...

Protected Member Functions
virtual void	checkMaterialProperty (const std::string &name, const unsigned int state)
	A helper method for checking material properties This method was required to avoid a compiler problem with the template getMaterialProperty method. More...
virtual void	getKokkosMaterialPropertyHook (const std::string &, const unsigned int)
	A virtual method that can be overriden by Kokkos objects to insert additional operations in getKokkosMaterialProperty. More...
void	markMatPropRequested (const std::string &)
	A proxy method for _mi_feproblem.markMatPropRequested(name) More...
MaterialPropertyName	getMaterialPropertyName (const std::string &name) const
void	checkExecutionStage ()
	Check and throw an error if the execution has progressed past the construction stage. More...
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)
template<typename T >
const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)
template<typename T >
const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

Protected Attributes
MaterialData &	_face_material_data
MaterialData &	_neighbor_material_data
const InputParameters &	_mi_params
	Parameters of the object with this interface. More...
const std::string	_mi_name
	The name of the object that this interface belongs to. More...
const MooseObjectName	_mi_moose_object_name
	The "complete" name of the object that this interface belongs for material property output. More...
FEProblemBase &	_mi_feproblem
	Reference to the FEProblemBase class. More...
SubProblem &	_mi_subproblem
	Reference to the subproblem. More...
const THREAD_ID	_mi_tid
	Current threaded it. More...
const bool	_is_kokkos_object
	Whether the MOOSE object is a Kokkos object. More...
const Moose::MaterialDataType	_material_data_type
	The type of data. More...
MaterialData &	_material_data
	The material data class that stores properties. More...
bool	_stateful_allowed
	True by default. More...
bool	_get_material_property_called
	Initialized to false. More...
std::vector< std::unique_ptr< PropertyValue > >	_default_properties
	Storage vector for default properties. More...
std::unordered_set< unsigned int >	_material_property_dependencies
	The set of material properties (as given by their IDs) that this object depends on. More...
const MaterialPropertyName	_get_suffix
const bool	_use_interpolated_state
	Use the interpolated state set up through the ProjectedStatefulMaterialStorageAction. More...

Static Protected Attributes
static const std::string	_interpolated_old = "_interpolated_old"
	name suffixes for interpolated old and older properties More...
static const std::string	_interpolated_older = "_interpolated_older"

Detailed Description

This interface is designed currently for DomainUserObject where material properties on element, face and neighboring face may all required.

It can be used in the future by objects having similar requirements as DomainUserObject. The base interface TwoMaterialPropertyInterface only provides functions to retrieve material properties on sides of its primary side (face) and its secondary side (neighbor).

Definition at line 24 of file ThreeMaterialPropertyInterface.h.

Constructor & Destructor Documentation

ThreeMaterialPropertyInterface()

ThreeMaterialPropertyInterface::ThreeMaterialPropertyInterface	(	const MooseObject *	moose_object,
		const std::set< SubdomainID > &	blocks_ids,
		const std::set< BoundaryID > &	boundary_ids
	)

Definition at line 25 of file ThreeMaterialPropertyInterface.C.

  : TwoMaterialPropertyInterface(moose_object, blocks_ids, boundary_ids),
    _face_material_data(_mi_feproblem.getMaterialData(
        Moose::FACE_MATERIAL_DATA, _mi_params.get<THREAD_ID>("_tid"), moose_object))
{
}

Member Function Documentation

buildRequiredMaterials()

std::unordered_map< SubdomainID, std::vector< MaterialBase * > > MaterialPropertyInterface::buildRequiredMaterials ( bool  allow_stateful = true )

inherited

get a map of MaterialBase pointers for all material objects that this object depends on for each block

Definition at line 243 of file MaterialPropertyInterface.C.

{
  std::unordered_map<SubdomainID, std::vector<MaterialBase *>> required_mats;
  const auto & mwh = _mi_feproblem.getMaterialWarehouse();
  for (const auto id : _mi_block_ids)
  {
    const auto & mats = mwh[_material_data_type].getActiveBlockObjects(id, _mi_tid);
    std::array<const MaterialPropertyInterface *, 1> consumers = {{this}};
    const auto block_required =
        MaterialBase::buildRequiredMaterials(consumers, mats, allow_stateful);
    required_mats[id].insert(
        required_mats[id].begin(), block_required.begin(), block_required.end());
  }
  return required_mats;
}

checkBlockAndBoundaryCompatibility()

void MaterialPropertyInterface::checkBlockAndBoundaryCompatibility ( std::shared_ptr< MaterialBase >  discrete )

inherited

Check if block and boundary restrictions of a given material are compatible with the current material.

Error out otherwise.

Definition at line 184 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getMaterialByName().

{
  // Check block compatibility
  if (!discrete->hasBlocks(_mi_block_ids))
  {
    std::ostringstream oss;
    oss << "Incompatible material and object blocks:";

    oss << "\n    " << discrete->parameters().paramLocationPrefix("block")
        << " material defined on blocks ";
    for (const auto & sbd_id : discrete->blockIDs())
      oss << sbd_id << ", ";

    oss << "\n    " << _mi_params.paramLocationPrefix("block")
        << " object needs material on blocks ";
    for (const auto & block_id : _mi_block_ids)
      oss << block_id << ", ";

    mooseError(oss.str());
  }

  // Check boundary compatibility
  if (!discrete->hasBoundary(_mi_boundary_ids))
  {
    std::ostringstream oss;
    oss << "Incompatible material and object boundaries:";

    oss << "\n    " << discrete->parameters().paramLocationPrefix("boundary")
        << " material defined on boundaries ";
    for (const auto & bnd_id : discrete->boundaryIDs())
      oss << bnd_id << ", ";

    oss << "\n    " << _mi_params.paramLocationPrefix("boundary")
        << " object needs material on boundaries ";
    for (const auto & bnd_id : _mi_boundary_ids)
      oss << bnd_id << ", ";

    mooseError(oss.str());
  }
}

checkExecutionStage()

void MaterialPropertyInterface::checkExecutionStage ( )

protectedinherited

Check and throw an error if the execution has progressed past the construction stage.

Definition at line 260 of file MaterialPropertyInterface.C.

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

{
  if (_mi_feproblem.startedInitialSetup())
    mooseError("Material properties must be retrieved during object construction. This is a code "
               "problem.");
}

checkMaterialProperty()

void MaterialPropertyInterface::checkMaterialProperty ( const std::string &  name, const unsigned int  state  )

protectedvirtualinherited

A helper method for checking material properties This method was required to avoid a compiler problem with the template getMaterialProperty method.

Reimplemented in Material, and Moose::Kokkos::Material.

Definition at line 155 of file MaterialPropertyInterface.C.

Referenced by Moose::Kokkos::Material::checkMaterialProperty(), Material::checkMaterialProperty(), MaterialPropertyInterface::getGenericMaterialPropertyByName(), and MaterialPropertyInterface::getKokkosMaterialPropertyByName().

{
  if (state == 0)
  {
    // If the material property is boundary restrictable, add to the list of materials to check
    if (_mi_boundary_restricted)
      for (const auto & bnd_id : _mi_boundary_ids)
        _mi_feproblem.storeBoundaryDelayedCheckMatProp(_mi_name, bnd_id, name);

    // The default is to assume block restrictions
    else
      for (const auto & blk_ids : _mi_block_ids)
        _mi_feproblem.storeSubdomainDelayedCheckMatProp(_mi_name, blk_ids, name);
  }
}

defaultADMaterialProperty()

template<typename T >

const ADMaterialProperty<T>* MaterialPropertyInterface::defaultADMaterialProperty ( const std::string &  name )

inlineprotectedinherited

Definition at line 653 of file MaterialPropertyInterface.h.

  {
    return defaultGenericMaterialProperty<T, true>(name);
  }

defaultGenericMaterialProperty()

template<typename T , bool is_ad>

const GenericMaterialProperty< T, is_ad > * MaterialPropertyInterface::defaultGenericMaterialProperty ( const std::string &  name )

protectedinherited

Returns

The default material property with the name name, if any.

"Default" properties are properties whose default values are set from within the name. That is, if we can cast name to a Real, and the prop type is a Real or RealVectorValue, we'll return said value.

Definition at line 750 of file MaterialPropertyInterface.h.

{
  if constexpr (std::is_same_v<T, Real> || std::is_same_v<T, RealVectorValue>)
  {
    std::istringstream ss(name);
    Real real_value;

    // check if the string parsed cleanly into a Real number
    if (ss >> real_value && ss.eof())
    {
      using prop_type = GenericMaterialProperty<T, is_ad>;

      const auto nqp = Moose::constMaxQpsPerElem;
      auto & property =
          _default_properties.emplace_back(std::make_unique<prop_type>(default_property_id));
      auto & T_property = static_cast<prop_type &>(*property);

      T_property.resize(nqp);
      for (const auto qp : make_range(nqp))
        T_property[qp] = real_value;

      return &T_property;
    }
  }

  return nullptr;
}

defaultMaterialProperty()

template<typename T >

const MaterialProperty<T>* MaterialPropertyInterface::defaultMaterialProperty ( const std::string &  name )

inlineprotectedinherited

Definition at line 648 of file MaterialPropertyInterface.h.

  {
    return defaultGenericMaterialProperty<T, false>(name);
  }

getADMaterialProperty() [1/2]

template<typename T >

const ADMaterialProperty<T>& MaterialPropertyInterface::getADMaterialProperty ( const std::string &  name )

inlineinherited

Definition at line 115 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialProperty<T, true>(name, 0);
  }

getADMaterialProperty() [2/2]

template<typename T >

const ADMaterialProperty<T>& MaterialPropertyInterface::getADMaterialProperty ( const std::string &  name, MaterialData &  material_data  )

inlineinherited

Retrieve the AD property named "name" for the specified material_data.

state is the property state; 0 = current, 1 = old, 2 = older, etc.

Definition at line 476 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialProperty<T, true>(name, material_data, 0);
  }

getADMaterialPropertyByName() [1/2]

template<typename T >

const ADMaterialProperty<T>& MaterialPropertyInterface::getADMaterialPropertyByName ( const MaterialPropertyName &  name )

inlineinherited

Definition at line 152 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialPropertyByName<T, true>(name, 0);
  }

getADMaterialPropertyByName() [2/2]

template<typename T >

const ADMaterialProperty<T>& MaterialPropertyInterface::getADMaterialPropertyByName ( const MaterialPropertyName &  name, MaterialData &  material_data  )

inlineinherited

Retrieve the AD property named "name" without any deduction for the specified material_data.

Definition at line 519 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialPropertyByName<T, true>(name, material_data, 0);
  }

getBlockMaterialProperty()

template<typename T >

std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > MaterialPropertyInterface::getBlockMaterialProperty ( const MaterialPropertyName &  name )

inherited

Retrieve pointer to a material property with the mesh blocks where it is defined The name required by this method is the name defined in the input file.

This function can be thought as the combination of getMaterialPropertyByName and getMaterialPropertyBlocks. It can be called after the action of all actions.

Parameters

name	The name of the material property to retrieve

Returns

Pointer to the material property with the name 'name' and the set of blocks where the property is valid

Definition at line 780 of file MaterialPropertyInterface.h.

{
  if (_mi_block_ids.empty())
    mooseError("getBlockMaterialProperty must be called by a block restrictable object");

  const auto name = _get_suffix.empty()
                        ? static_cast<const std::string &>(name_in)
                        : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");

  using pair_type = std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>;

  if (!hasMaterialPropertyByName<T>(name))
    return pair_type(nullptr, {});

  // Call first so that the ID gets registered
  const auto & prop = _material_data.getProperty<T, false>(name, 0, _mi_moose_object);
  auto blocks = getMaterialPropertyBlocks(name);
  auto prop_blocks_pair = pair_type(&prop, std::move(blocks));

  _material_property_dependencies.insert(_material_data.getPropertyId(name));

  // Update consumed properties in MaterialPropertyDebugOutput
  addConsumedPropertyName(_mi_moose_object_name, name);

  return prop_blocks_pair;
}

getFaceADMaterialProperty()

template<typename T >

const ADMaterialProperty< T > & ThreeMaterialPropertyInterface::getFaceADMaterialProperty

(

const std::string &

name

)

Retrieve the ADMaterialProperty named "name".

Definition at line 89 of file ThreeMaterialPropertyInterface.h.

{
  return getADMaterialProperty<T>(name, _face_material_data);
}

getFaceMaterialProperty()

template<typename T >

const MaterialProperty< T > & ThreeMaterialPropertyInterface::getFaceMaterialProperty

(

const std::string &

name

)

Retrieve the property deduced from the name name.

Definition at line 75 of file ThreeMaterialPropertyInterface.h.

{
  return getMaterialProperty<T>(name, _face_material_data);
}

getFaceMaterialPropertyByName()

template<typename T >

const MaterialProperty< T > & ThreeMaterialPropertyInterface::getFaceMaterialPropertyByName

(

const std::string &

name

)

Retrieve the property named "name" without any deduction.

Definition at line 82 of file ThreeMaterialPropertyInterface.h.

{
  return getMaterialPropertyByName<T>(name, _face_material_data);
}

getFaceMaterialPropertyOld()

template<typename T >

const MaterialProperty< T > & ThreeMaterialPropertyInterface::getFaceMaterialPropertyOld

(

const std::string &

name

)

Definition at line 96 of file ThreeMaterialPropertyInterface.h.

{
  return getMaterialPropertyOld<T>(name, _face_material_data);
}

getFaceMaterialPropertyOlder()

template<typename T >

const MaterialProperty< T > & ThreeMaterialPropertyInterface::getFaceMaterialPropertyOlder

(

const std::string &

name

)

Definition at line 103 of file ThreeMaterialPropertyInterface.h.

{
  return getMaterialPropertyOlder<T>(name, _face_material_data);
}

getGenericFaceMaterialProperty()

template<typename T , bool is_ad>

const auto& ThreeMaterialPropertyInterface::getGenericFaceMaterialProperty ( const std::string &  name )

inline

Retrieve the face material property whether AD or not.

Definition at line 61 of file ThreeMaterialPropertyInterface.h.

  {
    if constexpr (is_ad)
      return getFaceADMaterialProperty<T>(name);
    else
      return getFaceMaterialProperty<T>(name);
  }

getGenericMaterialProperty() [1/2]

template<typename T , bool is_ad>

const GenericMaterialProperty<T, is_ad>& MaterialPropertyInterface::getGenericMaterialProperty ( const std::string &  name, const unsigned int  state = 0  )

inlineinherited

Retrieve reference to material property or one of it's old or older values.

The name required by this method is the name that is hard-coded into your source code as the input parameter key. If no input parameter is found this behaves like the getMaterialPropertyByName family as a fall back.

Parameters

name	The name of the parameter key of the material property to retrieve
state	The state (current = 0, old = 1, older = 2)

Returns

Reference to the desired material property

Definition at line 103 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialProperty<T, is_ad>(name, _material_data, state);
  }

getGenericMaterialProperty() [2/2]

template<typename T , bool is_ad>

const GenericMaterialProperty< T, is_ad > & MaterialPropertyInterface::getGenericMaterialProperty ( const std::string &  name, MaterialData &  material_data, const unsigned int  state = 0  )

inherited

Retrieve the generic property named "name" for the specified material_data at state state.

Definition at line 921 of file MaterialPropertyInterface.h.

{
  // Check if the supplied parameter is a valid input parameter key
  const auto prop_name = getMaterialPropertyName(name);

  return getPossiblyConstantGenericMaterialPropertyByName<T, is_ad>(
      prop_name, material_data, state);
}

getGenericMaterialPropertyByName() [1/2]

template<typename T , bool is_ad>

const GenericMaterialProperty<T, is_ad>& MaterialPropertyInterface::getGenericMaterialPropertyByName ( const MaterialPropertyName &  name, const unsigned int  state = 0  )

inlineinherited

Retrieve reference to material property or its old or older value The name required by this method is the name defined in the input file.

Parameters

name	The name of the material property to retrieve
state	The state (current = 0, old = 1, older = 2)

Returns

Reference to the material property with the name 'name'

Definition at line 141 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialPropertyByName<T, is_ad>(name, _material_data, state);
  }

getGenericMaterialPropertyByName() [2/2]

template<typename T , bool is_ad>

const GenericMaterialProperty< T, is_ad > & MaterialPropertyInterface::getGenericMaterialPropertyByName ( const MaterialPropertyName &  name, MaterialData &  material_data, const unsigned int  state  )

inherited

Retrieve the generic property named "name" without any deduction for the specified material_data for state state.

Definition at line 934 of file MaterialPropertyInterface.h.

{
#ifdef MOOSE_KOKKOS_ENABLED
  if (_is_kokkos_object)
    _mi_moose_object.mooseError(
        "Attempted to retrieve a standard MOOSE material property from a Kokkos object.");
#endif

  if (_use_interpolated_state)
  {
    if (state == 1)
      return getGenericMaterialPropertyByName<T, is_ad>(
          name_in + _interpolated_old, material_data, 0);
    if (state == 2)
      return getGenericMaterialPropertyByName<T, is_ad>(
          name_in + _interpolated_older, material_data, 0);
  }

  const auto name = _get_suffix.empty()
                        ? static_cast<const std::string &>(name_in)
                        : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");

  checkExecutionStage();
  checkMaterialProperty(name, state);

  // mark property as requested
  markMatPropRequested(name);

  // Update the boolean flag.
  _get_material_property_called = true;

  // Call first so that the ID gets registered
  auto & prop = material_data.getProperty<T, is_ad>(name, state, _mi_moose_object);

  // Does the material data used here matter?
  _material_property_dependencies.insert(material_data.getPropertyId(name));

  if (state == 0)
    addConsumedPropertyName(_mi_moose_object_name, name);

  return prop;
}

getGenericNeighborMaterialProperty()

template<typename T , bool is_ad>

const GenericMaterialProperty<T, is_ad>& TwoMaterialPropertyInterface::getGenericNeighborMaterialProperty ( const std::string &  name, const unsigned int  state = 0  )

inlineinherited

Retrieve the neighbor property deduced from the name name.

state is the property state; 0 = current, 1 = old, 2 = older, etc.

Definition at line 39 of file TwoMaterialPropertyInterface.h.

  {
    return getGenericMaterialProperty<T, is_ad>(name, _neighbor_material_data, state);
  }

getGenericNeighborMaterialPropertyByName()

template<typename T , bool is_ad>

const GenericMaterialProperty<T, is_ad>& TwoMaterialPropertyInterface::getGenericNeighborMaterialPropertyByName ( const std::string &  name, const unsigned int  state = 0  )

inlineinherited

Retrieve the neighbor property named "name" without any deduction.

state is the property state; 0 = current, 1 = old, 2 = older, etc.

Definition at line 74 of file TwoMaterialPropertyInterface.h.

  {
    return getGenericMaterialPropertyByName<T, is_ad>(name, _neighbor_material_data, state);
  }

getGenericOptionalMaterialProperty()

template<typename T , bool is_ad>

const GenericOptionalMaterialProperty< T, is_ad > & MaterialPropertyInterface::getGenericOptionalMaterialProperty ( const std::string &  name, const unsigned int  state = 0  )

inherited

Optional material property getters state is the property state; 0 = current, 1 = old, 2 = older, etc.

Definition at line 886 of file MaterialPropertyInterface.h.

{
  auto proxy = std::make_unique<OptionalMaterialPropertyProxy<MaterialPropertyInterface, T, is_ad>>(
      name, state);
  auto & optional_property = proxy->value();
  _optional_property_proxies.push_back(std::move(proxy));
  return optional_property;
}

getGenericZeroMaterialProperty() [1/2]

template<typename T , bool is_ad>

const GenericMaterialProperty< T, is_ad > & MaterialPropertyInterface::getGenericZeroMaterialProperty ( const std::string &  name )

inherited

Return a material property that is initialized to zero by default and does not need to (but can) be declared by another material.

Definition at line 828 of file MaterialPropertyInterface.h.

{
  const auto prop_name = getMaterialPropertyName(name);
  return getGenericZeroMaterialPropertyByName<T, is_ad>(prop_name);
}

getGenericZeroMaterialProperty() [2/2]

template<typename T , bool is_ad>

const GenericMaterialProperty< T, is_ad > & MaterialPropertyInterface::getGenericZeroMaterialProperty ( )

inherited

Return a constant zero anonymous material property.

Definition at line 847 of file MaterialPropertyInterface.h.

{
  // static zero property storage
  static GenericMaterialProperty<T, is_ad> zero(zero_property_id);

  // resize to accomodate maximum number of qpoints
  // (in multiapp scenarios getMaxQps can return different values in each app; we need the max)
  unsigned int nqp = getMaxQps();
  if (nqp > zero.size())
    zero.resize(nqp);

  // set values for all qpoints to zero
  for (unsigned int qp = 0; qp < nqp; ++qp)
    MathUtils::mooseSetToZero(zero[qp]);

  return zero;
}

getGenericZeroMaterialPropertyByName()

template<typename T , bool is_ad>

const GenericMaterialProperty< T, is_ad > & MaterialPropertyInterface::getGenericZeroMaterialPropertyByName ( const std::string &  prop_name )

inherited

Definition at line 836 of file MaterialPropertyInterface.h.

{
  // if found return the requested property
  if (hasGenericMaterialPropertyByName<T, is_ad>(prop_name))
    return getGenericMaterialPropertyByName<T, is_ad>(prop_name);

  return getGenericZeroMaterialProperty<T, is_ad>();
}

getKokkosBlockMaterialProperty()

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

std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > > MaterialPropertyInterface::getKokkosBlockMaterialProperty ( const MaterialPropertyName &  name )

inherited

Retrieve a Kokkos material property with the mesh blocks where it is defined NOTE: This is not a drop-in replacement of getBlockMaterialProperty().

Unlike the original API, this function cannot be called after object construction

Template Parameters

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

Parameters

name	The name of the material property to retrieve

Returns

The Kokkos material property with the name 'name' and the set of blocks where the property is valid

Definition at line 1047 of file MaterialPropertyInterface.h.

{
  if (!_is_kokkos_object)
    _mi_moose_object.mooseError(
        "Attempted to retrieve a Kokkos material property from a standard MOOSE object.");

  if (_mi_block_ids.empty())
    mooseError("getKokkosBlockMaterialProperty must be called by a block restrictable object");

  const auto name = _get_suffix.empty()
                        ? static_cast<const std::string &>(name_in)
                        : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");

  using pair_type = std::pair<Moose::Kokkos::MaterialProperty<T, dimension>, std::set<SubdomainID>>;

  if (!hasKokkosMaterialPropertyByName<T, dimension>(name))
    return pair_type(Moose::Kokkos::MaterialProperty<T, dimension>(), {});

  checkExecutionStage();

  // Mark property as requested
  markMatPropRequested(name);

  // Call first so that the ID gets registered
  auto prop = _material_data.getKokkosProperty<T, dimension, state>(name);
  auto blocks = getMaterialPropertyBlocks(name);
  auto prop_blocks_pair = pair_type(prop, std::move(blocks));

  _material_property_dependencies.insert(_material_data.getPropertyId(name));

  // Update consumed properties in MaterialPropertyDebugOutput
  if constexpr (state == 0)
    addConsumedPropertyName(_mi_moose_object_name, name);

  getKokkosMaterialPropertyHook(name_in, state);

  return prop_blocks_pair;
}

getKokkosMaterialProperty()

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

Moose::Kokkos::MaterialProperty<T, dimension> MaterialPropertyInterface::getKokkosMaterialProperty ( const std::string &  name )

inlineinherited

Get a Kokkos material property for any state.

Template Parameters

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

Parameters

name	The property name or the parameter name containing the property name

Returns

The Kokkos material property

Definition at line 215 of file MaterialPropertyInterface.h.

  {
    return getKokkosMaterialPropertyByName<T, dimension, state>(getMaterialPropertyName(name));
  }

getKokkosMaterialPropertyByName()

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

Moose::Kokkos::MaterialProperty< T, dimension > MaterialPropertyInterface::getKokkosMaterialPropertyByName ( const std::string &  prop_name_in )

inherited

Get a Kokkos material property by property name for any state.

Template Parameters

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

Parameters

prop_name_in

The property name

Returns

The Kokkos material property

Definition at line 1001 of file MaterialPropertyInterface.h.

{
  if (!_is_kokkos_object)
    _mi_moose_object.mooseError(
        "Attempted to retrieve a Kokkos material property from a standard MOOSE object.");

  if constexpr (std::is_same_v<T, Real>)
  {
    std::istringstream ss(prop_name_in);
    Real value;

    // Check if the string parsed cleanly into a Real number
    if (ss >> value && ss.eof())
      return Moose::Kokkos::MaterialProperty<T, dimension>(value);
  }

  const auto prop_name =
      _get_suffix.empty()
          ? static_cast<const std::string &>(prop_name_in)
          : MooseUtils::join(std::vector<std::string>({prop_name_in, _get_suffix}), "_");

  checkExecutionStage();
  checkMaterialProperty(prop_name, state);

  // Mark property as requested
  markMatPropRequested(prop_name);

  // Update the boolean flag
  _get_material_property_called = true;

  // Call first so that the ID gets registered
  auto prop = _material_data.getKokkosProperty<T, dimension, state>(prop_name);

  // Does the material data used here matter?
  _material_property_dependencies.insert(_material_data.getPropertyId(prop_name));

  if constexpr (state == 0)
    addConsumedPropertyName(_mi_moose_object_name, prop_name);

  getKokkosMaterialPropertyHook(prop_name_in, state);

  return prop;
}

getKokkosMaterialPropertyHook()

virtual void MaterialPropertyInterface::getKokkosMaterialPropertyHook ( const std::string &  , const unsigned int    )

inlineprotectedvirtualinherited

A virtual method that can be overriden by Kokkos objects to insert additional operations in getKokkosMaterialProperty.

Parameters

prop_name_in	The property name
state	The property state

Reimplemented in Moose::Kokkos::AuxKernel, and Moose::Kokkos::Material.

Definition at line 616 of file MaterialPropertyInterface.h.

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

  {
  }

getKokkosMaterialPropertyOld()

template<typename T , unsigned int dimension = 0>

Moose::Kokkos::MaterialProperty<T, dimension> MaterialPropertyInterface::getKokkosMaterialPropertyOld ( const std::string &  name )

inlineinherited

Get an old Kokkos material property.

Template Parameters

T	The property data type
dimension	The property dimension

Parameters

name	The property name or the parameter name containing the property name

Returns

The Kokkos material property

Definition at line 228 of file MaterialPropertyInterface.h.

  {
    return getKokkosMaterialPropertyByName<T, dimension, 1>(getMaterialPropertyName(name));
  }

getKokkosMaterialPropertyOldByName()

template<typename T , unsigned int dimension = 0>

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

inlineinherited

Get an old Kokkos material property by property name.

Template Parameters

T	The property data type
dimension	The property dimension

Parameters

prop_name

The property name

Returns

The Kokkos material property

Definition at line 189 of file MaterialPropertyInterface.h.

  {
    return getKokkosMaterialPropertyByName<T, dimension, 1>(prop_name);
  }

getKokkosMaterialPropertyOlder()

template<typename T , unsigned int dimension = 0>

Moose::Kokkos::MaterialProperty<T, dimension> MaterialPropertyInterface::getKokkosMaterialPropertyOlder ( const std::string &  name )

inlineinherited

Get an older Kokkos material property.

Template Parameters

T	The property data type
dimension	The property dimension

Parameters

name	The property name or the parameter name containing the property name

Returns

The Kokkos material property

Definition at line 241 of file MaterialPropertyInterface.h.

  {
    return getKokkosMaterialPropertyByName<T, dimension, 2>(getMaterialPropertyName(name));
  }

getKokkosMaterialPropertyOlderByName()

template<typename T , unsigned int dimension = 0>

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

inlineinherited

Get an older Kokkos material property by property name.

Template Parameters

T	The property data type
dimension	The property dimension

Parameters

prop_name

The property name

Returns

The Kokkos material property

Definition at line 202 of file MaterialPropertyInterface.h.

  {
    return getKokkosMaterialPropertyByName<T, dimension, 2>(prop_name);
  }

getMaterial()

MaterialBase & MaterialPropertyInterface::getMaterial ( const std::string &  name )

inherited

Return a MaterialBase reference - usable for computing directly.

Parameters

name	The name of the input parameter or explicit material name.
no_warn	If true, suppress warning about retrieving the material potentially during its calculation. If you don't know what this is/means, then you don't need it.

Definition at line 227 of file MaterialPropertyInterface.C.

{
  return getMaterialByName(_mi_params.get<MaterialName>(name));
}

getMaterialByName()

MaterialBase & MaterialPropertyInterface::getMaterialByName ( const std::string &  name, bool  no_warn = false  )

inherited

Definition at line 233 of file MaterialPropertyInterface.C.

Referenced by ElementMaterialSampler::ElementMaterialSampler(), MaterialPropertyInterface::getMaterial(), and Material::getMaterialByName().

{
  std::shared_ptr<MaterialBase> discrete =
      _mi_feproblem.getMaterial(name, _material_data_type, _mi_tid, no_warn);

  checkBlockAndBoundaryCompatibility(discrete);
  return *discrete;
}

getMaterialProperty() [1/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialProperty ( const std::string &  name, const unsigned int  state = 0  )

inlineinherited

Definition at line 109 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialProperty<T, false>(name, state);
  }

getMaterialProperty() [2/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialProperty ( const std::string &  name, MaterialData &  material_data, const unsigned int  state = 0  )

inlineinherited

Retrieve the property named "name" for the specified material_data.

state is the property state; 0 = current, 1 = old, 2 = older, etc.

Definition at line 463 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialProperty<T, false>(name, material_data, state);
  }

getMaterialPropertyBlockNames()

std::vector< SubdomainName > MaterialPropertyInterface::getMaterialPropertyBlockNames ( const std::string &  name )

inherited

Retrieve the block names that the material property is defined.

Parameters

name	The name of the material property

Returns

A vector the the block names for the property

Definition at line 124 of file MaterialPropertyInterface.C.

{
  return _mi_feproblem.getMaterialPropertyBlockNames(name);
}

getMaterialPropertyBlocks()

std::set< SubdomainID > MaterialPropertyInterface::getMaterialPropertyBlocks ( const std::string &  name )

inherited

Retrieve the block ids that the material property is defined.

Parameters

name	The name of the material property

Returns

A vector the the block ids for the property

Definition at line 118 of file MaterialPropertyInterface.C.

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

{
  return _mi_feproblem.getMaterialPropertyBlocks(name);
}

getMaterialPropertyBoundaryIDs()

std::set< BoundaryID > MaterialPropertyInterface::getMaterialPropertyBoundaryIDs ( const std::string &  name )

inherited

Retrieve the boundary ids that the material property is defined.

Parameters

name	The name of the material property

Returns

A vector the the boundary ids for the property

Definition at line 130 of file MaterialPropertyInterface.C.

{
  return _mi_feproblem.getMaterialPropertyBoundaryIDs(name);
}

getMaterialPropertyBoundaryNames()

std::vector< BoundaryName > MaterialPropertyInterface::getMaterialPropertyBoundaryNames ( const std::string &  name )

inherited

Retrieve the boundary namess that the material property is defined.

Parameters

name	The name of the material property

Returns

A vector the the boundary names for the property

Definition at line 136 of file MaterialPropertyInterface.C.

{
  return _mi_feproblem.getMaterialPropertyBoundaryNames(name);
}

getMaterialPropertyByName() [1/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyByName ( const MaterialPropertyName &  name, const unsigned int  state = 0  )

inlineinherited

Definition at line 146 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialPropertyByName<T, false>(name, state);
  }

getMaterialPropertyByName() [2/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyByName ( const MaterialPropertyName &  name, MaterialData &  material_data, const unsigned int  state = 0  )

inlineinherited

Retrieve the property named "name" without any deduction for the specified material_data.

state is the property state; 0 = current, 1 = old, 2 = older, etc.

Definition at line 507 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialPropertyByName<T, false>(name, material_data, state);
  }

getMaterialPropertyCalled()

virtual bool MaterialPropertyInterface::getMaterialPropertyCalled ( ) const

inlinevirtualinherited

Returns true if getMaterialProperty() has been called, false otherwise.

Reimplemented in IPHDGKernel, and IPHDGBC.

Definition at line 434 of file MaterialPropertyInterface.h.

Referenced by IPHDGBC::getMaterialPropertyCalled(), and IPHDGKernel::getMaterialPropertyCalled().

{ return _get_material_property_called; }

getMaterialPropertyName()

MaterialPropertyName MaterialPropertyInterface::getMaterialPropertyName ( const std::string &  name ) const

protectedinherited

Returns

The name of the material property associated with name name.

If name is the name of a material property parameter and the parameter is valid, this will return the value of said parameter. Otherwise, it will just return the name.

Definition at line 110 of file MaterialPropertyInterface.C.

Referenced by InterfaceMaterial::getGenericMaterialProperty(), Material::getGenericMaterialProperty(), MaterialPropertyInterface::getGenericMaterialProperty(), InterfaceMaterial::getGenericNeighborMaterialProperty(), MaterialPropertyInterface::getGenericZeroMaterialProperty(), MaterialPropertyInterface::getKokkosMaterialProperty(), MaterialPropertyInterface::getKokkosMaterialPropertyOld(), MaterialPropertyInterface::getKokkosMaterialPropertyOlder(), MaterialPropertyInterface::hasADMaterialProperty(), MaterialPropertyInterface::hasKokkosMaterialProperty(), and MaterialPropertyInterface::hasMaterialProperty().

{
  if (_mi_params.have_parameter<MaterialPropertyName>(name) && _mi_params.isParamValid(name))
    return _mi_params.get<MaterialPropertyName>(name);
  return name;
}

getMaterialPropertyOld() [1/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyOld ( const std::string &  name )

inlineinherited

Definition at line 120 of file MaterialPropertyInterface.h.

  {
    return getMaterialProperty<T>(name, 1);
  }

getMaterialPropertyOld() [2/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyOld ( const std::string &  name, MaterialData &  material_data  )

inlineinherited

Retrieve the old property deduced from the name name for the specified material_data.

Definition at line 529 of file MaterialPropertyInterface.h.

  {
    return getMaterialProperty<T>(name, material_data, 1);
  }

getMaterialPropertyOldByName() [1/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyOldByName ( const MaterialPropertyName &  name )

inlineinherited

Definition at line 157 of file MaterialPropertyInterface.h.

  {
    return getMaterialPropertyByName<T>(name, 1);
  }

getMaterialPropertyOldByName() [2/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyOldByName ( const MaterialPropertyName &  name, MaterialData &  material_data  )

inlineinherited

Retrieve the old property named name without any deduction for the specified material_data.

Definition at line 551 of file MaterialPropertyInterface.h.

  {
    return getMaterialPropertyByName<T>(name, material_data, 1);
  }

getMaterialPropertyOlder() [1/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyOlder ( const std::string &  name )

inlineinherited

Definition at line 125 of file MaterialPropertyInterface.h.

  {
    return getMaterialProperty<T>(name, 2);
  }

getMaterialPropertyOlder() [2/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyOlder ( const std::string &  name, MaterialData &  material_data  )

inlineinherited

Retrieve the older property deduced from the name name for the specified material_data.

Definition at line 540 of file MaterialPropertyInterface.h.

  {
    return getMaterialProperty<T>(name, material_data, 2);
  }

getMaterialPropertyOlderByName() [1/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyOlderByName ( const MaterialPropertyName &  name )

inlineinherited

Definition at line 162 of file MaterialPropertyInterface.h.

  {
    return getMaterialPropertyByName<T>(name, 2);
  }

getMaterialPropertyOlderByName() [2/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyOlderByName ( const MaterialPropertyName &  name, MaterialData &  material_data  )

inlineinherited

Retrieve the older property named name without any deduction for the specified material_data.

Definition at line 562 of file MaterialPropertyInterface.h.

  {
    return getMaterialPropertyByName<T>(name, material_data, 2);
  }

getMatPropDependencies()

virtual const std::unordered_set<unsigned int>& MaterialPropertyInterface::getMatPropDependencies ( ) const

inlinevirtualinherited

Retrieve the set of material properties that this object depends on.

Returns

The IDs corresponding to the material properties that MUST be reinited before evaluating this object

Reimplemented in Material, InterfaceMaterial, Moose::Kokkos::Material, IPHDGKernel, and IPHDGBC.

Definition at line 442 of file MaterialPropertyInterface.h.

Referenced by IPHDGBC::getMatPropDependencies(), IPHDGKernel::getMatPropDependencies(), Moose::Kokkos::Material::getMatPropDependencies(), InterfaceMaterial::getMatPropDependencies(), Material::getMatPropDependencies(), NodalPatchRecovery::reinitPatch(), ComputeUserObjectsThread::subdomainChanged(), and MooseObjectWarehouseBase< Indicator >::updateMatPropDependencyHelper().

  {
    return _material_property_dependencies;
  }

getNeighborADMaterialProperty()

template<typename T >

const ADMaterialProperty<T>& TwoMaterialPropertyInterface::getNeighborADMaterialProperty ( const std::string &  name )

inlineinherited

Definition at line 50 of file TwoMaterialPropertyInterface.h.

  {
    return getGenericNeighborMaterialProperty<T, true>(name, 0);
  }

getNeighborADMaterialPropertyByName()

template<typename T >

const ADMaterialProperty<T>& TwoMaterialPropertyInterface::getNeighborADMaterialPropertyByName ( const std::string &  name )

inlineinherited

Definition at line 85 of file TwoMaterialPropertyInterface.h.

  {
    return getGenericNeighborMaterialPropertyByName<T, true>(name, 0);
  }

getNeighborMaterialProperty()

template<typename T >

const MaterialProperty<T>& TwoMaterialPropertyInterface::getNeighborMaterialProperty ( const std::string &  name, const unsigned int  state = 0  )

inlineinherited

Definition at line 44 of file TwoMaterialPropertyInterface.h.

  {
    return getGenericNeighborMaterialProperty<T, false>(name, state);
  }

getNeighborMaterialPropertyByName()

template<typename T >

const MaterialProperty<T>& TwoMaterialPropertyInterface::getNeighborMaterialPropertyByName ( const std::string &  name, const unsigned int  state = 0  )

inlineinherited

Definition at line 79 of file TwoMaterialPropertyInterface.h.

  {
    return getGenericNeighborMaterialPropertyByName<T, false>(name, state);
  }

getNeighborMaterialPropertyOld()

template<typename T >

const MaterialProperty<T>& TwoMaterialPropertyInterface::getNeighborMaterialPropertyOld ( const std::string &  name )

inlineinherited

Definition at line 55 of file TwoMaterialPropertyInterface.h.

  {
    return getGenericNeighborMaterialProperty<T, false>(name, 1);
  }

getNeighborMaterialPropertyOlder()

template<typename T >

const MaterialProperty<T>& TwoMaterialPropertyInterface::getNeighborMaterialPropertyOlder ( const std::string &  name )

inlineinherited

Definition at line 60 of file TwoMaterialPropertyInterface.h.

  {
    return getGenericNeighborMaterialProperty<T, false>(name, 2);
  }

getOptionalADMaterialProperty()

template<typename T >

const OptionalADMaterialProperty<T>& MaterialPropertyInterface::getOptionalADMaterialProperty ( const std::string &  name )

inlineinherited

Definition at line 260 of file MaterialPropertyInterface.h.

  {
    return getGenericOptionalMaterialProperty<T, true>(name);
  }

getOptionalMaterialProperty()

template<typename T >

const OptionalMaterialProperty<T>& MaterialPropertyInterface::getOptionalMaterialProperty ( const std::string &  name, const unsigned int  state = 0  )

inlineinherited

Definition at line 254 of file MaterialPropertyInterface.h.

  {
    return getGenericOptionalMaterialProperty<T, false>(name, state);
  }

getOptionalMaterialPropertyOld()

template<typename T >

const OptionalMaterialProperty<T>& MaterialPropertyInterface::getOptionalMaterialPropertyOld ( const std::string &  name )

inlineinherited

Definition at line 266 of file MaterialPropertyInterface.h.

  {
    return getOptionalMaterialProperty<T>(name, 1);
  }

getOptionalMaterialPropertyOlder()

template<typename T >

const OptionalMaterialProperty<T>& MaterialPropertyInterface::getOptionalMaterialPropertyOlder ( const std::string &  name )

inlineinherited

Definition at line 271 of file MaterialPropertyInterface.h.

  {
    return getOptionalMaterialProperty<T>(name, 2);
  }

getPossiblyConstantGenericMaterialPropertyByName()

template<typename T , bool is_ad>

const GenericMaterialProperty< T, is_ad > & MaterialPropertyInterface::getPossiblyConstantGenericMaterialPropertyByName ( const MaterialPropertyName &  prop_name, MaterialData &  material_data, const unsigned int  state  )

inherited

Retrieve the generic property named "prop_name" without any deduction for the specified material_data for state state.

This API allows the prop_name to be a constant, e.g. it allows the possibility that prop_name is not a name at all

Definition at line 898 of file MaterialPropertyInterface.h.

{
  // Check if it's just a constant
  if (const auto * default_property = defaultGenericMaterialProperty<T, is_ad>(prop_name))
  {
    _get_material_property_called = true;
    return *default_property;
  }

  if (state > 0 && !_stateful_allowed)
    mooseError("Stateful material properties not allowed for this object."
               " State ",
               state,
               " property for \"",
               prop_name,
               "\" was requested.");

  return this->getGenericMaterialPropertyByName<T, is_ad>(prop_name, material_data, state);
}

getZeroMaterialProperty()

template<typename T , typename... Ts>

const MaterialProperty<T>& MaterialPropertyInterface::getZeroMaterialProperty ( Ts...  args )

inlineinherited

for backwards compatibility

Definition at line 327 of file MaterialPropertyInterface.h.

  {
    return getGenericZeroMaterialProperty<T, false>(args...);
  }

hasADMaterialProperty()

template<typename T >

bool MaterialPropertyInterface::hasADMaterialProperty ( const std::string &  name )

inherited

Definition at line 867 of file MaterialPropertyInterface.h.

{
  // Check if the supplied parameter is a valid input parameter key
  const auto prop_name = getMaterialPropertyName(name);
  return hasADMaterialPropertyByName<T>(prop_name);
}

hasADMaterialPropertyByName()

template<typename T >

bool MaterialPropertyInterface::hasADMaterialPropertyByName ( const std::string &  name )

inherited

Definition at line 876 of file MaterialPropertyInterface.h.

{
  const auto name = _get_suffix.empty()
                        ? name_in
                        : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
  return _material_data.haveADProperty<T>(name);
}

hasGenericMaterialProperty()

template<typename T , bool is_ad>

bool MaterialPropertyInterface::hasGenericMaterialProperty ( const std::string &  name )

inlineinherited

generic hasMaterialProperty helper

Definition at line 407 of file MaterialPropertyInterface.h.

  {
    if constexpr (is_ad)
      return hasADMaterialProperty<T>(name);
    else
      return hasMaterialProperty<T>(name);
  }

hasGenericMaterialPropertyByName()

template<typename T , bool is_ad>

bool MaterialPropertyInterface::hasGenericMaterialPropertyByName ( const std::string &  name )

inlineinherited

Definition at line 415 of file MaterialPropertyInterface.h.

  {
    if constexpr (is_ad)
      return hasADMaterialPropertyByName<T>(name);
    else
      return hasMaterialPropertyByName<T>(name);
  }

hasKokkosMaterialProperty()

template<typename T , unsigned int dimension>

bool MaterialPropertyInterface::hasKokkosMaterialProperty ( const std::string &  name )

inherited

Definition at line 982 of file MaterialPropertyInterface.h.

{
  // Check if the supplied parameter is a valid input parameter key
  const auto prop_name = getMaterialPropertyName(name);
  return hasKokkosMaterialPropertyByName<T, dimension>(prop_name);
}

hasKokkosMaterialPropertyByName()

template<typename T , unsigned int dimension>

bool MaterialPropertyInterface::hasKokkosMaterialPropertyByName ( const std::string &  name )

inherited

Definition at line 991 of file MaterialPropertyInterface.h.

{
  const auto name = _get_suffix.empty()
                        ? name_in
                        : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
  return _material_data.haveKokkosProperty<T, dimension>(name);
}

hasMaterialProperty()

template<typename T >

bool MaterialPropertyInterface::hasMaterialProperty ( const std::string &  name )

inherited

Check if the material property exists.

Parameters

name	the name of the property to query

Returns

true if the property exists, otherwise false

Definition at line 809 of file MaterialPropertyInterface.h.

{
  // Check if the supplied parameter is a valid input parameter key
  const auto prop_name = getMaterialPropertyName(name);
  return hasMaterialPropertyByName<T>(prop_name);
}

hasMaterialPropertyByName()

template<typename T >

bool MaterialPropertyInterface::hasMaterialPropertyByName ( const std::string &  name )

inherited

Definition at line 818 of file MaterialPropertyInterface.h.

{
  const auto name = _get_suffix.empty()
                        ? name_in
                        : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
  return _material_data.haveProperty<T>(name);
}

markMatPropRequested()

void MaterialPropertyInterface::markMatPropRequested ( const std::string &  name )

protectedinherited

A proxy method for _mi_feproblem.markMatPropRequested(name)

Definition at line 172 of file MaterialPropertyInterface.C.

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

{
  _mi_feproblem.markMatPropRequested(name);
}

resolveOptionalProperties()

void MaterialPropertyInterface::resolveOptionalProperties ( )

virtualinherited

resolve all optional properties

Reimplemented in Material.

Definition at line 268 of file MaterialPropertyInterface.C.

{
  for (auto & proxy : _optional_property_proxies)
    proxy->resolve(*this);
}

statefulPropertiesAllowed()

void MaterialPropertyInterface::statefulPropertiesAllowed ( bool  stateful_allowed )

inherited

Derived classes can declare whether or not they work with stateful material properties.

See, for example, DiracKernel. By default, they are allowed.

Definition at line 178 of file MaterialPropertyInterface.C.

Referenced by ADDiracKernel::ADDiracKernel(), DiracKernelBase::DiracKernelBase(), and DiracKernelTempl< T >::DiracKernelTempl().

{
  _stateful_allowed = stateful_allowed;
}

validParams()

InputParameters ThreeMaterialPropertyInterface::validParams ( )

static

Definition at line 16 of file ThreeMaterialPropertyInterface.C.

Referenced by DomainUserObject::validParams().

{
  // Objects inheriting from ThreeMaterialPropertyInterface rely on Boundary MaterialData
  InputParameters params = TwoMaterialPropertyInterface::validParams();
  // We want the properties returned by getMaterialProperty* to be the volumetric ones
  params.set<Moose::MaterialDataType>("_material_data_type") = Moose::BLOCK_MATERIAL_DATA;
  return params;
}

Member Data Documentation

_default_properties

std::vector<std::unique_ptr<PropertyValue> > MaterialPropertyInterface::_default_properties

protectedinherited

Storage vector for default properties.

Definition at line 678 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::defaultGenericMaterialProperty().

_face_material_data

MaterialData& ThreeMaterialPropertyInterface::_face_material_data

protected

Definition at line 70 of file ThreeMaterialPropertyInterface.h.

Referenced by getFaceADMaterialProperty(), getFaceMaterialProperty(), getFaceMaterialPropertyByName(), getFaceMaterialPropertyOld(), and getFaceMaterialPropertyOlder().

_get_material_property_called

bool MaterialPropertyInterface::_get_material_property_called

protectedinherited

Initialized to false.

Gets set to true when getMaterialProperty() is called. Clients of this class can inquire whether getMaterialProperty() has been called by calling getMaterialPropertyCalled().

Definition at line 675 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getGenericMaterialPropertyByName(), MaterialPropertyInterface::getKokkosMaterialPropertyByName(), MaterialPropertyInterface::getMaterialPropertyCalled(), and MaterialPropertyInterface::getPossiblyConstantGenericMaterialPropertyByName().

_get_suffix

const MaterialPropertyName MaterialPropertyInterface::_get_suffix

protectedinherited

Definition at line 683 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getBlockMaterialProperty(), Material::getGenericMaterialPropertyByName(), MaterialPropertyInterface::getGenericMaterialPropertyByName(), MaterialPropertyInterface::getKokkosBlockMaterialProperty(), MaterialPropertyInterface::getKokkosMaterialPropertyByName(), MaterialPropertyInterface::hasADMaterialPropertyByName(), MaterialPropertyInterface::hasKokkosMaterialPropertyByName(), and MaterialPropertyInterface::hasMaterialPropertyByName().

_interpolated_old

const std::string MaterialPropertyInterface::_interpolated_old = "_interpolated_old"

staticprotectedinherited

name suffixes for interpolated old and older properties

Definition at line 689 of file MaterialPropertyInterface.h.

Referenced by Material::getGenericMaterialPropertyByName(), and MaterialPropertyInterface::getGenericMaterialPropertyByName().

_interpolated_older

const std::string MaterialPropertyInterface::_interpolated_older = "_interpolated_older"

staticprotectedinherited

Definition at line 690 of file MaterialPropertyInterface.h.

Referenced by Material::getGenericMaterialPropertyByName(), and MaterialPropertyInterface::getGenericMaterialPropertyByName().

_is_kokkos_object

const bool MaterialPropertyInterface::_is_kokkos_object

protectedinherited

Whether the MOOSE object is a Kokkos object.

Definition at line 593 of file MaterialPropertyInterface.h.

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

_material_data

MaterialData& MaterialPropertyInterface::_material_data

protectedinherited

The material data class that stores properties.

Definition at line 600 of file MaterialPropertyInterface.h.

Referenced by Material::computeProperties(), MaterialPropertyInterface::getBlockMaterialProperty(), MaterialPropertyInterface::getGenericMaterialProperty(), MaterialPropertyInterface::getGenericMaterialPropertyByName(), MaterialPropertyInterface::getKokkosBlockMaterialProperty(), MaterialPropertyInterface::getKokkosMaterialPropertyByName(), MaterialPropertyInterface::hasADMaterialPropertyByName(), MaterialPropertyInterface::hasKokkosMaterialPropertyByName(), MaterialPropertyInterface::hasMaterialPropertyByName(), Moose::Kokkos::Material::materialData(), InterfaceMaterial::materialData(), and Material::materialData().

_material_data_type

const Moose::MaterialDataType MaterialPropertyInterface::_material_data_type

protectedinherited

The type of data.

Definition at line 597 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::buildRequiredMaterials(), MaterialPropertyInterface::getMaterialByName(), Moose::Kokkos::Material::materialDataType(), InterfaceMaterial::materialDataType(), and Material::materialDataType().

_material_property_dependencies

std::unordered_set<unsigned int> MaterialPropertyInterface::_material_property_dependencies

protectedinherited

The set of material properties (as given by their IDs) that this object depends on.

Definition at line 681 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getBlockMaterialProperty(), MaterialPropertyInterface::getGenericMaterialPropertyByName(), MaterialPropertyInterface::getKokkosBlockMaterialProperty(), MaterialPropertyInterface::getKokkosMaterialPropertyByName(), and MaterialPropertyInterface::getMatPropDependencies().

_mi_feproblem

FEProblemBase& MaterialPropertyInterface::_mi_feproblem

protectedinherited

Reference to the FEProblemBase class.

Definition at line 583 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::addConsumedPropertyName(), MaterialPropertyInterface::buildRequiredMaterials(), MaterialPropertyInterface::checkExecutionStage(), MaterialPropertyInterface::checkMaterialProperty(), Material::getMaterialByName(), MaterialPropertyInterface::getMaterialByName(), MaterialPropertyInterface::getMaterialPropertyBlockNames(), MaterialPropertyInterface::getMaterialPropertyBlocks(), MaterialPropertyInterface::getMaterialPropertyBoundaryIDs(), MaterialPropertyInterface::getMaterialPropertyBoundaryNames(), MaterialPropertyInterface::getMaxQps(), and MaterialPropertyInterface::markMatPropRequested().

_mi_moose_object_name

const MooseObjectName MaterialPropertyInterface::_mi_moose_object_name

protectedinherited

The "complete" name of the object that this interface belongs for material property output.

Definition at line 580 of file MaterialPropertyInterface.h.

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

_mi_name

const std::string MaterialPropertyInterface::_mi_name

protectedinherited

The name of the object that this interface belongs to.

Definition at line 577 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::checkMaterialProperty().

_mi_params

const InputParameters& MaterialPropertyInterface::_mi_params

protectedinherited

Parameters of the object with this interface.

Definition at line 574 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::checkBlockAndBoundaryCompatibility(), MaterialPropertyInterface::getMaterial(), MaterialPropertyInterface::getMaterialDataType(), and MaterialPropertyInterface::getMaterialPropertyName().

_mi_subproblem

SubProblem& MaterialPropertyInterface::_mi_subproblem

protectedinherited

Reference to the subproblem.

Definition at line 586 of file MaterialPropertyInterface.h.

_mi_tid

const THREAD_ID MaterialPropertyInterface::_mi_tid

protectedinherited

Current threaded it.

Definition at line 589 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::buildRequiredMaterials(), and MaterialPropertyInterface::getMaterialByName().

_neighbor_material_data

MaterialData& TwoMaterialPropertyInterface::_neighbor_material_data

protectedinherited

Definition at line 92 of file TwoMaterialPropertyInterface.h.

Referenced by TwoMaterialPropertyInterface::getGenericNeighborMaterialProperty(), and TwoMaterialPropertyInterface::getGenericNeighborMaterialPropertyByName().

_stateful_allowed

bool MaterialPropertyInterface::_stateful_allowed

protectedinherited

True by default.

If false, this class throws an error if any of the stateful material properties interfaces are used.

Definition at line 668 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getPossiblyConstantGenericMaterialPropertyByName(), and MaterialPropertyInterface::statefulPropertiesAllowed().

_use_interpolated_state

const bool MaterialPropertyInterface::_use_interpolated_state

protectedinherited

Use the interpolated state set up through the ProjectedStatefulMaterialStorageAction.

Definition at line 686 of file MaterialPropertyInterface.h.

Referenced by Material::getGenericMaterialPropertyByName(), and MaterialPropertyInterface::getGenericMaterialPropertyByName().

default_property_id

constexpr PropertyValue::id_type MaterialPropertyInterface::default_property_id

staticinherited

Initial value:

=
      PropertyValue::invalid_property_id - 1

The material property ID for a default (parsed from input) property.

Definition at line 87 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::defaultGenericMaterialProperty().

zero_property_id

constexpr PropertyValue::id_type MaterialPropertyInterface::zero_property_id = PropertyValue::invalid_property_id - 2

staticinherited

The material property ID for a zero property.

Definition at line 90 of file MaterialPropertyInterface.h.

Referenced by MaterialBase::getGenericZeroMaterialProperty(), and MaterialPropertyInterface::getGenericZeroMaterialProperty().

---

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

• include/materials/ThreeMaterialPropertyInterface.h
• src/materials/ThreeMaterialPropertyInterface.C