TallyRelativeError Class Reference

#include <TallyRelativeError.h>

Inheritance diagram for TallyRelativeError:

Public Member Functions
	TallyRelativeError (const InputParameters &parameters)
virtual void	initialize () override
virtual void	execute () override
virtual Real	getValue () const 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 operation::OperationEnum	_type
	type of extrema operation More...
std::string	_score
	The tally score we want to fetch the relative error of. More...
const TallyBase *	_tally
	The tally we're computing the relative error from. More...
OpenMCCellAverageProblem *	_openmc_problem
	The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase. More...

Detailed Description

Compute the max/min relative error of the tally coupling OpenMC to MOOSE.

Constructor & Destructor Documentation

TallyRelativeError()

TallyRelativeError::TallyRelativeError

(

const InputParameters &

parameters

)

Member Function Documentation

execute()

virtual void TallyRelativeError::execute ( )

inlineoverridevirtual

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

getValue()

virtual Real TallyRelativeError::getValue ( ) const

overridevirtual

initialize()

virtual void TallyRelativeError::initialize ( )

inlineoverridevirtual

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 TallyRelativeError::validParams ( )

static

Member Data Documentation

_openmc_problem

OpenMCCellAverageProblem* OpenMCBase::_openmc_problem

protectedinherited

The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.

_score

std::string TallyRelativeError::_score

protected

The tally score we want to fetch the relative error of.

_tally

const TallyBase* TallyRelativeError::_tally

protected

The tally we're computing the relative error from.

_type

const operation::OperationEnum TallyRelativeError::_type

protected

type of extrema operation

---

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

• include/postprocessors/TallyRelativeError.h