ComputePolycrystalElasticityTensor Class Reference

Compute an evolving elasticity tensor coupled to a grain growth phase field model. More...

#include <ComputePolycrystalElasticityTensor.h>

Inheritance diagram for ComputePolycrystalElasticityTensor:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	ComputePolycrystalElasticityTensor (const InputParameters &parameters)
const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialProperty (const std::string &name)
const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialPropertyByName (const std::string &name)
void	validateDerivativeMaterialPropertyBase (const std::string &base)
const MaterialPropertyName	derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
const MaterialPropertyName	derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
const MaterialPropertyName	derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
const MaterialPropertyName	derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
bool	hasGuarantee (const MaterialPropertyName &prop_name, Guarantee guarantee)

Static Public Member Functions
static InputParameters	validParams ()

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

Protected Attributes
Real	_length_scale
Real	_pressure_scale
const GrainDataTracker< RankFourTensor > &	_grain_tracker
	Grain tracker object.
const unsigned int	_op_num
	Number of order parameters.
const std::vector< const VariableValue * >	_vals
	Order parameters.
const EulerAngleProvider *const	_euler
	object providing the Euler angles
MaterialProperty< RankTwoTensor > *	_crysrot
	Crystal Rotation Matrix used to rotate the slip system direction and normal.
std::vector< MaterialProperty< RankFourTensor > * >	_D_elastic_tensor
	vector of elasticity tensor material properties
const Real	_JtoeV
	Conversion factor from J to eV.
const std::string	_base_name
	Base name of the material system.
std::string	_elasticity_tensor_name
GenericMaterialProperty< T, is_ad > &	_elasticity_tensor
GenericMaterialProperty< Real, is_ad > &	_effective_stiffness
const Function *const	_prefactor_function
	prefactor function to multiply the elasticity tensor with

Private Member Functions
bool	haveMaterialProperty (const std::string &prop_name)
std::vector< VariableName >	buildVariableVector (const VariableName &c1, const VariableName &c2, const VariableName &c3)
void	validateCouplingHelper (const MaterialPropertyName &base, const std::vector< VariableName > &c, const System &system, std::vector< VariableName > &missing)
bool	isNotObjectVariable (const VariableName &name)

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

Detailed Description

Compute an evolving elasticity tensor coupled to a grain growth phase field model.

Definition at line 22 of file ComputePolycrystalElasticityTensor.h.

Constructor & Destructor Documentation

ComputePolycrystalElasticityTensor()

ComputePolycrystalElasticityTensor::ComputePolycrystalElasticityTensor

(

const InputParameters &

parameters

)

Definition at line 33 of file ComputePolycrystalElasticityTensor.C.

  : ComputeElasticityTensorBase(parameters),
    _length_scale(getParam<Real>("length_scale")),
    _pressure_scale(getParam<Real>("pressure_scale")),
    _grain_tracker(getUserObject<GrainDataTracker<RankFourTensor>>("grain_tracker")),
    _op_num(coupledComponents("v")),
    _vals(coupledValues("v")),
    _euler(isParamValid("euler_angle_provider")
               ? &getUserObject<EulerAngleProvider>("euler_angle_provider")
               : nullptr),
    _crysrot(isParamValid("euler_angle_provider")
                 ? &declareProperty<RankTwoTensor>(_base_name + "crysrot")
                 : nullptr),
    _D_elastic_tensor(_op_num),
    _JtoeV(6.24150974e18)
{
  // Loop over variables (ops)
  for (MooseIndex(_op_num) op_index = 0; op_index < _op_num; ++op_index)
  {
    // declare elasticity tensor derivative properties
    _D_elastic_tensor[op_index] = &declarePropertyDerivative<RankFourTensor>(
        _elasticity_tensor_name, coupledName("v", op_index));
  }
}

Member Function Documentation

computeQpElasticityTensor()

void ComputePolycrystalElasticityTensor::computeQpElasticityTensor ( )

protectedvirtual

Implements ComputeElasticityTensorBaseTempl< is_ad, T >.

Definition at line 60 of file ComputePolycrystalElasticityTensor.C.

