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:

Public Member Functions
	StatRelErrorIndicator (const InputParameters &parameters)
virtual void	computeIndicator () override

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
std::string	getScore (const std::string &score_param)
std::string	tallyByScore (const std::string &score, const std::string &tally_param)
Real	stdev (const double &mean, const double &sum_sq, unsigned int realizations) const
Real	kMean (const eigenvalue::EigenvalueEnum estimator) const
Real	kStandardDeviation (const eigenvalue::EigenvalueEnum estimator) 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

getScore()

std::string TallyInterface::getScore ( const std::string &  score_param )

protectedinherited

Get the score given a parameter name which points to a MooseEnum parameter. This checks to ensure that the score is valid (at least one tally is accumulating it).

Parameters

[in]

score_param

the name of the input parameter holding the score

Returns

the valid score

kMean()

Real OpenMCBase::kMean ( const eigenvalue::EigenvalueEnum  estimator ) const

protectedinherited

A function which computes the mean value of \(k_{eff}\).

Parameters

[in]

estimator

type of estimator

Returns

the mean value of the k-eigenvalue

kStandardDeviation()

Real OpenMCBase::kStandardDeviation ( const eigenvalue::EigenvalueEnum  estimator ) const

protectedinherited

A function which computes the standard deviation of \(k_{eff}\).

Parameters

[in]

estimator

type of estimator

Returns

the standard deviation of the k-eigenvalue

stdev()

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

protectedinherited

Compute standard deviation of a variable

Parameters

[in]	mean	mean
[in]	sum_sq	sum squared
[in]	realizations	the number of realizations of the variable

Returns

standard deviation

tallyByScore()

std::string TallyInterface::tallyByScore ( const std::string &  score, const std::string &  tally_param  )

protectedinherited

Fetch a tally name by the score and the tally param in the input parameters. This checks the tally to ensure it is valid for the given score. If the parameter 'tally_param' is not valid and only one tally object accumulates 'score', this function returns the name of that tally.

Parameters

[in]	score	the score which the tally should be accumulating
[in]	tally_param	the parameter name in the input parameters for '_object' which contains the name of a tally.

Returns

the name of the tally which can be used to fetch score variables

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:

• include/indicators/StatRelErrorIndicator.h