SpatialBinUserObject Class Reference

#include <SpatialBinUserObject.h>

Inheritance diagram for SpatialBinUserObject:

Public Member Functions
	SpatialBinUserObject (const InputParameters &parameters)
virtual void	execute () final
virtual void	initialize () final
virtual void	finalize () final
virtual Real	spatialValue (const Point &p) const override
virtual unsigned int	bin (const Point &p) const =0
virtual unsigned int	num_bins () const =0
unsigned int	binFromBounds (const Real &pt, const std::vector< Real > &bounds) const
virtual const std::vector< Point > &	getBinCenters () const
virtual const std::vector< unsigned int >	directions () const

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
std::vector< Point >	_bin_centers
	Center coordinates of the bins. More...
std::vector< unsigned int >	_directions
	Directions along which the bin defines points. More...

Detailed Description

Class that provides a bin index given a spatial coordinate

Constructor & Destructor Documentation

SpatialBinUserObject()

SpatialBinUserObject::SpatialBinUserObject

(

const InputParameters &

parameters

)

Member Function Documentation

bin()

virtual unsigned int SpatialBinUserObject::bin ( const Point &  p ) const

pure virtual

Get the bin index from a spatial point

Parameters

[in]

p

point

Returns

bin index

Implemented in HexagonalSubchannelBin, HexagonalSubchannelGapBin, LayeredBin, RadialBin, and LayeredGapBin.

binFromBounds()

unsigned int SpatialBinUserObject::binFromBounds	(	const Real &	pt,
		const std::vector< Real > &	bounds
	)		const

Get the bin given a point in an array of bounding points between layers

Parameters

[in]	pt	point along axis of the bounding points
[in]	bounds	vector of bounding points

Returns

layer

directions()

virtual const std::vector<unsigned int> SpatialBinUserObject::directions ( ) const

inlinevirtual

Get the coordinate directions (x, y, z) along which the bin distribution specifies the bins. For 1-D distributions, this will be just one of x, y, and z. For 2-D distributions, this will be a combination of x-y, y-z, or x-z.

execute()

virtual void SpatialBinUserObject::execute ( )

inlinefinalvirtual

finalize()

virtual void SpatialBinUserObject::finalize ( )

inlinefinalvirtual

getBinCenters()

virtual const std::vector<Point>& SpatialBinUserObject::getBinCenters ( ) const

inlinevirtual

Get the bin centers

Returns

bin centers

initialize()

virtual void SpatialBinUserObject::initialize ( )

inlinefinalvirtual

num_bins()

virtual unsigned int SpatialBinUserObject::num_bins ( ) const

pure virtual

Get the total number of bins

Returns

total number of bins

Implemented in HexagonalSubchannelBin, HexagonalSubchannelGapBin, LayeredBin, RadialBin, and LayeredGapBin.

spatialValue()

Real SpatialBinUserObject::spatialValue ( const Point &  p ) const

overridevirtual

validParams()

InputParameters SpatialBinUserObject::validParams ( )

static

Member Data Documentation

_bin_centers

std::vector<Point> SpatialBinUserObject::_bin_centers

protected

Center coordinates of the bins.

_directions

std::vector<unsigned int> SpatialBinUserObject::_directions

protected

Directions along which the bin defines points.

---

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

• include/userobjects/SpatialBinUserObject.h
• src/userobjects/SpatialBinUserObject.C