{
  // Get list of active order parameters from grain tracker
  const auto & op_to_grains = _grain_tracker.getVarToFeatureVector(_current_elem->id());
 
  // Calculate elasticity tensor
  _elasticity_tensor[_qp].zero();
  Real sum_h = 0.0;
  for (MooseIndex(op_to_grains) op_index = 0; op_index < op_to_grains.size(); ++op_index)
  {
    auto grain_id = op_to_grains[op_index];
    if (grain_id == FeatureFloodCount::invalid_id)
      continue;
 
    // Interpolation factor for elasticity tensors
    Real h = (1.0 + std::sin(libMesh::pi * ((*_vals[op_index])[_qp] - 0.5))) / 2.0;
 
    // Sum all rotated elasticity tensors
    _elasticity_tensor[_qp] += _grain_tracker.getData(grain_id) * h;
    sum_h += h;
 
    if (isParamValid("euler_angle_provider"))
    {
      EulerAngles angles;
      angles = _euler->getEulerAngles(grain_id);
 
      RotationTensor R(angles);
      if ((*_vals[op_index])[_qp] > 0.5)
        (*_crysrot)[_qp] = R; // this is done for the crystal plasticity model compatibility
    }
  }
 
  const Real tol = 1.0e-10;
  sum_h = std::max(sum_h, tol);
  _elasticity_tensor[_qp] /= sum_h;
 
  // Calculate elasticity tensor derivative: Cderiv = dhdopi/sum_h * (Cop - _Cijkl)
  for (MooseIndex(_op_num) op_index = 0; op_index < _op_num; ++op_index)
    (*_D_elastic_tensor[op_index])[_qp].zero();
 
  for (MooseIndex(op_to_grains) op_index = 0; op_index < op_to_grains.size(); ++op_index)
  {
    auto grain_id = op_to_grains[op_index];
    if (grain_id == FeatureFloodCount::invalid_id)
      continue;
 
    Real dhdopi = libMesh::pi * std::cos(libMesh::pi * ((*_vals[op_index])[_qp] - 0.5)) / 2.0;
    RankFourTensor & C_deriv = (*_D_elastic_tensor[op_index])[_qp];
 
    C_deriv = (_grain_tracker.getData(grain_id) - _elasticity_tensor[_qp]) * dhdopi / sum_h;
 
    // Convert from XPa to eV/(xm)^3, where X is pressure scale and x is length scale;
    C_deriv *= _JtoeV * (_length_scale * _length_scale * _length_scale) * _pressure_scale;
  }
}

computeQpProperties()

template<bool is_ad, typename T = RankFourTensor>

virtual void ComputeElasticityTensorBaseTempl< is_ad, T >::computeQpProperties ( )

protectedvirtualinherited

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::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  )

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

InputParameters ComputePolycrystalElasticityTensor::validParams ( )

static

Definition at line 16 of file ComputePolycrystalElasticityTensor.C.

{
  InputParameters params = ComputeElasticityTensorBase::validParams();
  params.addClassDescription(
      "Compute an evolving elasticity tensor coupled to a grain growth phase field model.");
  params.addRequiredParam<UserObjectName>(
      "grain_tracker", "Name of GrainTracker user object that provides RankFourTensors");
  params.addParam<Real>("length_scale", 1.0e-9, "Length scale of the problem, in meters");
  params.addParam<Real>("pressure_scale", 1.0e6, "Pressure scale of the problem, in pa");
  params.addRequiredCoupledVarWithAutoBuild(
      "v", "var_name_base", "op_num", "Array of coupled variables");
  params.addParam<UserObjectName>("euler_angle_provider",
                                  "Name of Euler angle provider user object");
 
  return params;
}

Member Data Documentation

_base_name

template<bool is_ad, typename T = RankFourTensor>

const std::string ComputeElasticityTensorBaseTempl< is_ad, T >::_base_name

protectedinherited

Base name of the material system.

Definition at line 35 of file ComputeElasticityTensorBase.h.

Referenced by LinearViscoelasticityBase::declareViscoelasticProperties(), GeneralizedKelvinVoigtBase::declareViscoelasticProperties(), and LinearViscoelasticityBase::LinearViscoelasticityBase().

_crysrot

MaterialProperty<RankTwoTensor>* ComputePolycrystalElasticityTensor::_crysrot

protected

Crystal Rotation Matrix used to rotate the slip system direction and normal.

Definition at line 48 of file ComputePolycrystalElasticityTensor.h.

_D_elastic_tensor

std::vector<MaterialProperty<RankFourTensor> *> ComputePolycrystalElasticityTensor::_D_elastic_tensor

protected

vector of elasticity tensor material properties

Definition at line 51 of file ComputePolycrystalElasticityTensor.h.

Referenced by ComputePolycrystalElasticityTensor(), and computeQpElasticityTensor().

_effective_stiffness

template<bool is_ad, typename T = RankFourTensor>

GenericMaterialProperty<Real, is_ad>& ComputeElasticityTensorBaseTempl< is_ad, T >::_effective_stiffness

protectedinherited

