Provides a neighborhood's placement with respect to the mesh's boundary. More...

#include <BoundaryState.h>

Public Member Functions
VTKM_EXEC	BoundaryState (const vtkm::Id3 &ijk, const vtkm::Id3 &pdims)

VTKM_EXEC bool	IsRadiusInBoundary (vtkm::IdComponent radius) const
	Returns true if a neighborhood of the given radius is contained within the bounds of the cell set. More...

VTKM_EXEC bool	IsNeighborInBoundary (const vtkm::IdComponent3 &neighbor) const
	Returns true if the neighbor at the specified offset vector is contained within the bounds of the cell set. More...

VTKM_EXEC vtkm::IdComponent3	MinNeighborIndices (vtkm::IdComponent radius) const
	Returns the minimum neighborhood indices that are within the bounds of the data. More...

VTKM_EXEC vtkm::IdComponent3	MaxNeighborIndices (vtkm::IdComponent radius) const
	Returns the minimum neighborhood indices that are within the bounds of the data. More...


VTKM_EXEC bool	IsRadiusInXBoundary (vtkm::IdComponent radius) const

VTKM_EXEC bool	IsRadiusInYBoundary (vtkm::IdComponent radius) const

VTKM_EXEC bool	IsRadiusInZBoundary (vtkm::IdComponent radius) const


VTKM_EXEC bool	IsNeighborInXBoundary (vtkm::IdComponent offset) const

VTKM_EXEC bool	IsNeighborInYBoundary (vtkm::IdComponent offset) const

VTKM_EXEC bool	IsNeighborInZBoundary (vtkm::IdComponent offset) const


VTKM_EXEC vtkm::Id3	NeighborIndexToFullIndexClamp (const vtkm::IdComponent3 &neighbor) const

VTKM_EXEC vtkm::Id3	NeighborIndexToFullIndexClamp (vtkm::IdComponent neighborI, vtkm::IdComponent neighborJ, vtkm::IdComponent neighborK) const


VTKM_EXEC vtkm::Id3	NeighborIndexToFullIndex (const vtkm::IdComponent3 &neighbor) const

VTKM_EXEC vtkm::Id3	NeighborIndexToFullIndex (vtkm::IdComponent neighborI, vtkm::IdComponent neighborJ, vtkm::IdComponent neighborK) const


VTKM_EXEC vtkm::IdComponent3	ClampNeighborIndex (const vtkm::IdComponent3 &neighbor) const

VTKM_EXEC vtkm::IdComponent3	ClampNeighborIndex (vtkm::IdComponent neighborI, vtkm::IdComponent neighborJ, vtkm::IdComponent neighborK) const


VTKM_EXEC vtkm::Id	NeighborIndexToFlatIndexClamp (const vtkm::IdComponent3 &neighbor) const

VTKM_EXEC vtkm::Id	NeighborIndexToFlatIndexClamp (vtkm::IdComponent neighborI, vtkm::IdComponent neighborJ, vtkm::IdComponent neighborK) const


VTKM_EXEC vtkm::Id	NeighborIndexToFlatIndex (const vtkm::IdComponent3 &neighbor) const

VTKM_EXEC vtkm::Id	NeighborIndexToFlatIndex (vtkm::IdComponent neighborI, vtkm::IdComponent neighborJ, vtkm::IdComponent neighborK) const

Public Attributes
vtkm::Id3	IJK

vtkm::Id3	PointDimensions

Detailed Description

Provides a neighborhood's placement with respect to the mesh's boundary.

BoundaryState provides functionality for WorkletPointNeighborhood algorithms and Fetch's to determine if they are operating on a point near the boundary. It allows you to query about overlaps of the neighborhood and the mesh boundary. It also helps convert local neighborhood ids to the corresponding location in the mesh.

This class is typically constructed using the Boundary tag in an ExecutionSignature. There is little reason to construct this in user code.

Constructor & Destructor Documentation

◆ BoundaryState()

VTKM_EXEC vtkm::exec::BoundaryState::BoundaryState	(	const vtkm::Id3 &	ijk,
		const vtkm::Id3 &	pdims
	)

inline

Member Function Documentation

◆ ClampNeighborIndex() [1/2]

VTKM_EXEC vtkm::IdComponent3 vtkm::exec::BoundaryState::ClampNeighborIndex ( const vtkm::IdComponent3 & neighbor ) const

inline

Takes a local neighborhood index (in the ranges of -neighborhood size to neighborhood size), clamps it to the dataset bounds, and returns a new neighborhood index. For example, if given a neighbor index that is past the minimum x range of the data, the neighbor index of the minimum x boundary is returned.

◆ ClampNeighborIndex() [2/2]

VTKM_EXEC vtkm::IdComponent3 vtkm::exec::BoundaryState::ClampNeighborIndex	(	vtkm::IdComponent	neighborI,
		vtkm::IdComponent	neighborJ,
		vtkm::IdComponent	neighborK
	)		const

inline

Takes a local neighborhood index (in the ranges of -neighborhood size to neighborhood size), clamps it to the dataset bounds, and returns a new neighborhood index. For example, if given a neighbor index that is past the minimum x range of the data, the neighbor index of the minimum x boundary is returned.

