VolumetricHeatSourceICAction Class Reference

#include <VolumetricHeatSourceICAction.h>

Inheritance diagram for VolumetricHeatSourceICAction:

Public Member Functions
	VolumetricHeatSourceICAction (const InputParameters &parameters)
virtual void	act ()

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual void	setObjectBlocks (InputParameters &params, const std::vector< SubdomainName > &blocks)

Protected Attributes
const VariableName &	_variable
	Variable name to apply the initial condition to. More...
const FunctionName &	_function
	Functional form for the heat source. More...
const Real &	_magnitude
	Total magnitude of the heat source upon integration. More...
std::vector< SubdomainName >	_blocks
	subdomains to which this action applies More...

Detailed Description

Action that automatically sets up a volumetric heat source initial condition as a wrapping of a FunctionElementIntegral and an IntegralPreservingFunctionIC.

Constructor & Destructor Documentation

VolumetricHeatSourceICAction()

VolumetricHeatSourceICAction::VolumetricHeatSourceICAction

(

const InputParameters &

parameters

)

Member Function Documentation

act()

void VolumetricHeatSourceICAction::act ( )

virtual

setObjectBlocks()

void CardinalAction::setObjectBlocks ( InputParameters &  params, const std::vector< SubdomainName > &  blocks  )

protectedvirtualinherited

Set the blocks to which an object created by this action applies

Parameters

[in]	params	input parameters
[in]	blocks	block that the object applies to

validParams()

InputParameters VolumetricHeatSourceICAction::validParams ( )

static

Member Data Documentation

_blocks

std::vector<SubdomainName> CardinalAction::_blocks

protectedinherited

subdomains to which this action applies

_function

const FunctionName& VolumetricHeatSourceICAction::_function

protected

Functional form for the heat source.

_magnitude

const Real& VolumetricHeatSourceICAction::_magnitude

protected

Total magnitude of the heat source upon integration.

_variable

const VariableName& VolumetricHeatSourceICAction::_variable

protected

Variable name to apply the initial condition to.

---

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

• include/actions/VolumetricHeatSourceICAction.h
• src/actions/VolumetricHeatSourceICAction.C