Cardinal
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ModelModifiersBase Class Referenceabstract

#include <ModelModifiersBase.h>

Inheritance diagram for ModelModifiersBase:
[legend]

Public Member Functions

 ModelModifiersBase (const InputParameters &parameters)
 
virtual void modifyOpenMCModel () const =0
 Modify the OpenMC model. More...
 

Static Public Member Functions

static InputParameters validParams ()
 

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

OpenMCCellAverageProblem_openmc_problem
 The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase. More...
 

Detailed Description

Applies a modification to the OpenMC model prior to execution.

Constructor & Destructor Documentation

◆ ModelModifiersBase()

ModelModifiersBase::ModelModifiersBase ( const InputParameters &  parameters)

Member Function Documentation

◆ 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

◆ modifyOpenMCModel()

virtual void ModelModifiersBase::modifyOpenMCModel ( ) const
pure virtual

Modify the OpenMC model.

Implemented in OpenMCCellMaterialFill.

◆ 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 ModelModifiersBase::validParams ( )
static

Member Data Documentation

◆ _openmc_problem

OpenMCCellAverageProblem* OpenMCBase::_openmc_problem
protectedinherited

The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.


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