KEigenvalue Class Reference

#include <KEigenvalue.h>

Inheritance diagram for KEigenvalue:

Public Member Functions
	KEigenvalue (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	kRelativeError () const
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 eigenvalue::EigenvalueEnum	_type
const statistics::OutputEnum	_output
	The value of the kinetics parameter to output. More...
OpenMCCellAverageProblem *	_openmc_problem
	The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase. More...

Detailed Description

Get the k-effective eigenvalue computed by OpenMC.

Constructor & Destructor Documentation

KEigenvalue()

KEigenvalue::KEigenvalue

(

const InputParameters &

parameters

)

Member Function Documentation

execute()

virtual void KEigenvalue::execute ( )

inlineoverridevirtual

getValue()

virtual Real KEigenvalue::getValue ( ) const

overridevirtual

Reimplemented in Reactivity, and LambdaEffective.

initialize()

virtual void KEigenvalue::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

kRelativeError()

Real KEigenvalue::kRelativeError ( ) const

protected

A function which computes the relative error of k_{eff}.

Returns

the relative error 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

validParams()

static InputParameters KEigenvalue::validParams ( )

static

Member Data Documentation

_openmc_problem

OpenMCCellAverageProblem* OpenMCBase::_openmc_problem

protectedinherited

The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.

_output

const statistics::OutputEnum KEigenvalue::_output

protected

The value of the kinetics parameter to output.

_type

const eigenvalue::EigenvalueEnum KEigenvalue::_type

protected

Type of k-effective 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:

• include/postprocessors/KEigenvalue.h