www.mooseframework.org
ViewFactorPP.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "ViewFactorPP.h"
11 #include "ViewFactorBase.h"
12 
13 registerMooseObject("HeatConductionApp", ViewFactorPP);
14 
16 
17 InputParameters
19 {
20  InputParameters params = GeneralPostprocessor::validParams();
21  params.addRequiredParam<UserObjectName>("view_factor_object_name",
22  "Name of the ViewFactor userobjects.");
23  params.addRequiredParam<BoundaryName>("from_boundary",
24  "The boundary from which to compute the view factor.");
25  params.addRequiredParam<BoundaryName>("to_boundary",
26  "The boundary from which to compute the view factor.");
27  params.addClassDescription(
28  "This postprocessor allows to extract view factors from ViewFactor userobjects.");
29  return params;
30 }
31 
32 ViewFactorPP::ViewFactorPP(const InputParameters & parameters)
33  : GeneralPostprocessor(parameters),
34  _vf_uo(getUserObject<ViewFactorBase>("view_factor_object_name")),
35  _from_bnd_id(_fe_problem.mesh().getBoundaryID(getParam<BoundaryName>("from_boundary"))),
36  _to_bnd_id(_fe_problem.mesh().getBoundaryID(getParam<BoundaryName>("to_boundary")))
37 {
38 }
39 
40 PostprocessorValue
42 {
44 }
ViewFactorBase.h
ViewFactorBase
A base class for automatic computation of view factors between sidesets.
Definition: ViewFactorBase.h:23
ViewFactorPP.h
ViewFactorPP::_to_bnd_id
const BoundaryID _to_bnd_id
Definition: ViewFactorPP.h:37
ViewFactorPP::_vf_uo
const ViewFactorBase & _vf_uo
Definition: ViewFactorPP.h:35
ViewFactorBase::getViewFactor
Real getViewFactor(BoundaryID from_id, BoundaryID to_id) const
public interface for obtaining view factors
Definition: ViewFactorBase.C:52
ViewFactorPP::getValue
virtual PostprocessorValue getValue() override
Definition: ViewFactorPP.C:41
registerMooseObject
registerMooseObject("HeatConductionApp", ViewFactorPP)
ViewFactorPP::validParams
static InputParameters validParams()
Definition: ViewFactorPP.C:18
ViewFactorPP::_from_bnd_id
const BoundaryID _from_bnd_id
Definition: ViewFactorPP.h:36
ViewFactorPP::ViewFactorPP
ViewFactorPP(const InputParameters &parameters)
Definition: ViewFactorPP.C:32
validParams
InputParameters validParams()
defineLegacyParams
defineLegacyParams(ViewFactorPP)
ViewFactorPP
This postprocessor allows to extract view factors from ViewFactor userobjects.
Definition: ViewFactorPP.h:23