OpenMCCellMaterialFill Class Reference

#include <OpenMCCellMaterialFill.h>

Inheritance diagram for OpenMCCellMaterialFill:

Public Member Functions
	OpenMCCellMaterialFill (const InputParameters &parameters)
void	extractMaterialIdsFromFile (std::string filename, std::vector< int32_t > &material_ids)
virtual void	modifyOpenMCModel () const override
	Modify the OpenMC model. More...
const int32_t &	getCellId () const
const int32_t &	getCellIndex () const
const std::vector< int32_t > &	getMaterialIndices () const

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 &	_cell_id
	Cell to be modified. More...
int32_t	_cell_index
	Index of the cell to be modified. More...
std::vector< int32_t >	_material_indices
	Materials to be filled into the cell instances. More...
std::string	_material_ids_file
	Name of a file containing material data to be assigned to _material_indices. More...
OpenMCCellAverageProblem *	_openmc_problem
	The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase. More...

Detailed Description

Modifies the material filling an OpenMC cell prior to execution

Constructor & Destructor Documentation

OpenMCCellMaterialFill()

OpenMCCellMaterialFill::OpenMCCellMaterialFill

(

const InputParameters &

parameters

)

Member Function Documentation

extractMaterialIdsFromFile()

void OpenMCCellMaterialFill::extractMaterialIdsFromFile	(	std::string	filename,
		std::vector< int32_t > &	material_ids
	)

Read data from hdf5 file to assign to _material_indices

Parameters

[in]	filename	filename
[out]	material_ids	passed by reference to assign

getCellId()

const int32_t& OpenMCCellMaterialFill::getCellId ( ) const

inline

getCellIndex()

const int32_t& OpenMCCellMaterialFill::getCellIndex ( ) const

inline

getMaterialIndices()

const std::vector<int32_t>& OpenMCCellMaterialFill::getMaterialIndices ( ) const

inline

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

modifyOpenMCModel()

virtual void OpenMCCellMaterialFill::modifyOpenMCModel ( ) const

overridevirtual

Modify the OpenMC model.

Implements ModelModifiersBase.

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

static

Member Data Documentation

_cell_id

const int32_t& OpenMCCellMaterialFill::_cell_id

protected

Cell to be modified.

_cell_index

int32_t OpenMCCellMaterialFill::_cell_index

protected

Index of the cell to be modified.

_material_ids_file

std::string OpenMCCellMaterialFill::_material_ids_file

protected

Name of a file containing material data to be assigned to _material_indices.

_material_indices

std::vector<int32_t> OpenMCCellMaterialFill::_material_indices

protected

Materials to be filled into the cell instances.

_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/modelmodifiers/OpenMCCellMaterialFill.h