ACGrGrElasticDrivingForce Class Reference

Calculates the porton of the Allen-Cahn equation that results from the deformation energy. More...

#include <ACGrGrElasticDrivingForce.h>

Inheritance diagram for ACGrGrElasticDrivingForce:

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

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
enum	PFFunctionType

Protected Member Functions
virtual Real	computeDFDOP (PFFunctionType type)
virtual Real	precomputeQpResidual ()
virtual Real	precomputeQpJacobian ()
virtual Real	computeQpOffDiagJacobian (unsigned int jvar)
virtual Real	computeDFDOP (PFFunctionType type)=0

Protected Attributes
const MaterialProperty< Real > &	_L
	Mobility. More...
const MaterialProperty< Real > &	_dLdop
	Mobility derivative w.r.t. order parameter. More...
std::vector< const MaterialProperty< Real > * >	_dLdarg
	Mobility derivative w.r.t coupled variables. More...

Private Attributes
const MaterialProperty< RankFourTensor > &	_D_elastic_tensor
const MaterialProperty< RankTwoTensor > &	_elastic_strain

Detailed Description

Calculates the porton of the Allen-Cahn equation that results from the deformation energy.

Must access the elastic_strain stored as a material property Requires the name of the elastic tensor derivative as an input.

Definition at line 31 of file ACGrGrElasticDrivingForce.h.

Member Enumeration Documentation

PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 37 of file ACBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

ACGrGrElasticDrivingForce()

ACGrGrElasticDrivingForce::ACGrGrElasticDrivingForce

(

const InputParameters &

parameters

)

Definition at line 29 of file ACGrGrElasticDrivingForce.C.

  : ACBulk<Real>(parameters),
    _D_elastic_tensor(getMaterialProperty<RankFourTensor>("D_tensor_name")),
    _elastic_strain(getMaterialPropertyByName<RankTwoTensor>("elastic_strain"))
{
}

Member Function Documentation

computeDFDOP() [1/2]

Real ACGrGrElasticDrivingForce::computeDFDOP ( PFFunctionType  type )

protectedvirtual

Definition at line 37 of file ACGrGrElasticDrivingForce.C.

{
  // Access the heterogeneous strain calculated by the Solid Mechanics kernels
  RankTwoTensor strain(_elastic_strain[_qp]);
 
  // Compute the partial derivative of the stress wrt the order parameter
  RankTwoTensor D_stress = _D_elastic_tensor[_qp] * strain;
 
  switch (type)
  {
    case Residual:
      return 0.5 *
             D_stress.doubleContraction(strain); // Compute the deformation energy driving force
 
    case Jacobian:
      return 0.0;
  }
 
  mooseError("Invalid type passed in");
}

computeDFDOP() [2/2]

virtual Real ACBulk< Real >::computeDFDOP ( PFFunctionType  type )

protectedpure virtualinherited

computeQpOffDiagJacobian()

Real ACBulk< Real >::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtualinherited

Reimplemented in CoupledAllenCahn, AllenCahn, KKSACBulkC, KKSACBulkF, KKSMultiACBulkC, KKSMultiACBulkF, ACGrGrMulti, ACGrGrPoly, ACBarrierFunction, and ACGBPoly.

Definition at line 116 of file ACBulk.h.

{
  // Get the coupled variable jvar is referring to
  const unsigned int cvar = mapJvarToCvar(jvar);
 
  // Set off-diagonal Jacobian term from mobility derivatives
  return (*_dLdarg[cvar])[_qp] * _phi[_j][_qp] * computeDFDOP(Residual) * _test[_i][_qp];
}

initialSetup()

void ACBulk< Real >::initialSetup ( )

virtualinherited

Reimplemented in KKSMultiACBulkBase, CoupledAllenCahn, KKSACBulkBase, and AllenCahn.

Definition at line 85 of file ACBulk.h.

{
  validateNonlinearCoupling<Real>("mob_name");
}

precomputeQpJacobian()

Real ACBulk< Real >::precomputeQpJacobian ( )

protectedvirtualinherited

Definition at line 103 of file ACBulk.h.

{
  // Get free energy derivative and Jacobian
  Real dFdop = computeDFDOP(Residual);
 
  Real JdFdop = computeDFDOP(Jacobian);
 
  // Set Jacobian value using product rule
  return _L[_qp] * JdFdop + _dLdop[_qp] * _phi[_j][_qp] * dFdop;
}

precomputeQpResidual()

Real ACBulk< Real >::precomputeQpResidual ( )

protectedvirtualinherited

Definition at line 92 of file ACBulk.h.

{
  // Get free energy derivative from function
  Real dFdop = computeDFDOP(Residual);
 
  // Set residual
  return _L[_qp] * dFdop;
}

validParams()

InputParameters ACBulk< Real >::validParams ( )

staticinherited

Definition at line 74 of file ACBulk.h.

{
  InputParameters params = ::validParams<KernelValue>();
  params.addClassDescription("Allen-Cahn base Kernel");
  params.addParam<MaterialPropertyName>("mob_name", "L", "The mobility used with the kernel");
  params.addCoupledVar("args", "Vector of arguments of the mobility");
  return params;
}

Member Data Documentation

_D_elastic_tensor

const MaterialProperty<RankFourTensor>& ACGrGrElasticDrivingForce::_D_elastic_tensor

private

Definition at line 40 of file ACGrGrElasticDrivingForce.h.

Referenced by computeDFDOP().

_dLdarg

std::vector<const MaterialProperty<Real > *> ACBulk< Real >::_dLdarg

protectedinherited

Mobility derivative w.r.t coupled variables.

Definition at line 52 of file ACBulk.h.

_dLdop

const MaterialProperty<Real >& ACBulk< Real >::_dLdop

protectedinherited

Mobility derivative w.r.t. order parameter.

Definition at line 49 of file ACBulk.h.

_elastic_strain

const MaterialProperty<RankTwoTensor>& ACGrGrElasticDrivingForce::_elastic_strain

private

Definition at line 41 of file ACGrGrElasticDrivingForce.h.

Referenced by computeDFDOP().

_L

const MaterialProperty<Real >& ACBulk< Real >::_L

protectedinherited

Mobility.

Definition at line 46 of file ACBulk.h.

---

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

• phase_field/include/kernels/ACGrGrElasticDrivingForce.h
• phase_field/src/kernels/ACGrGrElasticDrivingForce.C