Structure for locating cells. More...

#include <CellLocatorUniformBins.h>

Classes
struct	LastCell
	Structure capturing the location of a cell in the search structure. More...

Public Member Functions
template<typename CellSetType >
	CellLocatorUniformBins (const viskores::Id3 &cellDims, const viskores::Vec3f &origin, const viskores::Vec3f &maxPoint, const viskores::Vec3f &invSpacing, const viskores::Id3 &maxCellIds, const viskores::cont::ArrayHandleGroupVecVariable< CellIdArrayType, CellIdOffsetArrayType > &cellIds, const CellSetType &cellSet, const viskores::cont::CoordinateSystem &coords, viskores::cont::DeviceAdapterId device, viskores::cont::Token &token)

viskores::ErrorCode	FindCell (const viskores::Vec3f &point, viskores::Id &cellId, viskores::Vec3f &parametric) const
	Locate the cell containing the provided point. More...

viskores::ErrorCode	FindCell (const viskores::Vec3f &point, viskores::Id &cellId, viskores::Vec3f &parametric, LastCell &lastCell) const
	Locate the cell containing the provided point. More...

CellLocatorUniformBins *	operator-> ()

const CellLocatorUniformBins *	operator-> () const

Private Types
template<typename T >
using	ReadPortal = typename viskores::cont::ArrayHandle< T >::ReadPortalType

using	CoordsPortalType = typename viskores::cont::CoordinateSystem::MultiplexerArrayType::ReadPortalType

using	CellIdArrayType = viskores::cont::ArrayHandle< viskores::Id >

using	CellIdOffsetArrayType = viskores::cont::ArrayHandle< viskores::Id >

using	CellIdReadPortal = typename viskores::cont::ArrayHandleGroupVecVariable< CellIdArrayType, CellIdOffsetArrayType >::ReadPortalType

Private Member Functions
viskores::Id	FindBinIdx (const viskores::Vec3f &point) const

bool	LastCellValid (const LastCell &lastCell) const

bool	IsInside (const viskores::Vec3f &point) const

viskores::ErrorCode	FindCellImpl (const viskores::Vec3f &point, viskores::Id &cellId, viskores::Vec3f &parametric, LastCell &lastCell, viskores::Id ptBinIdx=-1) const

template<typename PointsVecType >
viskores::Bounds	ComputeCellBounds (const PointsVecType &points) const

template<typename CellShapeTag , typename CoordsType >
viskores::ErrorCode	PointInsideCell (viskores::Vec3f point, CellShapeTag cellShape, CoordsType cellPoints, viskores::Vec3f &parametricCoordinates, bool &inside) const

bool	PointInBin (const viskores::Vec3f &point, const viskores::Id &binIdx, viskores::Id &cellId, viskores::Vec3f &parametric, const viskores::Id &skipCellId=-1) const

bool	PointInCell (const viskores::Vec3f &point, const viskores::Id &cid, viskores::Vec3f &parametric) const

Private Attributes
viskores::Id3	CellDims

viskores::Vec3f	Origin

viskores::Vec3f	MaxPoint

viskores::Vec3f	InvSpacing

viskores::Id3	MaxCellIds

CellIdReadPortal	CellIds

CellStructureType	CellSet

CoordsPortalType	Coords

Detailed Description

template<typename CellStructureType>
class viskores::exec::CellLocatorUniformBins< CellStructureType >

Structure for locating cells.

Use the FindCell() method to identify which cell contains a point in space. The FindCell() method optionally takes a LastCell object, which is a structure nested in this class. The LastCell object can help speed locating cells for successive finds at nearby points.

This class is provided by viskores::cont::CellLocatorBoundingIntervalHierarchy when passed to a worklet.

Member Typedef Documentation

◆ CellIdArrayType

template<typename CellStructureType >

using viskores::exec::CellLocatorUniformBins< CellStructureType >::CellIdArrayType = viskores::cont::ArrayHandle<viskores::Id>

private

◆ CellIdOffsetArrayType

template<typename CellStructureType >

using viskores::exec::CellLocatorUniformBins< CellStructureType >::CellIdOffsetArrayType = viskores::cont::ArrayHandle<viskores::Id>

private

◆ CellIdReadPortal

template<typename CellStructureType >

