https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
RayTracingViewFactor Class Reference

Computes the view factors for planar faces in unobstructed radiative heat transfer. More...

#include <RayTracingViewFactor.h>

Inheritance diagram for RayTracingViewFactor:
[legend]

Public Types

enum  TEST_TYPE
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 RayTracingViewFactor (const InputParameters &parameters)
 
virtual void execute () override
 
virtual void initialize () override
 
virtual void finalize () override final
 
SubProblem & getSubProblem () const
 
bool shouldDuplicateInitialExecution () const
 
virtual Real spatialValue (const Point &) const
 
virtual const std::vector< Point > spatialPoints () const
 
void gatherSum (T &value)
 
void gatherMax (T &value)
 
void gatherMin (T &value)
 
void gatherProxyValueMax (T1 &proxy, T2 &value)
 
void gatherProxyValueMin (T1 &proxy, T2 &value)
 
void setPrimaryThreadCopy (UserObject *primary)
 
UserObject * primaryThreadCopy ()
 
std::set< UserObjectName > getDependObjects () const
 
virtual bool needThreadedCopy () const
 
const std::set< std::string > & getRequestedItems () override
 
const std::set< std::string > & getSuppliedItems () override
 
unsigned int systemNumber () const
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
virtual void initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void subdomainSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const T & getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
virtual const std::set< BoundaryID > & boundaryIDs () const
 
const std::vector< BoundaryName > & boundaryNames () const
 
unsigned int numBoundaryIDs () const
 
bool hasBoundary (const BoundaryName &name) const
 
bool hasBoundary (const std::vector< BoundaryName > &names) const
 
bool hasBoundary (const BoundaryID &id) const
 
bool hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const
 
bool hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const
 
bool isBoundarySubset (const std::set< BoundaryID > &ids) const
 
bool isBoundarySubset (const std::vector< BoundaryID > &ids) const
 
bool hasBoundaryMaterialProperty (const std::string &prop_name) const
 
virtual bool boundaryRestricted () const
 
const std::set< BoundaryID > & meshBoundaryIDs () const
 
virtual bool checkVariableBoundaryIntegrity () const
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
std::set< SubdomainID > getMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryID > getMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase *> > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
bool getMaterialPropertyCalled () const
 
virtual const std::unordered_set< unsigned int > & getMatPropDependencies () const
 
virtual void resolveOptionalProperties ()
 
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
virtual const VariableValue & coupledValueByName (const std::string &var_name)
 
virtual const ArrayVariableValue & coupledArrayValueByName (const std::string &var_name)
 
const std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > & getCoupledVars () const
 
const std::vector< MooseVariableFieldBase *> & getCoupledMooseVars () const
 
const std::vector< MooseVariable *> & getCoupledStandardMooseVars () const
 
const std::vector< VectorMooseVariable *> & getCoupledVectorMooseVars () const
 
const std::vector< ArrayMooseVariable *> & getCoupledArrayMooseVars () const
 
void addFEVariableCoupleableVectorTag (TagID tag)
 
void addFEVariableCoupleableMatrixTag (TagID tag)
 
std::set< TagID > & getFEVariableCoupleableVectorTags ()
 
const std::set< TagID > & getFEVariableCoupleableVectorTags () const
 
std::set< TagID > & getFEVariableCoupleableMatrixTags ()
 
const std::set< TagID > & getFEVariableCoupleableMatrixTags () const
 
auto & getWritableCoupledVariables () const
 
bool hasWritableCoupledVariables () const
 
const ADVariableValue * getADDefaultValue (const std::string &var_name) const
 
const ADVectorVariableValue * getADDefaultVectorValue (const std::string &var_name) const
 
const ADVariableGradient & getADDefaultGradient () const
 
const ADVectorVariableGradient & getADDefaultVectorGradient () const
 
const ADVariableSecond & getADDefaultSecond () const
 
const ADVectorVariableCurl & getADDefaultCurl () const
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const std::set< MooseVariableFieldBase *> & getMooseVariableDependencies () const
 
std::set< MooseVariableFieldBase *> checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})
 
std::set< MooseVariableFieldBase *> checkVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
virtual unsigned int getElementIDIndex (const std::string &id_parameter_name, unsigned int comp=0) const
 
virtual unsigned int getElementIDIndexByName (const std::string &id_name) const
 
virtual const dof_id_type & getElementID (const std::string &id_parameter_name, unsigned int comp=0) const
 
dof_id_type getElementID (const Elem *elem, unsigned int elem_id_index) const
 
virtual const dof_id_type & getElementIDNeighbor (const std::string &id_parameter_name, unsigned int comp=0) const
 
virtual const dof_id_type & getElementIDByName (const std::string &id_name) const
 
virtual const dof_id_type & getElementIDNeighborByName (const std::string &id_name) const
 
bool hasElementID (const std::string &id_name) const
 
dof_id_type maxElementID (unsigned int elem_id_index) const
 
dof_id_type minElementID (unsigned int elem_id_index) const
 
bool areElemIDsIdentical (const std::string &id_name1, const std::string &id_name2) const
 
std::unordered_map< dof_id_type, std::set< dof_id_type > > getElemIDMapping (const std::string &id_name1, const std::string &id_name2) const
 
std::set< dof_id_type > getAllElemIDs (unsigned int elem_id_index) const
 
std::set< dof_id_type > getElemIDsOnBlocks (unsigned int elem_id_index, const std::set< SubdomainID > &blks) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
const Function & getFunction (const std::string &name) const
 
const Function & getFunctionByName (const FunctionName &name) const
 
bool hasFunction (const std::string &param_name) const
 
bool hasFunctionByName (const FunctionName &name) const
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
 
const VectorPostprocessorName & getVectorPostprocessorName (const std::string &param_name) const
 
T & getSampler (const std::string &name)
 
Sampler & getSampler (const std::string &name)
 
T & getSamplerByName (const SamplerName &name)
 
