Cardinal
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
OpenMCVolumeCalculation Class Reference

#include <OpenMCVolumeCalculation.h>

Inheritance diagram for OpenMCVolumeCalculation:
[legend]

Public Member Functions

 OpenMCVolumeCalculation (const InputParameters &parameters)
 
virtual void initialize ()
 
virtual void finalize ()
 
virtual void execute ()
 
virtual void initializeVolumeCalculation ()
 Initialize the volume calculation (not in initialize() because we want to control this from the Problem) More...
 
virtual void computeVolumes ()
 Compute the cell volumes. More...
 
virtual void resetVolumeCalculation ()
 Erase previously-added volume calculation. More...
 
openmc::Position position (const Point &pt) const
 
void cellVolume (const unsigned int &index, Real &vol, Real &std_dev) const
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Attributes

const unsigned int & _n_samples
 Number of stochastic samples for calculation. More...
 
const MooseEnum _trigger
 Trigger for deciding when to terminate the stochastic volume calculation. More...
 
Real _trigger_threshold
 Threshold for terminating the trigger. More...
 
Real _scaling
 Length multiplier applied to [Mesh] to get into OpenMC centimeters. More...
 
Point _lower_left
 Lower left of the box within which to compute OpenMC volumes. More...
 
Point _upper_right
 Upper right of the box within which to compute OpenMC volumes. More...
 
std::unique_ptr< openmc::VolumeCalculation > _volume_calc
 Volume calculation object. More...
 
std::vector< openmc::VolumeCalculation::Result > _results
 Results of the volume calculation. More...
 
std::map< int, int > _index_to_calc_index
 Map from cell index to its volume calculation result. More...
 
unsigned int _calc_index
 Index of volume calculation we add in OpenMC. More...
 

Detailed Description

Class that computes a volume calculation over the OpenMC model based on information from the OpenMC wrapping (OpenMCCellAverageProblem).

Constructor & Destructor Documentation

◆ OpenMCVolumeCalculation()

OpenMCVolumeCalculation::OpenMCVolumeCalculation ( const InputParameters &  parameters)

Member Function Documentation

◆ cellVolume()

void OpenMCVolumeCalculation::cellVolume ( const unsigned int &  index,
Real &  vol,
Real &  std_dev 
) const

Get the OpenMC cell volume

Parameters
[in]indexcell index
[out]volstochastically-computed volume
[out]std_devstandard deviation

◆ computeVolumes()

virtual void OpenMCVolumeCalculation::computeVolumes ( )
virtual

Compute the cell volumes.

◆ execute()

virtual void OpenMCVolumeCalculation::execute ( )
inlinevirtual

◆ finalize()

virtual void OpenMCVolumeCalculation::finalize ( )
inlinevirtual

◆ initialize()

virtual void OpenMCVolumeCalculation::initialize ( )
inlinevirtual

◆ initializeVolumeCalculation()

virtual void OpenMCVolumeCalculation::initializeVolumeCalculation ( )
virtual

Initialize the volume calculation (not in initialize() because we want to control this from the Problem)

◆ position()

openmc::Position OpenMCVolumeCalculation::position ( const Point &  pt) const

Convert from a Point to a Position

Parameters
[in]pointpoint
Returns
position

◆ resetVolumeCalculation()

virtual void OpenMCVolumeCalculation::resetVolumeCalculation ( )
virtual

Erase previously-added volume calculation.

◆ validParams()

static InputParameters OpenMCVolumeCalculation::validParams ( )
static

Member Data Documentation

◆ _calc_index

unsigned int OpenMCVolumeCalculation::_calc_index
protected

Index of volume calculation we add in OpenMC.

◆ _index_to_calc_index

std::map<int, int> OpenMCVolumeCalculation::_index_to_calc_index
protected

Map from cell index to its volume calculation result.

◆ _lower_left

Point OpenMCVolumeCalculation::_lower_left
protected

Lower left of the box within which to compute OpenMC volumes.

◆ _n_samples

const unsigned int& OpenMCVolumeCalculation::_n_samples
protected

Number of stochastic samples for calculation.

◆ _results

std::vector<openmc::VolumeCalculation::Result> OpenMCVolumeCalculation::_results
protected

Results of the volume calculation.

◆ _scaling

Real OpenMCVolumeCalculation::_scaling
protected

Length multiplier applied to [Mesh] to get into OpenMC centimeters.

◆ _trigger

const MooseEnum OpenMCVolumeCalculation::_trigger
protected

Trigger for deciding when to terminate the stochastic volume calculation.

◆ _trigger_threshold

Real OpenMCVolumeCalculation::_trigger_threshold
protected

Threshold for terminating the trigger.

◆ _upper_right

Point OpenMCVolumeCalculation::_upper_right
protected

Upper right of the box within which to compute OpenMC volumes.

◆ _volume_calc

std::unique_ptr<openmc::VolumeCalculation> OpenMCVolumeCalculation::_volume_calc
protected

Volume calculation object.


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