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

Constructor & Destructor Documentation

◆ HHPFCRFF()

HHPFCRFF::HHPFCRFF ( const InputParameters &  parameters)

Definition at line 29 of file HHPFCRFF.C.

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

Member Function Documentation

◆ computeQpOffDiagJacobian()

Real HHPFCRFF::computeQpOffDiagJacobian ( unsigned int  jvar)
protectedvirtual

Definition at line 62 of file HHPFCRFF.C.

63 {
64  if (_has_coupled_var && jvar == _coupled_var_var)
65  return _kernel_sign * _prop[_qp] * _phi[_j][_qp] * _test[_i][_qp];
66 
67  return 0.0;
68 }
const Real _kernel_sign
Definition: HHPFCRFF.h:34
const bool _has_coupled_var
Definition: HHPFCRFF.h:38
const unsigned int _coupled_var_var
Definition: HHPFCRFF.h:40
const MaterialProperty< Real > & _prop
Definition: HHPFCRFF.h:36

◆ precomputeQpJacobian()

Real HHPFCRFF::precomputeQpJacobian ( )
protectedvirtual

Definition at line 53 of file HHPFCRFF.C.

54 {
55  if (_has_coupled_var)
56  return 0.0;
57 
58  return _kernel_sign * _prop[_qp] * _phi[_j][_qp];
59 }
const Real _kernel_sign
Definition: HHPFCRFF.h:34
const bool _has_coupled_var
Definition: HHPFCRFF.h:38
const MaterialProperty< Real > & _prop
Definition: HHPFCRFF.h:36

◆ precomputeQpResidual()

Real HHPFCRFF::precomputeQpResidual ( )
protectedvirtual

Definition at line 40 of file HHPFCRFF.C.

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

Member Data Documentation

◆ _coupled_var

const VariableValue* HHPFCRFF::_coupled_var
protected

Definition at line 39 of file HHPFCRFF.h.

◆ _coupled_var_var

const unsigned int HHPFCRFF::_coupled_var_var
protected

Definition at line 40 of file HHPFCRFF.h.

Referenced by computeQpOffDiagJacobian().

◆ _has_coupled_var

const bool HHPFCRFF::_has_coupled_var
protected

Definition at line 38 of file HHPFCRFF.h.

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

◆ _kernel_sign

const Real HHPFCRFF::_kernel_sign
protected

Definition at line 34 of file HHPFCRFF.h.

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

◆ _prop

const MaterialProperty<Real>& HHPFCRFF::_prop
protected

Definition at line 36 of file HHPFCRFF.h.

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


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