FoMAux Class Reference

#include <FoMAux.h>

Inheritance diagram for FoMAux:

Public Member Functions
	FoMAux (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
enum	FoMType { FoMType::VR = 0, FoMType::AMR = 1 }
	The type of FoM to compute. More...

Protected Member Functions
virtual Real	computeValue () override
bool	mappedElement ()
void	errorCoupledConstMonomial (const std::string &param_name)
std::string	getScore (const std::string &score_param)
std::string	tallyByScore (const std::string &score, const std::string &tally_param)
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 VariableValue *	_tally_val
	The variable containing the tally. Used for the AMR FoM. More...
const VariableValue *	_tally_val_init
	A variable containing the initial value of the tally. Used for the AMR FoM. More...
const VariableValue &	_tally_val_rel_err
	The statistical relative error of the tally. Used for both FoMs. More...
const Real &	_sim_time
	The simulation time. Used for both FoMs. More...
enum FoMAux::FoMType	_fom_type
OpenMCCellAverageProblem *	_openmc_problem
	The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase. More...

Detailed Description

A class which computes a Figure of Merit (FoM) for a tally quantity. There are two options:

• The variance reduction FoM: $FoM_{VR} = 1 / (T * R^2)$
• The Adaptive Mesh Refinement (AMR) FoM: $FoM_{AMR} = |u_j - u_0| / (T * R * u_0)$ where $T$ is the OpenMC simulation time, $R$ is the relative statistical error of the field variable, $u_j$ is the variable value at adaptivity step j, and $u_0$ is the initial value of the field variable on the initial simulation.

Member Enumeration Documentation

FoMType

enum FoMAux::FoMType

strongprotected

The type of FoM to compute.

Enumerator
VR
AMR

Constructor & Destructor Documentation

FoMAux()

FoMAux::FoMAux

(

const InputParameters &

parameters

)

Member Function Documentation

computeValue()

virtual Real FoMAux::computeValue ( )

overrideprotectedvirtual

Implements OpenMCAuxKernelTempl< ComputeValueType >.

errorCoupledConstMonomial()

template<typename ComputeValueType >

void OpenMCAuxKernelTempl< ComputeValueType >::errorCoupledConstMonomial ( const std::string &  param_name )

protectedinherited

A function which throws an error if a coupled variable is not a constant monomial.

Parameters

[in]

param_name

the name of the paraemter to check

getScore()

std::string TallyInterface::getScore ( const std::string &  score_param )

protectedinherited

Get the score given a parameter name which points to a MooseEnum parameter. This checks to ensure that the score is valid (at least one tally is accumulating it).

Parameters

[in]

score_param

the name of the input parameter holding the score

Returns

the valid score

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

mappedElement()

template<typename ComputeValueType >

bool OpenMCAuxKernelTempl< ComputeValueType >::mappedElement ( )

protectedinherited

Determine whether the MOOSE element maps to an OpenMC cell to make sure we don't call accessor methods that rely on valid values for the cell instance and index

Returns

whether element maps to OpenMC

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

tallyByScore()

std::string TallyInterface::tallyByScore ( const std::string &  score, const std::string &  tally_param  )

protectedinherited

Fetch a tally name by the score and the tally param in the input parameters. This checks the tally to ensure it is valid for the given score. If the parameter 'tally_param' is not valid and only one tally object accumulates 'score', this function returns the name of that tally.

Parameters

[in]	score	the score which the tally should be accumulating
[in]	tally_param	the parameter name in the input parameters for '_object' which contains the name of a tally.

Returns

the name of the tally which can be used to fetch score variables

validParams()

static InputParameters FoMAux::validParams ( )

static

Member Data Documentation

_fom_type

enum FoMAux::FoMType FoMAux::_fom_type

protected

_openmc_problem

OpenMCCellAverageProblem* OpenMCBase::_openmc_problem

protectedinherited

The OpenMCCellAverageProblem required by all objects which inherit from OpenMCBase.

_sim_time

const Real& FoMAux::_sim_time

protected

The simulation time. Used for both FoMs.

_tally_val

const VariableValue* FoMAux::_tally_val

protected

The variable containing the tally. Used for the AMR FoM.

_tally_val_init

const VariableValue* FoMAux::_tally_val_init

protected

A variable containing the initial value of the tally. Used for the AMR FoM.

_tally_val_rel_err

const VariableValue& FoMAux::_tally_val_rel_err

protected

The statistical relative error of the tally. Used for both FoMs.

---

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

• include/auxkernels/FoMAux.h