Cardinal
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
StatRelErrorIndicator Class Reference

An Indicator which returns the statistical error of a tally score in an element. More...

#include <StatRelErrorIndicator.h>

Inheritance diagram for StatRelErrorIndicator:
[legend]

Public Member Functions

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

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

Real stdev (const double &mean, const double &sum_sq, unsigned int realizations) const
 

Protected Attributes

const unsigned int _bin_index
 The external filter bin index for the score. More...
 
const VariableValue * _tally_rel_error
 The variables containing the tally score relative errors. More...
 
MooseVariable & _field_var
 The field variable holding the results of this indicator. More...
 
const Elem *const & _current_elem
 The current element. More...
 
OpenMCCellAverageProblem_openmc_problem
 The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase. More...
 

Detailed Description

An Indicator which returns the statistical error of a tally score in an element.

Constructor & Destructor Documentation

◆ StatRelErrorIndicator()

StatRelErrorIndicator::StatRelErrorIndicator ( const InputParameters &  parameters)

Member Function Documentation

◆ computeIndicator()

virtual void StatRelErrorIndicator::computeIndicator ( )
overridevirtual

◆ stdev()

Real OpenMCBase::stdev ( const double &  mean,
const double &  sum_sq,
unsigned int  realizations 
) const
protectedinherited

Compute standard deviation of a variable

Parameters
[in]meanmean
[in]sum_sqsum squared
[in]realizationsthe number of realizations of the variable
Returns
standard deviation

◆ validParams()

static InputParameters StatRelErrorIndicator::validParams ( )
static

Member Data Documentation

◆ _bin_index

const unsigned int StatRelErrorIndicator::_bin_index
protected

The external filter bin index for the score.

◆ _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.

◆ _openmc_problem

OpenMCCellAverageProblem* OpenMCBase::_openmc_problem
protectedinherited

The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.

◆ _tally_rel_error

const VariableValue* StatRelErrorIndicator::_tally_rel_error
protected

The variables containing the tally score relative errors.


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