JouleHeatingHeatGeneratedAux Class Reference

Auxiliary kernel for computing the heat generated from Joule heating. More...

#include <JouleHeatingHeatGeneratedAux.h>

Inheritance diagram for JouleHeatingHeatGeneratedAux:

Public Member Functions
	JouleHeatingHeatGeneratedAux (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual Real	computeValue ()

Protected Attributes
const VariableGradient &	_grad_elec
const MaterialProperty< Real > &	_elec_cond

Detailed Description

Auxiliary kernel for computing the heat generated from Joule heating.

Definition at line 22 of file JouleHeatingHeatGeneratedAux.h.

Constructor & Destructor Documentation

JouleHeatingHeatGeneratedAux()

JouleHeatingHeatGeneratedAux::JouleHeatingHeatGeneratedAux

(

const InputParameters &

parameters

)

Definition at line 30 of file JouleHeatingHeatGeneratedAux.C.

  : AuxKernel(parameters),
    _grad_elec(coupledGradient("elec")),
    _elec_cond(getMaterialProperty<Real>("electrical_conductivity"))
{
}

Member Function Documentation

computeValue()

Real JouleHeatingHeatGeneratedAux::computeValue ( )

protectedvirtual

Definition at line 38 of file JouleHeatingHeatGeneratedAux.C.

{
  return _elec_cond[_qp] * _grad_elec[_qp] * _grad_elec[_qp];
}

validParams()

InputParameters JouleHeatingHeatGeneratedAux::validParams ( )

static

Definition at line 17 of file JouleHeatingHeatGeneratedAux.C.

{
  InputParameters params = AuxKernel::validParams();
  params.addClassDescription("Compute heat generated from Joule heating "
                             "$(d\\vv{P}/d\\vv{V} = \\vv{E}^2 \\sigma )$.");
  params.addRequiredCoupledVar("elec", "Electric potential for joule heating.");
  params.addParam<MaterialPropertyName>(
      "electrical_conductivity",
      "electrical_conductivity",
      "Material property providing electrical conductivity of the material.");
  return params;
}

Member Data Documentation

_elec_cond

const MaterialProperty<Real>& JouleHeatingHeatGeneratedAux::_elec_cond

protected

Definition at line 33 of file JouleHeatingHeatGeneratedAux.h.

Referenced by computeValue().

_grad_elec

const VariableGradient& JouleHeatingHeatGeneratedAux::_grad_elec

protected

Definition at line 32 of file JouleHeatingHeatGeneratedAux.h.

Referenced by computeValue().

---

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

• heat_conduction/include/auxkernels/JouleHeatingHeatGeneratedAux.h
• heat_conduction/src/auxkernels/JouleHeatingHeatGeneratedAux.C