HHPFCRFF Class Reference

TODO: This Kernel needs Documentation!!! More...

#include <HHPFCRFF.h>

Inheritance diagram for HHPFCRFF:

Public Member Functions
	HHPFCRFF (const InputParameters &parameters)

Protected Member Functions
virtual Real	precomputeQpResidual ()
virtual Real	precomputeQpJacobian ()
virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

Protected Attributes
const Real	_kernel_sign
const MaterialProperty< Real > &	_prop
const bool	_has_coupled_var
const VariableValue *	_coupled_var
const unsigned int	_coupled_var_var

Detailed Description

TODO: This Kernel needs Documentation!!!

Definition at line 23 of file HHPFCRFF.h.

Constructor & Destructor Documentation

HHPFCRFF()

HHPFCRFF::HHPFCRFF

(

const InputParameters &

parameters

)

Definition at line 29 of file HHPFCRFF.C.

  : KernelValue(parameters),
    _kernel_sign(getParam<bool>("positive") ? 1.0 : -1.0),
    _prop(getMaterialProperty<Real>("prop_name")),
    _has_coupled_var(isCoupled("coupled_var")),
    _coupled_var(_has_coupled_var ? &coupledValue("coupled_var") : NULL),
    _coupled_var_var(_has_coupled_var ? coupled("coupled_var") : 0)
{
}

Member Function Documentation

computeQpOffDiagJacobian()

Real HHPFCRFF::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Definition at line 62 of file HHPFCRFF.C.

{
  if (_has_coupled_var && jvar == _coupled_var_var)
    return _kernel_sign * _prop[_qp] * _phi[_j][_qp] * _test[_i][_qp];
 
  return 0.0;
}

precomputeQpJacobian()

Real HHPFCRFF::precomputeQpJacobian ( )

protectedvirtual

Definition at line 53 of file HHPFCRFF.C.

{
  if (_has_coupled_var)
    return 0.0;
 
  return _kernel_sign * _prop[_qp] * _phi[_j][_qp];
}

precomputeQpResidual()

Real HHPFCRFF::precomputeQpResidual ( )

protectedvirtual

Definition at line 40 of file HHPFCRFF.C.

{
  // Assign value of the variable, whether coupled or not
  Real var;
  if (_has_coupled_var)
    var = (*_coupled_var)[_qp];
  else
    var = _u[_qp];
 
  return _kernel_sign * _prop[_qp] * var;
}

Member Data Documentation

_coupled_var

const VariableValue* HHPFCRFF::_coupled_var

protected

Definition at line 38 of file HHPFCRFF.h.

_coupled_var_var

const unsigned int HHPFCRFF::_coupled_var_var

protected

Definition at line 39 of file HHPFCRFF.h.

Referenced by computeQpOffDiagJacobian().

_has_coupled_var

const bool HHPFCRFF::_has_coupled_var

protected

Definition at line 37 of file HHPFCRFF.h.

Referenced by computeQpOffDiagJacobian(), precomputeQpJacobian(), and precomputeQpResidual().

_kernel_sign

const Real HHPFCRFF::_kernel_sign

protected

Definition at line 33 of file HHPFCRFF.h.

Referenced by computeQpOffDiagJacobian(), precomputeQpJacobian(), and precomputeQpResidual().

_prop

const MaterialProperty<Real>& HHPFCRFF::_prop

protected

Definition at line 35 of file HHPFCRFF.h.

Referenced by computeQpOffDiagJacobian(), precomputeQpJacobian(), and precomputeQpResidual().

---

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

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