ComputeElasticityTensorCP defines an elasticity tensor material object for crystal plasticity models. More...

#include <ComputeElasticityTensorCP.h>

Inheritance diagram for ComputeElasticityTensorCP:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	ComputeElasticityTensorCP (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 () override
	Defines the constant rotation matrix from the user specified Bunge Euler Angles or user-supplied rotation matrix.

virtual void	assignEulerAngles ()

virtual void	computeQpProperties ()

void	issueGuarantee (const MaterialPropertyName &prop_name, Guarantee guarantee)

void	revokeGuarantee (const MaterialPropertyName &prop_name, Guarantee guarantee)

Protected Attributes
const PropertyReadFile *const	_read_prop_user_object
	Element property read user object used to read in Euler angles.

MaterialProperty< RealVectorValue > &	_Euler_angles_mat_prop
	Material property that stores the values of the Euler Angles for postprocessing.

MaterialProperty< RankTwoTensor > &	_crysrot
	Crystal Rotation Matrix used to rotate the slip system direction and normal.

RotationTensor	_R
	Rotation matrix.

bool	_user_provided_rotation_matrix
	flag for user-defined rotation matrix, supplied in input file

unsigned int	_n_euler_angle_vars

const std::vector< const VariableValue * >	_euler_angle_vars

RankFourTensor	_Cijkl
	Individual material information.

RealVectorValue	_Euler_angles

const RealTensorValue	_rotation_matrix

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

ComputeElasticityTensorCP defines an elasticity tensor material object for crystal plasticity models.

This class accepts either Bunge Euler angles or a 3x3 rotation matrix, from which the 'passive' rotation matrix is generated. This rotation matrix is used by the crystal plasticity models to rotate the crystal slip system direction and plane normals into the user-specified orientation.

Definition at line 25 of file ComputeElasticityTensorCP.h.

Constructor & Destructor Documentation

◆ ComputeElasticityTensorCP()

ComputeElasticityTensorCP::ComputeElasticityTensorCP ( const InputParameters & parameters )

Definition at line 29 of file ComputeElasticityTensorCP.C.

  : ComputeElasticityTensor(parameters),
    _read_prop_user_object(isParamValid("read_prop_user_object")
                               ? &getUserObject<PropertyReadFile>("read_prop_user_object")
                               : nullptr),
    _Euler_angles_mat_prop(declareProperty<RealVectorValue>("Euler_angles")),
    _crysrot(declareProperty<RankTwoTensor>(_base_name + "crysrot")),
    _R(_Euler_angles),
    _n_euler_angle_vars(coupledComponents("euler_angle_variables")),
    _euler_angle_vars(coupledValues("euler_angle_variables"))
{
  // the base class guarantees constant in time, but in this derived class the
  // tensor will rotate over time once plastic deformation sets in
  revokeGuarantee(_elasticity_tensor_name, Guarantee::CONSTANT_IN_TIME);
 
  // the base class performs a passive rotation, but the crystal plasticity
  // materials use active rotation: recover unrotated _Cijkl here
  if (parameters.isParamValid("rotation_matrix"))
  {
    _user_provided_rotation_matrix = true;
    _Cijkl.rotate(_rotation_matrix.transpose());
  }
  else
  {
    _user_provided_rotation_matrix = false;
    _Cijkl.rotate(_R.transpose());
  }
 
  if (_user_provided_rotation_matrix &&
      (_read_prop_user_object || (parameters.isParamSetByUser("euler_angle_1")) ||
       (parameters.isParamSetByUser("euler_angle_2")) ||
       (parameters.isParamSetByUser("euler_angle_3"))))
    mooseError("Bunge Euler angle information and the rotation_matrix cannot both be specified. "
               "Provide only one type of orientation information in the input file.");
 
  // Check if source of Euler angle values has a conflict
  if (_read_prop_user_object && _n_euler_angle_vars)
    paramError("euler_angle_variables",
               "Euler angles cannot be supplied from both coupled variables and auxiliary input "
               "file in the option `read_prop_user_object`.");
 
  if (isCoupled("euler_angle_variables") && _n_euler_angle_vars != 3)
    paramError("euler_angle_variables", "The Euler angles should have three components.");
}

Member Function Documentation

◆ assignEulerAngles()

void ComputeElasticityTensorCP::assignEulerAngles ( )

protectedvirtual

Definition at line 75 of file ComputeElasticityTensorCP.C.

{
  if (_read_prop_user_object)
  {
    _Euler_angles_mat_prop[_qp](0) = _read_prop_user_object->getData(_current_elem, 0);
    _Euler_angles_mat_prop[_qp](1) = _read_prop_user_object->getData(_current_elem, 1);
    _Euler_angles_mat_prop[_qp](2) = _read_prop_user_object->getData(_current_elem, 2);
  }
  else if (_n_euler_angle_vars)
  {
    _Euler_angles_mat_prop[_qp](0) = (*_euler_angle_vars[0])[_qp];
    _Euler_angles_mat_prop[_qp](1) = (*_euler_angle_vars[1])[_qp];
    _Euler_angles_mat_prop[_qp](2) = (*_euler_angle_vars[2])[_qp];
  }
  else
    _Euler_angles_mat_prop[_qp] = _Euler_angles;
 
  _R.update(_Euler_angles_mat_prop[_qp]);
}

Referenced by computeQpElasticityTensor().

◆ computeQpElasticityTensor()

void ComputeElasticityTensorCP::computeQpElasticityTensor ( )

overrideprotectedvirtual

Defines the constant rotation matrix from the user specified Bunge Euler Angles or user-supplied rotation matrix.

Reimplemented from ComputeElasticityTensorTempl< is_ad >.

Definition at line 96 of file ComputeElasticityTensorCP.C.

{
  // Properties assigned at the beginning of every call to material calculation
  // is required by the monolithic and user object versions. If those classes
  // are deprecated, these update can be removed and save time
  if (!_user_provided_rotation_matrix)
  {
    assignEulerAngles();
    _crysrot[_qp] = _R.transpose();
  }
  else
    _crysrot[_qp] = _rotation_matrix.transpose();
 
  _elasticity_tensor[_qp] = _Cijkl;
  _elasticity_tensor[_qp].rotate(_crysrot[_qp]);
}

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

◆ validParams()

InputParameters ComputeElasticityTensorCP::validParams ( )

static

Definition at line 16 of file ComputeElasticityTensorCP.C.

{
  InputParameters params = ComputeElasticityTensor::validParams();
  params.addClassDescription("Compute an elasticity tensor for crystal plasticity.");
  params.addParam<UserObjectName>("read_prop_user_object",
                                  "The ElementReadPropertyFile "
                                  "GeneralUserObject to read element "
                                  "specific property values from file");
  params.addCoupledVar("euler_angle_variables",
                       "Vector of coupled variables representing the Euler angles' components.");
  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().

◆ _Cijkl

template<bool is_ad>

RankFourTensor ComputeElasticityTensorTempl< is_ad >::_Cijkl

protectedinherited

Individual material information.

Definition at line 29 of file ComputeElasticityTensor.h.

Referenced by ComputeElasticityTensorCP(), ComputeElasticityTensorTempl< is_ad >::ComputeElasticityTensorTempl(), and computeQpElasticityTensor().

◆ _crysrot

MaterialProperty<RankTwoTensor>& ComputeElasticityTensorCP::_crysrot

protected

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

Definition at line 48 of file ComputeElasticityTensorCP.h.

Referenced by 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(), ComputePolycrystalElasticityTensor::computeQpElasticityTensor(), ComputeConcentrationDependentElasticityTensor::computeQpElasticityTensor(), ComputeCosseratElasticityTensor::computeQpElasticityTensor(), ComputeLayeredCosseratElasticityTensor::computeQpElasticityTensor(), ComputeVariableIsotropicElasticityTensor::computeQpElasticityTensor(), and 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(), ComputeElasticityTensorTempl< is_ad >::ComputeElasticityTensorTempl(), ComputeLayeredCosseratElasticityTensor::ComputeLayeredCosseratElasticityTensor(), ComputePolycrystalElasticityTensor::ComputePolycrystalElasticityTensor(), ComputeVariableIsotropicElasticityTensor::ComputeVariableIsotropicElasticityTensor(), GeneralizedKelvinVoigtModel::GeneralizedKelvinVoigtModel(), GeneralizedMaxwellModel::GeneralizedMaxwellModel(), ComputeVariableIsotropicElasticityTensor::initialSetup(), and LinearViscoelasticityBase::LinearViscoelasticityBase().

◆ _euler_angle_vars

const std::vector<const VariableValue *> ComputeElasticityTensorCP::_euler_angle_vars

protected

Definition at line 58 of file ComputeElasticityTensorCP.h.

Referenced by assignEulerAngles().

◆ _Euler_angles

template<bool is_ad>

RealVectorValue ComputeRotatedElasticityTensorBaseTempl< is_ad >::_Euler_angles

protectedinherited

Definition at line 27 of file ComputeRotatedElasticityTensorBase.h.

Referenced by assignEulerAngles(), ComputeConcentrationDependentElasticityTensor::ComputeConcentrationDependentElasticityTensor(), and ComputeElasticityTensorTempl< is_ad >::ComputeElasticityTensorTempl().

◆ _Euler_angles_mat_prop

MaterialProperty<RealVectorValue>& ComputeElasticityTensorCP::_Euler_angles_mat_prop

protected

Material property that stores the values of the Euler Angles for postprocessing.

Definition at line 45 of file ComputeElasticityTensorCP.h.

Referenced by assignEulerAngles().

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

◆ _n_euler_angle_vars

unsigned int ComputeElasticityTensorCP::_n_euler_angle_vars

protected

Definition at line 57 of file ComputeElasticityTensorCP.h.

Referenced by assignEulerAngles(), and ComputeElasticityTensorCP().

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

◆ _R

RotationTensor ComputeElasticityTensorCP::_R

protected

Rotation matrix.

Definition at line 51 of file ComputeElasticityTensorCP.h.

Referenced by assignEulerAngles(), ComputeElasticityTensorCP(), and computeQpElasticityTensor().

◆ _read_prop_user_object

const PropertyReadFile* const ComputeElasticityTensorCP::_read_prop_user_object

protected

Element property read user object used to read in Euler angles.

Definition at line 42 of file ComputeElasticityTensorCP.h.

Referenced by assignEulerAngles(), and ComputeElasticityTensorCP().

◆ _rotation_matrix

template<bool is_ad>

const RealTensorValue ComputeRotatedElasticityTensorBaseTempl< is_ad >::_rotation_matrix

protectedinherited

Definition at line 28 of file ComputeRotatedElasticityTensorBase.h.

Referenced by ComputeElasticityTensorCP(), ComputeElasticityTensorTempl< is_ad >::ComputeElasticityTensorTempl(), and computeQpElasticityTensor().

◆ _user_provided_rotation_matrix

bool ComputeElasticityTensorCP::_user_provided_rotation_matrix

protected

flag for user-defined rotation matrix, supplied in input file

Definition at line 54 of file ComputeElasticityTensorCP.h.

Referenced by ComputeElasticityTensorCP(), and computeQpElasticityTensor().

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

solid_mechanics/include/materials/crystal_plasticity/ComputeElasticityTensorCP.h
solid_mechanics/src/materials/crystal_plasticity/ComputeElasticityTensorCP.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ComputeElasticityTensorCP()

Member Function Documentation

◆ assignEulerAngles()

◆ computeQpElasticityTensor()

◆ computeQpProperties()

◆ hasGuarantee()

◆ issueGuarantee()

◆ revokeGuarantee()

◆ validParams()

Member Data Documentation

◆ _base_name

◆ _Cijkl

◆ _crysrot

◆ _effective_stiffness

◆ _elasticity_tensor

◆ _elasticity_tensor_name

◆ _euler_angle_vars

◆ _Euler_angles

◆ _Euler_angles_mat_prop

◆ _guarantees

◆ _n_euler_angle_vars

◆ _prefactor_function

◆ _R

◆ _read_prop_user_object

◆ _rotation_matrix

◆ _user_provided_rotation_matrix