Cardinal
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
HexagonalSubchannelGapBin Class Reference

#include <HexagonalSubchannelGapBin.h>

Inheritance diagram for HexagonalSubchannelGapBin:
[legend]

Public Member Functions

 HexagonalSubchannelGapBin (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 &) const
 
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 Real & _bundle_pitch
 Bundle pitch. More...
 
const Real & _pin_pitch
 Pin pitch. More...
 
const Real & _pin_diameter
 Pin diameter. More...
 
const unsigned int & _n_rings
 Total number of rings of pins. More...
 
const unsigned int _axis
 Vertical axis of the bundle along which the pins are aligned. More...
 
std::unique_ptr< HexagonalLatticeUtils > _hex_lattice
 Underlying utility providing hexagonal lattice capabilities. 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 hexagonal subchannel gap discretization with unique bins for each gap.

Constructor & Destructor Documentation

◆ HexagonalSubchannelGapBin()

HexagonalSubchannelGapBin::HexagonalSubchannelGapBin ( const InputParameters &  parameters)

Member Function Documentation

◆ adjustBinValue()

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

Apply an additional normalization factor to the bin value

Parameters
[in]binbin index
Returns
multiplicative value to apply

Reimplemented in LayeredGapBin.

◆ bin()

unsigned int HexagonalSubchannelGapBin::bin ( const Point &  p) const
overridevirtual

Get the bin index from a spatial point

Parameters
[in]ppoint
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]ptpoint along axis of the bounding points
[in]boundsvector 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 HexagonalSubchannelGapBin::distanceFromGap ( const Point &  point,
const unsigned int &  gap_index 
) const
overridevirtual

Distance between a point and a gap

Parameters
[in]pointpoint
[in]gap_indexgap index

Implements PlaneSpatialBinUserObject.

◆ execute()

virtual void SpatialBinUserObject::execute ( )
inlinefinalvirtualinherited

◆ finalize()

virtual void SpatialBinUserObject::finalize ( )
inlinefinalvirtualinherited

◆ gapIndex()

unsigned int HexagonalSubchannelGapBin::gapIndex ( const Point &  point) const
overridevirtual

Gap index closest to the point

Parameters
[in]pointpoint
Returns
gap index

Implements PlaneSpatialBinUserObject.

◆ gapIndexAndDistance()

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

Distance between a point and a gap

Parameters
[in]pointpoint
[out]indexindex of the gap that the point is closest to
[out]distancedistance from point to the closest gap

Implements PlaneSpatialBinUserObject.

◆ gapUnitNormals()

virtual const std::vector<Point>& HexagonalSubchannelGapBin::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 HexagonalSubchannelGapBin::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 HexagonalSubchannelGapBin::validParams ( )
static

Member Data Documentation

◆ _axis

const unsigned int HexagonalSubchannelGapBin::_axis
protected

Vertical axis of the bundle along which the pins are aligned.

◆ _bin_centers

std::vector<Point> SpatialBinUserObject::_bin_centers
protectedinherited

Center coordinates of the bins.

◆ _bundle_pitch

const Real& HexagonalSubchannelGapBin::_bundle_pitch
protected

Bundle pitch.

◆ _directions

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

Directions along which the bin defines points.

◆ _hex_lattice

std::unique_ptr<HexagonalLatticeUtils> HexagonalSubchannelGapBin::_hex_lattice
protected

Underlying utility providing hexagonal lattice capabilities.

◆ _n_rings

const unsigned int& HexagonalSubchannelGapBin::_n_rings
protected

Total number of rings of pins.

◆ _pin_diameter

const Real& HexagonalSubchannelGapBin::_pin_diameter
protected

Pin diameter.

◆ _pin_pitch

const Real& HexagonalSubchannelGapBin::_pin_pitch
protected

Pin pitch.


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