OpenMCNuclideDensities Class Reference

#include <OpenMCNuclideDensities.h>

Inheritance diagram for OpenMCNuclideDensities:

Public Member Functions
	OpenMCNuclideDensities (const InputParameters &parameters)
virtual void	initialize ()
virtual void	finalize ()
virtual void	execute ()
virtual void	setValue ()
	Instead, we want to have a separate method that we can call from the OpenMC problem. 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
const int32_t &	_material_id
	The material ID. More...
int32_t	_material_index
	The material index. More...
const std::vector< std::string > &	_names
	Nuclide names. More...
const std::vector< double > &	_densities
	Nuclide densities. More...
OpenMCCellAverageProblem *	_openmc_problem
	The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase. More...

Detailed Description

User object to modify the nuclide densities in an OpenMC material.

Constructor & Destructor Documentation

OpenMCNuclideDensities()

OpenMCNuclideDensities::OpenMCNuclideDensities

(

const InputParameters &

parameters

)

Member Function Documentation

execute()

virtual void OpenMCNuclideDensities::execute ( )

inlinevirtual

finalize()

virtual void OpenMCNuclideDensities::finalize ( )

inlinevirtual

initialize()

virtual void OpenMCNuclideDensities::initialize ( )

inlinevirtual

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

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

setValue()

virtual void OpenMCNuclideDensities::setValue ( )

virtual

Instead, we want to have a separate method that we can call from the OpenMC problem.

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 OpenMCNuclideDensities::validParams ( )

static

Member Data Documentation

_densities

const std::vector<double>& OpenMCNuclideDensities::_densities

protected

Nuclide densities.

_material_id

const int32_t& OpenMCNuclideDensities::_material_id

protected

The material ID.

_material_index

int32_t OpenMCNuclideDensities::_material_index

protected

The material index.

_names

const std::vector<std::string>& OpenMCNuclideDensities::_names

protected

Nuclide names.

_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:

• include/userobjects/OpenMCNuclideDensities.h