◆ IsNeighborInBoundary()

VTKM_EXEC bool vtkm::exec::BoundaryState::IsNeighborInBoundary ( const vtkm::IdComponent3 & neighbor ) const

inline

Returns true if the neighbor at the specified offset vector is contained within the bounds of the cell set.

Returns false if the neighbor falls outside of the boundary of the data.

◆ IsNeighborInXBoundary()

VTKM_EXEC bool vtkm::exec::BoundaryState::IsNeighborInXBoundary ( vtkm::IdComponent offset ) const

inline

Returns true if the neighbor at the specified offset is contained within the bounds of the cell set in the X, Y, or Z direction. Returns false if the neighbor falls outside of the boundary of the data in the X, Y, or Z direction.

◆ IsNeighborInYBoundary()

VTKM_EXEC bool vtkm::exec::BoundaryState::IsNeighborInYBoundary ( vtkm::IdComponent offset ) const

inline

Returns true if the neighbor at the specified offset is contained within the bounds of the cell set in the X, Y, or Z direction. Returns false if the neighbor falls outside of the boundary of the data in the X, Y, or Z direction.

◆ IsNeighborInZBoundary()

VTKM_EXEC bool vtkm::exec::BoundaryState::IsNeighborInZBoundary ( vtkm::IdComponent offset ) const

inline

Returns true if the neighbor at the specified offset is contained within the bounds of the cell set in the X, Y, or Z direction. Returns false if the neighbor falls outside of the boundary of the data in the X, Y, or Z direction.

◆ IsRadiusInBoundary()

VTKM_EXEC bool vtkm::exec::BoundaryState::IsRadiusInBoundary ( vtkm::IdComponent radius ) const

inline

Returns true if a neighborhood of the given radius is contained within the bounds of the cell set.

Returns false if the neighborhood extends outside of the boundary of the data.

The radius defines the size of the neighborhood in terms of how far away it extends from the center. So if there is a radius of 1, the neighborhood extends 1 unit away from the center in each direction and is 3x3x3. If there is a radius of 2, the neighborhood extends 2 units for a size of 5x5x5.

◆ IsRadiusInXBoundary()

VTKM_EXEC bool vtkm::exec::BoundaryState::IsRadiusInXBoundary ( vtkm::IdComponent radius ) const

inline

Returns true if a neighborhood of the given radius is contained within the bounds of the cell set in the X, Y, or Z direction. Returns false if the neighborhood extends outside of the boundary of the data in the X, Y, or Z direction.

The radius defines the size of the neighborhood in terms of how far away it extends from the center. So if there is a radius of 1, the neighborhood extends 1 unit away from the center in each direction and is 3x3x3. If there is a radius of 2, the neighborhood extends 2 units for a size of 5x5x5.

◆ IsRadiusInYBoundary()

VTKM_EXEC bool vtkm::exec::BoundaryState::IsRadiusInYBoundary ( vtkm::IdComponent radius ) const

inline

Returns true if a neighborhood of the given radius is contained within the bounds of the cell set in the X, Y, or Z direction. Returns false if the neighborhood extends outside of the boundary of the data in the X, Y, or Z direction.

The radius defines the size of the neighborhood in terms of how far away it extends from the center. So if there is a radius of 1, the neighborhood extends 1 unit away from the center in each direction and is 3x3x3. If there is a radius of 2, the neighborhood extends 2 units for a size of 5x5x5.

◆ IsRadiusInZBoundary()

VTKM_EXEC bool vtkm::exec::BoundaryState::IsRadiusInZBoundary ( vtkm::IdComponent radius ) const

inline

Returns true if a neighborhood of the given radius is contained within the bounds of the cell set in the X, Y, or Z direction. Returns false if the neighborhood extends outside of the boundary of the data in the X, Y, or Z direction.

The radius defines the size of the neighborhood in terms of how far away it extends from the center. So if there is a radius of 1, the neighborhood extends 1 unit away from the center in each direction and is 3x3x3. If there is a radius of 2, the neighborhood extends 2 units for a size of 5x5x5.

◆ MaxNeighborIndices()

VTKM_EXEC vtkm::IdComponent3 vtkm::exec::BoundaryState::MaxNeighborIndices ( vtkm::IdComponent radius ) const

inline

Returns the minimum neighborhood indices that are within the bounds of the data.

◆ MinNeighborIndices()

VTKM_EXEC vtkm::IdComponent3 vtkm::exec::BoundaryState::MinNeighborIndices ( vtkm::IdComponent radius ) const

inline

Returns the minimum neighborhood indices that are within the bounds of the data.

◆ NeighborIndexToFlatIndex() [1/2]

VTKM_EXEC vtkm::Id vtkm::exec::BoundaryState::NeighborIndexToFlatIndex ( const vtkm::IdComponent3 & neighbor ) const

inline

Takes a local neighborhood index (in the ranges of -neighborhood size to neighborhood size) and returns the flat index of the equivalent point in the full data set. If the given value is out of range, the result is undefined.

◆ NeighborIndexToFlatIndex() [2/2]

