ViewFactorPP Class Reference

This postprocessor allows to extract view factors from ViewFactor userobjects. More...

#include <ViewFactorPP.h>

Inheritance diagram for ViewFactorPP:

Public Member Functions
	ViewFactorPP (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 ViewFactorBase &	_vf_uo
const BoundaryID	_from_bnd_id
const BoundaryID	_to_bnd_id

Detailed Description

This postprocessor allows to extract view factors from ViewFactor userobjects.

Definition at line 23 of file ViewFactorPP.h.

Constructor & Destructor Documentation

ViewFactorPP()

ViewFactorPP::ViewFactorPP

(

const InputParameters &

parameters

)

Definition at line 32 of file ViewFactorPP.C.

  : GeneralPostprocessor(parameters),
    _vf_uo(getUserObject<ViewFactorBase>("view_factor_object_name")),
    _from_bnd_id(_fe_problem.mesh().getBoundaryID(getParam<BoundaryName>("from_boundary"))),
    _to_bnd_id(_fe_problem.mesh().getBoundaryID(getParam<BoundaryName>("to_boundary")))
{
}

Member Function Documentation

execute()

virtual void ViewFactorPP::execute ( )

inlineoverridevirtual

Definition at line 31 of file ViewFactorPP.h.

{}

getValue()

PostprocessorValue ViewFactorPP::getValue ( )

overridevirtual

Definition at line 41 of file ViewFactorPP.C.

{
  return _vf_uo.getViewFactor(_from_bnd_id, _to_bnd_id);
}

initialize()

virtual void ViewFactorPP::initialize ( )

inlineoverridevirtual

Definition at line 30 of file ViewFactorPP.h.

{}

validParams()

InputParameters ViewFactorPP::validParams ( )

static

Definition at line 18 of file ViewFactorPP.C.

{
  InputParameters params = GeneralPostprocessor::validParams();
  params.addRequiredParam<UserObjectName>("view_factor_object_name",
                                          "Name of the ViewFactor userobjects.");
  params.addRequiredParam<BoundaryName>("from_boundary",
                                        "The boundary from which to compute the view factor.");
  params.addRequiredParam<BoundaryName>("to_boundary",
                                        "The boundary from which to compute the view factor.");
  params.addClassDescription(
      "This postprocessor allows to extract view factors from ViewFactor userobjects.");
  return params;
}

Member Data Documentation

_from_bnd_id

const BoundaryID ViewFactorPP::_from_bnd_id

protected

Definition at line 36 of file ViewFactorPP.h.

Referenced by getValue().

_to_bnd_id

const BoundaryID ViewFactorPP::_to_bnd_id

protected

Definition at line 37 of file ViewFactorPP.h.

Referenced by getValue().

_vf_uo

const ViewFactorBase& ViewFactorPP::_vf_uo

protected

Definition at line 35 of file ViewFactorPP.h.

Referenced by getValue().

---

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

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