VTK-m  2.2
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
vtkm::cont::CellSetExtrude Class Reference

Defines a 3-dimensional extruded mesh representation. More...

#include <CellSetExtrude.h>

Inheritance diagram for vtkm::cont::CellSetExtrude:
vtkm::cont::CellSet

Public Types

template<typename VisitTopology , typename IncidentTopology >
using ExecConnectivityType = typename detail::CellSetExtrudeConnectivityChooser< VisitTopology, IncidentTopology >::ExecConnectivityType
 

Public Member Functions

 CellSetExtrude ()
 
 CellSetExtrude (const vtkm::cont::ArrayHandle< vtkm::Int32 > &conn, vtkm::Int32 numberOfPointsPerPlane, vtkm::Int32 numberOfPlanes, const vtkm::cont::ArrayHandle< vtkm::Int32 > &nextNode, bool periodic)
 
 CellSetExtrude (const CellSetExtrude &src)
 
 CellSetExtrude (CellSetExtrude &&src) noexcept
 
CellSetExtrude & operator= (const CellSetExtrude &src)
 
CellSetExtrude & operator= (CellSetExtrude &&src) noexcept
 
 ~CellSetExtrude () override
 
vtkm::Int32 GetNumberOfPlanes () const
 
vtkm::Id GetNumberOfCells () const override
 Get the number of cells in the topology. More...
 
vtkm::Id GetNumberOfPoints () const override
 Get the number of points in the topology. More...
 
vtkm::Id GetNumberOfFaces () const override
 
vtkm::Id GetNumberOfEdges () const override
 
vtkm::Id2 GetSchedulingRange (vtkm::TopologyElementTagCell) const
 
vtkm::Id2 GetSchedulingRange (vtkm::TopologyElementTagPoint) const
 
vtkm::UInt8 GetCellShape (vtkm::Id id) const override
 Get the shell shape of a particular cell. More...
 
vtkm::IdComponent GetNumberOfPointsInCell (vtkm::Id id) const override
 Get the number of points incident to a particular cell. More...
 
void GetCellPointIds (vtkm::Id id, vtkm::Id *ptids) const override
 Get a list of points incident to a particular cell. More...
 
std::shared_ptr< CellSet > NewInstance () const override
 Return a new CellSet that is the same derived class. More...
 
void DeepCopy (const CellSet *src) override
 Copy the provided CellSet into this object. More...
 
void PrintSummary (std::ostream &out) const override
 Print a summary of this cell set. More...
 
void ReleaseResourcesExecution () override
 Remove the CellSet from any devices. More...
 
const vtkm::cont::ArrayHandle< vtkm::Int32 > & GetConnectivityArray () const
 
vtkm::Int32 GetNumberOfPointsPerPlane () const
 
const vtkm::cont::ArrayHandle< vtkm::Int32 > & GetNextNodeArray () const
 
bool GetIsPeriodic () const
 
template<vtkm::IdComponent NumIndices>
void GetIndices (vtkm::Id index, vtkm::Vec< vtkm::Id, NumIndices > &ids) const
 
void GetIndices (vtkm::Id index, vtkm::cont::ArrayHandle< vtkm::Id > &ids) const
 
vtkm::exec::ConnectivityExtrude PrepareForInput (vtkm::cont::DeviceAdapterId, vtkm::TopologyElementTagCell, vtkm::TopologyElementTagPoint, vtkm::cont::Token &) const
 
vtkm::exec::ReverseConnectivityExtrude PrepareForInput (vtkm::cont::DeviceAdapterId, vtkm::TopologyElementTagPoint, vtkm::TopologyElementTagCell, vtkm::cont::Token &) const
 
- Public Member Functions inherited from vtkm::cont::CellSet
 CellSet ()=default
 
 CellSet (const CellSet &)=default
 
 CellSet (CellSet &&) noexcept=default
 
CellSet & operator= (const CellSet &)=default
 
CellSet & operator= (CellSet &&) noexcept=default
 
virtual ~CellSet ()
 

Private Member Functions

void BuildReverseConnectivity ()
 

Private Attributes

bool IsPeriodic
 
vtkm::Int32 NumberOfPointsPerPlane
 
vtkm::Int32 NumberOfCellsPerPlane
 
vtkm::Int32 NumberOfPlanes
 
vtkm::cont::ArrayHandle< vtkm::Int32 > Connectivity
 
vtkm::cont::ArrayHandle< vtkm::Int32 > NextNode
 
