vtkm::cont::CellSet Class Reference

Defines the topological structure of the data in a DataSet. More...

#include <CellSet.h>

Inheritance diagram for vtkm::cont::CellSet:

Public Member Functions
	CellSet ()=default
	CellSet (const CellSet &)=default
	CellSet (CellSet &&) noexcept=default
CellSet &	operator= (const CellSet &)=default
CellSet &	operator= (CellSet &&) noexcept=default
virtual	~CellSet ()
virtual vtkm::Id	GetNumberOfCells () const =0
	Get the number of cells in the topology. More...
virtual vtkm::Id	GetNumberOfFaces () const =0
virtual vtkm::Id	GetNumberOfEdges () const =0
virtual vtkm::Id	GetNumberOfPoints () const =0
	Get the number of points in the topology. More...
virtual vtkm::UInt8	GetCellShape (vtkm::Id id) const =0
	Get the shell shape of a particular cell. More...
virtual vtkm::IdComponent	GetNumberOfPointsInCell (vtkm::Id id) const =0
	Get the number of points incident to a particular cell. More...
virtual void	GetCellPointIds (vtkm::Id id, vtkm::Id *ptids) const =0
	Get a list of points incident to a particular cell. More...
virtual std::shared_ptr< CellSet >	NewInstance () const =0
	Return a new CellSet that is the same derived class. More...
virtual void	DeepCopy (const CellSet *src)=0
	Copy the provided CellSet into this object. More...
virtual void	PrintSummary (std::ostream &) const =0
	Print a summary of this cell set. More...
virtual void	ReleaseResourcesExecution ()=0
	Remove the CellSet from any devices. More...

Detailed Description

Defines the topological structure of the data in a DataSet.

Fundamentally, any cell set is a collection of cells, which typically (but not always) represent some region in space.

Constructor & Destructor Documentation

CellSet() [1/3]

vtkm::cont::CellSet::CellSet ( )

default

CellSet() [2/3]

vtkm::cont::CellSet::CellSet ( const CellSet &  )

default

CellSet() [3/3]

vtkm::cont::CellSet::CellSet ( CellSet &&  )

defaultnoexcept

~CellSet()

virtual vtkm::cont::CellSet::~CellSet ( )

virtual

Member Function Documentation

DeepCopy()

virtual void vtkm::cont::CellSet::DeepCopy ( const CellSet *  src )

pure virtual

Copy the provided CellSet into this object.

The provided CellSet must be the same type as this one.

Implemented in vtkm::cont::CellSetExtrude.

GetCellPointIds()

virtual void vtkm::cont::CellSet::GetCellPointIds ( vtkm::Id  id, vtkm::Id *  ptids  ) const

pure virtual

Get a list of points incident to a particular cell.

Implemented in vtkm::cont::CellSetExtrude.

GetCellShape()

virtual vtkm::UInt8 vtkm::cont::CellSet::GetCellShape ( vtkm::Id  id ) const

pure virtual

Get the shell shape of a particular cell.

Implemented in vtkm::cont::CellSetExtrude.

GetNumberOfCells()

virtual vtkm::Id vtkm::cont::CellSet::GetNumberOfCells ( ) const

pure virtual

Get the number of cells in the topology.

Implemented in vtkm::cont::CellSetExtrude.

GetNumberOfEdges()

virtual vtkm::Id vtkm::cont::CellSet::GetNumberOfEdges ( ) const

pure virtual

Implemented in vtkm::cont::CellSetExtrude.

GetNumberOfFaces()

virtual vtkm::Id vtkm::cont::CellSet::GetNumberOfFaces ( ) const

pure virtual

Implemented in vtkm::cont::CellSetExtrude.

GetNumberOfPoints()

virtual vtkm::Id vtkm::cont::CellSet::GetNumberOfPoints ( ) const

pure virtual

Get the number of points in the topology.

Implemented in vtkm::cont::CellSetExtrude.

GetNumberOfPointsInCell()

virtual vtkm::IdComponent vtkm::cont::CellSet::GetNumberOfPointsInCell ( vtkm::Id  id ) const

pure virtual

Get the number of points incident to a particular cell.

Implemented in vtkm::cont::CellSetExtrude.

NewInstance()

virtual std::shared_ptr<CellSet> vtkm::cont::CellSet::NewInstance ( ) const

pure virtual

Return a new CellSet that is the same derived class.

Implemented in vtkm::cont::CellSetExtrude.

operator=() [1/2]

CellSet& vtkm::cont::CellSet::operator= ( CellSet &&  )

defaultnoexcept

operator=() [2/2]

CellSet& vtkm::cont::CellSet::operator= ( const CellSet &  )

default

PrintSummary()

virtual void vtkm::cont::CellSet::PrintSummary ( std::ostream &  ) const

pure virtual

Print a summary of this cell set.

Implemented in vtkm::cont::CellSetExtrude.

ReleaseResourcesExecution()

virtual void vtkm::cont::CellSet::ReleaseResourcesExecution ( )

pure virtual

Remove the CellSet from any devices.

Any memory used on a device to store this object will be deleted. However, the data will still remain on the host.

Implemented in vtkm::cont::CellSetExtrude.

---

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

• CellSet.h