Cardinal
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
BetaEffective Class Reference

#include <BetaEffective.h>

Inheritance diagram for BetaEffective:
[legend]

Public Member Functions

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

Static Public Member Functions

static InputParameters validParams ()
 

Protected Types

enum  BetaTypeEnum {
  BetaTypeEnum::Sum = 0, BetaTypeEnum::D_1 = 1, BetaTypeEnum::D_2 = 2, BetaTypeEnum::D_3 = 3,
  BetaTypeEnum::D_4 = 4, BetaTypeEnum::D_5 = 5, BetaTypeEnum::D_6 = 6
}
 

Protected Member Functions

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 statistics::OutputEnum _output
 The value of the kinetics parameter to output. More...
 
enum BetaEffective::BetaTypeEnum _beta_type
 
OpenMCCellAverageProblem_openmc_problem
 The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase. More...
 

Member Enumeration Documentation

◆ BetaTypeEnum

enum BetaEffective::BetaTypeEnum
strongprotected
Enumerator
Sum 
D_1 
D_2 
D_3 
D_4 
D_5 
D_6 

Constructor & Destructor Documentation

◆ BetaEffective()

BetaEffective::BetaEffective ( const InputParameters &  parameters)

Member Function Documentation

◆ execute()

virtual void BetaEffective::execute ( )
inlineoverridevirtual

◆ getValue()

virtual Real BetaEffective::getValue ( ) const
overridevirtual

◆ initialize()

virtual void BetaEffective::initialize ( )
inlineoverridevirtual

◆ kMean()

Real OpenMCBase::kMean ( const eigenvalue::EigenvalueEnum  estimator) const
protectedinherited

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

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

◆ validParams()

static InputParameters BetaEffective::validParams ( )
static

Member Data Documentation

◆ _beta_type

enum BetaEffective::BetaTypeEnum BetaEffective::_beta_type
protected

◆ _openmc_problem

OpenMCCellAverageProblem* OpenMCBase::_openmc_problem
protectedinherited

The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.

◆ _output

const statistics::OutputEnum BetaEffective::_output
protected

The value of the kinetics parameter to output.


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