Cardinal
RadialBin.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 "SpatialBinUserObject.h"
22 
28 {
29 public:
30  static InputParameters validParams();
31 
32  RadialBin(const InputParameters & parameters);
33 
34  virtual unsigned int bin(const Point & p) const override;
35 
36  virtual unsigned int num_bins() const override;
37 
38 protected:
40  const unsigned int _vertical_axis;
41 
43  const Real & _rmin;
44 
46  const Real & _rmax;
47 
49  const unsigned int & _nr;
50 
52  const Real & _growth_r;
53 
55  std::vector<Real> _radial_pts;
56 };
SpatialBinUserObject.h
RadialBin::_vertical_axis
const unsigned int _vertical_axis
Direction of the vertical axis (x, y, or z)
Definition: RadialBin.h:40
RadialBin::_radial_pts
std::vector< Real > _radial_pts
Points defining the bounds of the radial regions.
Definition: RadialBin.h:55
RadialBin::_rmin
const Real & _rmin
Minimum radial coordinate.
Definition: RadialBin.h:43
RadialBin::_rmax
const Real & _rmax
Maximum radial coordinate.
Definition: RadialBin.h:46
SpatialBinUserObject
Definition: SpatialBinUserObject.h:26
RadialBin::_nr
const unsigned int & _nr
Number of radial layers.
Definition: RadialBin.h:49
RadialBin::validParams
static InputParameters validParams()
Definition: RadialBin.C:24
RadialBin::bin
virtual unsigned int bin(const Point &p) const override
Definition: RadialBin.C:93
RadialBin
Definition: RadialBin.h:27
RadialBin::num_bins
virtual unsigned int num_bins() const override
Definition: RadialBin.C:100
RadialBin::_growth_r
const Real & _growth_r
Growth factor to apply to successive layers.
Definition: RadialBin.h:52
RadialBin::RadialBin
RadialBin(const InputParameters &parameters)
Definition: RadialBin.C:51