www.mooseframework.org
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
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:
[legend]

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 26 of file GuaranteeProvider.h.

Constructor & Destructor Documentation

◆ GuaranteeProvider()

GuaranteeProvider::GuaranteeProvider ( const MooseObject *  moose_object)

Definition at line 13 of file GuaranteeProvider.C.

13 {}

Member Function Documentation

◆ hasGuarantee()

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

Definition at line 16 of file GuaranteeProvider.C.

17 {
18  auto it = _guarantees.find(prop_name);
19  if (it == _guarantees.end())
20  return false;
21 
22  auto it2 = it->second.find(guarantee);
23  return it2 != it->second.end();
24 }
std::map< MaterialPropertyName, std::set< Guarantee > > _guarantees

◆ issueGuarantee()

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

◆ revokeGuarantee()

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

Definition at line 34 of file GuaranteeProvider.C.

Referenced by ComputeElasticityTensorCP::ComputeElasticityTensorCP().

35 {
36  auto it = _guarantees.find(prop_name);
37  if (it != _guarantees.end())
38  it->second.erase(guarantee);
39 }
std::map< MaterialPropertyName, std::set< Guarantee > > _guarantees

Member Data Documentation

◆ _guarantees

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

Definition at line 38 of file GuaranteeProvider.h.

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


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