Cardinal
OpenMCVolumeCalculation.h
Go to the documentation of this file.
1 /********************************************************************/
2 /* SOFTWARE COPYRIGHT NOTIFICATION */
3 /* Cardinal */
4 /* */
5 /* (c) 2021 UChicago Argonne, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by UChicago Argonne, LLC */
9 /* Under Contract No. DE-AC02-06CH11357 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* Prepared by Battelle Energy Alliance, LLC */
13 /* Under Contract No. DE-AC07-05ID14517 */
14 /* With the U. S. Department of Energy */
15 /* */
16 /* See LICENSE for full restrictions */
17 /********************************************************************/
18 
19 #pragma once
20 
21 #include "GeneralUserObject.h"
22 #include "openmc/volume_calc.h"
23 
28 class OpenMCVolumeCalculation : public GeneralUserObject
29 {
30 public:
31  static InputParameters validParams();
32 
33  OpenMCVolumeCalculation(const InputParameters & parameters);
34 
35  virtual void initialize() {}
36  virtual void finalize() {}
37  virtual void execute() {}
38 
40  virtual void initializeVolumeCalculation();
41 
43  virtual void computeVolumes();
44 
46  virtual void resetVolumeCalculation();
47 
53  openmc::Position position(const Point & pt) const;
54 
61  void cellVolume(const unsigned int & index, Real & vol, Real & std_dev) const;
62 
63 protected:
65  const unsigned int & _n_samples;
66 
68  const MooseEnum _trigger;
69 
72 
74  Real _scaling;
75 
77  Point _lower_left;
78 
80  Point _upper_right;
81 
83  std::unique_ptr<openmc::VolumeCalculation> _volume_calc;
84 
86  std::vector<openmc::VolumeCalculation::Result> _results;
87 
89  std::map<int, int> _index_to_calc_index;
90 
92  unsigned int _calc_index;
93 };
OpenMCVolumeCalculation::computeVolumes
virtual void computeVolumes()
Compute the cell volumes.
OpenMCVolumeCalculation::execute
virtual void execute()
Definition: OpenMCVolumeCalculation.h:37
OpenMCVolumeCalculation
Definition: OpenMCVolumeCalculation.h:28
OpenMCVolumeCalculation::_scaling
Real _scaling
Length multiplier applied to [Mesh] to get into OpenMC centimeters.
Definition: OpenMCVolumeCalculation.h:74
OpenMCVolumeCalculation::_trigger_threshold
Real _trigger_threshold
Threshold for terminating the trigger.
Definition: OpenMCVolumeCalculation.h:71
trigger::std_dev
@ std_dev
Definition: CardinalEnums.h:165
OpenMCVolumeCalculation::initializeVolumeCalculation
virtual void initializeVolumeCalculation()
Initialize the volume calculation (not in initialize() because we want to control this from the Probl...
OpenMCVolumeCalculation::_calc_index
unsigned int _calc_index
Index of volume calculation we add in OpenMC.
Definition: OpenMCVolumeCalculation.h:92
OpenMCVolumeCalculation::position
openmc::Position position(const Point &pt) const
OpenMCVolumeCalculation::_upper_right
Point _upper_right
Upper right of the box within which to compute OpenMC volumes.
Definition: OpenMCVolumeCalculation.h:80
OpenMCVolumeCalculation::initialize
virtual void initialize()
Definition: OpenMCVolumeCalculation.h:35
OpenMCVolumeCalculation::OpenMCVolumeCalculation
OpenMCVolumeCalculation(const InputParameters &parameters)
OpenMCVolumeCalculation::validParams
static InputParameters validParams()
OpenMCVolumeCalculation::_lower_left
Point _lower_left
Lower left of the box within which to compute OpenMC volumes.
Definition: OpenMCVolumeCalculation.h:77
OpenMCVolumeCalculation::_results
std::vector< openmc::VolumeCalculation::Result > _results
Results of the volume calculation.
Definition: OpenMCVolumeCalculation.h:86
OpenMCVolumeCalculation::resetVolumeCalculation
virtual void resetVolumeCalculation()
Erase previously-added volume calculation.
OpenMCVolumeCalculation::_volume_calc
std::unique_ptr< openmc::VolumeCalculation > _volume_calc
Volume calculation object.
Definition: OpenMCVolumeCalculation.h:83
OpenMCVolumeCalculation::finalize
virtual void finalize()
Definition: OpenMCVolumeCalculation.h:36
OpenMCVolumeCalculation::cellVolume
void cellVolume(const unsigned int &index, Real &vol, Real &std_dev) const
OpenMCVolumeCalculation::_trigger
const MooseEnum _trigger
Trigger for deciding when to terminate the stochastic volume calculation.
Definition: OpenMCVolumeCalculation.h:68
OpenMCVolumeCalculation::_index_to_calc_index
std::map< int, int > _index_to_calc_index
Map from cell index to its volume calculation result.
Definition: OpenMCVolumeCalculation.h:89
OpenMCVolumeCalculation::_n_samples
const unsigned int & _n_samples
Number of stochastic samples for calculation.
Definition: OpenMCVolumeCalculation.h:65