#include <vtkUnstructuredGridSides.h>

Detailed Description

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>
class vtkUnstructuredGridSides< TId, TSideId >

the sides of the cells of a vtkUnstructuredGrid, matched without cell links

vtkUnstructuredGridSides finds the sides of the cells of a vtkUnstructuredGrid (their faces, edges or vertices), and keeps some of them depending on how many cells share them, without building cell links. As in vtkCellGridComputeSides (see vtkCellGridSidesQuery), the sides to find are selected with SideFlags, e.g., the faces of the 3D cells, and the sides to keep with SummaryStrategy, e.g., the boundary. The sides are scattered by their key, their smallest point id, as with vtk::keys, and are built in one of three ways:

BuildScatteredSides(): all the sides, by key, not matched, e.g., to match them in another way;
BuildReducedSides(): the kept sides, by key, see vtk::keys::Reduce(), e.g., the boundary;
BuildGroupedSides(): all the sides, by key, the equal sides of every key contiguous, in groups, see vtk::keys::Group(), e.g., a face of a mesh and the cells that share it. Each side is given by a cell that has it, its local index among the sides of its dimension in the cell, or -1 for the cell itself (see SetPreserveRenderableInputs()), and its dimension (0 for a vertex, 1 for an edge, 2 for a face). The sides are built again only when this object or the dataset is modified, or to build them in another way, as by vtkLocator::BuildLocator().

// The boundary faces of the 3D cells of a grid.
using Sides = vtkUnstructuredGridSides<vtkTypeInt32>;
vtkNew<Sides> sides;
sides->SetDataSet(grid);
sides->SetOutputDimensionControl(Sides::SideFlags::SurfacesOfVolumes);
sides->BuildReducedSides();
for (vtkTypeInt32 keyId = 0; keyId < sides->GetNumberOfKeys(); ++keyId)
{
  for (vtkIdType k = 0; k < sides->GetNumberOfSidesOfKey(keyId); ++k)
  {
    // The face sides->GetSideIdOfSide(keyId, k) of the cell sides->GetCellIdOfSide(keyId, k),
    // whose type and size are given by sides->GetSideInformation(keyId, k, cell), and whose
    // points are given by sides->GetSidePoints(keyId, k, ...).
  }
}
// The faces of the 3D cells of a grid, each with the cells that share it.
sides->BuildGroupedSides();
for (vtkTypeInt32 keyId = 0; keyId < sides->GetNumberOfKeys(); ++keyId)
{
  for (vtkIdType group = sides->GetGroupOffsetOfKey(keyId);
       group < sides->GetGroupOffsetOfKey(keyId + 1); ++group)
  {
    // The face `group`, whose sides are k in [first, first + sides->GetNumberOfSidesOfGroup(
    // group)) of the key, where first = sides->GetSideOffsetOfGroup(group) -
    // sides->GetSideOffsetOfKey(keyId).
  }
}

The sides are scattered by their key, their smallest point id, with vtk::keys::ScatterDense(), as the faces of DP-Hash-Count (see below): only their cell and local index are stored, and their points are computed again from the cell arrays of the dataset. The sides of a key are in the order of their cells and of their local index, whatever the threads, so that the scattered, reduced and grouped sides are the same from one run to the next. Two sides of a key match if they have the same corners in the same cyclic order, in either direction, and, for the nonlinear sides, the same other points, e.g., the mid-edge points of the faces of the quadratic cells, unless SetMatchSidePoints() is off. A degenerate side whose smallest corner is repeated, e.g., a face of a collapsed hexahedron, is compared in a canonical form of its corners.

Cells can be masked, as in vtkGeometryFilter: the cells clipped by their ids, by their point ids or by an extent (see SetCellClipping(), SetPointClipping() and SetExtentClipping()), and the masked ghost cells, hidden or refined by default (see SetMaskedGhostTypes()), take no part. With SetRemoveGhostInterfaces(), the duplicate ghost cells match the sides of the other cells, so that the interfaces between processes are not boundaries, but their own sides are not kept; otherwise, they are ordinary cells.

The class is templated on the type of the ids, TId, vtkTypeInt32 or vtkTypeInt64, which must hold the number of points and the number of cells, e.g., vtkTypeInt32 halves the memory when they fit, and the type of the local side indices, TSideId, vtkTypeInt8 or vtkTypeInt32, which must hold the local index of every side among the sides of its dimension, which is only asserted: vtkTypeInt32 is needed when a cell can have more than 128 sides of a dimension, i.e., the faces or edges of polyhedra and the faces of convex point sets, or the edges of polygons and triangle strips and the vertices of polylines and poly-vertices with many points. These 4 combinations are instantiated. The positions of the sides in their keys, and the groups, are vtkIdType.

Warning: The edges and vertices of a cell are those of its vtkCell, e.g., all the points of a nonlinear cell are its vertices. The faces of a 3D cell are those of vtkUnstructuredGrid::GetCellFacePoints(), e.g., read from the face arrays for a polyhedron.; This class has been threaded with vtkSMPTools. Using TBB or other non-sequential type (set in the CMake variable VTK_SMP_IMPLEMENTATION_TYPE) may improve performance significantly.

Reference:: S. Tsalikis, W. Schroeder, D. Szafir, and K. Moreland, "Memory-Aware External Facelist Calculation: A Data-Parallel Atomic Hash Counting Approach," IEEE Transactions on Visualization and Computer Graphics, vol. 32, no. 6, pp. 4862-4871, 2026, doi: 10.1109/TVCG.2026.3694435.

See also: vtkCellGridComputeSides vtkCellGridSidesQuery

Tests:: vtkUnstructuredGridSides (Tests)

Definition at line 118 of file vtkUnstructuredGridSides.h.

Inheritance diagram for vtkUnstructuredGridSides< TId, TSideId >:

[legend]

Collaboration diagram for vtkUnstructuredGridSides< TId, TSideId >:

[legend]

Classes
struct	SideInformation
	The information of a side, see GetSideInformation(). More...

Public Types
enum class	BuildMode : std::uint8_t { None , Scattered , Reduced , Grouped }
	How the sides were built, see GetBuildMode(). More...
using	SelfType = vtkUnstructuredGridSides<TId, TSideId>
using	SideFlags = vtkCellGridSidesQuery::SideFlags
	Which sides of which cells to find, see vtkCellGridSidesQuery::SideFlags, whose bits can be combined.
