Loading [MathJax]/extensions/tex2jax.js
Cardinal
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Static Public Member Functions | Protected Types | Protected Attributes | List of all members
ElementOpticalDepthIndicator Class Reference

#include <ElementOpticalDepthIndicator.h>

Inheritance diagram for ElementOpticalDepthIndicator:
[legend]

Public Member Functions

 ElementOpticalDepthIndicator (const InputParameters &parameters)
 
virtual void computeIndicator () override
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Types

enum class  HType { Min = 0 , Max = 1 , CubeRoot = 2 }
 The type of element length to use for estimating the optical depth. More...
 

Protected Attributes

enum ElementOpticalDepthIndicator::HType _h_type
 
std::vector< const VariableValue * > _rxn_rates
 
std::vector< const VariableValue * > _scalar_fluxes
 
MooseVariable & _field_var
 The field variable holding the results of this indicator.
 
const Elem *const & _current_elem
 The current element.
 
OpenMCCellAverageProblem_openmc_problem
 The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.
 

Detailed Description

An Indicator which returns an estimate of the optical depth experienced by photons/neutrons which traverse the element.

Member Enumeration Documentation

◆ HType

enum class ElementOpticalDepthIndicator::HType
strongprotected

The type of element length to use for estimating the optical depth.

Enumerator
Min 
Max 
CubeRoot 

Constructor & Destructor Documentation

◆ ElementOpticalDepthIndicator()

ElementOpticalDepthIndicator::ElementOpticalDepthIndicator ( const InputParameters &  parameters)

Member Function Documentation

◆ computeIndicator()

virtual void ElementOpticalDepthIndicator::computeIndicator ( )
overridevirtual

◆ validParams()

static InputParameters ElementOpticalDepthIndicator::validParams ( )
static

Member Data Documentation

◆ _current_elem

const Elem* const& OpenMCIndicator::_current_elem
protectedinherited

The current element.

◆ _field_var

MooseVariable& OpenMCIndicator::_field_var
protectedinherited

The field variable holding the results of this indicator.

◆ _h_type

enum ElementOpticalDepthIndicator::HType ElementOpticalDepthIndicator::_h_type
protected

◆ _openmc_problem

OpenMCCellAverageProblem* OpenMCBase::_openmc_problem
protectedinherited

The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.

◆ _rxn_rates

std::vector<const VariableValue *> ElementOpticalDepthIndicator::_rxn_rates
protected

The variables containing the reaction rate. This needs to be a vector because the reaction rate score may have filters applied, and so we need to sum the reaction rate over all filter bins.

◆ _scalar_fluxes

std::vector<const VariableValue *> ElementOpticalDepthIndicator::_scalar_fluxes
protected

The variables containing the scalar flux. This needs to be a vector because the scalar flux score may have filters applied, and so we need to sum the scalar fluxes over all filter bins.


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