viskores::cont::CellLocatorRectilinearGrid Class Reference

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

#include <CellLocatorRectilinearGrid.h>

Inheritance diagram for viskores::cont::CellLocatorRectilinearGrid:

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

Public Member Functions
	CellLocatorRectilinearGrid ()=default
	~CellLocatorRectilinearGrid ()=default
viskores::exec::CellLocatorRectilinearGrid	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...

Protected Member Functions
void	Build () override
Protected Member Functions inherited from viskores::cont::CellLocatorBase
void	SetModified ()
bool	GetModified () const

Private Types
using	Structured2DType = viskores::cont::CellSetStructured< 2 >
using	Structured3DType = viskores::cont::CellSetStructured< 3 >
using	AxisHandle = viskores::cont::ArrayHandle< viskores::FloatDefault >
using	RectilinearType = viskores::cont::ArrayHandleCartesianProduct< AxisHandle, AxisHandle, AxisHandle >

Private Attributes
viskores::Bounds	Bounds
viskores::Id	PlaneSize
viskores::Id	RowSize
bool	Is3D = true

Detailed Description

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

This locator is optimized for structured data that has nonuniform 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::ArrayHandleCartesianProduct for its data.

Member Typedef Documentation

AxisHandle

using viskores::cont::CellLocatorRectilinearGrid::AxisHandle = viskores::cont::ArrayHandle<viskores::FloatDefault>

private

LastCell

using viskores::cont::CellLocatorRectilinearGrid::LastCell = viskores::exec::CellLocatorRectilinearGrid::LastCell

RectilinearType

using viskores::cont::CellLocatorRectilinearGrid::RectilinearType = viskores::cont::ArrayHandleCartesianProduct<AxisHandle, AxisHandle, AxisHandle>

private

Structured2DType

using viskores::cont::CellLocatorRectilinearGrid::Structured2DType = viskores::cont::CellSetStructured<2>

private

Structured3DType

using viskores::cont::CellLocatorRectilinearGrid::Structured3DType = viskores::cont::CellSetStructured<3>

private

Constructor & Destructor Documentation

CellLocatorRectilinearGrid()

viskores::cont::CellLocatorRectilinearGrid::CellLocatorRectilinearGrid ( )

default

~CellLocatorRectilinearGrid()

viskores::cont::CellLocatorRectilinearGrid::~CellLocatorRectilinearGrid ( )

default

Member Function Documentation

Build()

void viskores::cont::CellLocatorRectilinearGrid::Build ( )

overrideprotectedvirtual

Implements viskores::cont::CellLocatorBase.

PrepareForExecution()

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

Member Data Documentation

Bounds

viskores::Bounds viskores::cont::CellLocatorRectilinearGrid::Bounds

private

Is3D

bool viskores::cont::CellLocatorRectilinearGrid::Is3D = true

private

PlaneSize

viskores::Id viskores::cont::CellLocatorRectilinearGrid::PlaneSize

private

RowSize

viskores::Id viskores::cont::CellLocatorRectilinearGrid::RowSize

private

---

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

• cont/CellLocatorRectilinearGrid.h