GradientComponent Class Reference

#include <GradientComponent.h>

Inheritance diagram for GradientComponent:

Public Member Functions
	GradientComponent (const InputParameters &parameters)

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

Protected Attributes
const unsigned int	_v_var
	Identity of the coupled variable. More...
const VariableGradient &	_grad_v
	Gradient of the coupled variable. More...
const unsigned int	_component
	Component of the gradient vector to match. More...

Detailed Description

Definition at line 19 of file GradientComponent.h.

Constructor & Destructor Documentation

GradientComponent()

GradientComponent::GradientComponent

(

const InputParameters &

parameters

)

Definition at line 27 of file GradientComponent.C.

  : Kernel(parameters),
    _v_var(coupled("v")),
    _grad_v(coupledGradient("v")),
    _component(getParam<unsigned int>("component"))
{
  if (_component >= LIBMESH_DIM)
    paramError("component", "Component too large for LIBMESH_DIM");
}

Member Function Documentation

computeQpJacobian()

Real GradientComponent::computeQpJacobian ( )

protectedvirtual

Definition at line 44 of file GradientComponent.C.

{
  return _phi[_j][_qp] * _test[_i][_qp];
}

computeQpOffDiagJacobian()

Real GradientComponent::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Definition at line 50 of file GradientComponent.C.

{
  if (jvar == _v_var)
    return -_grad_phi[_j][_qp](_component) * _test[_i][_qp];
  return 0.0;
}

computeQpResidual()

Real GradientComponent::computeQpResidual ( )

protectedvirtual

Definition at line 38 of file GradientComponent.C.

{
  return (_u[_qp] - _grad_v[_qp](_component)) * _test[_i][_qp];
}

Member Data Documentation

_component

const unsigned int GradientComponent::_component

protected

Component of the gradient vector to match.

Definition at line 36 of file GradientComponent.h.

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

_grad_v

const VariableGradient& GradientComponent::_grad_v

protected

Gradient of the coupled variable.

Definition at line 33 of file GradientComponent.h.

Referenced by computeQpResidual().

_v_var

const unsigned int GradientComponent::_v_var

protected

Identity of the coupled variable.

Definition at line 30 of file GradientComponent.h.

Referenced by computeQpOffDiagJacobian().

---

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

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