vtkm::CellClassification Class Reference

Bit flags used in ghost arrays to identify what type a cell is. More...

#include <CellClassification.h>

Public Types
enum	: vtkm::UInt8 {   Normal = 0, Ghost = 1 << 0, Invalid = 1 << 1, Unused0 = 1 << 2,   Blanked = 1 << 3, Unused3 = 1 << 4, Unused4 = 1 << 5, Unused5 = 1 << 6 }

Public Member Functions
constexpr	CellClassification (vtkm::UInt8 flags=vtkm::UInt8{ Normal })
constexpr	operator vtkm::UInt8 () const

Private Attributes
vtkm::UInt8	Flags

Detailed Description

Bit flags used in ghost arrays to identify what type a cell is.

CellClassification contains several bit flags that determine whether a cell is normal or if it should be treated as duplicated or removed in some way. The flags can be (and should be) treated as vtkm::UInt8 and or-ed together.

Member Enumeration Documentation

anonymous enum

anonymous enum : vtkm::UInt8

Enumerator
Normal	Value used for a normal cell. This value is the clearing of any cell classification flags. This identifies the cells as a "normal" cell without any special or exclusionary properties.
Ghost	Flag used for a ghost cell. This flag indicates the associated cell is repeated information from a different partition. The ghost cell is provided to give data from cells in neighboring partitions. This allows operations to correctly compute neighborhood information without explicit communications. Ghost cells are typically removed for rendering.
Invalid	Flag used for an invalid cell.
Unused0
Blanked	Flag used for a cell that should not be considered part of the data. A blanked cell should be ignored from the data. Cells with this flag should be treated as if they were not declared. Blanked cells are primarily used in structured cell sets to remove parts of the interior of the mesh volume that could not otherwise be removed. Blanked cells are common in AMR structures to indicate cells that are further refined in deeper levels.
Unused3
Unused4
Unused5

Constructor & Destructor Documentation

CellClassification()

constexpr vtkm::CellClassification::CellClassification ( vtkm::UInt8  flags = vtkm::UInt8{ Normal } )

inlineconstexpr

Member Function Documentation

operator vtkm::UInt8()

constexpr vtkm::CellClassification::operator vtkm::UInt8 ( ) const

inlineconstexpr

Member Data Documentation

Flags

vtkm::UInt8 vtkm::CellClassification::Flags

private

---

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

• CellClassification.h