ACBarrierFunction Class Reference

#include <ACBarrierFunction.h>

Inheritance diagram for ACBarrierFunction:

Public Member Functions
	ACBarrierFunction (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual Real	computeDFDOP (PFFunctionType type)
virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

Protected Attributes
unsigned int	_n_eta
const MaterialProperty< Real > &	_d2mudvar2
const std::vector< VariableName >	_vname
std::vector< const MaterialProperty< Real > * >	_d2mudvardeta
const JvarMap &	_vmap
const NonlinearVariableName	_uname
const MaterialPropertyName	_gamma_name
const GenericMaterialProperty< Real, is_ad > &	_gamma
const GenericMaterialProperty< Real, is_ad > &	_dmudvar

Private Member Functions
Real	calculateF0 ()

Detailed Description

Definition at line 43 of file ACBarrierFunction.h.

Constructor & Destructor Documentation

ACBarrierFunction()

ACBarrierFunction::ACBarrierFunction

(

const InputParameters &

parameters

)

Definition at line 38 of file ACBarrierFunction.C.

  : ACBarrierFunctionTempl<false>(parameters),
    _n_eta(_vals.size()),
    _d2mudvar2(getMaterialPropertyDerivative<Real>("mu", _uname, _uname)),
    _vname(getParam<std::vector<VariableName>>("v")),
    _d2mudvardeta(_n_eta),
    _vmap(getParameterJvarMap("v"))
{
  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 118 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()

Real ACBarrierFunction::computeDFDOP ( PFFunctionType  type )

protectedvirtual

Definition at line 51 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");
  }
}

computeQpOffDiagJacobian()

Real ACBarrierFunction::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Definition at line 93 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];
 
  auto etavar = mapJvarToCvar(jvar, _vmap);
  if (etavar >= 0)
  {
    df0deta_base = (*_vals[etavar])[_qp] * (*_vals[etavar])[_qp] - 1.0 +
                   2.0 * _gamma[_qp] * (_u[_qp] * _u[_qp] + sum_etai2);
    df0deta = (*_vals[etavar])[_qp] * df0deta_base;
 
    return ((*_d2mudvardeta[etavar])[_qp] * calculateF0() + _dmudvar[_qp] * df0deta) *
           _phi[_j][_qp] * _test[_i][_qp] * _L[_qp];
  }
  return 0.0;
}

validParams()

InputParameters ACBarrierFunctionTempl< is_ad >::validParams ( )

staticinherited

Definition at line 27 of file ACBarrierFunction.C.

{
  InputParameters params = ACBarrierFunctionBase<is_ad>::validParams();
  params.addRequiredParam<MaterialPropertyName>(
      "gamma", "The interface profile coefficient to use with the kernel");
  params.addClassDescription("Allen-Cahn kernel used when 'mu' is a function of variables");
  return params;
}

Member Data Documentation

_d2mudvar2

const MaterialProperty<Real>& ACBarrierFunction::_d2mudvar2

protected

Definition at line 53 of file ACBarrierFunction.h.

Referenced by computeDFDOP().

_d2mudvardeta

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

protected

Definition at line 56 of file ACBarrierFunction.h.

Referenced by ACBarrierFunction(), and computeQpOffDiagJacobian().

_dmudvar

const GenericMaterialProperty<Real, is_ad>& ACBarrierFunctionTempl< is_ad >::_dmudvar

protectedinherited

Definition at line 35 of file ACBarrierFunction.h.

_gamma

const GenericMaterialProperty<Real, is_ad>& ACBarrierFunctionTempl< is_ad >::_gamma

protectedinherited

Definition at line 34 of file ACBarrierFunction.h.

_gamma_name

const MaterialPropertyName ACBarrierFunctionTempl< is_ad >::_gamma_name

protectedinherited

Definition at line 33 of file ACBarrierFunction.h.

_n_eta

unsigned int ACBarrierFunction::_n_eta

protected

Definition at line 52 of file ACBarrierFunction.h.

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

_uname

const NonlinearVariableName ACBarrierFunctionTempl< is_ad >::_uname

protectedinherited

Definition at line 32 of file ACBarrierFunction.h.

_vmap

const JvarMap& ACBarrierFunction::_vmap

protected

Definition at line 57 of file ACBarrierFunction.h.

Referenced by computeQpOffDiagJacobian().

_vname

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

protected

Definition at line 55 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