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

#include <Reactivity.h>

Inheritance diagram for Reactivity:
[legend]

Public Member Functions

 Reactivity (const InputParameters &parameters)
 
virtual Real getValue () const override
 
virtual void initialize () override
 
virtual void execute () override
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

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

Calculate the reactivity based on the k-effective value.

Constructor & Destructor Documentation

◆ Reactivity()

Reactivity::Reactivity ( const InputParameters &  parameters)

Member Function Documentation

◆ execute()

virtual void KEigenvalue::execute ( )
inlineoverridevirtualinherited

◆ getValue()

virtual Real Reactivity::getValue ( ) const
overridevirtual

Reimplemented from KEigenvalue.

◆ initialize()

virtual void KEigenvalue::initialize ( )
inlineoverridevirtualinherited

◆ kMean()

Real KEigenvalue::kMean ( ) const
protectedinherited

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

Returns
the mean value of the k-eigenvalue

◆ kRelativeError()

Real KEigenvalue::kRelativeError ( ) const
protectedinherited

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

Returns
the relative error of the k-eigenvalue

◆ KStandardDeviation()

Real KEigenvalue::KStandardDeviation ( ) const
protectedinherited

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

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]meanmean
[in]sum_sqsum squared
[in]realizationsthe number of realizations of the variable
Returns
standard deviation

◆ validParams()

static InputParameters Reactivity::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
protectedinherited

The value of the kinetics parameter to output.

◆ _type

const eigenvalue::EigenvalueEnum KEigenvalue::_type
protectedinherited

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: