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

#include <TallyRelativeError.h>

Inheritance diagram for TallyRelativeError:
[legend]

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

Real stdev (const double &mean, const double &sum_sq, unsigned int realizations) 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...
 
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

◆ getValue()

virtual Real TallyRelativeError::getValue ( ) const
overridevirtual

◆ initialize()

virtual void TallyRelativeError::initialize ( )
inlineoverridevirtual

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

◆ _type

const operation::OperationEnum TallyRelativeError::_type
protected

type of extrema operation


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