Definition at line 40 of file ComputeElasticityTensorBase.h.

_elasticity_tensor

template<bool is_ad, typename T = RankFourTensor>

GenericMaterialProperty<T, is_ad>& ComputeElasticityTensorBaseTempl< is_ad, T >::_elasticity_tensor

protectedinherited

Definition at line 39 of file ComputeElasticityTensorBase.h.

Referenced by GeneralizedKelvinVoigtBase::computeQpApparentCreepStrain(), GeneralizedMaxwellBase::computeQpApparentCreepStrain(), GeneralizedKelvinVoigtBase::computeQpApparentElasticityTensors(), GeneralizedMaxwellBase::computeQpApparentElasticityTensors(), computeQpElasticityTensor(), ComputeConcentrationDependentElasticityTensor::computeQpElasticityTensor(), ComputeCosseratElasticityTensor::computeQpElasticityTensor(), ComputeLayeredCosseratElasticityTensor::computeQpElasticityTensor(), ComputeVariableIsotropicElasticityTensor::computeQpElasticityTensor(), and ComputeElasticityTensorCP::computeQpElasticityTensor().

_elasticity_tensor_name

template<bool is_ad, typename T = RankFourTensor>

std::string ComputeElasticityTensorBaseTempl< is_ad, T >::_elasticity_tensor_name

protectedinherited

Definition at line 37 of file ComputeElasticityTensorBase.h.

Referenced by ADComputeVariableIsotropicElasticityTensor::ADComputeVariableIsotropicElasticityTensor(), ComputeCosseratElasticityTensor::ComputeCosseratElasticityTensor(), ComputeElasticityTensorCP::ComputeElasticityTensorCP(), ComputeElasticityTensorTempl< is_ad >::ComputeElasticityTensorTempl(), ComputeLayeredCosseratElasticityTensor::ComputeLayeredCosseratElasticityTensor(), ComputePolycrystalElasticityTensor(), ComputeVariableIsotropicElasticityTensor::ComputeVariableIsotropicElasticityTensor(), GeneralizedKelvinVoigtModel::GeneralizedKelvinVoigtModel(), GeneralizedMaxwellModel::GeneralizedMaxwellModel(), ComputeVariableIsotropicElasticityTensor::initialSetup(), and LinearViscoelasticityBase::LinearViscoelasticityBase().

_euler

const EulerAngleProvider* const ComputePolycrystalElasticityTensor::_euler

protected

object providing the Euler angles

Definition at line 45 of file ComputePolycrystalElasticityTensor.h.

Referenced by computeQpElasticityTensor().

_grain_tracker

const GrainDataTracker<RankFourTensor>& ComputePolycrystalElasticityTensor::_grain_tracker

protected

Grain tracker object.

Definition at line 36 of file ComputePolycrystalElasticityTensor.h.

Referenced by computeQpElasticityTensor().

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

_JtoeV

const Real ComputePolycrystalElasticityTensor::_JtoeV

protected

Conversion factor from J to eV.

Definition at line 54 of file ComputePolycrystalElasticityTensor.h.

Referenced by computeQpElasticityTensor().

_length_scale

Real ComputePolycrystalElasticityTensor::_length_scale

protected

Definition at line 32 of file ComputePolycrystalElasticityTensor.h.

Referenced by computeQpElasticityTensor().

_op_num

const unsigned int ComputePolycrystalElasticityTensor::_op_num

protected

Number of order parameters.

Definition at line 39 of file ComputePolycrystalElasticityTensor.h.

Referenced by ComputePolycrystalElasticityTensor(), and computeQpElasticityTensor().

_prefactor_function

template<bool is_ad, typename T = RankFourTensor>

const Function* const ComputeElasticityTensorBaseTempl< is_ad, T >::_prefactor_function

protectedinherited

prefactor function to multiply the elasticity tensor with

Definition at line 43 of file ComputeElasticityTensorBase.h.

Referenced by ComputeLayeredCosseratElasticityTensor::computeQpElasticityTensor().

_pressure_scale

Real ComputePolycrystalElasticityTensor::_pressure_scale

protected

Definition at line 33 of file ComputePolycrystalElasticityTensor.h.

Referenced by computeQpElasticityTensor().

_vals

const std::vector<const VariableValue *> ComputePolycrystalElasticityTensor::_vals

protected

Order parameters.

Definition at line 42 of file ComputePolycrystalElasticityTensor.h.

Referenced by computeQpElasticityTensor().

---

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

• phase_field/include/materials/ComputePolycrystalElasticityTensor.h
• phase_field/src/materials/ComputePolycrystalElasticityTensor.C