ElasticEnergyMaterial Class Reference

Material class to compute the elastic free energy and its derivatives. More...

#include <ElasticEnergyMaterial.h>

Inheritance diagram for ElasticEnergyMaterial:

Public Member Functions
	ElasticEnergyMaterial (const InputParameters &parameters)
virtual void	initialSetup () override

Protected Member Functions
virtual Real	computeF () override
virtual Real	computeDF (unsigned int i_var) override
virtual Real	computeD2F (unsigned int i_var, unsigned int j_var) override

Protected Attributes
const std::string	_base_name
const MaterialProperty< RankTwoTensor > &	_stress
	Stress tensor. More...
const MaterialProperty< RankFourTensor > &	_elasticity_tensor
	Elasticity tensor derivatives. More...
std::vector< const MaterialProperty< RankFourTensor > * >	_delasticity_tensor
std::vector< std::vector< const MaterialProperty< RankFourTensor > * > >	_d2elasticity_tensor
const MaterialProperty< RankTwoTensor > &	_strain
	Strain and derivatives. More...
std::vector< const MaterialProperty< RankTwoTensor > * >	_dstrain
std::vector< std::vector< const MaterialProperty< RankTwoTensor > * > >	_d2strain

Detailed Description

Material class to compute the elastic free energy and its derivatives.

Definition at line 29 of file ElasticEnergyMaterial.h.

Constructor & Destructor Documentation

ElasticEnergyMaterial()

ElasticEnergyMaterial::ElasticEnergyMaterial

(

const InputParameters &

parameters

)

Definition at line 31 of file ElasticEnergyMaterial.C.

  : DerivativeFunctionMaterialBase(parameters),
    _base_name(isParamValid("base_name") ? getParam<std::string>("base_name") + "_" : ""),
    _stress(getMaterialPropertyByName<RankTwoTensor>(_base_name + "stress")),
    _elasticity_tensor(getMaterialPropertyByName<RankFourTensor>(_base_name + "elasticity_tensor")),
    _strain(getMaterialPropertyByName<RankTwoTensor>(_base_name + "elastic_strain"))
{
  _dstrain.resize(_nargs);
  _d2strain.resize(_nargs);
  _delasticity_tensor.resize(_nargs);
  _d2elasticity_tensor.resize(_nargs);
 
  // fetch stress and elasticity tensor derivatives (in simple eigenstrain models this is is only
  // w.r.t. 'c')
  for (unsigned int i = 0; i < _nargs; ++i)
  {
    _dstrain[i] = &getMaterialPropertyDerivativeByName<RankTwoTensor>(_base_name + "elastic_strain",
                                                                      _arg_names[i]);
    _delasticity_tensor[i] = &getMaterialPropertyDerivativeByName<RankFourTensor>(
        _base_name + "elasticity_tensor", _arg_names[i]);
 
    _d2strain[i].resize(_nargs);
    _d2elasticity_tensor[i].resize(_nargs);
 
    for (unsigned int j = 0; j < _nargs; ++j)
    {
      _d2strain[i][j] = &getMaterialPropertyDerivativeByName<RankTwoTensor>(
          _base_name + "elastic_strain", _arg_names[i], _arg_names[j]);
      _d2elasticity_tensor[i][j] = &getMaterialPropertyDerivativeByName<RankFourTensor>(
          _base_name + "elasticity_tensor", _arg_names[i], _arg_names[j]);
    }
  }
}

Member Function Documentation

computeD2F()

Real ElasticEnergyMaterial::computeD2F ( unsigned int  i_var, unsigned int  j_var  )

overrideprotectedvirtual

Definition at line 89 of file ElasticEnergyMaterial.C.

