GuaranteeProvider Class Reference

Add-on class that provides the functionality to issue guarantees for declared material properties. More...

#include <GuaranteeProvider.h>

Inheritance diagram for GuaranteeProvider:

Public Member Functions
	GuaranteeProvider (const MooseObject *moose_object)
bool	hasGuarantee (const MaterialPropertyName &prop_name, Guarantee guarantee)

Protected Member Functions
void	issueGuarantee (const MaterialPropertyName &prop_name, Guarantee guarantee)
void	revokeGuarantee (const MaterialPropertyName &prop_name, Guarantee guarantee)

Private Attributes
std::map< MaterialPropertyName, std::set< Guarantee > >	_guarantees

Detailed Description

Add-on class that provides the functionality to issue guarantees for declared material properties.

The types of guarantees are listed in Guarantees.h

Definition at line 25 of file GuaranteeProvider.h.

Constructor & Destructor Documentation

GuaranteeProvider()

GuaranteeProvider::GuaranteeProvider

(

const MooseObject *

moose_object

)

Definition at line 13 of file GuaranteeProvider.C.

{}

Member Function Documentation

hasGuarantee()

bool GuaranteeProvider::hasGuarantee	(	const MaterialPropertyName &	prop_name,
		Guarantee	guarantee
	)

Definition at line 16 of file GuaranteeProvider.C.

{
  auto it = _guarantees.find(prop_name);
  if (it == _guarantees.end())
    return false;
 
  auto it2 = it->second.find(guarantee);
  return it2 != it->second.end();
}

issueGuarantee()

void GuaranteeProvider::issueGuarantee ( const MaterialPropertyName &  prop_name, Guarantee  guarantee  )

protected

Definition at line 27 of file GuaranteeProvider.C.

{
  // intentional insertion
  _guarantees[prop_name].insert(guarantee);
}

Referenced by ADComputeVariableIsotropicElasticityTensor::ADComputeVariableIsotropicElasticityTensor(), ComputeCosseratElasticityTensor::ComputeCosseratElasticityTensor(), ComputeElasticityTensorTempl< is_ad >::ComputeElasticityTensorTempl(), ComputeIsotropicElasticityTensorTempl< is_ad, T >::ComputeIsotropicElasticityTensorTempl(), ComputeLagrangianStrainBase< G >::ComputeLagrangianStrainBase(), ComputeLayeredCosseratElasticityTensor::ComputeLayeredCosseratElasticityTensor(), ComputeVariableIsotropicElasticityTensor::ComputeVariableIsotropicElasticityTensor(), GeneralizedKelvinVoigtModel::GeneralizedKelvinVoigtModel(), and GeneralizedMaxwellModel::GeneralizedMaxwellModel().

revokeGuarantee()

void GuaranteeProvider::revokeGuarantee ( const MaterialPropertyName &  prop_name, Guarantee  guarantee  )

protected

Definition at line 34 of file GuaranteeProvider.C.

{
  auto it = _guarantees.find(prop_name);
  if (it != _guarantees.end())
    it->second.erase(guarantee);
}

Referenced by ComputeElasticityTensorCP::ComputeElasticityTensorCP().

Member Data Documentation

_guarantees

std::map<MaterialPropertyName, std::set<Guarantee> > GuaranteeProvider::_guarantees

private

Definition at line 37 of file GuaranteeProvider.h.

Referenced by hasGuarantee(), issueGuarantee(), and revokeGuarantee().

---

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

• solid_mechanics/include/utils/GuaranteeProvider.h
• solid_mechanics/src/utils/GuaranteeProvider.C