ViewFactorBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#pragma once
 
#include "SideUserObject.h"
 
// Forward Declarations
 
class ViewFactorBase : public SideUserObject
{
public:
  static InputParameters validParams();
 
  ViewFactorBase(const InputParameters & parameters);
 
  enum class NormalizationMethod
  {
    LAGRANGE_MULTIPLIER = 0,
    INVERSE_ROW_SUM = 1
  };
 
  Real getViewFactor(BoundaryID from_id, BoundaryID to_id) const;
  Real getViewFactor(BoundaryName from_name, BoundaryName to_name) const;
 
  virtual void initialize() override;
  virtual void execute() override;
  virtual void finalize() override final;
 
protected:
  virtual void threadJoin(const UserObject & y) override final;
 
  Real devReciprocity(unsigned int i, unsigned int j) const;
 
  Real maxDevReciprocity() const;
 
  Real viewFactorRowSum(unsigned int i) const;
 
  Real maxDevRowSum() const;
 
  void normalizeUsingLagrangeMultiplier();
 
  void normalizeUsingInverseRowSum();
 
  unsigned int indexHelper(unsigned int i, unsigned int j) const;
 
  unsigned int getSideNameIndex(std::string name) const;
 
  void checkAndNormalizeViewFactor();
 
  virtual void finalizeViewFactor() = 0;
 
  virtual void threadJoinViewFactor(const UserObject & y) = 0;
 
  unsigned int _n_sides;
 
  std::vector<Real> _areas;
 
  const Real _view_factor_tol;
 
  const bool _normalize_view_factor;
 
  const NormalizationMethod _normalization_method;
 
  // whether to print view factor information
  const bool _print_view_factor_info;
 
  std::vector<std::vector<Real>> _view_factors;
 
  std::unordered_map<std::string, unsigned int> _side_name_index;
};