https://mooseframework.inl.gov
ViewFactorPP.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
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("HeatTransferApp", ViewFactorPP);
14 
17 {
19  params.addRequiredParam<UserObjectName>("view_factor_object_name",
20  "Name of the ViewFactor userobjects.");
21  params.addRequiredParam<BoundaryName>("from_boundary",
22  "The boundary from which to compute the view factor.");
23  params.addRequiredParam<BoundaryName>("to_boundary",
24  "The boundary from which to compute the view factor.");
25  params.addClassDescription(
26  "This postprocessor allows to extract view factors from ViewFactor userobjects.");
27  return params;
28 }
29 
31  : GeneralPostprocessor(parameters),
32  _vf_uo(getUserObject<ViewFactorBase>("view_factor_object_name")),
33  _from_bnd_id(_fe_problem.mesh().getBoundaryID(getParam<BoundaryName>("from_boundary"))),
34  _to_bnd_id(_fe_problem.mesh().getBoundaryID(getParam<BoundaryName>("to_boundary")))
35 {
36 }
37 
40 {
42 }
MeshBase & mesh
Real getViewFactor(BoundaryID from_id, BoundaryID to_id) const
public interface for obtaining view factors
void addRequiredParam(const std::string &name, const std::string &doc_string)
const BoundaryID _from_bnd_id
Definition: ViewFactorPP.h:32
A base class for automatic computation of view factors between sidesets.
ViewFactorPP(const InputParameters &parameters)
Definition: ViewFactorPP.C:30
static InputParameters validParams()
BoundaryID getBoundaryID(const BoundaryName &boundary_name, const MeshBase &mesh)
registerMooseObject("HeatTransferApp", ViewFactorPP)
Real PostprocessorValue
const BoundaryID _to_bnd_id
Definition: ViewFactorPP.h:33
This postprocessor allows to extract view factors from ViewFactor userobjects.
Definition: ViewFactorPP.h:19
virtual PostprocessorValue getValue() const override
Definition: ViewFactorPP.C:39
void addClassDescription(const std::string &doc_string)
const ViewFactorBase & _vf_uo
Definition: ViewFactorPP.h:31
static InputParameters validParams()
Definition: ViewFactorPP.C:16