#include <LayeredGapBin.h>

Inheritance diagram for LayeredGapBin:

Public Member Functions
	LayeredGapBin (const InputParameters &parameters)

virtual unsigned int	bin (const Point &p) const override

virtual unsigned int	num_bins () const override

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

virtual unsigned int	gapIndex (const Point &point) const override

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

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

virtual Real	adjustBinValue (const unsigned int &i) 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)

const unsigned int &	_num_layers
	Number of equal-size layers.

const SubProblem *	_layered_subproblem
	Underlying problem.

const unsigned int	_num_faces
	Number of bins.

Real	_direction_min
	Minimum coordinate in the direction.

Real	_direction_max
	Maxium coordinate in the direction.

std::vector< Real >	_layer_pts
	Bounds of the 1-D layering.

std::vector< Real >	_effective_layer_pts
	Bounds of the volume bins that achieve the same pairing of points to bins.

std::vector< Point >	_unit_normals
	Unit normal vectors of the gaps.

std::vector< Point >	_bin_centers
	Center coordinates of the bins.

std::vector< unsigned int >	_directions
	Directions along which the bin defines points.

Detailed Description

Class that bins spatial coordinates into planes oriented in a particular direction.

Constructor & Destructor Documentation

◆ LayeredGapBin()

LayeredGapBin::LayeredGapBin ( const InputParameters & parameters )

Member Function Documentation

◆ adjustBinValue()

Real LayeredGapBin::adjustBinValue ( const unsigned int & ) const

overridevirtual

Apply an additional normalization factor to the bin value

Parameters

[in] bin bin index

Returns: multiplicative value to apply

Reimplemented from PlaneSpatialBinUserObject.

◆ bin()

unsigned int LayeredGapBin::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.

◆ distanceFromGap()

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

overridevirtual

Distance between a point and a gap

Parameters

[in]	point	point
[in]	gap_index	gap index

Implements PlaneSpatialBinUserObject.

◆ execute()

virtual void SpatialBinUserObject::execute ( )

inlinefinalvirtualinherited

◆ finalize()

virtual void SpatialBinUserObject::finalize ( )

inlinefinalvirtualinherited

◆ gapIndex()

unsigned int LayeredGapBin::gapIndex ( const Point & point ) const

overridevirtual

Gap index closest to the point

Parameters

[in] point point

Returns: gap index

Implements PlaneSpatialBinUserObject.

◆ gapIndexAndDistance()

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

overridevirtual

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

Implements PlaneSpatialBinUserObject.

◆ gapUnitNormals()

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

inlineoverridevirtual

Get the unit normals for each gap

Returns: gap unit normals

Implements PlaneSpatialBinUserObject.

◆ 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 LayeredGapBin::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 LayeredGapBin::validParams ( )

static

Member Data Documentation

◆ _bin_centers

std::vector<Point> SpatialBinUserObject::_bin_centers

protectedinherited

Center coordinates of the bins.

◆ _direction

const unsigned int LayeredGapBin::_direction

protected

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

◆ _direction_max

Real LayeredGapBin::_direction_max

protected

Maxium coordinate in the direction.

◆ _direction_min

Real LayeredGapBin::_direction_min

protected

Minimum coordinate in the direction.

◆ _directions

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

protectedinherited

Directions along which the bin defines points.

◆ _effective_layer_pts

std::vector<Real> LayeredGapBin::_effective_layer_pts

protected

Bounds of the volume bins that achieve the same pairing of points to bins.

◆ _layer_pts

std::vector<Real> LayeredGapBin::_layer_pts

protected

Bounds of the 1-D layering.

◆ _layered_subproblem

const SubProblem* LayeredGapBin::_layered_subproblem

protected

Underlying problem.

◆ _num_faces

const unsigned int LayeredGapBin::_num_faces

protected

Number of bins.

◆ _num_layers

const unsigned int& LayeredGapBin::_num_layers

protected

Number of equal-size layers.

◆ _unit_normals

std::vector<Point> LayeredGapBin::_unit_normals

protected

Unit normal vectors of the gaps.

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

include/userobjects/LayeredGapBin.h
src/userobjects/LayeredGapBin.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LayeredGapBin()

Member Function Documentation

◆ adjustBinValue()

◆ bin()

◆ binFromBounds()

◆ directions()

◆ distanceFromGap()

◆ execute()

◆ finalize()

◆ gapIndex()

◆ gapIndexAndDistance()

◆ gapUnitNormals()

◆ getBinCenters()

◆ initialize()

◆ num_bins()

◆ spatialValue()

◆ validParams()

Member Data Documentation

◆ _bin_centers

◆ _direction

◆ _direction_max

◆ _direction_min

◆ _directions

◆ _effective_layer_pts

◆ _layer_pts

◆ _layered_subproblem

◆ _num_faces

◆ _num_layers

◆ _unit_normals