OpenMCMaterialSearch Class Reference

#include <OpenMCMaterialSearch.h>

Inheritance diagram for OpenMCMaterialSearch:

Public Member Functions
	OpenMCMaterialSearch (const InputParameters &parameters)
virtual void	updateOpenMCModel (const Real &input)=0
virtual void	searchForCriticality ()
	Use Brent's method to search for criticality. More...

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual std::string	quantity () const =0
	The quantity being varied in the search for criticality, for console prints. More...
virtual std::string	units () const =0
	Assumed units in the input quantities. More...
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
	Material to be modified. More...
int32_t	_material_index
	Material index corresponding to the ID. More...
const Real &	_maximum
	Maximum range of value to explore. More...
const Real &	_minimum
	Minimum range of value to explore. More...
const Real &	_tolerance
	Absolute tolerance for finding a critical configuration. More...
const eigenvalue::EigenvalueEnum	_estimator
	Estimator to use for k. More...
const Real &	_target
	Target k. More...
std::vector< Real >	_inputs
	Values used in search. More...
std::vector< Real >	_k_values
	Values obtained in search. More...
std::vector< Real >	_k_std_dev_values
	Standard deviation values obtained in search. More...
const std::string	_pp_name = "critical_value"
	Postprocessor that holds the result of the criticality search. More...
OpenMCCellAverageProblem *	_openmc_problem
	The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase. More...

Detailed Description

Perform a criticality search based on a material

Constructor & Destructor Documentation

OpenMCMaterialSearch()

OpenMCMaterialSearch::OpenMCMaterialSearch

(

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]

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

quantity()

virtual std::string CriticalitySearchBase::quantity ( ) const

protectedpure virtualinherited

The quantity being varied in the search for criticality, for console prints.

Implemented in BoratedWater, OpenMCMaterialDensity, and RotationSearch.

searchForCriticality()

virtual void CriticalitySearchBase::searchForCriticality ( )

virtualinherited

Use Brent's method to search for criticality.

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

units()

virtual std::string CriticalitySearchBase::units ( ) const

protectedpure virtualinherited

Assumed units in the input quantities.

Implemented in BoratedWater, OpenMCMaterialDensity, and RotationSearch.

updateOpenMCModel()

virtual void CriticalitySearchBase::updateOpenMCModel ( const Real &  input )

pure virtualinherited

Modify the OpenMC model

Parameters

[in]

input

value to apply to the new model; interpretation depends on derived classes

Implemented in BoratedWater, OpenMCMaterialDensity, and RotationSearch.

validParams()

static InputParameters OpenMCMaterialSearch::validParams ( )

static

Member Data Documentation

_estimator

const eigenvalue::EigenvalueEnum CriticalitySearchBase::_estimator

protectedinherited

Estimator to use for k.

_inputs

std::vector<Real> CriticalitySearchBase::_inputs

protectedinherited

Values used in search.

_k_std_dev_values

std::vector<Real> CriticalitySearchBase::_k_std_dev_values

protectedinherited

Standard deviation values obtained in search.

_k_values

std::vector<Real> CriticalitySearchBase::_k_values

protectedinherited

Values obtained in search.

_material_id

const int32_t& OpenMCMaterialSearch::_material_id

protected

Material to be modified.

_material_index

int32_t OpenMCMaterialSearch::_material_index

protected

Material index corresponding to the ID.

_maximum

const Real& CriticalitySearchBase::_maximum

protectedinherited

Maximum range of value to explore.

_minimum

const Real& CriticalitySearchBase::_minimum

protectedinherited

Minimum range of value to explore.

_openmc_problem

OpenMCCellAverageProblem* OpenMCBase::_openmc_problem

protectedinherited

The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.

_pp_name

const std::string CriticalitySearchBase::_pp_name = "critical_value"

protectedinherited

Postprocessor that holds the result of the criticality search.

_target

const Real& CriticalitySearchBase::_target

protectedinherited

Target k.

_tolerance

const Real& CriticalitySearchBase::_tolerance

protectedinherited

Absolute tolerance for finding a critical configuration.

---

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

• include/criticality/OpenMCMaterialSearch.h