#include <RotationSearch.h>

Inheritance diagram for RotationSearch:

Public Member Functions
	RotationSearch (const InputParameters &parameters)

virtual void	updateOpenMCModel (const Real &angle) override

virtual void	searchForCriticality ()
	Use Brent's method to search for criticality. More...

void	transform (const MooseEnum &transform_type, const Point &transform_vector)

Static Public Member Functions
static InputParameters	validParams ()

Static Public Attributes
static const MooseEnum	transform_type
	Enumeration for the transform type. More...

static const std::array< std::string, 3 >	rotation_vector_symbols
	The symbols for each dimension in the transform vector: ["φ", "θ", "ψ"]. More...

static const std::string	rotation_vector_symbols_list
	The symbols for the transform vector in a list form: "φ, θ, ψ". More...

Protected Member Functions
virtual std::string	units () const override
	Assumed units in the input quantities. More...

virtual std::string	quantity () const override
	The quantity being varied in the search for criticality, for console prints. 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 int	_rotation_axis_idx
	the index of the rotational axis used to search for criticality 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...

const std::set< int32_t >	_cell_ids
	OpenMC cell IDs to which the translation will be applied. More...

Detailed Description

Perform a criticality search based on a rotation angle

Constructor & Destructor Documentation

◆ RotationSearch()

RotationSearch::RotationSearch ( 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 RotationSearch::quantity ( ) const

inlineoverrideprotectedvirtual

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

Implements CriticalitySearchBase.

◆ 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

◆ transform()

void OpenMCCellTransformBase::transform	(	const MooseEnum &	transform_type,
		const Point &	transform_vector
	)

inherited

Do a transformation on the given cells.

Parameters

[in]	transform_type	The transform type (translation or rotation)
[in]	transform_vector	The vector by to transform

◆ units()

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

inlineoverrideprotectedvirtual

Assumed units in the input quantities.

Implements CriticalitySearchBase.

◆ updateOpenMCModel()

virtual void RotationSearch::updateOpenMCModel ( const Real & angle )

overridevirtual

Update OpenMC model with the next guess for critical.

Parameters

[in] angle guess to pass to the next iteration

Implements CriticalitySearchBase.

◆ validParams()

static InputParameters RotationSearch::validParams ( )

static

Member Data Documentation

◆ _cell_ids

const std::set<int32_t> OpenMCCellTransformBase::_cell_ids

protectedinherited

OpenMC cell IDs to which the translation will be applied.

◆ _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.

◆ _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.

◆ _rotation_axis_idx

const int RotationSearch::_rotation_axis_idx

protected

the index of the rotational axis used to search for criticality

◆ _target

const Real& CriticalitySearchBase::_target

protectedinherited

Target k.

◆ _tolerance

const Real& CriticalitySearchBase::_tolerance

protectedinherited

Absolute tolerance for finding a critical configuration.

◆ rotation_vector_symbols

const std::array<std::string, 3> OpenMCCellTransformBase::rotation_vector_symbols

staticinherited

The symbols for each dimension in the transform vector: ["φ", "θ", "ψ"].

◆ rotation_vector_symbols_list

const std::string OpenMCCellTransformBase::rotation_vector_symbols_list

staticinherited

The symbols for the transform vector in a list form: "φ, θ, ψ".

◆ transform_type

const MooseEnum OpenMCCellTransformBase::transform_type

staticinherited

Enumeration for the transform type.

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

include/criticality/RotationSearch.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RotationSearch()

Member Function Documentation

◆ kMean()

◆ kStandardDeviation()

◆ quantity()

◆ searchForCriticality()

◆ stdev()

◆ transform()

◆ units()

◆ updateOpenMCModel()

◆ validParams()

Member Data Documentation

◆ _cell_ids

◆ _estimator

◆ _inputs

◆ _k_std_dev_values

◆ _k_values

◆ _maximum

◆ _minimum

◆ _openmc_problem

◆ _pp_name

◆ _rotation_axis_idx

◆ _target

◆ _tolerance

◆ rotation_vector_symbols

◆ rotation_vector_symbols_list

◆ transform_type