ViewFactorBase Class Reference

A base class for automatic computation of view factors between sidesets. More...

#include <ViewFactorBase.h>

Inheritance diagram for ViewFactorBase:

Public Member Functions
	ViewFactorBase (const InputParameters &parameters)
virtual void	finalize () override final
Real	getViewFactor (BoundaryID from_id, BoundaryID to_id) const
	public interface for obtaining view factors More...
Real	getViewFactor (BoundaryName from_name, BoundaryName to_name) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual void	threadJoin (const UserObject &y) override final
void	checkAndNormalizeViewFactor ()
	this function checks & normalizes view factors to sum to one, this is not always More...
virtual void	finalizeViewFactor ()=0
	a purely virtural function called in finalize, must be overriden by derived class More...
virtual void	threadJoinViewFactor (const UserObject &y)=0
	a purely virtural function called in finalize, must be overriden by derived class More...

Protected Attributes
unsigned int	_n_sides
	number of boundaries of this side uo More...
std::vector< Real >	_areas
	area of the sides i More...
const Real	_view_factor_tol
	view factor tolerance More...
const bool	_normalize_view_factor
	whether to normalize view factors so vf[from][:] sums to one More...
std::vector< std::vector< Real > >	_view_factors
	the view factor from side i to side j More...
std::unordered_map< std::string, unsigned int >	_side_name_index
	boundary name to index map More...

Detailed Description

A base class for automatic computation of view factors between sidesets.

Definition at line 23 of file ViewFactorBase.h.

Constructor & Destructor Documentation

ViewFactorBase()

ViewFactorBase::ViewFactorBase

(

const InputParameters &

parameters

)

Definition at line 33 of file ViewFactorBase.C.

  : SideUserObject(parameters),
    _n_sides(boundaryIDs().size()),
    _areas(_n_sides),
    _view_factor_tol(getParam<Real>("view_factor_tol")),
    _normalize_view_factor(getParam<bool>("normalize_view_factor"))
{
  // sizing the view factor array
  _view_factors.resize(_n_sides);
  for (auto & v : _view_factors)
    v.resize(_n_sides);
 
  // set up the map from the side id to the local index & side name to local index
  std::vector<BoundaryName> boundary_names = getParam<std::vector<BoundaryName>>("boundary");
  for (unsigned int j = 0; j < boundary_names.size(); ++j)
    _side_name_index[boundary_names[j]] = j;
}

Member Function Documentation

checkAndNormalizeViewFactor()

void ViewFactorBase::checkAndNormalizeViewFactor ( )

protected

this function checks & normalizes view factors to sum to one, this is not always

Definition at line 106 of file ViewFactorBase.C.

{
  for (unsigned int from = 0; from < _n_sides; ++from)
  {
    Real s = 0;
    for (unsigned int to = 0; to < _n_sides; ++to)
      s += _view_factors[from][to];
 
    if (std::abs(1 - s) > _view_factor_tol)
      mooseError("View factor from boundary ", boundaryNames()[from], " add to ", s);
 
    if (_normalize_view_factor)
      for (unsigned int to = 0; to < _n_sides; ++to)
        _view_factors[from][to] /= s;
  }
}

Referenced by finalize().

finalize()

void ViewFactorBase::finalize ( )

finaloverridevirtual

Definition at line 83 of file ViewFactorBase.C.

{
  // do some communication before finalizing view_factors
  for (unsigned int i = 0; i < _n_sides; ++i)
    gatherSum(_view_factors[i]);
 
  finalizeViewFactor();
  checkAndNormalizeViewFactor();
}

finalizeViewFactor()

virtual void ViewFactorBase::finalizeViewFactor ( )

protectedpure virtual

a purely virtural function called in finalize, must be overriden by derived class

Implemented in UnobstructedPlanarViewFactor.

Referenced by finalize().

getViewFactor() [1/2]

Real ViewFactorBase::getViewFactor	(	BoundaryID	from_id,
		BoundaryID	to_id
	)		const

public interface for obtaining view factors

Definition at line 52 of file ViewFactorBase.C.

{
  auto from_name = _mesh.getBoundaryName(from_id);
  auto to_name = _mesh.getBoundaryName(to_id);
 
  return getViewFactor(from_name, to_name);
}

Referenced by ViewFactorPP::getValue(), and ViewFactorObjectSurfaceRadiation::setViewFactors().

getViewFactor() [2/2]