using	SummaryStrategy = vtkCellGridSidesQuery::SummaryStrategy
	Which sides to keep, see vtkCellGridSidesQuery::SummaryStrategy.

Public Member Functions
	vtkTemplateTypeMacro (SelfType, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	BuildScatteredSides ()
	Find the sides of the cells given by OutputDimensionControl, and scatter all of them by their key, their smallest point id, not matched, e.g., to match them in another way.
void	BuildReducedSides ()
	Same as BuildScatteredSides(), then match the sides of every key, and keep them as given by the summary strategy: e.g., the boundary of the dataset.
void	BuildGroupedSides ()
	Same as BuildScatteredSides(), then match the sides of every key, and keep all of them, the equal sides of a key contiguous, as a group: e.g., a face of the dataset and the cells that share it.
BuildMode	GetBuildMode () const
	How the sides were last built, None if they were not, e.g., after Reset().
void	Reset ()
	Release the memory, so that the sides are built again.
virtual vtkMTimeType	GetBuildTime ()
	The time at which the sides were built.
bool	UsesGarbageCollector () const override
	The dataset is reported to the garbage collector, see ReportReferences().
vtkIdType	GetNumberOfSides () const
	The number of sides: the kept sides after BuildReducedSides(), all the sides otherwise.
TId	GetNumberOfKeys () const
	The number of keys: the number of points plus one if some sides are found, otherwise one, e.g., before the sides are built.
vtkIdType	GetNumberOfSidesOfKey (TId keyId) const
	The number of sides of a key, as GetNumberOfSides(), 0 <= keyId < GetNumberOfKeys().
vtkIdType	GetSideOffsetOfKey (TId keyId) const
	The offset of a key, 0 <= keyId <= GetNumberOfKeys(): the number of sides of the keys before it, e.g., to write the sides of the keys in parallel, as the offsets of a vtkCellArray.
const TId *	GetCellIdsOfKey (TId keyId) const
	The cells of the sides of a key, of GetNumberOfSidesOfKey() values, 0 <= keyId < GetNumberOfKeys().
const TSideId *	GetSideIdsOfKey (TId keyId) const
	The local indices of the sides of a key in their cell, of GetNumberOfSidesOfKey() values, -1 for a preserved cell.
SideInformation	GetSideInformation (TId keyId, vtkIdType k, vtkGenericCell *tempCell) const
	The information of the side k of a key, without reading its points: its type and size are given by vtkCellTypeSides::GetCellSideType() and vtkCellTypeSides::GetCellSideSize(), those of a preserved cell being its own.
void	GetSidePoints (TId keyId, vtkIdType k, vtkIdList sidePtIds, unsigned char &cellType, vtkIdList tempCellPointIds, vtkGenericCell *tempCell) const
	Get the point ids of the side k of a key, in the order of the side in its cell, from the cell arrays of the dataset: a vertex is a point of its cell, an edge and a face are given as by vtkUnstructuredGrid::GetCellEdgePoints() and vtkUnstructuredGrid::GetCellFacePoints(), and a preserved cell by its points.
int	GetDimensionOfGroup (vtkIdType group) const
	The dimension of the sides of a group, 0 <= group < GetNumberOfGroups(), which all have the same one, since equal sides have the same number of points.

virtual void	SetDataSet (vtkUnstructuredGrid *dataSet)
	The dataset whose sides are built, which is referenced.
virtual vtkUnstructuredGrid *	GetDataSet ()
	The dataset whose sides are built, which is referenced.

virtual void	SetPreserveRenderableInputs (bool)
	Whether the cells of dimension 2 or less are preserved, as sides with a side id of -1, in the last key, in the order of their ids, without being matched, and in no group.
virtual bool	GetPreserveRenderableInputs ()
	Whether the cells of dimension 2 or less are preserved, as sides with a side id of -1, in the last key, in the order of their ids, without being matched, and in no group.
virtual void	PreserveRenderableInputsOn ()
	Whether the cells of dimension 2 or less are preserved, as sides with a side id of -1, in the last key, in the order of their ids, without being matched, and in no group.
virtual void	PreserveRenderableInputsOff ()
	Whether the cells of dimension 2 or less are preserved, as sides with a side id of -1, in the last key, in the order of their ids, without being matched, and in no group.

virtual void	SetOmitSidesForRenderableInputs (bool)
	Whether no side is found for the cells of dimension 2 or less.
virtual bool	GetOmitSidesForRenderableInputs ()
	Whether no side is found for the cells of dimension 2 or less.
virtual void	OmitSidesForRenderableInputsOn ()
	Whether no side is found for the cells of dimension 2 or less.
virtual void	OmitSidesForRenderableInputsOff ()
	Whether no side is found for the cells of dimension 2 or less.

virtual void	SetOutputDimensionControl (int)
	Which sides of which cells to find: any combination of the bits of SideFlags, e.g., SideFlags::VerticesOfEdges \| SideFlags::EdgesOfVolumes, as vtkCellGridSidesQuery::SetOutputDimensionControl().
virtual int	GetOutputDimensionControl ()
	Which sides of which cells to find: any combination of the bits of SideFlags, e.g., SideFlags::VerticesOfEdges \| SideFlags::EdgesOfVolumes, as vtkCellGridSidesQuery::SetOutputDimensionControl().

virtual void	SetStrategy (SummaryStrategy)
	Which sides to keep, see BuildReducedSides().
void	SetStrategyToWinding ()
	Which sides to keep, see BuildReducedSides().
void	SetStrategyToAnyOccurrence ()
	Which sides to keep, see BuildReducedSides().
void	SetStrategyToBoundary ()
	Which sides to keep, see BuildReducedSides().
virtual void	SetStrategy (int strategy)
	This method exists for ParaView to set the strategy.
virtual SummaryStrategy	GetStrategy ()
	Which sides to keep, see BuildReducedSides().

virtual void	SetPointClipping (bool)
	Turn on/off the clipping of the cells by their point ids: a cell takes no part if one of its points is not in [PointMinimum, PointMaximum].
virtual bool	GetPointClipping ()
	Turn on/off the clipping of the cells by their point ids: a cell takes no part if one of its points is not in [PointMinimum, PointMaximum].
virtual void	PointClippingOn ()
	Turn on/off the clipping of the cells by their point ids: a cell takes no part if one of its points is not in [PointMinimum, PointMaximum].
virtual void	PointClippingOff ()
	Turn on/off the clipping of the cells by their point ids: a cell takes no part if one of its points is not in [PointMinimum, PointMaximum].

virtual void	SetCellClipping (bool)
	Turn on/off the clipping of the cells by their ids: a cell takes no part if its id is not in [CellMinimum, CellMaximum].
virtual bool	GetCellClipping ()
	Turn on/off the clipping of the cells by their ids: a cell takes no part if its id is not in [CellMinimum, CellMaximum].
virtual void	CellClippingOn ()
	Turn on/off the clipping of the cells by their ids: a cell takes no part if its id is not in [CellMinimum, CellMaximum].
virtual void	CellClippingOff ()
	Turn on/off the clipping of the cells by their ids: a cell takes no part if its id is not in [CellMinimum, CellMaximum].

virtual void	SetExtentClipping (bool)
	Turn on/off the clipping of the cells by an extent: a cell takes no part if one of its points is not in the Extent.
virtual bool	GetExtentClipping ()
	Turn on/off the clipping of the cells by an extent: a cell takes no part if one of its points is not in the Extent.
virtual void	ExtentClippingOn ()
	Turn on/off the clipping of the cells by an extent: a cell takes no part if one of its points is not in the Extent.
virtual void	ExtentClippingOff ()
	Turn on/off the clipping of the cells by an extent: a cell takes no part if one of its points is not in the Extent.

virtual void	SetPointMinimum (vtkIdType)
	The range of the point ids of the point clipping, see SetPointClipping().
virtual vtkIdType	GetPointMinimum ()
	The range of the point ids of the point clipping, see SetPointClipping().
virtual void	SetPointMaximum (vtkIdType)
	The range of the point ids of the point clipping, see SetPointClipping().
virtual vtkIdType	GetPointMaximum ()
	The range of the point ids of the point clipping, see SetPointClipping().

virtual void	SetCellMinimum (vtkIdType)
	The range of the cell ids of the cell clipping, see SetCellClipping().
virtual vtkIdType	GetCellMinimum ()
	The range of the cell ids of the cell clipping, see SetCellClipping().
virtual void	SetCellMaximum (vtkIdType)
	The range of the cell ids of the cell clipping, see SetCellClipping().
virtual vtkIdType	GetCellMaximum ()
	The range of the cell ids of the cell clipping, see SetCellClipping().

virtual void	SetExtent (double, double, double, double, double, double)
	The (xmin, xmax, ymin, ymax, zmin, zmax) bounding box of the extent clipping, see SetExtentClipping().
virtual void	SetExtent (double[6])
	The (xmin, xmax, ymin, ymax, zmin, zmax) bounding box of the extent clipping, see SetExtentClipping().
virtual double *	GetExtent ()
	The (xmin, xmax, ymin, ymax, zmin, zmax) bounding box of the extent clipping, see SetExtentClipping().
virtual void	GetExtent (double &, double &, double &, double &, double &, double &)
	The (xmin, xmax, ymin, ymax, zmin, zmax) bounding box of the extent clipping, see SetExtentClipping().
virtual void	GetExtent (double[6])
	The (xmin, xmax, ymin, ymax, zmin, zmax) bounding box of the extent clipping, see SetExtentClipping().

virtual void	SetRemoveGhostInterfaces (bool)
	Whether the duplicate ghost cells match the sides of the other cells, so that the interfaces between processes are not boundaries.
virtual bool	GetRemoveGhostInterfaces ()
	Whether the duplicate ghost cells match the sides of the other cells, so that the interfaces between processes are not boundaries.
virtual void	RemoveGhostInterfacesOn ()
	Whether the duplicate ghost cells match the sides of the other cells, so that the interfaces between processes are not boundaries.
virtual void	RemoveGhostInterfacesOff ()
	Whether the duplicate ghost cells match the sides of the other cells, so that the interfaces between processes are not boundaries.

virtual void	SetMaskedGhostTypes (unsigned char)
	The ghost types that mask a cell, see vtkDataSetAttributes::CellGhostTypes: a cell with one of them takes no part.
virtual unsigned char	GetMaskedGhostTypes ()
	The ghost types that mask a cell, see vtkDataSetAttributes::CellGhostTypes: a cell with one of them takes no part.

virtual void	SetMatchSidePoints (bool)
	Whether the matched nonlinear sides must also have the same other points than their corners, in any order, e.g., their mid-edge points: a face of a quadratic cell then does not match a face of a linear cell with the same corners, nor faces of Lagrange cells of different orders or with distinct mid-edge points, so that both are kept by Boundary, since their interface is not conforming.
virtual bool	GetMatchSidePoints ()
	Whether the matched nonlinear sides must also have the same other points than their corners, in any order, e.g., their mid-edge points: a face of a quadratic cell then does not match a face of a linear cell with the same corners, nor faces of Lagrange cells of different orders or with distinct mid-edge points, so that both are kept by Boundary, since their interface is not conforming.
virtual void	MatchSidePointsOn ()
	Whether the matched nonlinear sides must also have the same other points than their corners, in any order, e.g., their mid-edge points: a face of a quadratic cell then does not match a face of a linear cell with the same corners, nor faces of Lagrange cells of different orders or with distinct mid-edge points, so that both are kept by Boundary, since their interface is not conforming.
virtual void	MatchSidePointsOff ()
	Whether the matched nonlinear sides must also have the same other points than their corners, in any order, e.g., their mid-edge points: a face of a quadratic cell then does not match a face of a linear cell with the same corners, nor faces of Lagrange cells of different orders or with distinct mid-edge points, so that both are kept by Boundary, since their interface is not conforming.

TId	GetCellIdOfSide (TId keyId, vtkIdType k) const
	The cell, the local index in its cell, and the dimension of the side k of a key, 0 <= k < GetNumberOfSidesOfKey(keyId).
TSideId	GetSideIdOfSide (TId keyId, vtkIdType k) const
	The cell, the local index in its cell, and the dimension of the side k of a key, 0 <= k < GetNumberOfSidesOfKey(keyId).
int	GetDimensionOfSide (TId keyId, vtkIdType k) const
	The cell, the local index in its cell, and the dimension of the side k of a key, 0 <= k < GetNumberOfSidesOfKey(keyId).

vtkIdType	GetNumberOfGroups () const
	The groups of equal sides, ordered by key: their number, e.g., the number of distinct faces, and the first group of a key, 0 <= keyId <= GetNumberOfKeys(), so that the groups of a key are [GetGroupOffsetOfKey(keyId), GetGroupOffsetOfKey(keyId + 1)).
vtkIdType	GetGroupOffsetOfKey (TId keyId) const
	The groups of equal sides, ordered by key: their number, e.g., the number of distinct faces, and the first group of a key, 0 <= keyId <= GetNumberOfKeys(), so that the groups of a key are [GetGroupOffsetOfKey(keyId), GetGroupOffsetOfKey(keyId + 1)).

vtkIdType	GetNumberOfSidesOfGroup (vtkIdType group) const
	The number of sides of a group, 0 <= group < GetNumberOfGroups(), and its first side, 0 <= group <= GetNumberOfGroups(), among all the sides: the first side of the group is k = GetSideOffsetOfGroup(group) - GetSideOffsetOfKey(keyId) of its key.
vtkIdType	GetSideOffsetOfGroup (vtkIdType group) const
	The number of sides of a group, 0 <= group < GetNumberOfGroups(), and its first side, 0 <= group <= GetNumberOfGroups(), among all the sides: the first side of the group is k = GetSideOffsetOfGroup(group) - GetSideOffsetOfKey(keyId) of its key.

const TId *	GetCellIdsOfGroup (vtkIdType group) const
	The cells and the local indices in their cell of the sides of a group, of GetNumberOfSidesOfGroup() values, 0 <= group < GetNumberOfGroups(), e.g., the cells that share a face, read without its key.
const TSideId *	GetSideIdsOfGroup (vtkIdType group) const
	The cells and the local indices in their cell of the sides of a group, of GetNumberOfSidesOfGroup() values, 0 <= group < GetNumberOfGroups(), e.g., the cells that share a face, read without its key.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static SelfType *	New ()
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
	vtkUnstructuredGridSides ()
	~vtkUnstructuredGridSides () override
void	ReportReferences (vtkGarbageCollector *) override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTimeStamp	BuildTime
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Member Typedef Documentation

◆ SelfType

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

using vtkUnstructuredGridSides< TId, TSideId >::SelfType = vtkUnstructuredGridSides<TId, TSideId>

Definition at line 121 of file vtkUnstructuredGridSides.h.

◆ SideFlags

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

using vtkUnstructuredGridSides< TId, TSideId >::SideFlags = vtkCellGridSidesQuery::SideFlags

Which sides of which cells to find, see vtkCellGridSidesQuery::SideFlags, whose bits can be combined.

Definition at line 130 of file vtkUnstructuredGridSides.h.

◆ SummaryStrategy

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

using vtkUnstructuredGridSides< TId, TSideId >::SummaryStrategy = vtkCellGridSidesQuery::SummaryStrategy

Which sides to keep, see vtkCellGridSidesQuery::SummaryStrategy.

Definition at line 135 of file vtkUnstructuredGridSides.h.

Member Enumeration Documentation

◆ BuildMode

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

enum class vtkUnstructuredGridSides::BuildMode : std::uint8_t

strong

How the sides were built, see GetBuildMode().

Enumerator
None	Not built, e.g., after Reset().
Scattered	BuildScatteredSides().
Reduced	BuildReducedSides().
Grouped	BuildGroupedSides().

Definition at line 289 of file vtkUnstructuredGridSides.h.

Constructor & Destructor Documentation

◆ vtkUnstructuredGridSides()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

vtkUnstructuredGridSides< TId, TSideId >::vtkUnstructuredGridSides ( )

protected

◆ ~vtkUnstructuredGridSides()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

vtkUnstructuredGridSides< TId, TSideId >::~vtkUnstructuredGridSides ( )

overrideprotected

Member Function Documentation

◆ New()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

SelfType * vtkUnstructuredGridSides< TId, TSideId >::New ( )

static

◆ vtkTemplateTypeMacro()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

vtkUnstructuredGridSides< TId, TSideId >::vtkTemplateTypeMacro	(	SelfType	,
		vtkObject	)

◆ PrintSelf()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

void vtkUnstructuredGridSides< TId, TSideId >::PrintSelf	(	ostream &	os,
		vtkIndent	indent )

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ SetDataSet()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetDataSet ( vtkUnstructuredGrid * dataSet )

virtual

The dataset whose sides are built, which is referenced.

The sides are built again when it is modified.

◆ GetDataSet()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual vtkUnstructuredGrid * vtkUnstructuredGridSides< TId, TSideId >::GetDataSet ( )

virtual

The dataset whose sides are built, which is referenced.

The sides are built again when it is modified.

◆ SetPreserveRenderableInputs()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetPreserveRenderableInputs ( bool )

virtual

Whether the cells of dimension 2 or less are preserved, as sides with a side id of -1, in the last key, in the order of their ids, without being matched, and in no group.

Off by default.

◆ GetPreserveRenderableInputs()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual bool vtkUnstructuredGridSides< TId, TSideId >::GetPreserveRenderableInputs ( )

virtual

Whether the cells of dimension 2 or less are preserved, as sides with a side id of -1, in the last key, in the order of their ids, without being matched, and in no group.

Off by default.

◆ PreserveRenderableInputsOn()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::PreserveRenderableInputsOn ( )

virtual

Whether the cells of dimension 2 or less are preserved, as sides with a side id of -1, in the last key, in the order of their ids, without being matched, and in no group.

Off by default.

◆ PreserveRenderableInputsOff()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::PreserveRenderableInputsOff ( )

virtual

Whether the cells of dimension 2 or less are preserved, as sides with a side id of -1, in the last key, in the order of their ids, without being matched, and in no group.

Off by default.

◆ SetOmitSidesForRenderableInputs()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetOmitSidesForRenderableInputs ( bool )

virtual

Whether no side is found for the cells of dimension 2 or less.

Off by default.

◆ GetOmitSidesForRenderableInputs()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual bool vtkUnstructuredGridSides< TId, TSideId >::GetOmitSidesForRenderableInputs ( )

virtual

Whether no side is found for the cells of dimension 2 or less.

Off by default.

◆ OmitSidesForRenderableInputsOn()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::OmitSidesForRenderableInputsOn ( )

virtual

Whether no side is found for the cells of dimension 2 or less.

Off by default.

◆ OmitSidesForRenderableInputsOff()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::OmitSidesForRenderableInputsOff ( )

virtual

Whether no side is found for the cells of dimension 2 or less.

Off by default.

◆ SetOutputDimensionControl()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetOutputDimensionControl ( int )

virtual

Which sides of which cells to find: any combination of the bits of SideFlags, e.g., SideFlags::VerticesOfEdges | SideFlags::EdgesOfVolumes, as vtkCellGridSidesQuery::SetOutputDimensionControl().

NextLowestDimension by default.

◆ GetOutputDimensionControl()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual int vtkUnstructuredGridSides< TId, TSideId >::GetOutputDimensionControl ( )

virtual

Which sides of which cells to find: any combination of the bits of SideFlags, e.g., SideFlags::VerticesOfEdges | SideFlags::EdgesOfVolumes, as vtkCellGridSidesQuery::SetOutputDimensionControl().

NextLowestDimension by default.

◆ SetStrategy() [1/2]

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetStrategy ( SummaryStrategy )

virtual

Which sides to keep, see BuildReducedSides().

Boundary by default.

◆ SetStrategyToWinding()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

void vtkUnstructuredGridSides< TId, TSideId >::SetStrategyToWinding ( )

inline

Which sides to keep, see BuildReducedSides().

Boundary by default.

Definition at line 180 of file vtkUnstructuredGridSides.h.

◆ SetStrategyToAnyOccurrence()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

void vtkUnstructuredGridSides< TId, TSideId >::SetStrategyToAnyOccurrence ( )

inline

Which sides to keep, see BuildReducedSides().

Boundary by default.

Definition at line 181 of file vtkUnstructuredGridSides.h.

◆ SetStrategyToBoundary()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

void vtkUnstructuredGridSides< TId, TSideId >::SetStrategyToBoundary ( )

inline

Which sides to keep, see BuildReducedSides().

Boundary by default.

Definition at line 182 of file vtkUnstructuredGridSides.h.

◆ SetStrategy() [2/2]

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetStrategy ( int strategy )

inlinevirtual

This method exists for ParaView to set the strategy.

Definition at line 184 of file vtkUnstructuredGridSides.h.

◆ GetStrategy()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual SummaryStrategy vtkUnstructuredGridSides< TId, TSideId >::GetStrategy ( )

virtual

Which sides to keep, see BuildReducedSides().

Boundary by default.

◆ SetPointClipping()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetPointClipping ( bool )

virtual

Turn on/off the clipping of the cells by their point ids: a cell takes no part if one of its points is not in [PointMinimum, PointMaximum].

Off by default.

◆ GetPointClipping()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual bool vtkUnstructuredGridSides< TId, TSideId >::GetPointClipping ( )

virtual

Turn on/off the clipping of the cells by their point ids: a cell takes no part if one of its points is not in [PointMinimum, PointMaximum].

Off by default.

◆ PointClippingOn()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::PointClippingOn ( )

virtual

Turn on/off the clipping of the cells by their point ids: a cell takes no part if one of its points is not in [PointMinimum, PointMaximum].

Off by default.

◆ PointClippingOff()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::PointClippingOff ( )

virtual

Turn on/off the clipping of the cells by their point ids: a cell takes no part if one of its points is not in [PointMinimum, PointMaximum].

Off by default.

◆ SetCellClipping()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetCellClipping ( bool )

virtual

Turn on/off the clipping of the cells by their ids: a cell takes no part if its id is not in [CellMinimum, CellMaximum].

Off by default.

◆ GetCellClipping()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual bool vtkUnstructuredGridSides< TId, TSideId >::GetCellClipping ( )

virtual

Turn on/off the clipping of the cells by their ids: a cell takes no part if its id is not in [CellMinimum, CellMaximum].

Off by default.

◆ CellClippingOn()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::CellClippingOn ( )

virtual

Turn on/off the clipping of the cells by their ids: a cell takes no part if its id is not in [CellMinimum, CellMaximum].

Off by default.

◆ CellClippingOff()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::CellClippingOff ( )

virtual

Turn on/off the clipping of the cells by their ids: a cell takes no part if its id is not in [CellMinimum, CellMaximum].

Off by default.

◆ SetExtentClipping()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetExtentClipping ( bool )

virtual

Turn on/off the clipping of the cells by an extent: a cell takes no part if one of its points is not in the Extent.

Off by default.

◆ GetExtentClipping()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual bool vtkUnstructuredGridSides< TId, TSideId >::GetExtentClipping ( )

virtual

Turn on/off the clipping of the cells by an extent: a cell takes no part if one of its points is not in the Extent.

Off by default.

◆ ExtentClippingOn()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::ExtentClippingOn ( )

virtual

Turn on/off the clipping of the cells by an extent: a cell takes no part if one of its points is not in the Extent.

Off by default.

◆ ExtentClippingOff()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::ExtentClippingOff ( )

virtual

Turn on/off the clipping of the cells by an extent: a cell takes no part if one of its points is not in the Extent.

Off by default.

◆ SetPointMinimum()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetPointMinimum ( vtkIdType )

virtual

The range of the point ids of the point clipping, see SetPointClipping().

[0, VTK_ID_MAX] by default.

◆ GetPointMinimum()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual vtkIdType vtkUnstructuredGridSides< TId, TSideId >::GetPointMinimum ( )

virtual

The range of the point ids of the point clipping, see SetPointClipping().

[0, VTK_ID_MAX] by default.

◆ SetPointMaximum()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetPointMaximum ( vtkIdType )

virtual

The range of the point ids of the point clipping, see SetPointClipping().

[0, VTK_ID_MAX] by default.

◆ GetPointMaximum()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual vtkIdType vtkUnstructuredGridSides< TId, TSideId >::GetPointMaximum ( )

virtual

The range of the point ids of the point clipping, see SetPointClipping().

[0, VTK_ID_MAX] by default.

◆ SetCellMinimum()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetCellMinimum ( vtkIdType )

virtual

The range of the cell ids of the cell clipping, see SetCellClipping().

[0, VTK_ID_MAX] by default.

◆ GetCellMinimum()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual vtkIdType vtkUnstructuredGridSides< TId, TSideId >::GetCellMinimum ( )

virtual

The range of the cell ids of the cell clipping, see SetCellClipping().

[0, VTK_ID_MAX] by default.

◆ SetCellMaximum()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetCellMaximum ( vtkIdType )

virtual

The range of the cell ids of the cell clipping, see SetCellClipping().

[0, VTK_ID_MAX] by default.

◆ GetCellMaximum()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual vtkIdType vtkUnstructuredGridSides< TId, TSideId >::GetCellMaximum ( )

virtual

The range of the cell ids of the cell clipping, see SetCellClipping().

[0, VTK_ID_MAX] by default.

◆ SetExtent() [1/2]

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetExtent	(	double	,
		double	,
		double	,
		double	,
		double	,
		double	)

virtual

The (xmin, xmax, ymin, ymax, zmin, zmax) bounding box of the extent clipping, see SetExtentClipping().

Unbounded by default.

◆ SetExtent() [2/2]

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetExtent ( double [6] )

virtual

The (xmin, xmax, ymin, ymax, zmin, zmax) bounding box of the extent clipping, see SetExtentClipping().

Unbounded by default.

◆ GetExtent() [1/3]

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual double * vtkUnstructuredGridSides< TId, TSideId >::GetExtent ( )

virtual

The (xmin, xmax, ymin, ymax, zmin, zmax) bounding box of the extent clipping, see SetExtentClipping().

Unbounded by default.

◆ GetExtent() [2/3]

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::GetExtent	(	double &	,
		double &	,
		double &	,
		double &	,
		double &	,
		double &	)

virtual

The (xmin, xmax, ymin, ymax, zmin, zmax) bounding box of the extent clipping, see SetExtentClipping().

Unbounded by default.

◆ GetExtent() [3/3]

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::GetExtent ( double [6] )

virtual

The (xmin, xmax, ymin, ymax, zmin, zmax) bounding box of the extent clipping, see SetExtentClipping().

Unbounded by default.

◆ SetRemoveGhostInterfaces()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetRemoveGhostInterfaces ( bool )

virtual

Whether the duplicate ghost cells match the sides of the other cells, so that the interfaces between processes are not boundaries.

On by default.

◆ GetRemoveGhostInterfaces()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual bool vtkUnstructuredGridSides< TId, TSideId >::GetRemoveGhostInterfaces ( )

virtual

Whether the duplicate ghost cells match the sides of the other cells, so that the interfaces between processes are not boundaries.

On by default.

◆ RemoveGhostInterfacesOn()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::RemoveGhostInterfacesOn ( )

virtual

Whether the duplicate ghost cells match the sides of the other cells, so that the interfaces between processes are not boundaries.

On by default.

◆ RemoveGhostInterfacesOff()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::RemoveGhostInterfacesOff ( )

virtual

Whether the duplicate ghost cells match the sides of the other cells, so that the interfaces between processes are not boundaries.

On by default.

◆ SetMaskedGhostTypes()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetMaskedGhostTypes ( unsigned char )

virtual

The ghost types that mask a cell, see vtkDataSetAttributes::CellGhostTypes: a cell with one of them takes no part.

vtkDataSetAttributes::HIDDENCELL | vtkDataSetAttributes::REFINEDCELL by default, as in vtkGeometryFilter; 0 masks no ghost cell.

◆ GetMaskedGhostTypes()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual unsigned char vtkUnstructuredGridSides< TId, TSideId >::GetMaskedGhostTypes ( )

virtual

The ghost types that mask a cell, see vtkDataSetAttributes::CellGhostTypes: a cell with one of them takes no part.

vtkDataSetAttributes::HIDDENCELL | vtkDataSetAttributes::REFINEDCELL by default, as in vtkGeometryFilter; 0 masks no ghost cell.

◆ SetMatchSidePoints()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::SetMatchSidePoints ( bool )

virtual

Whether the matched nonlinear sides must also have the same other points than their corners, in any order, e.g., their mid-edge points: a face of a quadratic cell then does not match a face of a linear cell with the same corners, nor faces of Lagrange cells of different orders or with distinct mid-edge points, so that both are kept by Boundary, since their interface is not conforming.

The linear sides match by their corners, which are all their points. On by default. Off, the sides match by their corners only, e.g., those of cells of different orders.

◆ GetMatchSidePoints()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual bool vtkUnstructuredGridSides< TId, TSideId >::GetMatchSidePoints ( )

virtual

Whether the matched nonlinear sides must also have the same other points than their corners, in any order, e.g., their mid-edge points: a face of a quadratic cell then does not match a face of a linear cell with the same corners, nor faces of Lagrange cells of different orders or with distinct mid-edge points, so that both are kept by Boundary, since their interface is not conforming.

The linear sides match by their corners, which are all their points. On by default. Off, the sides match by their corners only, e.g., those of cells of different orders.

◆ MatchSidePointsOn()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::MatchSidePointsOn ( )

virtual

Whether the matched nonlinear sides must also have the same other points than their corners, in any order, e.g., their mid-edge points: a face of a quadratic cell then does not match a face of a linear cell with the same corners, nor faces of Lagrange cells of different orders or with distinct mid-edge points, so that both are kept by Boundary, since their interface is not conforming.

The linear sides match by their corners, which are all their points. On by default. Off, the sides match by their corners only, e.g., those of cells of different orders.

◆ MatchSidePointsOff()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual void vtkUnstructuredGridSides< TId, TSideId >::MatchSidePointsOff ( )

virtual

Whether the matched nonlinear sides must also have the same other points than their corners, in any order, e.g., their mid-edge points: a face of a quadratic cell then does not match a face of a linear cell with the same corners, nor faces of Lagrange cells of different orders or with distinct mid-edge points, so that both are kept by Boundary, since their interface is not conforming.

The linear sides match by their corners, which are all their points. On by default. Off, the sides match by their corners only, e.g., those of cells of different orders.

◆ BuildScatteredSides()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

void vtkUnstructuredGridSides< TId, TSideId >::BuildScatteredSides ( )

Find the sides of the cells given by OutputDimensionControl, and scatter all of them by their key, their smallest point id, not matched, e.g., to match them in another way.

Nothing is done if they were scattered after the last modification of this object and of the dataset.

◆ BuildReducedSides()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

void vtkUnstructuredGridSides< TId, TSideId >::BuildReducedSides ( )

Same as BuildScatteredSides(), then match the sides of every key, and keep them as given by the summary strategy: e.g., the boundary of the dataset.

The keys then hold the kept sides only. Nothing is done if they were reduced after the last modification of this object and of the dataset.

◆ BuildGroupedSides()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

void vtkUnstructuredGridSides< TId, TSideId >::BuildGroupedSides ( )

Same as BuildScatteredSides(), then match the sides of every key, and keep all of them, the equal sides of a key contiguous, as a group: e.g., a face of the dataset and the cells that share it.

The groups of a key are in the order of their first sides, and the sides of a group in the order of their cells. The summary strategy is not used, and the sides of the duplicate ghost cells are in the groups like the others. Nothing is done if they were grouped after the last modification of this object and of the dataset.

◆ GetBuildMode()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

BuildMode vtkUnstructuredGridSides< TId, TSideId >::GetBuildMode ( ) const

inline

How the sides were last built, None if they were not, e.g., after Reset().

Definition at line 325 of file vtkUnstructuredGridSides.h.

◆ Reset()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

void vtkUnstructuredGridSides< TId, TSideId >::Reset ( )

Release the memory, so that the sides are built again.

◆ GetBuildTime()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

virtual vtkMTimeType vtkUnstructuredGridSides< TId, TSideId >::GetBuildTime ( )

virtual

The time at which the sides were built.

◆ UsesGarbageCollector()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

bool vtkUnstructuredGridSides< TId, TSideId >::UsesGarbageCollector ( ) const

inlineoverridevirtual

The dataset is reported to the garbage collector, see ReportReferences().

Reimplemented from vtkObjectBase.

Definition at line 340 of file vtkUnstructuredGridSides.h.

◆ GetNumberOfSides()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

vtkIdType vtkUnstructuredGridSides< TId, TSideId >::GetNumberOfSides ( ) const

The number of sides: the kept sides after BuildReducedSides(), all the sides otherwise.

◆ GetNumberOfKeys()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

TId vtkUnstructuredGridSides< TId, TSideId >::GetNumberOfKeys ( ) const

The number of keys: the number of points plus one if some sides are found, otherwise one, e.g., before the sides are built.

A key is the smallest point id of its sides, and its key id, as in vtk::keys, its position, which is the same, since the keys start at point 0: key id p has the sides whose smallest point id is p. The last key id, GetNumberOfKeys() - 1, has the preserved cells (see SetPreserveRenderableInputs()), which have no key.

◆ GetNumberOfSidesOfKey()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

vtkIdType vtkUnstructuredGridSides< TId, TSideId >::GetNumberOfSidesOfKey ( TId keyId ) const

The number of sides of a key, as GetNumberOfSides(), 0 <= keyId < GetNumberOfKeys().

◆ GetSideOffsetOfKey()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

vtkIdType vtkUnstructuredGridSides< TId, TSideId >::GetSideOffsetOfKey ( TId keyId ) const

The offset of a key, 0 <= keyId <= GetNumberOfKeys(): the number of sides of the keys before it, e.g., to write the sides of the keys in parallel, as the offsets of a vtkCellArray.

◆ GetCellIdsOfKey()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

const TId * vtkUnstructuredGridSides< TId, TSideId >::GetCellIdsOfKey ( TId keyId ) const

The cells of the sides of a key, of GetNumberOfSidesOfKey() values, 0 <= keyId < GetNumberOfKeys().

◆ GetSideIdsOfKey()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

const TSideId * vtkUnstructuredGridSides< TId, TSideId >::GetSideIdsOfKey ( TId keyId ) const

The local indices of the sides of a key in their cell, of GetNumberOfSidesOfKey() values, -1 for a preserved cell.

◆ GetCellIdOfSide()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

TId vtkUnstructuredGridSides< TId, TSideId >::GetCellIdOfSide	(	TId	keyId,
		vtkIdType	k ) const

The cell, the local index in its cell, and the dimension of the side k of a key, 0 <= k < GetNumberOfSidesOfKey(keyId).

◆ GetSideIdOfSide()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

TSideId vtkUnstructuredGridSides< TId, TSideId >::GetSideIdOfSide	(	TId	keyId,
		vtkIdType	k ) const

The cell, the local index in its cell, and the dimension of the side k of a key, 0 <= k < GetNumberOfSidesOfKey(keyId).

◆ GetDimensionOfSide()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

int vtkUnstructuredGridSides< TId, TSideId >::GetDimensionOfSide	(	TId	keyId,
		vtkIdType	k ) const

The cell, the local index in its cell, and the dimension of the side k of a key, 0 <= k < GetNumberOfSidesOfKey(keyId).

◆ GetSideInformation()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

SideInformation vtkUnstructuredGridSides< TId, TSideId >::GetSideInformation	(	TId	keyId,
		vtkIdType	k,
		vtkGenericCell *	tempCell ) const

The information of the side k of a key, without reading its points: its type and size are given by vtkCellTypeSides::GetCellSideType() and vtkCellTypeSides::GetCellSideSize(), those of a preserved cell being its own.

It is thread-safe, with a scratch cell of the calling thread.

Parameters

keyId	The key id of the side, 0 <= keyId < GetNumberOfKeys().
k	The index of the side in its key, 0 <= k < GetNumberOfSidesOfKey(keyId).
tempCell	Scratch vtkGenericCell, for the cells whose sides are built, e.g., higher-order cells.

◆ GetSidePoints()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

void vtkUnstructuredGridSides< TId, TSideId >::GetSidePoints	(	TId	keyId,
		vtkIdType	k,
		vtkIdList *	sidePtIds,
		unsigned char &	cellType,
		vtkIdList *	tempCellPointIds,
		vtkGenericCell *	tempCell ) const

Get the point ids of the side k of a key, in the order of the side in its cell, from the cell arrays of the dataset: a vertex is a point of its cell, an edge and a face are given as by vtkUnstructuredGrid::GetCellEdgePoints() and vtkUnstructuredGrid::GetCellFacePoints(), and a preserved cell by its points.

It is thread-safe, with scratch objects of the calling thread.

Parameters

keyId	The key id of the side, 0 <= keyId < GetNumberOfKeys().
k	The index of the side in its key, 0 <= k < GetNumberOfSidesOfKey(keyId).
sidePtIds	Output vtkIdList populated with the point ids of the side.
cellType	Output parameter returning the type of the cell of the side.
tempCellPointIds	Scratch vtkIdList used to retrieve the point ids of the cell.
tempCell	Scratch vtkGenericCell, for the cells whose sides are built, e.g., higher-order cells and the edges of the polyhedra.

◆ GetNumberOfGroups()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

vtkIdType vtkUnstructuredGridSides< TId, TSideId >::GetNumberOfGroups ( ) const

The groups of equal sides, ordered by key: their number, e.g., the number of distinct faces, and the first group of a key, 0 <= keyId <= GetNumberOfKeys(), so that the groups of a key are [GetGroupOffsetOfKey(keyId), GetGroupOffsetOfKey(keyId + 1)).

The preserved cells, in the last key, are in no group.

◆ GetGroupOffsetOfKey()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

vtkIdType vtkUnstructuredGridSides< TId, TSideId >::GetGroupOffsetOfKey ( TId keyId ) const

The groups of equal sides, ordered by key: their number, e.g., the number of distinct faces, and the first group of a key, 0 <= keyId <= GetNumberOfKeys(), so that the groups of a key are [GetGroupOffsetOfKey(keyId), GetGroupOffsetOfKey(keyId + 1)).

The preserved cells, in the last key, are in no group.

◆ GetNumberOfSidesOfGroup()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

vtkIdType vtkUnstructuredGridSides< TId, TSideId >::GetNumberOfSidesOfGroup ( vtkIdType group ) const

The number of sides of a group, 0 <= group < GetNumberOfGroups(), and its first side, 0 <= group <= GetNumberOfGroups(), among all the sides: the first side of the group is k = GetSideOffsetOfGroup(group) - GetSideOffsetOfKey(keyId) of its key.

◆ GetSideOffsetOfGroup()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

vtkIdType vtkUnstructuredGridSides< TId, TSideId >::GetSideOffsetOfGroup ( vtkIdType group ) const

The number of sides of a group, 0 <= group < GetNumberOfGroups(), and its first side, 0 <= group <= GetNumberOfGroups(), among all the sides: the first side of the group is k = GetSideOffsetOfGroup(group) - GetSideOffsetOfKey(keyId) of its key.

◆ GetCellIdsOfGroup()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

const TId * vtkUnstructuredGridSides< TId, TSideId >::GetCellIdsOfGroup ( vtkIdType group ) const

The cells and the local indices in their cell of the sides of a group, of GetNumberOfSidesOfGroup() values, 0 <= group < GetNumberOfGroups(), e.g., the cells that share a face, read without its key.

The sides of all the groups are contiguous, so that GetCellIdsOfGroup(0)[GetSideOffsetOfGroup(group) + i] is side i of a group.

◆ GetSideIdsOfGroup()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

const TSideId * vtkUnstructuredGridSides< TId, TSideId >::GetSideIdsOfGroup ( vtkIdType group ) const

The cells and the local indices in their cell of the sides of a group, of GetNumberOfSidesOfGroup() values, 0 <= group < GetNumberOfGroups(), e.g., the cells that share a face, read without its key.

The sides of all the groups are contiguous, so that GetCellIdsOfGroup(0)[GetSideOffsetOfGroup(group) + i] is side i of a group.

◆ GetDimensionOfGroup()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

int vtkUnstructuredGridSides< TId, TSideId >::GetDimensionOfGroup ( vtkIdType group ) const

The dimension of the sides of a group, 0 <= group < GetNumberOfGroups(), which all have the same one, since equal sides have the same number of points.

◆ ReportReferences()

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

void vtkUnstructuredGridSides< TId, TSideId >::ReportReferences ( vtkGarbageCollector * )

overrideprotectedvirtual

Reimplemented from vtkObjectBase.

Member Data Documentation

◆ BuildTime

template<typename TId = vtkIdType, typename TSideId = vtkTypeInt8>

vtkTimeStamp vtkUnstructuredGridSides< TId, TSideId >::BuildTime

protected

Definition at line 482 of file vtkUnstructuredGridSides.h.

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

Common/DataModel/vtkUnstructuredGridSides.h

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ SelfType

◆ SideFlags

◆ SummaryStrategy

Member Enumeration Documentation

◆ BuildMode

Constructor & Destructor Documentation

◆ vtkUnstructuredGridSides()

◆ ~vtkUnstructuredGridSides()

Member Function Documentation

◆ New()

◆ vtkTemplateTypeMacro()

◆ PrintSelf()

◆ SetDataSet()

◆ GetDataSet()

◆ SetPreserveRenderableInputs()

◆ GetPreserveRenderableInputs()

◆ PreserveRenderableInputsOn()

◆ PreserveRenderableInputsOff()

◆ SetOmitSidesForRenderableInputs()

◆ GetOmitSidesForRenderableInputs()

◆ OmitSidesForRenderableInputsOn()

◆ OmitSidesForRenderableInputsOff()

◆ SetOutputDimensionControl()

◆ GetOutputDimensionControl()

◆ SetStrategy() [1/2]

◆ SetStrategyToWinding()

◆ SetStrategyToAnyOccurrence()

◆ SetStrategyToBoundary()

◆ SetStrategy() [2/2]

◆ GetStrategy()

◆ SetPointClipping()

◆ GetPointClipping()

◆ PointClippingOn()

◆ PointClippingOff()

◆ SetCellClipping()

◆ GetCellClipping()

◆ CellClippingOn()

◆ CellClippingOff()

◆ SetExtentClipping()

◆ GetExtentClipping()

◆ ExtentClippingOn()

◆ ExtentClippingOff()

◆ SetPointMinimum()

◆ GetPointMinimum()

◆ SetPointMaximum()

◆ GetPointMaximum()

◆ SetCellMinimum()

◆ GetCellMinimum()

◆ SetCellMaximum()

◆ GetCellMaximum()

◆ SetExtent() [1/2]

◆ SetExtent() [2/2]

◆ GetExtent() [1/3]

◆ GetExtent() [2/3]

◆ GetExtent() [3/3]

◆ SetRemoveGhostInterfaces()

◆ GetRemoveGhostInterfaces()

◆ RemoveGhostInterfacesOn()

◆ RemoveGhostInterfacesOff()

◆ SetMaskedGhostTypes()

◆ GetMaskedGhostTypes()

◆ SetMatchSidePoints()

◆ GetMatchSidePoints()

◆ MatchSidePointsOn()

◆ MatchSidePointsOff()

◆ BuildScatteredSides()

◆ BuildReducedSides()

◆ BuildGroupedSides()

◆ GetBuildMode()

◆ Reset()

◆ GetBuildTime()