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
KStandardDeviation Class Reference

#include <KStandardDeviation.h>

Inheritance diagram for KStandardDeviation:
[legend]

Public Member Functions

 KStandardDeviation (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) const
 

Protected Attributes

const eigenvalue::EigenvalueEnum _type
 
OpenMCCellAverageProblem_openmc_problem
 The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.
 

Detailed Description

Get the k-effective eigenvalue standard deviation computed by OpenMC.

Constructor & Destructor Documentation

◆ KStandardDeviation()

KStandardDeviation::KStandardDeviation ( const InputParameters &  parameters)

Member Function Documentation

◆ execute()

virtual void KStandardDeviation::execute ( )
inlineoverridevirtual

◆ getValue()

virtual Real KStandardDeviation::getValue ( ) const
overridevirtual

◆ initialize()

virtual void KStandardDeviation::initialize ( )
inlineoverridevirtual

◆ stdev()

Real KStandardDeviation::stdev ( const double &  mean,
const double &  sum_sq 
) const
protected

Compute standard deviation

Parameters
[in]meanmean
[in]sum_sqsum squared
Returns
standard deviation given N OpenMC realizations

◆ validParams()

static InputParameters KStandardDeviation::validParams ( )
static

Member Data Documentation

◆ _openmc_problem

OpenMCCellAverageProblem* OpenMCBase::_openmc_problem
protectedinherited

The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.

◆ _type

const eigenvalue::EigenvalueEnum KStandardDeviation::_type
protected

Type of k-effective standard deviation value to report. Options: collision, absorption, tracklength, and combined (default).

The combined k-effective estimate is a minimum variance estimate of k-effective based on a linear combination of the collision, absorption, and tracklength estimates.


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