Several kernels use a material property called mu. More...

#include <ACBarrierFunction.h>

Inheritance diagram for ACBarrierFunction:

Public Member Functions
	ACBarrierFunction (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	computeQpOffDiagJacobian (unsigned int jvar)

virtual Real	precomputeQpResidual ()

virtual Real	precomputeQpJacobian ()

virtual Real	computeDFDOP (PFFunctionType type)=0

Protected Attributes
unsigned int	_n_eta

const NonlinearVariableName	_uname

const MaterialPropertyName	_gamma_name

const MaterialProperty< Real > &	_gamma

const MaterialProperty< Real > &	_dmudvar

const MaterialProperty< Real > &	_d2mudvar2

const std::vector< VariableName >	_vname

std::vector< const MaterialProperty< Real > * >	_d2mudvardeta

const unsigned int	_op_num

std::vector< const VariableValue * >	_vals

std::vector< unsigned int >	_vals_var

const MaterialProperty< Real > &	_mu

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 Member Functions
Real	calculateF0 ()

Detailed Description

Several kernels use a material property called mu.

If mu is not a constant, then this kernel will calculate the bulk AC term where mu is the derivative term. It currently only takes a single value for gamma.

Definition at line 24 of file ACBarrierFunction.h.

Member Enumeration Documentation

◆ PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 37 of file ACBulk.h.

   {
     Jacobian,
     Residual
   };

Constructor & Destructor Documentation

◆ ACBarrierFunction()

ACBarrierFunction::ACBarrierFunction ( const InputParameters & parameters )

Definition at line 26 of file ACBarrierFunction.C.

   : ACGrGrBase(parameters),
     _n_eta(_vals.size()),
     _uname(getParam<NonlinearVariableName>("variable")),
     _gamma_name(getParam<MaterialPropertyName>("gamma")),
     _gamma(getMaterialPropertyByName<Real>(_gamma_name)),
     _dmudvar(getMaterialPropertyDerivative<Real>("mu", _uname)),
     _d2mudvar2(getMaterialPropertyDerivative<Real>("mu", _uname, _uname)),
     _vname(getParam<std::vector<VariableName>>("v")),
     _d2mudvardeta(_n_eta)
 {
   for (unsigned int i = 0; i < _n_eta; ++i)
     _d2mudvardeta[i] = &getMaterialPropertyDerivative<Real>("mu", _uname, _vname[i]);
 }

Member Function Documentation

◆ calculateF0()

Real ACBarrierFunction::calculateF0 ( )

private

Definition at line 87 of file ACBarrierFunction.C.

 {
   Real var_phase = 0.25 * _u[_qp] * _u[_qp] * _u[_qp] * _u[_qp] - 0.5 * _u[_qp] * _u[_qp];
   Real eta_phase = 0.0;
   Real eta_interface = 0.0;
   Real sum_eta_j2;
  
   for (unsigned int i = 0; i < _n_eta; ++i)
   {
     sum_eta_j2 = 0.0;
     for (unsigned int j = i + 1; j < _n_eta; ++j)
       sum_eta_j2 += (*_vals[j])[_qp] * (*_vals[j])[_qp];
     // eta_phase += 0.25 * (*_vals[i])[_qp] * (*_vals[i])[_qp] * (*_vals[i])[_qp] * (*_vals[i])[_qp]
     // -
     //             0.5 * (*_vals[i])[_qp] * (*_vals[i])[_qp];
     eta_phase += 0.25 * Utility::pow<4>((*_vals[i])[_qp]) - 0.5 * Utility::pow<2>((*_vals[i])[_qp]);
     eta_interface +=
         (_u[_qp] * _u[_qp] + sum_eta_j2) * (*_vals[i])[_qp] * (*_vals[i])[_qp] * _gamma[_qp];
   }
   return 0.25 + var_phase + eta_phase + eta_interface;
 }

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

◆ computeDFDOP() [1/2]

Real ACBarrierFunction::computeDFDOP ( PFFunctionType type )

protectedvirtual

Definition at line 42 of file ACBarrierFunction.C.

 {
   switch (type)
   {
     case Residual:
       return _dmudvar[_qp] * calculateF0();
  
     case Jacobian:
     {
       Real df0dvar = 0.0;
       for (unsigned int i = 0; i < _n_eta; ++i)
         df0dvar += (*_vals[i])[_qp] * (*_vals[i])[_qp];
  
       df0dvar *= 2.0 * _gamma[_qp] * _u[_qp];
       df0dvar += _u[_qp] * _u[_qp] * _u[_qp] - _u[_qp];
  
       return (_d2mudvar2[_qp] * calculateF0() + _dmudvar[_qp] * df0dvar) * _phi[_j][_qp];
     }
  
     default:
       mooseError("Invalid type passed in");
   }
 }

◆ computeDFDOP() [2/2]

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

protectedpure virtualinherited

◆ computeQpOffDiagJacobian()

Real ACBarrierFunction::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Reimplemented from ACBulk< Real >.

Definition at line 67 of file ACBarrierFunction.C.

 {
   const unsigned int j = mapJvarToCvar(jvar);
   Real sum_etai2 = 0.0;
   Real df0deta_base = 0.0;
   Real df0deta = 0.0;
  
   for (unsigned int i = 0; i < _n_eta; ++i)
     if (i != j)
       sum_etai2 += (*_vals[i])[_qp] * (*_vals[i])[_qp];
  
   df0deta_base = (*_vals[j])[_qp] * (*_vals[j])[_qp] - 1.0 +
                  2.0 * _gamma[_qp] * (_u[_qp] * _u[_qp] + sum_etai2);
   df0deta = (*_vals[j])[_qp] * df0deta_base;
  
   return ((*_d2mudvardeta[j])[_qp] * calculateF0() + _dmudvar[_qp] * df0deta) * _phi[_j][_qp] *
          _test[_i][_qp] * _L[_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

◆ _d2mudvar2

const MaterialProperty<Real>& ACBarrierFunction::_d2mudvar2

protected

Definition at line 38 of file ACBarrierFunction.h.

Referenced by computeDFDOP().

◆ _d2mudvardeta

std::vector<const MaterialProperty<Real> *> ACBarrierFunction::_d2mudvardeta

protected

Definition at line 41 of file ACBarrierFunction.h.

Referenced by ACBarrierFunction(), and computeQpOffDiagJacobian().

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

◆ _dmudvar

const MaterialProperty<Real>& ACBarrierFunction::_dmudvar

protected

Definition at line 37 of file ACBarrierFunction.h.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

◆ _gamma

const MaterialProperty<Real>& ACBarrierFunction::_gamma

protected

Definition at line 36 of file ACBarrierFunction.h.

Referenced by calculateF0(), computeDFDOP(), and computeQpOffDiagJacobian().

◆ _gamma_name

const MaterialPropertyName ACBarrierFunction::_gamma_name

protected

Definition at line 35 of file ACBarrierFunction.h.

◆ _L

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

protectedinherited

Mobility.

Definition at line 46 of file ACBulk.h.

◆ _mu

const MaterialProperty<Real>& ACGrGrBase::_mu

protectedinherited

Definition at line 36 of file ACGrGrBase.h.

Referenced by ACGrGrMulti::computeDFDOP(), ACGrGrPoly::computeDFDOP(), ACGrGrPoly::computeQpOffDiagJacobian(), and ACGrGrMulti::computeQpOffDiagJacobian().

◆ _n_eta

unsigned int ACBarrierFunction::_n_eta

protected

Definition at line 33 of file ACBarrierFunction.h.

Referenced by ACBarrierFunction(), calculateF0(), computeDFDOP(), and computeQpOffDiagJacobian().

◆ _op_num

const unsigned int ACGrGrBase::_op_num

protectedinherited

Definition at line 31 of file ACGrGrBase.h.

Referenced by ACGrGrBase::ACGrGrBase(), ACGrGrMulti::computedF0du(), ACGrGrPoly::computeDFDOP(), ACGrGrMulti::computeDFDOP(), ACGrGrMulti::computeQpOffDiagJacobian(), and ACGrGrPoly::computeQpOffDiagJacobian().

◆ _uname

const NonlinearVariableName ACBarrierFunction::_uname

protected

Definition at line 34 of file ACBarrierFunction.h.

Referenced by ACBarrierFunction().

◆ _vals

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

protectedinherited

Definition at line 33 of file ACGrGrBase.h.

Referenced by ACGrGrBase::ACGrGrBase(), calculateF0(), ACGrGrMulti::computedF0du(), computeDFDOP(), ACGrGrPoly::computeDFDOP(), ACGrGrMulti::computeDFDOP(), computeQpOffDiagJacobian(), ACGrGrPoly::computeQpOffDiagJacobian(), and ACGrGrMulti::computeQpOffDiagJacobian().

◆ _vals_var

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

protectedinherited

Definition at line 34 of file ACGrGrBase.h.

Referenced by ACGrGrBase::ACGrGrBase(), ACGrGrPoly::computeQpOffDiagJacobian(), and ACGrGrMulti::computeQpOffDiagJacobian().

◆ _vname

const std::vector<VariableName> ACBarrierFunction::_vname

protected

Definition at line 40 of file ACBarrierFunction.h.

Referenced by ACBarrierFunction().

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

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

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ PFFunctionType

Constructor & Destructor Documentation

◆ ACBarrierFunction()

Member Function Documentation

◆ calculateF0()

◆ computeDFDOP() [1/2]

◆ computeDFDOP() [2/2]

◆ computeQpOffDiagJacobian()

◆ initialSetup()

◆ precomputeQpJacobian()

◆ precomputeQpResidual()

◆ validParams()

Member Data Documentation

◆ _d2mudvar2

◆ _d2mudvardeta

◆ _dLdarg

◆ _dLdop

◆ _dmudvar

◆ _gamma

◆ _gamma_name

◆ _L

◆ _mu

◆ _n_eta

◆ _op_num

◆ _uname

◆ _vals

◆ _vals_var

◆ _vname