bool ReverseConnectivityBuilt
 
vtkm::cont::ArrayHandle< vtkm::Int32 > RConnectivity
 
vtkm::cont::ArrayHandle< vtkm::Int32 > ROffsets
 
vtkm::cont::ArrayHandle< vtkm::Int32 > RCounts
 
vtkm::cont::ArrayHandle< vtkm::Int32 > PrevNode
 

Detailed Description

Defines a 3-dimensional extruded mesh representation.

CellSetExtrude takes takes a mesh defined in the XZ-plane and extrudes it along the Y-axis. This plane is repeated in a series of steps and forms wedge cells between them.

The extrusion can be linear or rotational (e.g., to form a torus).

Member Typedef Documentation

◆ ExecConnectivityType

template<typename VisitTopology , typename IncidentTopology >
using vtkm::cont::CellSetExtrude::ExecConnectivityType = typename detail::CellSetExtrudeConnectivityChooser<VisitTopology, IncidentTopology>::ExecConnectivityType

Constructor & Destructor Documentation

◆ CellSetExtrude() [1/4]

vtkm::cont::CellSetExtrude::CellSetExtrude ( )

◆ CellSetExtrude() [2/4]

vtkm::cont::CellSetExtrude::CellSetExtrude ( const vtkm::cont::ArrayHandle< vtkm::Int32 > &  conn,
vtkm::Int32  numberOfPointsPerPlane,
vtkm::Int32  numberOfPlanes,
const vtkm::cont::ArrayHandle< vtkm::Int32 > &  nextNode,
bool  periodic 
)

◆ CellSetExtrude() [3/4]

vtkm::cont::CellSetExtrude::CellSetExtrude ( const CellSetExtrude &  src)

◆ CellSetExtrude() [4/4]

vtkm::cont::CellSetExtrude::CellSetExtrude ( CellSetExtrude &&  src)
noexcept

◆ ~CellSetExtrude()

vtkm::cont::CellSetExtrude::~CellSetExtrude ( )
override

Member Function Documentation

◆ BuildReverseConnectivity()

void vtkm::cont::CellSetExtrude::BuildReverseConnectivity ( )
private

◆ DeepCopy()

void vtkm::cont::CellSetExtrude::DeepCopy ( const CellSet *  src)
overridevirtual

Copy the provided CellSet into this object.

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

Implements vtkm::cont::CellSet.

◆ GetCellPointIds()

void vtkm::cont::CellSetExtrude::GetCellPointIds ( vtkm::Id  id,
vtkm::Id *  ptids 
) const
overridevirtual

Get a list of points incident to a particular cell.

Implements vtkm::cont::CellSet.

◆ GetCellShape()

vtkm::UInt8 vtkm::cont::CellSetExtrude::GetCellShape ( vtkm::Id  id) const
overridevirtual

Get the shell shape of a particular cell.

Implements vtkm::cont::CellSet.

◆ GetConnectivityArray()

const vtkm::cont::ArrayHandle<vtkm::Int32>& vtkm::cont::CellSetExtrude::GetConnectivityArray ( ) const
inline

◆ GetIndices() [1/2]

void vtkm::cont::CellSetExtrude::GetIndices ( vtkm::Id  index,
vtkm::cont::ArrayHandle< vtkm::Id > &  ids 
) const

◆ GetIndices() [2/2]

template<vtkm::IdComponent NumIndices>
void vtkm::cont::CellSetExtrude::GetIndices ( vtkm::Id  index,
vtkm::Vec< vtkm::Id, NumIndices > &  ids 
) const

◆ GetIsPeriodic()

bool vtkm::cont::CellSetExtrude::GetIsPeriodic ( ) const
inline

◆ GetNextNodeArray()

const vtkm::cont::ArrayHandle<vtkm::Int32>& vtkm::cont::CellSetExtrude::GetNextNodeArray ( ) const
inline

◆ GetNumberOfCells()

vtkm::Id vtkm::cont::CellSetExtrude::GetNumberOfCells ( ) const
overridevirtual

Get the number of cells in the topology.

Implements vtkm::cont::CellSet.

◆ GetNumberOfEdges()

vtkm::Id vtkm::cont::CellSetExtrude::GetNumberOfEdges ( ) const
overridevirtual

Implements vtkm::cont::CellSet.

◆ GetNumberOfFaces()

vtkm::Id vtkm::cont::CellSetExtrude::GetNumberOfFaces ( ) const
overridevirtual