using viskores::exec::CellLocatorUniformBins< CellStructureType >::CellIdReadPortal = typename viskores::cont::ArrayHandleGroupVecVariable<CellIdArrayType, CellIdOffsetArrayType>::ReadPortalType

private

◆ CoordsPortalType

template<typename CellStructureType >

using viskores::exec::CellLocatorUniformBins< CellStructureType >::CoordsPortalType = typename viskores::cont::CoordinateSystem::MultiplexerArrayType::ReadPortalType

private

◆ ReadPortal

template<typename CellStructureType >

template<typename T >

using viskores::exec::CellLocatorUniformBins< CellStructureType >::ReadPortal = typename viskores::cont::ArrayHandle<T>::ReadPortalType

private

Constructor & Destructor Documentation

◆ CellLocatorUniformBins()

template<typename CellStructureType >

template<typename CellSetType >

viskores::exec::CellLocatorUniformBins< CellStructureType >::CellLocatorUniformBins	(	const viskores::Id3 &	cellDims,
		const viskores::Vec3f &	origin,
		const viskores::Vec3f &	maxPoint,
		const viskores::Vec3f &	invSpacing,
		const viskores::Id3 &	maxCellIds,
		const viskores::cont::ArrayHandleGroupVecVariable< CellIdArrayType, CellIdOffsetArrayType > &	cellIds,
		const CellSetType &	cellSet,
		const viskores::cont::CoordinateSystem &	coords,
		viskores::cont::DeviceAdapterId	device,
		viskores::cont::Token &	token
	)

inline

Member Function Documentation

◆ ComputeCellBounds()

template<typename CellStructureType >

template<typename PointsVecType >

viskores::Bounds viskores::exec::CellLocatorUniformBins< CellStructureType >::ComputeCellBounds ( const PointsVecType & points ) const

inlineprivate

◆ FindBinIdx()

template<typename CellStructureType >

viskores::Id viskores::exec::CellLocatorUniformBins< CellStructureType >::FindBinIdx ( const viskores::Vec3f & point ) const

inlineprivate

◆ FindCell() [1/2]

template<typename CellStructureType >

viskores::ErrorCode viskores::exec::CellLocatorUniformBins< CellStructureType >::FindCell	(	const viskores::Vec3f &	point,
		viskores::Id &	cellId,
		viskores::Vec3f &	parametric
	)		const

inline

Locate the cell containing the provided point.

Given the point coordinate point, this method determines which cell contains that point. The identification of the cell is returned in the cellId reference parameter. The method also determines the cell's parametric coordinates to the point and returns that in the parametric reference parameter. This result can be used in functions like viskores::exec::CellInterpolate().

FindCell() takes an optional LastCell parameter. This parameter captures the location of the found cell and can be passed to the next call of FindCell(). If the subsequent FindCell() call is for a point that is in or near the same cell, the operation may go faster.

This method will return viskores::ErrorCode::Success if a cell is found. If a cell is not found, viskores::ErrorCode::CellNotFound is returned and cellId is set to -1.

◆ FindCell() [2/2]

template<typename CellStructureType >

viskores::ErrorCode viskores::exec::CellLocatorUniformBins< CellStructureType >::FindCell	(	const viskores::Vec3f &	point,
		viskores::Id &	cellId,
		viskores::Vec3f &	parametric,
		LastCell &	lastCell
	)		const

inline

Locate the cell containing the provided point.

Given the point coordinate point, this method determines which cell contains that point. The identification of the cell is returned in the cellId reference parameter. The method also determines the cell's parametric coordinates to the point and returns that in the parametric reference parameter. This result can be used in functions like viskores::exec::CellInterpolate().

FindCell() takes an optional LastCell parameter. This parameter captures the location of the found cell and can be passed to the next call of FindCell(). If the subsequent FindCell() call is for a point that is in or near the same cell, the operation may go faster.

This method will return viskores::ErrorCode::Success if a cell is found. If a cell is not found, viskores::ErrorCode::CellNotFound is returned and cellId is set to -1.

◆ FindCellImpl()

template<typename CellStructureType >

viskores::ErrorCode viskores::exec::CellLocatorUniformBins< CellStructureType >::FindCellImpl	(	const viskores::Vec3f &	point,
		viskores::Id &	cellId,
		viskores::Vec3f &	parametric,
		LastCell &	lastCell,
		viskores::Id	ptBinIdx = `-1`
	)		const

