VTKm
2.0

Provides a neighborhood's placement with respect to the mesh's boundary. More...
#include <BoundaryState.h>
Public Attributes  
vtkm::Id3  IJK 
vtkm::Id3  PointDimensions 
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.

inline 

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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.

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.

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.

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.

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.

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.

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.

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.
vtkm::Id3 vtkm::exec::BoundaryState::IJK 
vtkm::Id3 vtkm::exec::BoundaryState::PointDimensions 