LayeredBin Class Reference

#include <LayeredBin.h>

Inheritance diagram for LayeredBin:

Public Member Functions
	LayeredBin (const InputParameters &parameters)
virtual unsigned int	bin (const Point &p) const override
virtual unsigned int	num_bins () const override
virtual void	execute () final
virtual void	initialize () final
virtual void	finalize () final
virtual Real	spatialValue (const Point &p) const override
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
const unsigned int	_direction
	Direction of the bins (x, y, or z) More...
const unsigned int &	_num_layers
	Number of equal-size layers. More...
const SubProblem *	_layered_subproblem
	Underlying problem. More...
Real	_direction_min
	Minimum coordinate in the direction. More...
Real	_direction_max
	Maxium coordinate in the direction. More...
std::vector< Real >	_layer_pts
	Bounds of the 1-D layering. More...
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 bins spatial coordinates into a 1-D set of layers between the bounding box of the domain.

Constructor & Destructor Documentation

LayeredBin()

LayeredBin::LayeredBin

(

const InputParameters &

parameters

)

Member Function Documentation

bin()

unsigned int LayeredBin::bin ( const Point &  p ) const

overridevirtual

Get the bin index from a spatial point

Parameters

[in]

p

point

Returns

bin index

Implements SpatialBinUserObject.

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.

execute()

virtual void SpatialBinUserObject::execute ( )

inlinefinalvirtualinherited

finalize()

virtual void SpatialBinUserObject::finalize ( )

inlinefinalvirtualinherited

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()

unsigned int LayeredBin::num_bins ( ) const

overridevirtual

Get the total number of bins

Returns

total number of bins

Implements SpatialBinUserObject.

spatialValue()

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

overridevirtualinherited

validParams()

InputParameters LayeredBin::validParams ( )

static

Member Data Documentation

_bin_centers

std::vector<Point> SpatialBinUserObject::_bin_centers

protectedinherited

Center coordinates of the bins.

_direction

const unsigned int LayeredBin::_direction

protected

Direction of the bins (x, y, or z)

_direction_max

Real LayeredBin::_direction_max

protected

Maxium coordinate in the direction.

_direction_min

Real LayeredBin::_direction_min

protected

Minimum coordinate in the direction.

_directions

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

protectedinherited

Directions along which the bin defines points.

_layer_pts

std::vector<Real> LayeredBin::_layer_pts

protected

Bounds of the 1-D layering.

_layered_subproblem

const SubProblem* LayeredBin::_layered_subproblem

protected

Underlying problem.

_num_layers

const unsigned int& LayeredBin::_num_layers

protected

Number of equal-size layers.

---

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

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