GrayLambertSurfaceRadiationPP Class Reference

A postprocessor that extracts information from the GrayLambertSurfaceRadiationBase UserObject. More...

#include <GrayLambertSurfaceRadiationPP.h>

Inheritance diagram for GrayLambertSurfaceRadiationPP:

Public Member Functions
	GrayLambertSurfaceRadiationPP (const InputParameters &parameters)
virtual void	initialize () override
virtual void	execute () override
virtual PostprocessorValue	getValue () override

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const GrayLambertSurfaceRadiationBase &	_glsr_uo
MooseEnum	_return_type
BoundaryID	_bnd_id

Detailed Description

A postprocessor that extracts information from the GrayLambertSurfaceRadiationBase UserObject.

Definition at line 24 of file GrayLambertSurfaceRadiationPP.h.

Constructor & Destructor Documentation

GrayLambertSurfaceRadiationPP()

GrayLambertSurfaceRadiationPP::GrayLambertSurfaceRadiationPP

(

const InputParameters &

parameters

)

Definition at line 32 of file GrayLambertSurfaceRadiationPP.C.

  : GeneralPostprocessor(parameters),
    _glsr_uo(getUserObject<GrayLambertSurfaceRadiationBase>("surface_radiation_object_name")),
    _return_type(getParam<MooseEnum>("return_type")),
    _bnd_id(_fe_problem.mesh().getBoundaryID(getParam<BoundaryName>("boundary")))
{
}

Member Function Documentation

execute()

virtual void GrayLambertSurfaceRadiationPP::execute ( )

inlineoverridevirtual

Definition at line 32 of file GrayLambertSurfaceRadiationPP.h.

{}

getValue()

PostprocessorValue GrayLambertSurfaceRadiationPP::getValue ( )

overridevirtual

Definition at line 41 of file GrayLambertSurfaceRadiationPP.C.

{
  if (_return_type == "RADIOSITY")
    return _glsr_uo.getSurfaceRadiosity(_bnd_id);
  else if (_return_type == "TEMPERATURE")
    return _glsr_uo.getSurfaceTemperature(_bnd_id);
  return _glsr_uo.getSurfaceHeatFluxDensity(_bnd_id);
}

initialize()

virtual void GrayLambertSurfaceRadiationPP::initialize ( )

inlineoverridevirtual

Definition at line 31 of file GrayLambertSurfaceRadiationPP.h.

{}

validParams()

InputParameters GrayLambertSurfaceRadiationPP::validParams ( )

static

Definition at line 17 of file GrayLambertSurfaceRadiationPP.C.

{
  InputParameters params = GeneralPostprocessor::validParams();
  MooseEnum return_type("RADIOSITY HEAT_FLUX_DENSITY TEMPERATURE", "HEAT_FLUX_DENSITY");
  params.addParam<MooseEnum>("return_type",
                             return_type,
                             "Requested return type: RADIOSITY | HEAT_FLUX_DENSITY | TEMPERATURE");
  params.addRequiredParam<UserObjectName>("surface_radiation_object_name",
                                          "Name of the GrayLambertSurfaceRadiationBase UO");
  params.addRequiredParam<BoundaryName>("boundary", "The boundary of interest.");
  params.addClassDescription("This postprocessor allows to extract radiosity, heat flux density, "
                             "and temperature from the GrayLambertSurfaceRadiationBase object.");
  return params;
}

Member Data Documentation

_bnd_id

BoundaryID GrayLambertSurfaceRadiationPP::_bnd_id

protected

Definition at line 38 of file GrayLambertSurfaceRadiationPP.h.

Referenced by getValue().

_glsr_uo

const GrayLambertSurfaceRadiationBase& GrayLambertSurfaceRadiationPP::_glsr_uo

protected

Definition at line 36 of file GrayLambertSurfaceRadiationPP.h.

Referenced by getValue().

_return_type

MooseEnum GrayLambertSurfaceRadiationPP::_return_type

protected

Definition at line 37 of file GrayLambertSurfaceRadiationPP.h.

Referenced by getValue().

---

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

• heat_conduction/include/postprocessors/GrayLambertSurfaceRadiationPP.h
• heat_conduction/src/postprocessors/GrayLambertSurfaceRadiationPP.C