Real ViewFactorBase::getViewFactor	(	BoundaryName	from_name,
		BoundaryName	to_name
	)		const

Definition at line 61 of file ViewFactorBase.C.

{
  auto from = _side_name_index.find(from_name);
  auto to = _side_name_index.find(to_name);
  if (from == _side_name_index.end())
    mooseError("Boundary id ",
               _mesh.getBoundaryID(from_name),
               " with name ",
               from_name,
               " not listed in boundary parameter.");
 
  if (to == _side_name_index.end())
    mooseError("Boundary id ",
               _mesh.getBoundaryID(to_name),
               " with name ",
               to_name,
               " not listed in boundary parameter.");
 
  return _view_factors[from->second][to->second];
}

threadJoin()

void ViewFactorBase::threadJoin ( const UserObject &  y )

finaloverrideprotectedvirtual

Definition at line 94 of file ViewFactorBase.C.

{
  const ViewFactorBase & pps = static_cast<const ViewFactorBase &>(y);
  for (unsigned int i = 0; i < _n_sides; ++i)
  {
    for (unsigned int j = 0; j < _n_sides; ++j)
      _view_factors[i][j] += pps._view_factors[i][j];
  }
  threadJoinViewFactor(y);
}

threadJoinViewFactor()

virtual void ViewFactorBase::threadJoinViewFactor ( const UserObject &  y )

protectedpure virtual

a purely virtural function called in finalize, must be overriden by derived class

Implemented in UnobstructedPlanarViewFactor.

Referenced by threadJoin().

validParams()

InputParameters ViewFactorBase::validParams ( )

static

Definition at line 18 of file ViewFactorBase.C.

{
  InputParameters params = SideUserObject::validParams();
  params.addParam<Real>("view_factor_tol",
                        std::numeric_limits<Real>::max(),
                        "Tolerance for checking view factors. Default is to allow everything.");
  params.addParam<bool>("normalize_view_factor",
                        true,
                        "Determines if view factors are normalized to sum to one (consistent with "
                        "their definition).");
  params.addClassDescription(
      "A base class for automatic computation of view factors between sidesets.");
  return params;
}

Referenced by UnobstructedPlanarViewFactor::validParams().

Member Data Documentation

_areas

std::vector<Real> ViewFactorBase::_areas

protected

area of the sides i

Definition at line 53 of file ViewFactorBase.h.

Referenced by UnobstructedPlanarViewFactor::execute(), UnobstructedPlanarViewFactor::finalizeViewFactor(), UnobstructedPlanarViewFactor::initialize(), and UnobstructedPlanarViewFactor::threadJoinViewFactor().

_n_sides

unsigned int ViewFactorBase::_n_sides

protected

number of boundaries of this side uo

Definition at line 50 of file ViewFactorBase.h.

Referenced by checkAndNormalizeViewFactor(), finalize(), UnobstructedPlanarViewFactor::finalizeViewFactor(), UnobstructedPlanarViewFactor::initialize(), threadJoin(), UnobstructedPlanarViewFactor::threadJoinViewFactor(), and ViewFactorBase().

_normalize_view_factor

const bool ViewFactorBase::_normalize_view_factor

protected

whether to normalize view factors so vf[from][:] sums to one

Definition at line 59 of file ViewFactorBase.h.

Referenced by checkAndNormalizeViewFactor().

_side_name_index

std::unordered_map<std::string, unsigned int> ViewFactorBase::_side_name_index

protected

boundary name to index map

Definition at line 65 of file ViewFactorBase.h.

Referenced by UnobstructedPlanarViewFactor::execute(), getViewFactor(), and ViewFactorBase().

_view_factor_tol

const Real ViewFactorBase::_view_factor_tol

protected

view factor tolerance

Definition at line 56 of file ViewFactorBase.h.

Referenced by checkAndNormalizeViewFactor().

_view_factors

std::vector<std::vector<Real> > ViewFactorBase::_view_factors

protected

the view factor from side i to side j

Definition at line 62 of file ViewFactorBase.h.

Referenced by checkAndNormalizeViewFactor(), UnobstructedPlanarViewFactor::execute(), finalize(), UnobstructedPlanarViewFactor::finalizeViewFactor(), getViewFactor(), UnobstructedPlanarViewFactor::initialize(), threadJoin(), and ViewFactorBase().

---

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

• heat_conduction/include/userobjects/ViewFactorBase.h
• heat_conduction/src/userobjects/ViewFactorBase.C