www.mooseframework.org
Public Member Functions | Static Public Member Functions | List of all members
HeatSource Class Reference

#include <HeatSource.h>

Inheritance diagram for HeatSource:
[legend]

Public Member Functions

 HeatSource (const InputParameters &parameters)
 

Static Public Member Functions

static InputParameters validParams ()
 

Detailed Description

Definition at line 20 of file HeatSource.h.

Constructor & Destructor Documentation

◆ HeatSource()

HeatSource::HeatSource ( const InputParameters &  parameters)

Definition at line 27 of file HeatSource.C.

27 : BodyForce(parameters) {}

Member Function Documentation

◆ validParams()

InputParameters HeatSource::validParams ( )
static

Definition at line 17 of file HeatSource.C.

18 {
19  InputParameters params = BodyForce::validParams();
20 
21  // Override defaults and documentation, weak form is identical to BodyForce in MOOSE
22  params.addParam<Real>("value", 1.0, "Value of heat source. Multiplied by function if present.");
23  params.addParam<FunctionName>("function", "1", "Function describing the volumetric heat source");
24  return params;
25 }

Referenced by JouleHeatingSource::validParams().


The documentation for this class was generated from the following files:
validParams
InputParameters validParams()