viskores::cont::CellLocatorUniformGrid Class Reference

A cell locator optimized for finding cells in a uniform grid. More...

#include <CellLocatorUniformGrid.h>

Inheritance diagram for viskores::cont::CellLocatorUniformGrid:

Public Types
using	LastCell = viskores::exec::CellLocatorUniformGrid::LastCell

Public Member Functions
viskores::exec::CellLocatorUniformGrid	PrepareForExecution (viskores::cont::DeviceAdapterId device, viskores::cont::Token &token) const
Public Member Functions inherited from viskores::cont::CellLocatorBase
virtual	~CellLocatorBase ()=default
const viskores::cont::UnknownCellSet &	GetCellSet () const
	Specify the CellSet defining the structure of the cells being searched. More...
void	SetCellSet (const viskores::cont::UnknownCellSet &cellSet)
	Specify the CellSet defining the structure of the cells being searched. More...
const viskores::cont::CoordinateSystem &	GetCoordinates () const
	Specify the CoordinateSystem defining the location of the cells. More...
void	SetCoordinates (const viskores::cont::CoordinateSystem &coords)
	Specify the CoordinateSystem defining the location of the cells. More...
void	SetCoordinates (const viskores::cont::UnknownArrayHandle &coords)
	Specify the CoordinateSystem defining the location of the cells. More...
void	Update () const
	Build the search structure used to look up cells. More...

Private Member Functions
void	Build () override

Private Attributes
viskores::Id3	CellDims
viskores::Id3	PointDims
viskores::Vec3f	Origin
viskores::Vec3f	InvSpacing
viskores::Vec3f	MaxPoint
bool	Is3D = true

Additional Inherited Members
Protected Member Functions inherited from viskores::cont::CellLocatorBase
void	SetModified ()
bool	GetModified () const

Detailed Description

A cell locator optimized for finding cells in a uniform grid.

This locator is optimized for structured data that has uniform axis-aligned spacing. For this cell locator to work, it has to be given a cell set of type viskores::cont::CellSetStructured and a coordinate system using a viskores::cont::ArrayHandleUniformPointCoordinates for its coordinate system. If the data set matches this structure, then this locator will be faster than any others.

Member Typedef Documentation

LastCell

using viskores::cont::CellLocatorUniformGrid::LastCell = viskores::exec::CellLocatorUniformGrid::LastCell

Member Function Documentation

Build()

void viskores::cont::CellLocatorUniformGrid::Build ( )

overrideprivatevirtual

Implements viskores::cont::CellLocatorBase.

PrepareForExecution()

viskores::exec::CellLocatorUniformGrid viskores::cont::CellLocatorUniformGrid::PrepareForExecution	(	viskores::cont::DeviceAdapterId	device,
		viskores::cont::Token &	token
	)		const

Member Data Documentation

CellDims

viskores::Id3 viskores::cont::CellLocatorUniformGrid::CellDims

private

InvSpacing

viskores::Vec3f viskores::cont::CellLocatorUniformGrid::InvSpacing

private

Is3D

bool viskores::cont::CellLocatorUniformGrid::Is3D = true

private

MaxPoint

viskores::Vec3f viskores::cont::CellLocatorUniformGrid::MaxPoint

private

Origin

viskores::Vec3f viskores::cont::CellLocatorUniformGrid::Origin

private

PointDims

viskores::Id3 viskores::cont::CellLocatorUniformGrid::PointDims

private

---

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

• cont/CellLocatorUniformGrid.h