VTKM_EXEC vtkm::Id vtkm::exec::BoundaryState::NeighborIndexToFlatIndex	(	vtkm::IdComponent	neighborI,
		vtkm::IdComponent	neighborJ,
		vtkm::IdComponent	neighborK
	)		const

inline

Takes a local neighborhood index (in the ranges of -neighborhood size to neighborhood size) and returns the flat index of the equivalent point in the full data set. If the given value is out of range, the result is undefined.

◆ NeighborIndexToFlatIndexClamp() [1/2]

VTKM_EXEC vtkm::Id vtkm::exec::BoundaryState::NeighborIndexToFlatIndexClamp ( const vtkm::IdComponent3 & neighbor ) const

inline

Takes a local neighborhood index (in the ranges of -neighborhood size to neighborhood size) and returns the flat index of the equivalent point in the full data set. If the given value is out of range, the value is clamped to the nearest boundary. For example, if given a neighbor index that is past the minimum x range of the data, the index at the minimum x boundary is returned.

◆ NeighborIndexToFlatIndexClamp() [2/2]

VTKM_EXEC vtkm::Id vtkm::exec::BoundaryState::NeighborIndexToFlatIndexClamp	(	vtkm::IdComponent	neighborI,
		vtkm::IdComponent	neighborJ,
		vtkm::IdComponent	neighborK
	)		const

inline

Takes a local neighborhood index (in the ranges of -neighborhood size to neighborhood size) and returns the flat index of the equivalent point in the full data set. If the given value is out of range, the value is clamped to the nearest boundary. For example, if given a neighbor index that is past the minimum x range of the data, the index at the minimum x boundary is returned.

◆ NeighborIndexToFullIndex() [1/2]

VTKM_EXEC vtkm::Id3 vtkm::exec::BoundaryState::NeighborIndexToFullIndex ( const vtkm::IdComponent3 & neighbor ) const

inline

Takes a local neighborhood index (in the ranges of -neighborhood size to neighborhood size) and returns the ijk of the equivalent point in the full data set. If the given value is out of range, the returned value is undefined.

◆ NeighborIndexToFullIndex() [2/2]

VTKM_EXEC vtkm::Id3 vtkm::exec::BoundaryState::NeighborIndexToFullIndex	(	vtkm::IdComponent	neighborI,
		vtkm::IdComponent	neighborJ,
		vtkm::IdComponent	neighborK
	)		const

inline

Takes a local neighborhood index (in the ranges of -neighborhood size to neighborhood size) and returns the ijk of the equivalent point in the full data set. If the given value is out of range, the returned value is undefined.

◆ NeighborIndexToFullIndexClamp() [1/2]

VTKM_EXEC vtkm::Id3 vtkm::exec::BoundaryState::NeighborIndexToFullIndexClamp ( const vtkm::IdComponent3 & neighbor ) const

inline

Takes a local neighborhood index (in the ranges of -neighborhood size to neighborhood size) and returns the ijk of the equivalent point in the full data set. If the given value is out of range, the value is clamped to the nearest boundary. For example, if given a neighbor index that is past the minimum x range of the data, the index at the minimum x boundary is returned.

◆ NeighborIndexToFullIndexClamp() [2/2]

VTKM_EXEC vtkm::Id3 vtkm::exec::BoundaryState::NeighborIndexToFullIndexClamp	(	vtkm::IdComponent	neighborI,
		vtkm::IdComponent	neighborJ,
		vtkm::IdComponent	neighborK
	)		const

inline

Takes a local neighborhood index (in the ranges of -neighborhood size to neighborhood size) and returns the ijk of the equivalent point in the full data set. If the given value is out of range, the value is clamped to the nearest boundary. For example, if given a neighbor index that is past the minimum x range of the data, the index at the minimum x boundary is returned.

Member Data Documentation

◆ IJK

vtkm::Id3 vtkm::exec::BoundaryState::IJK

◆ PointDimensions

vtkm::Id3 vtkm::exec::BoundaryState::PointDimensions

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

BoundaryState.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BoundaryState()

Member Function Documentation

◆ ClampNeighborIndex() [1/2]

◆ ClampNeighborIndex() [2/2]

◆ IsNeighborInBoundary()

◆ IsNeighborInXBoundary()

◆ IsNeighborInYBoundary()

◆ IsNeighborInZBoundary()

◆ IsRadiusInBoundary()

◆ IsRadiusInXBoundary()

◆ IsRadiusInYBoundary()

◆ IsRadiusInZBoundary()

◆ MaxNeighborIndices()

◆ MinNeighborIndices()

◆ NeighborIndexToFlatIndex() [1/2]

◆ NeighborIndexToFlatIndex() [2/2]

◆ NeighborIndexToFlatIndexClamp() [1/2]

◆ NeighborIndexToFlatIndexClamp() [2/2]

◆ NeighborIndexToFullIndex() [1/2]

◆ NeighborIndexToFullIndex() [2/2]

◆ NeighborIndexToFullIndexClamp() [1/2]

◆ NeighborIndexToFullIndexClamp() [2/2]

Member Data Documentation

◆ IJK

◆ PointDimensions