{
  unsigned int i = argIndex(i_var);
  unsigned int j = argIndex(j_var);
 
  // product rule d/dj computeDF
  // TODO: simplify because doubleContraction commutes
  return 0.5 * (((*_d2elasticity_tensor[i][j])[_qp] * _strain[_qp] +
                 (*_delasticity_tensor[i])[_qp] * (*_dstrain[j])[_qp] +
                 (*_delasticity_tensor[j])[_qp] * (*_dstrain[i])[_qp] +
                 _elasticity_tensor[_qp] * (*_d2strain[i][j])[_qp])
                    .doubleContraction(_strain[_qp]) +
                ((*_delasticity_tensor[i])[_qp] * _strain[_qp] +
                 _elasticity_tensor[_qp] * (*_dstrain[i])[_qp])
                    .doubleContraction((*_dstrain[j])[_qp])
 
                +
                ( // dstress/dj
                    (*_delasticity_tensor[j])[_qp] * _strain[_qp] +
                    _elasticity_tensor[_qp] * (*_dstrain[j])[_qp])
                    .doubleContraction((*_dstrain[i])[_qp]) +
                _stress[_qp].doubleContraction((*_d2strain[i][j])[_qp]));
}

computeDF()

Real ElasticEnergyMaterial::computeDF ( unsigned int  i_var )

overrideprotectedvirtual

Definition at line 79 of file ElasticEnergyMaterial.C.

{
  unsigned int i = argIndex(i_var);
 
  // product rule d/di computeF (doubleContraction commutes)
  return 0.5 * ((*_delasticity_tensor[i])[_qp] * _strain[_qp]).doubleContraction(_strain[_qp]) +
         (_elasticity_tensor[_qp] * (*_dstrain[i])[_qp]).doubleContraction(_strain[_qp]);
}

computeF()

Real ElasticEnergyMaterial::computeF ( )

overrideprotectedvirtual

Definition at line 73 of file ElasticEnergyMaterial.C.

{
  return 0.5 * _stress[_qp].doubleContraction(_strain[_qp]);
}

initialSetup()

void ElasticEnergyMaterial::initialSetup ( )

overridevirtual

Definition at line 66 of file ElasticEnergyMaterial.C.

{
  validateCoupling<RankTwoTensor>(_base_name + "elastic_strain");
  validateCoupling<RankFourTensor>(_base_name + "elasticity_tensor");
}

Member Data Documentation

_base_name

const std::string ElasticEnergyMaterial::_base_name

protected

Definition at line 41 of file ElasticEnergyMaterial.h.

Referenced by ElasticEnergyMaterial(), and initialSetup().

_d2elasticity_tensor

std::vector<std::vector<const MaterialProperty<RankFourTensor> *> > ElasticEnergyMaterial::_d2elasticity_tensor

protected

Definition at line 51 of file ElasticEnergyMaterial.h.

Referenced by computeD2F(), and ElasticEnergyMaterial().

_d2strain

std::vector<std::vector<const MaterialProperty<RankTwoTensor> *> > ElasticEnergyMaterial::_d2strain

protected

Definition at line 57 of file ElasticEnergyMaterial.h.

Referenced by computeD2F(), and ElasticEnergyMaterial().

_delasticity_tensor

std::vector<const MaterialProperty<RankFourTensor> *> ElasticEnergyMaterial::_delasticity_tensor

protected

Definition at line 50 of file ElasticEnergyMaterial.h.

Referenced by computeD2F(), computeDF(), and ElasticEnergyMaterial().

_dstrain

std::vector<const MaterialProperty<RankTwoTensor> *> ElasticEnergyMaterial::_dstrain

protected

Definition at line 56 of file ElasticEnergyMaterial.h.

Referenced by computeD2F(), computeDF(), and ElasticEnergyMaterial().

_elasticity_tensor

const MaterialProperty<RankFourTensor>& ElasticEnergyMaterial::_elasticity_tensor

protected

Elasticity tensor derivatives.

Definition at line 49 of file ElasticEnergyMaterial.h.

Referenced by computeD2F(), and computeDF().

_strain

const MaterialProperty<RankTwoTensor>& ElasticEnergyMaterial::_strain

protected

Strain and derivatives.

Definition at line 55 of file ElasticEnergyMaterial.h.

Referenced by computeD2F(), computeDF(), and computeF().

_stress

const MaterialProperty<RankTwoTensor>& ElasticEnergyMaterial::_stress

protected

Stress tensor.

Definition at line 44 of file ElasticEnergyMaterial.h.

Referenced by computeD2F(), and computeF().

---

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

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