ADComputeElasticityTensorBase< compute_stage > Class Template Reference

ADComputeElasticityTensorBase is a the base class for computing elasticity tensors. More...

#include <ADComputeElasticityTensorBase.h>

Inheritance diagram for ADComputeElasticityTensorBase< compute_stage >:

Public Member Functions
	ADComputeElasticityTensorBase (const InputParameters &parameters)
bool	hasGuarantee (const MaterialPropertyName &prop_name, Guarantee guarantee)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual void	computeQpProperties ()
virtual void	computeQpElasticityTensor ()=0
	ADMaterialProperty (RankFourTensor) &_elasticity_tensor
void	issueGuarantee (const MaterialPropertyName &prop_name, Guarantee guarantee)
void	revokeGuarantee (const MaterialPropertyName &prop_name, Guarantee guarantee)

Protected Attributes
const std::string	_base_name
std::string	_elasticity_tensor_name
const Function *const	_prefactor_function
	prefactor function to multiply the elasticity tensor with More...
	usingMaterialMembers

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

Detailed Description

template<ComputeStage compute_stage>
class ADComputeElasticityTensorBase< compute_stage >

ADComputeElasticityTensorBase is a the base class for computing elasticity tensors.

Definition at line 24 of file ADComputeElasticityTensorBase.h.

Constructor & Destructor Documentation

ADComputeElasticityTensorBase()

template<ComputeStage compute_stage>

ADComputeElasticityTensorBase< compute_stage >::ADComputeElasticityTensorBase

(

const InputParameters &

parameters

)

Definition at line 31 of file ADComputeElasticityTensorBase.C.

  : ADMaterial<compute_stage>(parameters),
    GuaranteeProvider(this),
    _base_name(isParamValid("base_name") ? getParam<std::string>("base_name") + "_" : ""),
    _elasticity_tensor_name(_base_name + "elasticity_tensor"),
    _elasticity_tensor(declareADProperty<RankFourTensor>(_elasticity_tensor_name)),
    _prefactor_function(isParamValid("elasticity_tensor_prefactor")
                            ? &getFunction("elasticity_tensor_prefactor")
                            : nullptr)
{
}

Member Function Documentation

ADMaterialProperty()

template<ComputeStage compute_stage>

ADComputeElasticityTensorBase< compute_stage >::ADMaterialProperty ( RankFourTensor  ) &

protected

computeQpElasticityTensor()

template<ComputeStage compute_stage>

virtual void ADComputeElasticityTensorBase< compute_stage >::computeQpElasticityTensor ( )

protectedpure virtual

Implemented in ADComputeVariableIsotropicElasticityTensor< compute_stage >.

computeQpProperties()

template<ComputeStage compute_stage>

void ADComputeElasticityTensorBase< compute_stage >::computeQpProperties ( )

protectedvirtual

Definition at line 46 of file ADComputeElasticityTensorBase.C.

{
  computeQpElasticityTensor();
 
  // Multiply by prefactor
  if (_prefactor_function)
    _elasticity_tensor[_qp] *= _prefactor_function->value(_t, _q_point[_qp]);
}

hasGuarantee()

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

inherited

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  )

protectedinherited

Definition at line 27 of file GuaranteeProvider.C.

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

Referenced by ADComputeVariableIsotropicElasticityTensor< compute_stage >::ADComputeVariableIsotropicElasticityTensor(), ComputeCosseratElasticityTensor::ComputeCosseratElasticityTensor(), ComputeElasticityTensor::ComputeElasticityTensor(), ComputeIsotropicElasticityTensor::ComputeIsotropicElasticityTensor(), ComputeLayeredCosseratElasticityTensor::ComputeLayeredCosseratElasticityTensor(), ComputeVariableIsotropicElasticityTensor::ComputeVariableIsotropicElasticityTensor(), GeneralizedKelvinVoigtModel::GeneralizedKelvinVoigtModel(), and GeneralizedMaxwellModel::GeneralizedMaxwellModel().

revokeGuarantee()

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

protectedinherited

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().

validParams()

template<ComputeStage compute_stage>

InputParameters ADComputeElasticityTensorBase< compute_stage >::validParams ( )

static

Definition at line 17 of file ADComputeElasticityTensorBase.C.

{
  InputParameters params = ADMaterial<compute_stage>::validParams();
  params.addParam<FunctionName>(
      "elasticity_tensor_prefactor",
      "Optional function to use as a scalar prefactor on the elasticity tensor.");
  params.addParam<std::string>(
      "base_name",
      "Optional parameter that allows the user to define multiple mechanics "
      "material systems on the same block, i.e. for multiple phases");
  return params;
}

Referenced by ADComputeVariableIsotropicElasticityTensor< compute_stage >::validParams().

Member Data Documentation

_base_name

template<ComputeStage compute_stage>

const std::string ADComputeElasticityTensorBase< compute_stage >::_base_name

protected

Definition at line 48 of file ADComputeElasticityTensorBase.h.

_elasticity_tensor_name

template<ComputeStage compute_stage>

std::string ADComputeElasticityTensorBase< compute_stage >::_elasticity_tensor_name

protected

Definition at line 49 of file ADComputeElasticityTensorBase.h.

Referenced by ADComputeVariableIsotropicElasticityTensor< compute_stage >::ADComputeVariableIsotropicElasticityTensor().

_guarantees

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

privateinherited

Definition at line 37 of file GuaranteeProvider.h.

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

_prefactor_function

template<ComputeStage compute_stage>

const Function* const ADComputeElasticityTensorBase< compute_stage >::_prefactor_function

protected

prefactor function to multiply the elasticity tensor with

Definition at line 54 of file ADComputeElasticityTensorBase.h.

usingMaterialMembers

template<ComputeStage compute_stage>

ADComputeElasticityTensorBase< compute_stage >::usingMaterialMembers

protected

Definition at line 56 of file ADComputeElasticityTensorBase.h.

---

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

• tensor_mechanics/include/materials/ADComputeElasticityTensorBase.h
• tensor_mechanics/src/materials/ADComputeElasticityTensorBase.C