vtkm::cont::CellLocatorRectilinearGrid Class Reference

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

#include <CellLocatorRectilinearGrid.h>

Inheritance diagram for vtkm::cont::CellLocatorRectilinearGrid:

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

Public Member Functions
	CellLocatorRectilinearGrid ()=default
	~CellLocatorRectilinearGrid ()=default
vtkm::exec::CellLocatorRectilinearGrid	PrepareForExecution (vtkm::cont::DeviceAdapterId device, vtkm::cont::Token &token) const
Public Member Functions inherited from vtkm::cont::CellLocatorBase
virtual	~CellLocatorBase ()=default
const vtkm::cont::UnknownCellSet &	GetCellSet () const
	Specify the CellSet defining the structure of the cells being searched. More...
void	SetCellSet (const vtkm::cont::UnknownCellSet &cellSet)
	Specify the CellSet defining the structure of the cells being searched. More...
const vtkm::cont::CoordinateSystem &	GetCoordinates () const
	Specify the CoordinateSystem defining the location of the cells. More...
void	SetCoordinates (const vtkm::cont::CoordinateSystem &coords)
	Specify the CoordinateSystem defining the location of the cells. More...
void	SetCoordinates (const vtkm::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 vtkm::cont::CellLocatorBase
void	SetModified ()
bool	GetModified () const

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

Private Attributes
vtkm::Bounds	Bounds
vtkm::Id	PlaneSize
vtkm::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 vtkm::cont::CellSetStructured and a coordinate system using a vtkm::cont::ArrayHandleCartesianProduct for its data.

Member Typedef Documentation

AxisHandle

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

private

LastCell

using vtkm::cont::CellLocatorRectilinearGrid::LastCell = vtkm::exec::CellLocatorRectilinearGrid::LastCell

RectilinearType

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

private

Structured2DType

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

private

Structured3DType

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

private

Constructor & Destructor Documentation

CellLocatorRectilinearGrid()

vtkm::cont::CellLocatorRectilinearGrid::CellLocatorRectilinearGrid ( )

default

~CellLocatorRectilinearGrid()

vtkm::cont::CellLocatorRectilinearGrid::~CellLocatorRectilinearGrid ( )

default

Member Function Documentation

Build()

void vtkm::cont::CellLocatorRectilinearGrid::Build ( )

overrideprotectedvirtual

Implements vtkm::cont::CellLocatorBase.

PrepareForExecution()

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

Member Data Documentation

Bounds

vtkm::Bounds vtkm::cont::CellLocatorRectilinearGrid::Bounds

private

Is3D

bool vtkm::cont::CellLocatorRectilinearGrid::Is3D = true

private

PlaneSize

vtkm::Id vtkm::cont::CellLocatorRectilinearGrid::PlaneSize

private

RowSize

vtkm::Id vtkm::cont::CellLocatorRectilinearGrid::RowSize

private

---

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

• cont/CellLocatorRectilinearGrid.h