inlineprivate

◆ IsInside()

template<typename CellStructureType >

bool viskores::exec::CellLocatorUniformBins< CellStructureType >::IsInside ( const viskores::Vec3f & point ) const

inlineprivate

◆ LastCellValid()

template<typename CellStructureType >

bool viskores::exec::CellLocatorUniformBins< CellStructureType >::LastCellValid ( const LastCell & lastCell ) const

inlineprivate

◆ operator->() [1/2]

template<typename CellStructureType >

CellLocatorUniformBins* viskores::exec::CellLocatorUniformBins< CellStructureType >::operator-> ( )

inline

◆ operator->() [2/2]

template<typename CellStructureType >

const CellLocatorUniformBins* viskores::exec::CellLocatorUniformBins< CellStructureType >::operator-> ( ) const

inline

◆ PointInBin()

template<typename CellStructureType >

bool viskores::exec::CellLocatorUniformBins< CellStructureType >::PointInBin	(	const viskores::Vec3f &	point,
		const viskores::Id &	binIdx,
		viskores::Id &	cellId,
		viskores::Vec3f &	parametric,
		const viskores::Id &	skipCellId = `-1`
	)		const

inlineprivate

◆ PointInCell()

template<typename CellStructureType >

bool viskores::exec::CellLocatorUniformBins< CellStructureType >::PointInCell	(	const viskores::Vec3f &	point,
		const viskores::Id &	cid,
		viskores::Vec3f &	parametric
	)		const

inlineprivate

◆ PointInsideCell()

template<typename CellStructureType >

template<typename CellShapeTag , typename CoordsType >

viskores::ErrorCode viskores::exec::CellLocatorUniformBins< CellStructureType >::PointInsideCell	(	viskores::Vec3f	point,
		CellShapeTag	cellShape,
		CoordsType	cellPoints,
		viskores::Vec3f &	parametricCoordinates,
		bool &	inside
	)		const

inlineprivate

Member Data Documentation

◆ CellDims

template<typename CellStructureType >

viskores::Id3 viskores::exec::CellLocatorUniformBins< CellStructureType >::CellDims

private

◆ CellIds

template<typename CellStructureType >

CellIdReadPortal viskores::exec::CellLocatorUniformBins< CellStructureType >::CellIds

private

◆ CellSet

template<typename CellStructureType >

CellStructureType viskores::exec::CellLocatorUniformBins< CellStructureType >::CellSet

private

◆ Coords

template<typename CellStructureType >

CoordsPortalType viskores::exec::CellLocatorUniformBins< CellStructureType >::Coords

private

◆ InvSpacing

template<typename CellStructureType >

viskores::Vec3f viskores::exec::CellLocatorUniformBins< CellStructureType >::InvSpacing

private

◆ MaxCellIds

template<typename CellStructureType >

viskores::Id3 viskores::exec::CellLocatorUniformBins< CellStructureType >::MaxCellIds

private

◆ MaxPoint

template<typename CellStructureType >

viskores::Vec3f viskores::exec::CellLocatorUniformBins< CellStructureType >::MaxPoint

private

◆ Origin

template<typename CellStructureType >

viskores::Vec3f viskores::exec::CellLocatorUniformBins< CellStructureType >::Origin

private

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

exec/CellLocatorUniformBins.h

Classes

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

template<typename CellStructureType> class viskores::exec::CellLocatorUniformBins< CellStructureType >

Member Typedef Documentation

◆ CellIdArrayType

◆ CellIdOffsetArrayType

◆ CellIdReadPortal

◆ CoordsPortalType

◆ ReadPortal

Constructor & Destructor Documentation

◆ CellLocatorUniformBins()

Member Function Documentation

◆ ComputeCellBounds()

◆ FindBinIdx()

◆ FindCell() [1/2]

◆ FindCell() [2/2]

◆ FindCellImpl()

◆ IsInside()

◆ LastCellValid()

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ PointInBin()

◆ PointInCell()

◆ PointInsideCell()

Member Data Documentation

◆ CellDims

◆ CellIds

◆ CellSet

◆ Coords

◆ InvSpacing

◆ MaxCellIds

◆ MaxPoint

◆ Origin

template<typename CellStructureType>
class viskores::exec::CellLocatorUniformBins< CellStructureType >