Sampler & getSamplerByName (const SamplerName &name)
 
virtual void meshChanged ()
 
virtual void meshDisplaced ()
 
PerfGraph & perfGraph ()
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 
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 ()
 
static void sort (typename std::vector< T > &vector)
 
static void sortDFS (typename std::vector< T > &vector)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
 
static bool restricted (const std::set< BoundaryID > &ids)
 

Public Attributes

 ALL
 
 ANY
 
const ConsoleStream _console
 

Static Public Attributes

static constexpr PropertyValue::id_type default_property_id
 
static constexpr PropertyValue::id_type zero_property_id
 
static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

virtual void threadJoinViewFactor (const UserObject &y) override
 a purely virtual function called in finalize, must be overriden by derived class More...
 
virtual void finalizeViewFactor () override
 a purely virtural function called in finalize, must be overriden by derived class More...
 
virtual void threadJoin (const UserObject &y) override final
 
Real devReciprocity (unsigned int i, unsigned int j) const
 this function computes the deviation from reciprocity defined as Fij - Aj/Ai * Fji More...
 
Real maxDevReciprocity () const
 this function computes the maximum absolute value of the deviation from reciprocity More...
 
Real viewFactorRowSum (unsigned int i) const
 sum of a row in the view factor matrix More...
 
Real maxDevRowSum () const
 maximum deviation of any view factor row sum from 1 More...
 
unsigned int indexHelper (unsigned int i, unsigned int j) const
 helper for finding index of correction for i,j-th entry More...
 
unsigned int getSideNameIndex (std::string name) const
 helper function to get the index from the boundary name More...
 
void checkAndNormalizeViewFactor ()
 this function checks & normalizes view factors to sum to one, this is not always More...
 
void getFaceInfos ()
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObject &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
const ReporterName & getReporterName (const std::string &param_name) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
bool hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
virtual void coupledCallback (const std::string &, bool) const
 
virtual bool isCoupled (const std::string &var_name, unsigned int i=0) const
 
virtual bool isCoupledConstant (const std::string &var_name) const
 
unsigned int coupledComponents (const std::string &var_name) const
 
VariableName coupledName (const std::string &var_name, unsigned int comp=0) const
 
std::vector< VariableName > coupledNames (const std::string &var_name) const
 
virtual unsigned int coupled (const std::string &var_name, unsigned int comp=0) const
 
std::vector< unsigned int > coupledIndices (const std::string &var_name) const
 
virtual const VariableValue & coupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValues (const std::string &var_name) const
 
std::vector< const VectorVariableValue *> coupledVectorValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
const GenericVectorVariableValue< is_ad > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVectorVariableValue< false > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const
 
const GenericVectorVariableValue< true > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const
 
