www.mooseframework.org
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
HHPFCRFF Class Reference

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

#include <HHPFCRFF.h>

Inheritance diagram for HHPFCRFF:
[legend]

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 22 of file HHPFCRFF.h.

Constructor & Destructor Documentation

HHPFCRFF::HHPFCRFF ( const InputParameters &  parameters)

Definition at line 25 of file HHPFCRFF.C.

26  : KernelValue(parameters),
27  _kernel_sign(getParam<bool>("positive") ? 1.0 : -1.0),
28  _prop(getMaterialProperty<Real>("prop_name")),
29  _has_coupled_var(isCoupled("coupled_var")),
30  _coupled_var(_has_coupled_var ? &coupledValue("coupled_var") : NULL),
31  _coupled_var_var(_has_coupled_var ? coupled("coupled_var") : 0)
32 {
33 }
const Real _kernel_sign
Definition: HHPFCRFF.h:32
const bool _has_coupled_var
Definition: HHPFCRFF.h:36
const VariableValue * _coupled_var
Definition: HHPFCRFF.h:37
const unsigned int _coupled_var_var
Definition: HHPFCRFF.h:38
const MaterialProperty< Real > & _prop
Definition: HHPFCRFF.h:34

Member Function Documentation

Real HHPFCRFF::computeQpOffDiagJacobian ( unsigned int  jvar)
protectedvirtual

Definition at line 58 of file HHPFCRFF.C.

59 {
60  if (_has_coupled_var && jvar == _coupled_var_var)
61  return _kernel_sign * _prop[_qp] * _phi[_j][_qp] * _test[_i][_qp];
62 
63  return 0.0;
64 }
const Real _kernel_sign
Definition: HHPFCRFF.h:32
const bool _has_coupled_var
Definition: HHPFCRFF.h:36
const unsigned int _coupled_var_var
Definition: HHPFCRFF.h:38
const MaterialProperty< Real > & _prop
Definition: HHPFCRFF.h:34
Real HHPFCRFF::precomputeQpJacobian ( )
protectedvirtual

Definition at line 49 of file HHPFCRFF.C.

50 {
51  if (_has_coupled_var)
52  return 0.0;
53 
54  return _kernel_sign * _prop[_qp] * _phi[_j][_qp];
55 }
const Real _kernel_sign
Definition: HHPFCRFF.h:32
const bool _has_coupled_var
Definition: HHPFCRFF.h:36
const MaterialProperty< Real > & _prop
Definition: HHPFCRFF.h:34
Real HHPFCRFF::precomputeQpResidual ( )
protectedvirtual

Definition at line 36 of file HHPFCRFF.C.

37 {
38  // Assign value of the variable, whether coupled or not
39  Real var;
40  if (_has_coupled_var)
41  var = (*_coupled_var)[_qp];
42  else
43  var = _u[_qp];
44 
45  return _kernel_sign * _prop[_qp] * var;
46 }
const Real _kernel_sign
Definition: HHPFCRFF.h:32
const bool _has_coupled_var
Definition: HHPFCRFF.h:36
const MaterialProperty< Real > & _prop
Definition: HHPFCRFF.h:34

Member Data Documentation

const VariableValue* HHPFCRFF::_coupled_var
protected

Definition at line 37 of file HHPFCRFF.h.

const unsigned int HHPFCRFF::_coupled_var_var
protected

Definition at line 38 of file HHPFCRFF.h.

Referenced by computeQpOffDiagJacobian().

const bool HHPFCRFF::_has_coupled_var
protected

Definition at line 36 of file HHPFCRFF.h.

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

const Real HHPFCRFF::_kernel_sign
protected

Definition at line 32 of file HHPFCRFF.h.

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

const MaterialProperty<Real>& HHPFCRFF::_prop
protected

Definition at line 34 of file HHPFCRFF.h.

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


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