#include <ACSEDGPoly.h>

Inheritance diagram for ACSEDGPoly:

Public Member Functions
	ACSEDGPoly (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 unsigned int	_op_num

std::vector< const VariableValue * >	_vals

std::vector< unsigned int >	_vals_var

const MaterialProperty< Real > &	_beta
	the prefactor needed to calculate the deformation energy from dislocation density More...

const MaterialProperty< Real > &	_rho_eff
	the average/effective dislocation density More...

const MaterialProperty< Real > &	_Disloc_Den_i
	dislocation density in grain i More...

unsigned int	_deformed_grain_num
	number of deformed grains More...

const GrainTrackerInterface &	_grain_tracker
	Grain tracker object. More...

unsigned int	_op_index
	index of the OP the kernel is currently acting on More...

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

Detailed Description

Definition at line 31 of file ACSEDGPoly.h.

Member Enumeration Documentation

◆ PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 37 of file ACBulk.h.

   {
     Jacobian,
     Residual
   };

Constructor & Destructor Documentation

◆ ACSEDGPoly()

ACSEDGPoly::ACSEDGPoly ( const InputParameters & parameters )

Definition at line 31 of file ACSEDGPoly.C.

   : ACBulk<Real>(parameters),
     _op_num(coupledComponents("v")),
     _vals(_op_num),
     _vals_var(_op_num),
     _beta(getMaterialProperty<Real>("beta")),
     _rho_eff(getMaterialProperty<Real>("rho_eff")),
     _Disloc_Den_i(getMaterialProperty<Real>("Disloc_Den_i")),
     _deformed_grain_num(getParam<unsigned int>("deformed_grain_num")),
     _grain_tracker(getUserObject<GrainTrackerInterface>("grain_tracker")),
     _op_index(getParam<unsigned int>("op_index"))
 {
   // Loop through grains and load coupled variables into the arrays
   for (unsigned int i = 0; i < _op_num; ++i)
   {
     _vals[i] = &coupledValue("v", i);
     _vals_var[i] = coupled("v", i);
   }
 }

Member Function Documentation

◆ computeDFDOP() [1/2]

Real ACSEDGPoly::computeDFDOP ( PFFunctionType type )

protectedvirtual

Definition at line 52 of file ACSEDGPoly.C.

 {
   Real SumEtaj = 0.0;
   for (unsigned int i = 0; i < _op_num; ++i)
     SumEtaj += (*_vals[i])[_qp] * (*_vals[i])[_qp];
  
   // Add the current OP to the sum
   Real SumEtai2 = SumEtaj + _u[_qp] * _u[_qp];
   // Dislocation density in deformed grains
   Real rho_i = _Disloc_Den_i[_qp];
   // undeformed grains are dislocation-free
   const auto & op_to_grain = _grain_tracker.getVarToFeatureVector(_current_elem->id());
   const auto grn_index = op_to_grain[_op_index];
   if (grn_index >= _deformed_grain_num)
     rho_i = 0.0;
  
   // Calculate the contributions of the deformation energy to the residual and Jacobian
   Real drho_eff_detai = 2.0 * _u[_qp] * (rho_i - _rho_eff[_qp]) / SumEtai2;
  
   // Calculate the Stored Energy contribution to either the residual or Jacobian of the grain growth
   // free energy
   switch (type)
   {
     case Residual:
       return _beta[_qp] * drho_eff_detai;
  
     case Jacobian:
       return _beta[_qp] * _phi[_j][_qp] *
              (2.0 * SumEtai2 * ((rho_i - _rho_eff[_qp]) - _u[_qp] * drho_eff_detai) -
               4.0 * _u[_qp] * _u[_qp] * (rho_i - _rho_eff[_qp])) /
              (SumEtai2 * SumEtai2);
   }
   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

◆ _beta

const MaterialProperty<Real>& ACSEDGPoly::_beta

protected

the prefactor needed to calculate the deformation energy from dislocation density

Definition at line 45 of file ACSEDGPoly.h.

Referenced by computeDFDOP().

◆ _deformed_grain_num

unsigned int ACSEDGPoly::_deformed_grain_num

protected

number of deformed grains

Definition at line 54 of file ACSEDGPoly.h.

Referenced by computeDFDOP().

◆ _Disloc_Den_i

const MaterialProperty<Real>& ACSEDGPoly::_Disloc_Den_i

protected

dislocation density in grain i

Definition at line 51 of file ACSEDGPoly.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.

◆ _grain_tracker

const GrainTrackerInterface& ACSEDGPoly::_grain_tracker

protected

Grain tracker object.

Definition at line 57 of file ACSEDGPoly.h.

Referenced by computeDFDOP().

◆ _L

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

protectedinherited

Mobility.

Definition at line 46 of file ACBulk.h.

◆ _op_index

unsigned int ACSEDGPoly::_op_index

protected

index of the OP the kernel is currently acting on

Definition at line 60 of file ACSEDGPoly.h.

Referenced by computeDFDOP().

◆ _op_num

const unsigned int ACSEDGPoly::_op_num

protected

Definition at line 39 of file ACSEDGPoly.h.

Referenced by ACSEDGPoly(), and computeDFDOP().

◆ _rho_eff

const MaterialProperty<Real>& ACSEDGPoly::_rho_eff

protected

the average/effective dislocation density

Definition at line 48 of file ACSEDGPoly.h.

Referenced by computeDFDOP().

◆ _vals

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

protected

Definition at line 41 of file ACSEDGPoly.h.

Referenced by ACSEDGPoly(), and computeDFDOP().

◆ _vals_var

std::vector<unsigned int> ACSEDGPoly::_vals_var

protected

Definition at line 42 of file ACSEDGPoly.h.

Referenced by ACSEDGPoly().

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

phase_field/include/kernels/ACSEDGPoly.h
phase_field/src/kernels/ACSEDGPoly.C

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ PFFunctionType

Constructor & Destructor Documentation

◆ ACSEDGPoly()

Member Function Documentation

◆ computeDFDOP() [1/2]

◆ computeDFDOP() [2/2]

◆ computeQpOffDiagJacobian()

◆ initialSetup()

◆ precomputeQpJacobian()

◆ precomputeQpResidual()

◆ validParams()

Member Data Documentation

◆ _beta

◆ _deformed_grain_num

◆ _Disloc_Den_i

◆ _dLdarg

◆ _dLdop

◆ _grain_tracker

◆ _L

◆ _op_index

◆ _op_num

◆ _rho_eff

◆ _vals

◆ _vals_var