std::vector< const GenericVariableValue< is_ad > *> coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< false > *> coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< true > *> coupledGenericValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericDofValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< is_ad > & coupledGenericDot (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< is_ad > & coupledGenericDotDot (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDotDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDotDot (const std::string &var_name, unsigned int comp) const
 
virtual const VariableValue & coupledValueLower (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledValues (const std::string &var_name) const
 
const ADVariableValue & adCoupledLowerValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValue & adCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVectorVariableValue *> adCoupledVectorValues (const std::string &var_name) const
 
virtual const VariableValue & coupledVectorTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValue & coupledVectorTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableValue *> coupledVectorTagValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledVectorTagValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const ArrayVariableValue & coupledVectorTagArrayValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableValue & coupledVectorTagArrayValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const ArrayVariableValue *> coupledVectorTagArrayValues (const std::string &var_names, TagID tag) const
 
std::vector< const ArrayVariableValue *> coupledVectorTagArrayValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableGradient & coupledVectorTagGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableGradient & coupledVectorTagGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableGradient *> coupledVectorTagGradients (const std::string &var_names, TagID tag) const
 
std::vector< const VariableGradient *> coupledVectorTagGradients (const std::string &var_names, const std::string &tag_name) const
 
virtual const ArrayVariableGradient & coupledVectorTagArrayGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableGradient & coupledVectorTagArrayGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const ArrayVariableGradient *> coupledVectorTagArrayGradients (const std::string &var_names, TagID tag) const
 
std::vector< const ArrayVariableGradient *> coupledVectorTagArrayGradients (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableValue & coupledVectorTagDofValue (const std::string &var_name, TagID tag, unsigned int index=0) const
 
virtual const VariableValue & coupledVectorTagDofValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
const ArrayVariableValue & coupledVectorTagArrayDofValue (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledVectorTagDofValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledVectorTagDofValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableValue & coupledMatrixTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValue & coupledMatrixTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableValue *> coupledMatrixTagValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledMatrixTagValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VectorVariableValue & coupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ArrayVariableValue *> coupledArrayValues (const std::string &var_name) const
 
MooseWritableVariable & writableVariable (const std::string &var_name, unsigned int comp=0)
 
virtual VariableValue & writableCoupledValue (const std::string &var_name, unsigned int comp=0)
 
void checkWritableVar (MooseWritableVariable *var)
 
virtual const VariableValue & coupledValueOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValuesOld (const std::string &var_name) const
 
std::vector< const VectorVariableValue *> coupledVectorValuesOld (const std::string &var_name) const
 
virtual const VariableValue & coupledValueOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValuesOlder (const std::string &var_name) const
 
virtual const VariableValue & coupledValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradient (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient *> coupledGradients (const std::string &var_name) const
 
const ADVariableGradient & adCoupledGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableGradient & adCoupledGradientDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableGradient *> adCoupledGradients (const std::string &var_name) const
 
const GenericVariableGradient< is_ad > & coupledGenericGradient (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableGradient< false > & coupledGenericGradient (const std::string &var_name, unsigned int comp) const
 
const GenericVariableGradient< true > & coupledGenericGradient (const std::string &var_name, unsigned int comp) const
 
std::vector< const GenericVariableGradient< is_ad > *> coupledGenericGradients (const std::string &var_name) const
 
std::vector< const GenericVariableGradient< false > *> coupledGenericGradients (const std::string &var_name) const
 
std::vector< const GenericVariableGradient< true > *> coupledGenericGradients (const std::string &var_name) const
 
const ADVectorVariableGradient & adCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableSecond & adCoupledSecond (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableSecond & adCoupledVectorSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient *> coupledGradientsOld (const std::string &var_name) const
 
virtual const VariableGradient & coupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurl & coupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurl & coupledCurlOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurl & coupledCurlOlder (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableCurl & adCoupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergence & coupledDiv (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergence & coupledDivOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergence & coupledDivOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecondOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecondOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecondPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledDots (const std::string &var_name) const
 
virtual const VariableValue & coupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledDots (const std::string &var_name) const
 
const ADVariableValue & adCoupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValue & adCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledVectorDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledVectorDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledArrayDotDu (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValue (const std::string &var_name, unsigned int comp=0) const
 
const Moose::ADType< T >::type & adCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNodalDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNodalDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNodalDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValues (const std::string &var_name) const
 
virtual const VariableValue & coupledDofValuesOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValuesOld (const std::string &var_name) const
 
virtual const VariableValue & coupledDofValuesOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValuesOlder (const std::string &var_name) const
 
virtual const ArrayVariableValue & coupledArrayDofValues (const std::string &var_name, unsigned int comp=0) const
 
virtual const ADVariableValue & adCoupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adZeroValue () const
 
const ADVariableGradient & adZeroGradient () const
 
const ADVariableSecond & adZeroSecond () const
 
const GenericVariableValue< is_ad > & genericZeroValue ()
 
const GenericVariableValue< false > & genericZeroValue ()
 
const GenericVariableValue< true > & genericZeroValue ()
 
const GenericVariableGradient< is_ad > & genericZeroGradient ()
 
const GenericVariableGradient< false > & genericZeroGradient ()
 
const GenericVariableGradient< true > & genericZeroGradient ()
 
const GenericVariableSecond< is_ad > & genericZeroSecond ()
 
const GenericVariableSecond< false > & genericZeroSecond ()
 
const GenericVariableSecond< true > & genericZeroSecond ()
 
bool checkVar (const std::string &var_name, unsigned int comp=0, unsigned int comp_bound=0) const
 
const MooseVariableFieldBase * getFEVar (const std::string &var_name, unsigned int comp) const
 
const MooseVariableFieldBase * getFieldVar (const std::string &var_name, unsigned int comp) const
 
MooseVariableFieldBase * getFieldVar (const std::string &var_name, unsigned int comp)
 
const T * getVarHelper (const std::string &var_name, unsigned int comp) const
 
T * getVarHelper (const std::string &var_name, unsigned int comp)
 
MooseVariable * getVar (const std::string &var_name, unsigned int comp)
 
const MooseVariable * getVar (const std::string &var_name, unsigned int comp) const
 
VectorMooseVariable * getVectorVar (const std::string &var_name, unsigned int comp)
 
const VectorMooseVariable * getVectorVar (const std::string &var_name, unsigned int comp) const
 
ArrayMooseVariable * getArrayVar (const std::string &var_name, unsigned int comp)
 
const ArrayMooseVariable * getArrayVar (const std::string &var_name, unsigned int comp) const
 
void validateExecutionerType (const std::string &name, const std::string &fn_name) const
 
std::vector< T > coupledVectorHelper (const std::string &var_name, const Func &func) const
 
bool isCoupledScalar (const std::string &var_name, unsigned int i=0) const
 
unsigned int coupledScalarComponents (const std::string &var_name) const
 
unsigned int coupledScalar (const std::string &var_name, unsigned int comp=0) const
 
libMesh::Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< is_ad > & coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const VariableValue & coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalar * getScalarVar (const std::string &var_name, unsigned int comp) const
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

Protected Attributes

const ViewFactorRayStudy & _ray_study
 
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...
 
const bool _print_view_factor_info
 
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...
 
MooseMesh & _mesh
 
const MooseArray< Point > & _q_point
 
const QBase *const & _qrule
 
const MooseArray< Real > & _JxW
 
const MooseArray< Real > & _coord
 
const MooseArray< Point > & _normals
 
const Elem *const & _current_elem
 
const unsigned int & _current_side
 
const Elem *const & _current_side_elem
 
const Real & _current_side_volume
 
const BoundaryID & _current_boundary_id
 
std::vector< const FaceInfo *> _face_infos
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
const THREAD_ID _tid
 
Assembly & _assembly
 
const Moose::CoordinateSystemType & _coord_sys
 
const bool _duplicate_initial_execution
 
std::set< std::string > _depend_uo
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase & _mci_feproblem
 
FEProblemBase & _mdi_feproblem
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const InputParameters & _mi_params
 
const std::string _mi_name
 
const MooseObjectName _mi_moose_object_name
 
FEProblemBase & _mi_feproblem
 
SubProblem & _mi_subproblem
 
const THREAD_ID _mi_tid
 
const Moose::MaterialDataType _material_data_type
 
MaterialData & _material_data
 
bool _stateful_allowed
 
bool _get_material_property_called
 
std::vector< std::unique_ptr< PropertyValue > > _default_properties
 
std::unordered_set< unsigned int > _material_property_dependencies
 
const MaterialPropertyName _get_suffix
 
const bool _use_interpolated_state
 
const InputParameters & _c_parameters
 
const std::string & _c_name
 
const std::string & _c_type
 
FEProblemBase & _c_fe_problem
 
const SystemBase *const _c_sys
 
std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > _coupled_vars
 
std::vector< MooseVariableFieldBase *> _coupled_moose_vars
 
std::vector< MooseVariable *> _coupled_standard_moose_vars
 
std::vector< VectorMooseVariable *> _coupled_vector_moose_vars
 
std::vector< ArrayMooseVariable *> _coupled_array_moose_vars
 
std::vector< MooseVariableFV< Real > *> _coupled_standard_fv_moose_vars
 
std::vector< MooseLinearVariableFV< Real > *> _coupled_standard_linear_fv_moose_vars
 
const std::unordered_map< std::string, std::string > & _new_to_deprecated_coupled_vars
 
bool _c_nodal
 
bool _c_is_implicit
 
const bool _c_allow_element_to_nodal_coupling
 
THREAD_ID _c_tid
 
std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > > _default_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADReal > > > _ad_default_value
 
std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > > _default_vector_value
 
std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > > _default_array_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > > _ad_default_vector_value
 
VariableValue _default_value_zero
 
VariableGradient _default_gradient
 
MooseArray< ADRealVectorValue > _ad_default_gradient
 
MooseArray< ADRealTensorValue > _ad_default_vector_gradient
 
VariableSecond _default_second
 
MooseArray< ADRealTensorValue > _ad_default_second
 
MooseArray< ADRealVectorValue > _ad_default_curl
 
const VariableValue & _zero
 
const VariablePhiValue & _phi_zero
 
const MooseArray< ADReal > & _ad_zero
 
const VariableGradient & _grad_zero
 
const MooseArray< ADRealVectorValue > & _ad_grad_zero
 
const VariablePhiGradient & _grad_phi_zero
 
const VariableSecond & _second_zero
 
const MooseArray< ADRealTensorValue > & _ad_second_zero
 
const VariablePhiSecond & _second_phi_zero
 
const VectorVariableValue & _vector_zero
 
const VectorVariableCurl & _vector_curl_zero
 
VectorVariableValue _default_vector_value_zero
 
VectorVariableGradient _default_vector_gradient
 
VectorVariableCurl _default_vector_curl
 
VectorVariableDivergence _default_div
 
ArrayVariableValue _default_array_value_zero
 
ArrayVariableGradient _default_array_gradient
 
bool _coupleable_neighbor
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
const InputParameters & _ti_params
 
FEProblemBase & _ti_feproblem
 
bool _is_implicit
 
Real & _t
 
const Real & _t_old
 
int & _t_step
 
Real & _dt
 
Real & _dt_old
 
bool _is_transient
 
const Parallel::Communicator & _communicator
 

Static Protected Attributes

static const std::string _interpolated_old
 
static const std::string _interpolated_older
 

Detailed Description

Computes the view factors for planar faces in unobstructed radiative heat transfer.

Definition at line 20 of file RayTracingViewFactor.h.

Constructor & Destructor Documentation

◆ RayTracingViewFactor()

RayTracingViewFactor::RayTracingViewFactor ( const InputParameters &  parameters)

Definition at line 26 of file RayTracingViewFactor.C.

27  : ViewFactorBase(parameters), _ray_study(getUserObject<ViewFactorRayStudy>("ray_study_name"))
28 {
29  if (_mesh.dimension() == 1)
30  mooseError("View factor calculations do not support 1D");
31 }
ViewFactorBase::ViewFactorBase
ViewFactorBase(const InputParameters &parameters)
Definition: ViewFactorBase.C:33
MooseMesh::dimension
virtual unsigned int dimension() const
SideUserObject::_mesh
MooseMesh & _mesh
SideUserObject::mooseError
void mooseError(Args &&... args) const
SideUserObject::parameters
const InputParameters & parameters() const
RayTracingViewFactor::_ray_study
const ViewFactorRayStudy & _ray_study
Definition: RayTracingViewFactor.h:34

Member Function Documentation

◆ checkAndNormalizeViewFactor()

void ViewFactorBase::checkAndNormalizeViewFactor ( )
protectedinherited

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

Definition at line 158 of file ViewFactorBase.C.

Referenced by ViewFactorBase::finalize().

159 {
160  // collect statistics
161  Real max_sum_deviation = maxDevRowSum();
162  Real max_reciprocity_deviation = maxDevReciprocity();
163  Real max_correction = std::numeric_limits<Real>::lowest();
164  Real min_correction = std::numeric_limits<Real>::max();
165 
166  if (_print_view_factor_info)
167  _console << "\nSum of all view factors from side i to all other faces before normalization.\n"
168  << std::endl;
169 
170  // check view factors
171  if (_print_view_factor_info)
172  for (unsigned int from = 0; from < _n_sides; ++from)
173  _console << "View factors from sideset " << boundaryNames()[from] << " sum to "
174  << viewFactorRowSum(from) << std::endl;
175 
176  if (max_sum_deviation > _view_factor_tol)
177  mooseError("Maximum deviation of view factor row sum is ",
178  max_sum_deviation,
179  " exceeding the set tolerance of ",
180  _view_factor_tol);
181 
182  // normalize view factors
183  if (_normalize_view_factor)
184  {
185  if (_print_view_factor_info)
186  _console << "\nNormalizing view factors.\n" << std::endl;
187 
188  // allocate space
189  DenseVector<Real> rhs(_n_sides);
190  DenseVector<Real> lmults(_n_sides);
191  DenseMatrix<Real> matrix(_n_sides, _n_sides);
192 
193  // equations for the Lagrange multiplier
194  for (unsigned int i = 0; i < _n_sides; ++i)
195  {
196  // set the right hand side
197  rhs(i) = 1 - viewFactorRowSum(i);
198 
199  // contribution from the delta_ii element
200  matrix(i, i) = -0.5;
201 
202  // contributions from the upper diagonal
203  for (unsigned int j = i + 1; j < _n_sides; ++j)
204  {
205  Real ar = _areas[i] / _areas[j];
206  Real f = 2 * (1 + ar * ar);
207  matrix(i, i) += -1 / f;
208  matrix(i, j) += -1 / f * ar;
209  rhs(i) += ar * ar / (1 + ar * ar) * devReciprocity(i, j);
210  }
211 
212  // contributions from the lower diagonal
213  for (unsigned int j = 0; j < i; ++j)
214  {
215  Real ar = _areas[j] / _areas[i];
216  Real f = 2 * (1 + ar * ar);
217  matrix(i, i) += -1 / f * ar * ar;
218  matrix(i, j) += -1 / f * ar;
219  rhs(i) -= ar * devReciprocity(j, i) * (1 - ar * ar / (1 + ar * ar));
220  }
221  }
222 
223  // solve the linear system
224  matrix.lu_solve(rhs, lmults);
225 
226  // perform corrections but store view factors to temporary array
227  // because we cannot modify _view_factors as it's used in this calc
228  std::vector<std::vector<Real>> vf_temp = _view_factors;
229  for (unsigned int i = 0; i < _n_sides; ++i)
230  for (unsigned int j = 0; j < _n_sides; ++j)
231  {
232  Real correction;
233  if (i == j)
234  correction = -0.5 * lmults(i);
235  else
236  {
237  Real ar = _areas[i] / _areas[j];
238  Real f = 2 * (1 + ar * ar);
239  correction = -(lmults(i) + lmults(j) * ar + 2 * ar * ar * devReciprocity(i, j)) / f;
240  }
241 
242  // update the temporary view factor
243  vf_temp[i][j] += correction;
244 
245  if (correction < min_correction)
246  min_correction = correction;
247  if (correction > max_correction)
248  max_correction = correction;
249  }
250  _view_factors = vf_temp;
251  }
252 
253  if (_print_view_factor_info)
254  {
255  _console << "\nFinal view factors.\n" << std::endl;
256  for (unsigned int from = 0; from < _n_sides; ++from)
257  {
258  std::string from_name;
259  for (auto pair : _side_name_index)
260  if (pair.second == from)
261  from_name = pair.first;
262  auto from_id = _mesh.getBoundaryID(from_name);
263 
264  for (unsigned int to = 0; to < _n_sides; ++to)
265  {
266  std::string to_name;
267  for (auto pair : _side_name_index)
268  if (pair.second == to)
269  to_name = pair.first;
270  auto to_id = _mesh.getBoundaryID(to_name);
271  _console << from_name << " (" << from_id << ") -> " << to_name << " (" << to_id
272  << ") = " << _view_factors[from][to] << std::endl;
273  }
274  }
275  }
276 
277  // check sum of view factors and maximum deviation on reciprocity
278  Real max_sum_deviation_after_normalization = maxDevRowSum();
279  Real max_reciprocity_deviation_after_normalization = maxDevReciprocity();
280 
281  // print summary
282  _console << std::endl;
283  _console << COLOR_CYAN << "Summary of the view factor computation"
284  << "\n"
285  << COLOR_DEFAULT << std::endl;
286  if (_normalize_view_factor)
287  _console << "Normalization is performed." << std::endl;
288  else
289  _console << "Normalization is skipped." << std::endl;
290  _console << std::setw(60) << std::left << "Number of patches: " << _n_sides << std::endl;
291  _console << std::setw(60) << std::left
292  << "Max deviation sum = 1 before normalization: " << max_sum_deviation << std::endl;
293  _console << std::setw(60) << std::left
294  << "Max deviation from reciprocity before normalization: " << max_reciprocity_deviation
295  << std::endl;
296  if (_normalize_view_factor)
297  {
298  _console << std::setw(60) << std::left << "Maximum correction: " << max_correction << std::endl;
299  _console << std::setw(60) << std::left << "Minimum correction: " << min_correction << std::endl;
300  _console << std::setw(60) << "Max deviation sum = 1 after normalization: "
301  << max_sum_deviation_after_normalization << std::endl;
302  _console << std::setw(60) << std::left << "Max deviation from reciprocity after normalization: "
303  << max_reciprocity_deviation_after_normalization << std::endl;
304  _console << std::endl;
305  }
306 }
ViewFactorBase::_areas
std::vector< Real > _areas
area of the sides i
Definition: ViewFactorBase.h:67
ViewFactorBase::_side_name_index
std::unordered_map< std::string, unsigned int > _side_name_index
boundary name to index map
Definition: ViewFactorBase.h:82
ViewFactorBase::_view_factor_tol
const Real _view_factor_tol
view factor tolerance
Definition: ViewFactorBase.h:70
ViewFactorBase::_n_sides
unsigned int _n_sides
number of boundaries of this side uo
Definition: ViewFactorBase.h:64
ViewFactorBase::_print_view_factor_info
const bool _print_view_factor_info
Definition: ViewFactorBase.h:76
ViewFactorBase::_normalize_view_factor
const bool _normalize_view_factor
whether to normalize view factors so vf[from][:] sums to one
Definition: ViewFactorBase.h:73
ViewFactorBase::devReciprocity
Real devReciprocity(unsigned int i, unsigned int j) const
this function computes the deviation from reciprocity defined as Fij - Aj/Ai * Fji ...
Definition: ViewFactorBase.C:116
ViewFactorBase::maxDevRowSum
Real maxDevRowSum() const
maximum deviation of any view factor row sum from 1
Definition: ViewFactorBase.C:145
ViewFactorBase::_view_factors
std::vector< std::vector< Real > > _view_factors
the view factor from side i to side j
Definition: ViewFactorBase.h:79
f
Real f(Real x)
Test function for Brents method.
Definition: BrentsMethodTest.C:21
ViewFactorBase::viewFactorRowSum
Real viewFactorRowSum(unsigned int i) const
sum of a row in the view factor matrix
Definition: ViewFactorBase.C:136
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
SideUserObject::_mesh
MooseMesh & _mesh
SideUserObject::mooseError
void mooseError(Args &&... args) const
EM::j
static const std::complex< double > j(0, 1)
Complex number "j" (also known as "i")
SideUserObject::_console
const ConsoleStream _console
SideUserObject::boundaryNames
const std::vector< BoundaryName > & boundaryNames() const
ViewFactorBase::maxDevReciprocity
Real maxDevReciprocity() const
this function computes the maximum absolute value of the deviation from reciprocity ...
Definition: ViewFactorBase.C:122
MooseMesh::getBoundaryID
BoundaryID getBoundaryID(const BoundaryName &boundary_name) const

◆ devReciprocity()

Real ViewFactorBase::devReciprocity ( unsigned int  i,
unsigned int  j 
) const
protectedinherited

this function computes the deviation from reciprocity defined as Fij - Aj/Ai * Fji

Definition at line 116 of file ViewFactorBase.C.

Referenced by ViewFactorBase::checkAndNormalizeViewFactor(), and ViewFactorBase::maxDevReciprocity().

117 {
118  return _view_factors[i][j] - _areas[j] / _areas[i] * _view_factors[j][i];
119 }
ViewFactorBase::_areas
std::vector< Real > _areas
area of the sides i
Definition: ViewFactorBase.h:67
ViewFactorBase::_view_factors
std::vector< std::vector< Real > > _view_factors
the view factor from side i to side j
Definition: ViewFactorBase.h:79
EM::j
static const std::complex< double > j(0, 1)
Complex number "j" (also known as "i")

◆ execute()

void RayTracingViewFactor::execute ( )
overridevirtual

Implements SideUserObject.

Definition at line 34 of file RayTracingViewFactor.C.

35 {
36  // compute areas
37  auto current_boundary_name = _mesh.getBoundaryName(_current_boundary_id);
38  auto it = _side_name_index.find(current_boundary_name);
39  if (it == _side_name_index.end())
40  mooseError("Current boundary name: ",
41  current_boundary_name,
42  " with id ",
43  _current_boundary_id,
44  " not in boundary parameter.");
45 
46  _areas[it->second] += _current_side_volume;
47 }
ViewFactorBase::_areas
std::vector< Real > _areas
area of the sides i
Definition: ViewFactorBase.h:67
ViewFactorBase::_side_name_index
std::unordered_map< std::string, unsigned int > _side_name_index
boundary name to index map
Definition: ViewFactorBase.h:82
MooseMesh::getBoundaryName
const std::string & getBoundaryName(BoundaryID boundary_id)
SideUserObject::_current_side_volume
const Real & _current_side_volume
SideUserObject::_current_boundary_id
const BoundaryID & _current_boundary_id
SideUserObject::_mesh
MooseMesh & _mesh
SideUserObject::mooseError
void mooseError(Args &&... args) const

◆ finalize()

void ViewFactorBase::finalize ( )
finaloverridevirtualinherited

Implements SideUserObject.

Definition at line 93 of file ViewFactorBase.C.

94 {
95  // do some communication before finalizing view_factors
96  for (unsigned int i = 0; i < _n_sides; ++i)
97  gatherSum(_view_factors[i]);
98 
99  finalizeViewFactor();
100  checkAndNormalizeViewFactor();
101 }
ViewFactorBase::finalizeViewFactor
virtual void finalizeViewFactor()=0
a purely virtural function called in finalize, must be overriden by derived class ...
ViewFactorBase::_n_sides
unsigned int _n_sides
number of boundaries of this side uo
Definition: ViewFactorBase.h:64
SideUserObject::gatherSum
void gatherSum(T &value)
ViewFactorBase::_view_factors
std::vector< std::vector< Real > > _view_factors
the view factor from side i to side j
Definition: ViewFactorBase.h:79
ViewFactorBase::checkAndNormalizeViewFactor
void checkAndNormalizeViewFactor()
this function checks & normalizes view factors to sum to one, this is not always
Definition: ViewFactorBase.C:158

◆ finalizeViewFactor()

void RayTracingViewFactor::finalizeViewFactor ( )
overrideprotectedvirtual

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

Implements ViewFactorBase.

Definition at line 57 of file RayTracingViewFactor.C.

58 {
59  gatherSum(_areas);
60 
61  // get the _view_factors from ray study
62  for (const auto & from_name : boundaryNames())
63  for (const auto & to_name : boundaryNames())
64  {
65  unsigned int from_index = getSideNameIndex(from_name);
66  unsigned int to_index = getSideNameIndex(to_name);
67  BoundaryID from_id = _mesh.getBoundaryID(from_name);
68  BoundaryID to_id = _mesh.getBoundaryID(to_name);
69  _view_factors[from_index][to_index] = _ray_study.viewFactorInfo(from_id, to_id);
70  }
71 
72  // divide view_factor Fij by Ai and pi
73  const Real divisor = _mesh.dimension() == 2 ? 2 : libMesh::pi;
74  for (unsigned int i = 0; i < _n_sides; ++i)
75  {
76  const Real factor = 1. / (_areas[i] * divisor);
77  for (auto & vf : _view_factors[i])
78  vf *= factor;
79  }
80 }
ViewFactorBase::_areas
std::vector< Real > _areas
area of the sides i
Definition: ViewFactorBase.h:67
ViewFactorBase::_n_sides
unsigned int _n_sides
number of boundaries of this side uo
Definition: ViewFactorBase.h:64
SideUserObject::gatherSum
void gatherSum(T &value)
ViewFactorBase::_view_factors
std::vector< std::vector< Real > > _view_factors
the view factor from side i to side j
Definition: ViewFactorBase.h:79
MooseMesh::dimension
virtual unsigned int dimension() const
BoundaryID
boundary_id_type BoundaryID
ViewFactorBase::getSideNameIndex
unsigned int getSideNameIndex(std::string name) const
helper function to get the index from the boundary name
Definition: ViewFactorBase.C:53
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
SideUserObject::_mesh
MooseMesh & _mesh
ViewFactorRayStudy::viewFactorInfo
Real viewFactorInfo(const BoundaryID from_id, const BoundaryID to_id) const
Accessor for the finalized view factor info.
Definition: ViewFactorRayStudy.C:406
RayTracingViewFactor::_ray_study
const ViewFactorRayStudy & _ray_study
Definition: RayTracingViewFactor.h:34
SideUserObject::boundaryNames
const std::vector< BoundaryName > & boundaryNames() const
MooseMesh::getBoundaryID
BoundaryID getBoundaryID(const BoundaryName &boundary_name) const
libMesh::pi
const Real pi

◆ getSideNameIndex()

unsigned int ViewFactorBase::getSideNameIndex ( std::string  name) const
protectedinherited

helper function to get the index from the boundary name

Definition at line 53 of file ViewFactorBase.C.

Referenced by finalizeViewFactor().

54 {
55  auto it = _side_name_index.find(name);
56  if (it == _side_name_index.end())
57  mooseError("Boundary ", name, " does not exist.");
58  return it->second;
59 }
ViewFactorBase::_side_name_index
std::unordered_map< std::string, unsigned int > _side_name_index
boundary name to index map
Definition: ViewFactorBase.h:82
SideUserObject::name
virtual const std::string & name() const
SideUserObject::mooseError
void mooseError(Args &&... args) const

◆ getViewFactor() [1/2]

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

public interface for obtaining view factors

Definition at line 62 of file ViewFactorBase.C.

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

63 {
64  auto from_name = _mesh.getBoundaryName(from_id);
65  auto to_name = _mesh.getBoundaryName(to_id);
66 
67  return getViewFactor(from_name, to_name);
68 }
MooseMesh::getBoundaryName
const std::string & getBoundaryName(BoundaryID boundary_id)
ViewFactorBase::getViewFactor
Real getViewFactor(BoundaryID from_id, BoundaryID to_id) const
public interface for obtaining view factors
Definition: ViewFactorBase.C:62
SideUserObject::_mesh
MooseMesh & _mesh

◆ getViewFactor() [2/2]

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

Definition at line 71 of file ViewFactorBase.C.

72 {
73  auto from = _side_name_index.find(from_name);
74  auto to = _side_name_index.find(to_name);
75  if (from == _side_name_index.end())
76  mooseError("Boundary id ",
77  _mesh.getBoundaryID(from_name),
78  " with name ",
79  from_name,
80  " not listed in boundary parameter.");
81 
82  if (to == _side_name_index.end())
83  mooseError("Boundary id ",
84  _mesh.getBoundaryID(to_name),
85  " with name ",
86  to_name,
87  " not listed in boundary parameter.");
88 
89  return _view_factors[from->second][to->second];
90 }
ViewFactorBase::_side_name_index
std::unordered_map< std::string, unsigned int > _side_name_index
boundary name to index map
Definition: ViewFactorBase.h:82
ViewFactorBase::_view_factors
std::vector< std::vector< Real > > _view_factors
the view factor from side i to side j
Definition: ViewFactorBase.h:79
SideUserObject::_mesh
MooseMesh & _mesh
SideUserObject::mooseError
void mooseError(Args &&... args) const
MooseMesh::getBoundaryID
BoundaryID getBoundaryID(const BoundaryName &boundary_name) const

◆ indexHelper()

unsigned int ViewFactorBase::indexHelper ( unsigned int  i,
unsigned int  j 
) const
protectedinherited

helper for finding index of correction for i,j-th entry

Definition at line 309 of file ViewFactorBase.C.

310 {
311  mooseAssert(i <= j, "indexHelper requires i <= j");
312  if (i == j)
313  return _n_sides + i;
314  unsigned int pos = 2 * _n_sides;
315  for (unsigned int l = 0; l < _n_sides; ++l)
316  for (unsigned int m = l + 1; m < _n_sides; ++m)
317  {
318  if (l == i && m == j)
319  return pos;
320  else
321  ++pos;
322  }
323  mooseError("Should never get here");
324  return 0;
325 }
ViewFactorBase::_n_sides
unsigned int _n_sides
number of boundaries of this side uo
Definition: ViewFactorBase.h:64
SideUserObject::mooseError
void mooseError(Args &&... args) const
EM::j
static const std::complex< double > j(0, 1)
Complex number "j" (also known as "i")

◆ initialize()

void RayTracingViewFactor::initialize ( )
overridevirtual

Implements SideUserObject.

Definition at line 50 of file RayTracingViewFactor.C.

51 {
52  // set view_factors to zero
53  std::fill(_areas.begin(), _areas.end(), 0);
54 }
ViewFactorBase::_areas
std::vector< Real > _areas
area of the sides i
Definition: ViewFactorBase.h:67

◆ maxDevReciprocity()

Real ViewFactorBase::maxDevReciprocity ( ) const
protectedinherited

this function computes the maximum absolute value of the deviation from reciprocity

Definition at line 122 of file ViewFactorBase.C.

Referenced by ViewFactorBase::checkAndNormalizeViewFactor().

123 {
124  Real v = 0;
125  for (unsigned int i = 0; i < _n_sides; ++i)
126  for (unsigned int j = i + 1; j < _n_sides; ++j)
127  {
128  Real s = std::abs(devReciprocity(i, j));
129  if (s > v)
130  v = s;
131  }
132  return v;
133 }
ViewFactorBase::_n_sides
unsigned int _n_sides
number of boundaries of this side uo
Definition: ViewFactorBase.h:64
ViewFactorBase::devReciprocity
Real devReciprocity(unsigned int i, unsigned int j) const
this function computes the deviation from reciprocity defined as Fij - Aj/Ai * Fji ...
Definition: ViewFactorBase.C:116
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
NS::v
static const std::string v
Definition: NS.h:84
EM::j
static const std::complex< double > j(0, 1)
Complex number "j" (also known as "i")

◆ maxDevRowSum()

Real ViewFactorBase::maxDevRowSum ( ) const
protectedinherited

maximum deviation of any view factor row sum from 1

Definition at line 145 of file ViewFactorBase.C.

Referenced by ViewFactorBase::checkAndNormalizeViewFactor().

146 {
147  Real v = 0;
148  for (unsigned int i = 0; i < _n_sides; ++i)
149  {
150  Real s = std::abs(1 - viewFactorRowSum(i));
151  if (s > v)
152  v = s;
153  }
154  return v;
155 }
ViewFactorBase::_n_sides
unsigned int _n_sides
number of boundaries of this side uo
Definition: ViewFactorBase.h:64
ViewFactorBase::viewFactorRowSum
Real viewFactorRowSum(unsigned int i) const
sum of a row in the view factor matrix
Definition: ViewFactorBase.C:136
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
NS::v
static const std::string v
Definition: NS.h:84

◆ threadJoin()

void ViewFactorBase::threadJoin ( const UserObject &  y)
finaloverrideprotectedvirtualinherited

Implements SideUserObject.

Definition at line 104 of file ViewFactorBase.C.

105 {
106  const auto & pps = static_cast<const ViewFactorBase &>(y);
107  for (unsigned int i = 0; i < _n_sides; ++i)
108  {
109  for (unsigned int j = 0; j < _n_sides; ++j)
110  _view_factors[i][j] += pps._view_factors[i][j];
111  }
112  threadJoinViewFactor(y);
113 }
ViewFactorBase::_n_sides
unsigned int _n_sides
number of boundaries of this side uo
Definition: ViewFactorBase.h:64
y
const std::vector< double > y
Definition: EquilibriumConstantFitTest.C:18
ViewFactorBase
A base class for automatic computation of view factors between sidesets.
Definition: ViewFactorBase.h:19
ViewFactorBase::_view_factors
std::vector< std::vector< Real > > _view_factors
the view factor from side i to side j
Definition: ViewFactorBase.h:79
ViewFactorBase::threadJoinViewFactor
virtual void threadJoinViewFactor(const UserObject &y)=0
a purely virtual function called in finalize, must be overriden by derived class
EM::j
static const std::complex< double > j(0, 1)
Complex number "j" (also known as "i")

◆ threadJoinViewFactor()

void RayTracingViewFactor::threadJoinViewFactor ( const UserObject &  y)
overrideprotectedvirtual

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

Implements ViewFactorBase.

Definition at line 83 of file RayTracingViewFactor.C.

84 {
85  const auto & pps = static_cast<const RayTracingViewFactor &>(y);
86  for (unsigned int i = 0; i < _n_sides; ++i)
87  _areas[i] += pps._areas[i];
88 }
ViewFactorBase::_areas
std::vector< Real > _areas
area of the sides i
Definition: ViewFactorBase.h:67
ViewFactorBase::_n_sides
unsigned int _n_sides
number of boundaries of this side uo
Definition: ViewFactorBase.h:64
y
const std::vector< double > y
Definition: EquilibriumConstantFitTest.C:18
RayTracingViewFactor
Computes the view factors for planar faces in unobstructed radiative heat transfer.
Definition: RayTracingViewFactor.h:20

◆ validParams()

InputParameters RayTracingViewFactor::validParams ( )
static

Definition at line 17 of file RayTracingViewFactor.C.

18 {
19  InputParameters params = ViewFactorBase::validParams();
20  params.addRequiredParam<UserObjectName>("ray_study_name",
21  "Name of the view factor ray study UO.");
22  params.addClassDescription("Computes view factors for arbitrary geometries using raytracing.");
23  return params;
24 }
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
ViewFactorBase::validParams
static InputParameters validParams()
Definition: ViewFactorBase.C:16
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

◆ viewFactorRowSum()

Real ViewFactorBase::viewFactorRowSum ( unsigned int  i) const
protectedinherited

sum of a row in the view factor matrix

Definition at line 136 of file ViewFactorBase.C.

Referenced by ViewFactorBase::checkAndNormalizeViewFactor(), and ViewFactorBase::maxDevRowSum().

137 {
138  Real s = 0;
139  for (unsigned int to = 0; to < _n_sides; ++to)
140  s += _view_factors[i][to];
141  return s;
142 }
ViewFactorBase::_n_sides
unsigned int _n_sides
number of boundaries of this side uo
Definition: ViewFactorBase.h:64
ViewFactorBase::_view_factors
std::vector< std::vector< Real > > _view_factors
the view factor from side i to side j
Definition: ViewFactorBase.h:79
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Member Data Documentation

◆ _areas

std::vector<Real> ViewFactorBase::_areas
protectedinherited

area of the sides i

Definition at line 67 of file ViewFactorBase.h.

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

◆ _n_sides

unsigned int ViewFactorBase::_n_sides
protectedinherited

number of boundaries of this side uo

Definition at line 64 of file ViewFactorBase.h.

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

◆ _normalize_view_factor

const bool ViewFactorBase::_normalize_view_factor
protectedinherited

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

Definition at line 73 of file ViewFactorBase.h.

Referenced by ViewFactorBase::checkAndNormalizeViewFactor().

◆ _print_view_factor_info

const bool ViewFactorBase::_print_view_factor_info
protectedinherited

Definition at line 76 of file ViewFactorBase.h.

Referenced by ViewFactorBase::checkAndNormalizeViewFactor().

◆ _ray_study

const ViewFactorRayStudy& RayTracingViewFactor::_ray_study
protected

Definition at line 34 of file RayTracingViewFactor.h.

Referenced by finalizeViewFactor().

◆ _side_name_index

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

boundary name to index map

Definition at line 82 of file ViewFactorBase.h.

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

◆ _view_factor_tol

const Real ViewFactorBase::_view_factor_tol
protectedinherited

view factor tolerance

Definition at line 70 of file ViewFactorBase.h.

Referenced by ViewFactorBase::checkAndNormalizeViewFactor().

◆ _view_factors

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

the view factor from side i to side j

Definition at line 79 of file ViewFactorBase.h.

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

The documentation for this class was generated from the following files:
Generated on Thu Jul 17 2025 01:50:59 for https://mooseframework.inl.gov by   doxygen 1.8.14