PlaneSpatialBinUserObject Class Reference

#include <PlaneSpatialBinUserObject.h>

Inheritance diagram for PlaneSpatialBinUserObject:

Public Member Functions
	PlaneSpatialBinUserObject (const InputParameters &parameters)
virtual Real	distanceFromGap (const Point &point, const unsigned int &gap_index) const =0
virtual unsigned int	gapIndex (const Point &point) const =0
virtual void	gapIndexAndDistance (const Point &point, unsigned int &index, Real &distance) const =0
virtual const std::vector< Point > &	gapUnitNormals () const =0
virtual Real	adjustBinValue (const unsigned int &) const
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 side bin index given a spatial coordinate

Constructor & Destructor Documentation

PlaneSpatialBinUserObject()

PlaneSpatialBinUserObject::PlaneSpatialBinUserObject

(

const InputParameters &

parameters

)

Member Function Documentation

adjustBinValue()

virtual Real PlaneSpatialBinUserObject::adjustBinValue ( const unsigned int &  ) const

inlinevirtual

Apply an additional normalization factor to the bin value

Parameters

[in]

bin

bin index

Returns

multiplicative value to apply

Reimplemented in LayeredGapBin.

bin()

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

pure virtualinherited

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

inherited

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

inlinevirtualinherited

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.

distanceFromGap()

virtual Real PlaneSpatialBinUserObject::distanceFromGap ( const Point &  point, const unsigned int &  gap_index  ) const

pure virtual

Distance between a point and a gap

Parameters

[in]	point	point
[in]	gap_index	gap index

Implemented in HexagonalSubchannelGapBin, and LayeredGapBin.

execute()

virtual void SpatialBinUserObject::execute ( )

inlinefinalvirtualinherited

finalize()

virtual void SpatialBinUserObject::finalize ( )

inlinefinalvirtualinherited

gapIndex()

virtual unsigned int PlaneSpatialBinUserObject::gapIndex ( const Point &  point ) const

pure virtual

Gap index closest to the point

Parameters

[in]

point

point

Returns

gap index

Implemented in HexagonalSubchannelGapBin, and LayeredGapBin.

gapIndexAndDistance()

virtual void PlaneSpatialBinUserObject::gapIndexAndDistance ( const Point &  point, unsigned int &  index, Real &  distance  ) const

pure virtual

Distance between a point and a gap

Parameters

[in]	point	point
[out]	index	index of the gap that the point is closest to
[out]	distance	distance from point to the closest gap

Implemented in HexagonalSubchannelGapBin, and LayeredGapBin.

gapUnitNormals()

virtual const std::vector<Point>& PlaneSpatialBinUserObject::gapUnitNormals ( ) const

pure virtual

Get the unit normals for each gap

Returns

gap unit normals

Implemented in HexagonalSubchannelGapBin, and LayeredGapBin.

getBinCenters()

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

inlinevirtualinherited

Get the bin centers

Returns

bin centers

initialize()

virtual void SpatialBinUserObject::initialize ( )

inlinefinalvirtualinherited

num_bins()

virtual unsigned int SpatialBinUserObject::num_bins ( ) const

pure virtualinherited

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

overridevirtualinherited

validParams()

InputParameters PlaneSpatialBinUserObject::validParams ( )

static

Member Data Documentation

_bin_centers

std::vector<Point> SpatialBinUserObject::_bin_centers

protectedinherited

Center coordinates of the bins.

_directions

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

protectedinherited

Directions along which the bin defines points.

---

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

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