MatReaction Class Reference

This kernel adds to the residual a contribution of \( -L*v \) where \( L \) is a material property and \( v \) is a variable (nonlinear or coupled). More...

#include <MatReaction.h>

Inheritance diagram for MatReaction:

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

Protected Member Functions
virtual Real	computeQpResidual ()
virtual Real	computeQpJacobian ()
virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

Protected Attributes
const bool	_is_coupled
	is the kernel used in a coupled form? More...
std::string	_v_name
	Kernel variable (can be nonlinear or coupled variable) (For constrained Allen-Cahn problems, v = lambda where lambda is the Lagrange multiplier) More...
const VariableValue &	_v
unsigned int	_v_var
const MaterialProperty< Real > &	_L
	Reaction rate. More...
VariableName	_eta_name
	name of the order parameter (needed to retrieve the derivative material properties) More...
const MaterialProperty< Real > &	_dLdop
	Reaction rate derivative w.r.t. order parameter. More...
const MaterialProperty< Real > &	_dLdv
	Reaction rate derivative w.r.t. the variable being added by this kernel. More...
const unsigned int	_nvar
	number of coupled variables More...
std::vector< const MaterialProperty< Real > * >	_dLdarg
	Reaction rate derivatives w.r.t. other coupled variables. More...

Detailed Description

This kernel adds to the residual a contribution of \( -L*v \) where \( L \) is a material property and \( v \) is a variable (nonlinear or coupled).

Definition at line 26 of file MatReaction.h.

Constructor & Destructor Documentation

MatReaction()

MatReaction::MatReaction

(

const InputParameters &

parameters

)

Definition at line 28 of file MatReaction.C.

  : DerivativeMaterialInterface<JvarMapKernelInterface<Kernel>>(parameters),
    _is_coupled(isCoupled("v")),
    _v_name(_is_coupled ? getVar("v", 0)->name() : _var.name()),
    _v(_is_coupled ? coupledValue("v") : _u),
    _v_var(_is_coupled ? coupled("v") : _var.number()),
    _L(getMaterialProperty<Real>("mob_name")),
    _eta_name(_var.name()),
    _dLdop(getMaterialPropertyDerivative<Real>("mob_name", _eta_name)),
    _dLdv(getMaterialPropertyDerivative<Real>("mob_name", _v_name)),
    _nvar(_coupled_moose_vars.size()),
    _dLdarg(_nvar)
{
  // Get reaction rate derivatives
  for (unsigned int i = 0; i < _nvar; ++i)
  {
    MooseVariableFEBase * ivar = _coupled_moose_vars[i];
    _dLdarg[i] = &getMaterialPropertyDerivative<Real>("mob_name", ivar->name());
  }
}

Member Function Documentation

computeQpJacobian()

Real MatReaction::computeQpJacobian ( )

protectedvirtual

Definition at line 62 of file MatReaction.C.

{
  if (_is_coupled)
    return -_dLdop[_qp] * _v[_qp] * _phi[_j][_qp] * _test[_i][_qp];
 
  return -(_L[_qp] + _dLdop[_qp] * _v[_qp]) * _phi[_j][_qp] * _test[_i][_qp];
}

computeQpOffDiagJacobian()

Real MatReaction::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Definition at line 71 of file MatReaction.C.

{
  // first handle the case where jvar is a coupled variable v being added to residual
  // the first term in the sum just multiplies by L which is always needed
  // the second term accounts for cases where L depends on v
  if ((jvar == _v_var) && _is_coupled)
    return -(_L[_qp] + _dLdv[_qp] * _v[_qp]) * _test[_i][_qp] * _phi[_j][_qp];
 
  //  for all other vars get the coupled variable jvar is referring to
  const unsigned int cvar = mapJvarToCvar(jvar);
 
  return -(*_dLdarg[cvar])[_qp] * _v[_qp] * _test[_i][_qp] * _phi[_j][_qp];
}

computeQpResidual()

Real MatReaction::computeQpResidual ( )

protectedvirtual

Definition at line 56 of file MatReaction.C.

{
  return -_L[_qp] * _test[_i][_qp] * _v[_qp];
}

initialSetup()

void MatReaction::initialSetup ( )

virtual

Definition at line 50 of file MatReaction.C.

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

Member Data Documentation

_dLdarg

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

protected

Reaction rate derivatives w.r.t. other coupled variables.

Definition at line 66 of file MatReaction.h.

Referenced by computeQpOffDiagJacobian(), and MatReaction().

_dLdop

const MaterialProperty<Real>& MatReaction::_dLdop

protected

Reaction rate derivative w.r.t. order parameter.

Definition at line 57 of file MatReaction.h.

Referenced by computeQpJacobian().

_dLdv

const MaterialProperty<Real>& MatReaction::_dLdv

protected

Reaction rate derivative w.r.t. the variable being added by this kernel.

Definition at line 60 of file MatReaction.h.

Referenced by computeQpOffDiagJacobian().

_eta_name

VariableName MatReaction::_eta_name

protected

name of the order parameter (needed to retrieve the derivative material properties)

Definition at line 54 of file MatReaction.h.

_is_coupled

const bool MatReaction::_is_coupled

protected

is the kernel used in a coupled form?

Definition at line 38 of file MatReaction.h.

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

_L

const MaterialProperty<Real>& MatReaction::_L

protected

Reaction rate.

Definition at line 51 of file MatReaction.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

_nvar

const unsigned int MatReaction::_nvar

protected

number of coupled variables

Definition at line 63 of file MatReaction.h.

Referenced by MatReaction().

_v

const VariableValue& MatReaction::_v

protected

Definition at line 47 of file MatReaction.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

_v_name

std::string MatReaction::_v_name

protected

Kernel variable (can be nonlinear or coupled variable) (For constrained Allen-Cahn problems, v = lambda where lambda is the Lagrange multiplier)

Definition at line 46 of file MatReaction.h.

_v_var

unsigned int MatReaction::_v_var

protected

Definition at line 48 of file MatReaction.h.

Referenced by computeQpOffDiagJacobian().

---

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

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