Implements vtkm::cont::CellSet.

◆ GetNumberOfPlanes()

vtkm::Int32 vtkm::cont::CellSetExtrude::GetNumberOfPlanes ( ) const

◆ GetNumberOfPoints()

vtkm::Id vtkm::cont::CellSetExtrude::GetNumberOfPoints ( ) const
overridevirtual

Get the number of points in the topology.

Implements vtkm::cont::CellSet.

◆ GetNumberOfPointsInCell()

vtkm::IdComponent vtkm::cont::CellSetExtrude::GetNumberOfPointsInCell ( vtkm::Id  id) const
overridevirtual

Get the number of points incident to a particular cell.

Implements vtkm::cont::CellSet.

◆ GetNumberOfPointsPerPlane()

vtkm::Int32 vtkm::cont::CellSetExtrude::GetNumberOfPointsPerPlane ( ) const
inline

◆ GetSchedulingRange() [1/2]

vtkm::Id2 vtkm::cont::CellSetExtrude::GetSchedulingRange ( vtkm::TopologyElementTagCell  ) const

◆ GetSchedulingRange() [2/2]

vtkm::Id2 vtkm::cont::CellSetExtrude::GetSchedulingRange ( vtkm::TopologyElementTagPoint  ) const

◆ NewInstance()

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

Return a new CellSet that is the same derived class.

Implements vtkm::cont::CellSet.

◆ operator=() [1/2]

CellSetExtrude& vtkm::cont::CellSetExtrude::operator= ( CellSetExtrude &&  src)
noexcept

◆ operator=() [2/2]

CellSetExtrude& vtkm::cont::CellSetExtrude::operator= ( const CellSetExtrude &  src)

◆ PrepareForInput() [1/2]

vtkm::exec::ConnectivityExtrude vtkm::cont::CellSetExtrude::PrepareForInput ( vtkm::cont::DeviceAdapterId  ,
vtkm::TopologyElementTagCell  ,
vtkm::TopologyElementTagPoint  ,
vtkm::cont::Token &   
) const

◆ PrepareForInput() [2/2]

vtkm::exec::ReverseConnectivityExtrude vtkm::cont::CellSetExtrude::PrepareForInput ( vtkm::cont::DeviceAdapterId  ,
vtkm::TopologyElementTagPoint  ,
vtkm::TopologyElementTagCell  ,
vtkm::cont::Token &   
) const

◆ PrintSummary()

void vtkm::cont::CellSetExtrude::PrintSummary ( std::ostream &  ) const
overridevirtual

Print a summary of this cell set.

Implements vtkm::cont::CellSet.

◆ ReleaseResourcesExecution()

void vtkm::cont::CellSetExtrude::ReleaseResourcesExecution ( )
overridevirtual

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.

Implements vtkm::cont::CellSet.

Member Data Documentation

◆ Connectivity

vtkm::cont::ArrayHandle<vtkm::Int32> vtkm::cont::CellSetExtrude::Connectivity
private

◆ IsPeriodic

bool vtkm::cont::CellSetExtrude::IsPeriodic
private

◆ NextNode

vtkm::cont::ArrayHandle<vtkm::Int32> vtkm::cont::CellSetExtrude::NextNode
private

◆ NumberOfCellsPerPlane

vtkm::Int32 vtkm::cont::CellSetExtrude::NumberOfCellsPerPlane
private

◆ NumberOfPlanes

vtkm::Int32 vtkm::cont::CellSetExtrude::NumberOfPlanes
private

◆ NumberOfPointsPerPlane

vtkm::Int32 vtkm::cont::CellSetExtrude::NumberOfPointsPerPlane
private

◆ PrevNode

vtkm::cont::ArrayHandle<vtkm::Int32> vtkm::cont::CellSetExtrude::PrevNode
private

◆ RConnectivity

vtkm::cont::ArrayHandle<vtkm::Int32> vtkm::cont::CellSetExtrude::RConnectivity
private

◆ RCounts

vtkm::cont::ArrayHandle<vtkm::Int32> vtkm::cont::CellSetExtrude::RCounts
private

◆ ReverseConnectivityBuilt

bool vtkm::cont::CellSetExtrude::ReverseConnectivityBuilt
private

◆ ROffsets

vtkm::cont::ArrayHandle<vtkm::Int32> vtkm::cont::CellSetExtrude::ROffsets
private
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.17