GuaranteeConsumer Class Reference

Add-on class that provides the functionality to check if guarantees for material properties are provided. More...

#include <GuaranteeConsumer.h>

Inheritance diagram for GuaranteeConsumer:

Public Member Functions
	GuaranteeConsumer (MooseObject *moose_object)

Protected Member Functions
bool	hasGuaranteedMaterialProperty (const MaterialPropertyName &prop, Guarantee guarantee)

Private Attributes
const InputParameters &	_gc_params
	Parameters of the object with this interface. More...
FEProblemBase *const	_gc_feproblem
	Reference to the FEProblemBase class. More...
BlockRestrictable *const	_gc_block_restrict
	Access block restrictions of the object with this interface. More...

Detailed Description

Add-on class that provides the functionality to check if guarantees for material properties are provided.

The types of guarantees are listed in Guarantees.h

Definition at line 25 of file GuaranteeConsumer.h.

Constructor & Destructor Documentation

GuaranteeConsumer()

GuaranteeConsumer::GuaranteeConsumer

(

MooseObject *

moose_object

)

Definition at line 20 of file GuaranteeConsumer.C.

  : _gc_params(moose_object->parameters()),
    _gc_feproblem(_gc_params.get<FEProblemBase *>("_fe_problem_base")),
    _gc_block_restrict(dynamic_cast<BlockRestrictable *>(moose_object))
{
}

Member Function Documentation

hasGuaranteedMaterialProperty()

bool GuaranteeConsumer::hasGuaranteedMaterialProperty ( const MaterialPropertyName &  prop, Guarantee  guarantee  )

protected

Definition at line 28 of file GuaranteeConsumer.C.

Referenced by ComputeFiniteStrainElasticStress::computeQpStress(), ADComputeSmearedCrackingStress::initialSetup(), ComputeSmearedCrackingStress::initialSetup(), ComputeLinearElasticPFFractureStress::initialSetup(), ComputeSimoHughesJ2PlasticityStress::initialSetup(), CriticalTimeStep::initialSetup(), ComputeStVenantKirchhoffStress::initialSetup(), ComputeMultipleInelasticStressBase::initialSetup(), and ADComputeMultipleInelasticStress::initialSetup().

{
  if (!_gc_feproblem->startedInitialSetup())
    mooseError("hasGuaranteedMaterialProperty() needs to be called in initialSetup()");

  // Reference to MaterialWarehouse for testing and retrieving block ids
  const auto & warehouse = _gc_feproblem->getMaterialWarehouse();

  // Complete set of ids that this object is active
  const auto & ids = (_gc_block_restrict && _gc_block_restrict->blockRestricted())
                         ? _gc_block_restrict->blockIDs()
                         : _gc_feproblem->mesh().meshSubdomains();

  // Loop over each id for this object
  for (const auto & id : ids)
  {
    // If block materials exist, look if any issue the required guarantee
    if (warehouse.hasActiveBlockObjects(id))
    {
      const std::vector<std::shared_ptr<MaterialBase>> & mats = warehouse.getActiveBlockObjects(id);
      for (const auto & mat : mats)
      {
        const auto & mat_props = mat->getSuppliedItems();
        if (mat_props.count(prop_name))
        {
          auto guarantee_mat = dynamic_cast<GuaranteeProvider *>(mat.get());
          if (guarantee_mat && !guarantee_mat->hasGuarantee(prop_name, guarantee))
          {
            // we found at least one material on the set of block we operate on
            // that does _not_ provide the requested guarantee
            return false;
          }
        }
      }
    }
  }

  return true;
}

Member Data Documentation

_gc_block_restrict

BlockRestrictable* const GuaranteeConsumer::_gc_block_restrict

private

Access block restrictions of the object with this interface.

Definition at line 41 of file GuaranteeConsumer.h.

Referenced by hasGuaranteedMaterialProperty().

_gc_feproblem

FEProblemBase* const GuaranteeConsumer::_gc_feproblem

private

Reference to the FEProblemBase class.

Definition at line 38 of file GuaranteeConsumer.h.

Referenced by hasGuaranteedMaterialProperty().

_gc_params

const InputParameters& GuaranteeConsumer::_gc_params

private

Parameters of the object with this interface.

Definition at line 35 of file GuaranteeConsumer.h.

---

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

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