itk::HexahedronCell< TCellInterface > Class Template Reference

#include <itkHexahedronCell.h>

Detailed Description

template<typename TCellInterface>
class itk::HexahedronCell< TCellInterface >

Represents a hexahedron (cuboid) for a Mesh.

HexahedronCell represents a hexahedron, more precisely, a cuboid, for a Mesh.

Todo:

When reviewing this class, the documentation of the template parameters MUST be fixed.

NOTE: ONLY 3D implementations are instrumented. All other dimensions result in incorrect processing.

Definition at line 45 of file itkHexahedronCell.h.

Inheritance diagram for itk::HexahedronCell< TCellInterface >:

Collaboration diagram for itk::HexahedronCell< TCellInterface >:

Public Types
using	EdgeAutoPointer = typename EdgeType::SelfAutoPointer
using	EdgeType = LineCell< TCellInterface >
using	FaceAutoPointer = typename FaceType::SelfAutoPointer
using	FaceType = QuadrilateralCell< TCellInterface >
using	VertexAutoPointer = typename VertexType::SelfAutoPointer
using	VertexType = VertexCell< TCellInterface >

Public Member Functions
bool	EvaluatePosition (CoordRepType *, PointsContainer *, CoordRepType *, CoordRepType[], double *, InterpolationWeightType *) override
bool	GetBoundaryFeature (int dimension, CellFeatureIdentifier, CellAutoPointer &) override
unsigned int	GetDimension () const override
virtual bool	GetEdge (CellFeatureIdentifier, EdgeAutoPointer &)
virtual bool	GetFace (CellFeatureIdentifier, FaceAutoPointer &)
const char *	GetNameOfClass () const override
CellFeatureCount	GetNumberOfBoundaryFeatures (int dimension) const override
virtual CellFeatureCount	GetNumberOfEdges () const
virtual CellFeatureCount	GetNumberOfFaces () const
unsigned int	GetNumberOfPoints () const override
virtual CellFeatureCount	GetNumberOfVertices () const
virtual bool	GetVertex (CellFeatureIdentifier, VertexAutoPointer &)
	HexahedronCell ()=default
	itkCellVisitMacro (CellGeometryEnum::HEXAHEDRON_CELL)
PointIdConstIterator	PointIdsBegin () const override
PointIdIterator	PointIdsBegin () override
PointIdConstIterator	PointIdsEnd () const override
PointIdIterator	PointIdsEnd () override
void	SetPointId (int localId, PointIdentifier) override
void	SetPointIds (PointIdConstIterator first) override
void	SetPointIds (PointIdConstIterator first, PointIdConstIterator last) override
	~HexahedronCell () override=default
	itkCellCommonTypedefs (HexahedronCell)
	itkCellInheritedTypedefs (TCellInterface)
CellGeometryEnum	GetType () const override
void	MakeCopy (CellAutoPointer &) const override

Static Public Attributes
static constexpr unsigned int	CellDimension = 3
static constexpr unsigned int	CellDimension3D = 3
static constexpr unsigned int	NumberOfEdges = 12
static constexpr unsigned int	NumberOfFaces = 6
static constexpr unsigned int	NumberOfPoints = 8
static constexpr unsigned int	NumberOfVertices = 8
static constexpr unsigned int	PointDimension3D = 3

Protected Member Functions
void	EvaluateLocation (int &, PointsContainer *points, CoordRepType pcoords[Self::CellDimension], CoordRepType x[Self::CellDimension], InterpolationWeightType *weights)
void	InterpolationDerivs (CoordRepType pcoords[Self::CellDimension], CoordRepType derivs[Self::CellDimension *Self::NumberOfPoints])
void	InterpolationFunctions (CoordRepType pcoords[Self::CellDimension], InterpolationWeightType sf[Self::NumberOfPoints])

Protected Attributes
std::array< PointIdentifier, NumberOfPoints >	m_PointIds

Additional Inherited Members
Private Member Functions inherited from itk::HexahedronCellTopology
	HexahedronCellTopology ()
virtual	~HexahedronCellTopology ()
Static Private Attributes inherited from itk::HexahedronCellTopology
static const int	m_Edges [12][2]
static const int	m_Faces [6][4]

Member Typedef Documentation

EdgeAutoPointer

template<typename TCellInterface >

using itk::HexahedronCell< TCellInterface >::EdgeAutoPointer = typename EdgeType::SelfAutoPointer

Definition at line 66 of file itkHexahedronCell.h.

EdgeType

template<typename TCellInterface >

using itk::HexahedronCell< TCellInterface >::EdgeType = LineCell<TCellInterface>

The type of boundary for this triangle's edges.

Definition at line 65 of file itkHexahedronCell.h.

FaceAutoPointer

template<typename TCellInterface >

using itk::HexahedronCell< TCellInterface >::FaceAutoPointer = typename FaceType::SelfAutoPointer

Definition at line 70 of file itkHexahedronCell.h.

FaceType

template<typename TCellInterface >

using itk::HexahedronCell< TCellInterface >::FaceType = QuadrilateralCell<TCellInterface>

The type of boundary for this hexahedron's faces.

Definition at line 69 of file itkHexahedronCell.h.

VertexAutoPointer

template<typename TCellInterface >

using itk::HexahedronCell< TCellInterface >::VertexAutoPointer = typename VertexType::SelfAutoPointer

Definition at line 62 of file itkHexahedronCell.h.

VertexType

template<typename TCellInterface >

using itk::HexahedronCell< TCellInterface >::VertexType = VertexCell<TCellInterface>

The type of boundary for this triangle's vertices.

Definition at line 61 of file itkHexahedronCell.h.

Constructor & Destructor Documentation

HexahedronCell()

template<typename TCellInterface >

itk::HexahedronCell< TCellInterface >::HexahedronCell ( )

default

~HexahedronCell()

template<typename TCellInterface >

itk::HexahedronCell< TCellInterface >::~HexahedronCell ( )

overridedefault

Member Function Documentation

EvaluateLocation()

template<typename TCellInterface >

void itk::HexahedronCell< TCellInterface >::EvaluateLocation ( int &  , PointsContainer *  points, CoordRepType  pcoords[Self::CellDimension], CoordRepType  x[Self::CellDimension], InterpolationWeightType *  weights  )

protected

EvaluatePosition()

template<typename TCellInterface >

bool itk::HexahedronCell< TCellInterface >::EvaluatePosition ( CoordRepType *  , PointsContainer *  , CoordRepType *  , CoordRepType  [], double *  , InterpolationWeightType *    )

override

Evaluate the position inside the cell

GetBoundaryFeature()

template<typename TCellInterface >

bool itk::HexahedronCell< TCellInterface >::GetBoundaryFeature ( int  dimension, CellFeatureIdentifier  , CellAutoPointer &    )

override

GetDimension()

template<typename TCellInterface >

unsigned int itk::HexahedronCell< TCellInterface >::GetDimension ( ) const

override

GetEdge()

template<typename TCellInterface >

virtual bool itk::HexahedronCell< TCellInterface >::GetEdge ( CellFeatureIdentifier  , EdgeAutoPointer &    )

virtual

GetFace()

template<typename TCellInterface >

virtual bool itk::HexahedronCell< TCellInterface >::GetFace ( CellFeatureIdentifier  , FaceAutoPointer &    )

virtual

GetNameOfClass()

template<typename TCellInterface >

const char * itk::HexahedronCell< TCellInterface >::GetNameOfClass ( ) const

override

See also

LightObject::GetNameOfClass()

GetNumberOfBoundaryFeatures()

template<typename TCellInterface >

CellFeatureCount itk::HexahedronCell< TCellInterface >::GetNumberOfBoundaryFeatures ( int  dimension ) const

override

GetNumberOfEdges()

template<typename TCellInterface >

virtual CellFeatureCount itk::HexahedronCell< TCellInterface >::GetNumberOfEdges ( ) const

virtual

GetNumberOfFaces()

template<typename TCellInterface >

virtual CellFeatureCount itk::HexahedronCell< TCellInterface >::GetNumberOfFaces ( ) const

virtual

GetNumberOfPoints()

template<typename TCellInterface >

unsigned int itk::HexahedronCell< TCellInterface >::GetNumberOfPoints ( ) const

override

GetNumberOfVertices()

template<typename TCellInterface >

virtual CellFeatureCount itk::HexahedronCell< TCellInterface >::GetNumberOfVertices ( ) const

virtual

Hexahedron-specific interface.

GetType()

template<typename TCellInterface >

CellGeometryEnum itk::HexahedronCell< TCellInterface >::GetType ( ) const

inlineoverride

Implement the standard CellInterface.

Definition at line 89 of file itkHexahedronCell.h.

References itk::CommonEnums::HEXAHEDRON_CELL.

GetVertex()

template<typename TCellInterface >

virtual bool itk::HexahedronCell< TCellInterface >::GetVertex ( CellFeatureIdentifier  , VertexAutoPointer &    )

virtual

InterpolationDerivs()

template<typename TCellInterface >

void itk::HexahedronCell< TCellInterface >::InterpolationDerivs ( CoordRepType  pcoords[Self::CellDimension], CoordRepType  derivs[Self::CellDimension *Self::NumberOfPoints]  )

protected

InterpolationFunctions()

template<typename TCellInterface >

void itk::HexahedronCell< TCellInterface >::InterpolationFunctions ( CoordRepType  pcoords[Self::CellDimension], InterpolationWeightType  sf[Self::NumberOfPoints]  )

protected

itkCellCommonTypedefs()

template<typename TCellInterface >

itk::HexahedronCell< TCellInterface >::itkCellCommonTypedefs

(

HexahedronCell< TCellInterface >

)

Standard class type aliases.

itkCellInheritedTypedefs()

template<typename TCellInterface >

itk::HexahedronCell< TCellInterface >::itkCellInheritedTypedefs

(

TCellInterface

)

Standard class type aliases.

itkCellVisitMacro()

template<typename TCellInterface >

itk::HexahedronCell< TCellInterface >::itkCellVisitMacro

(

CellGeometryEnum::HEXAHEDRON_CELL

)

Visitor interface

MakeCopy()

template<typename TCellInterface >

void itk::HexahedronCell< TCellInterface >::MakeCopy ( CellAutoPointer &  ) const

override

Implement the standard CellInterface.

PointIdsBegin() [1/2]

template<typename TCellInterface >

PointIdConstIterator itk::HexahedronCell< TCellInterface >::PointIdsBegin ( ) const

override

PointIdsBegin() [2/2]

template<typename TCellInterface >

PointIdIterator itk::HexahedronCell< TCellInterface >::PointIdsBegin ( )

override

PointIdsEnd() [1/2]

template<typename TCellInterface >

PointIdConstIterator itk::HexahedronCell< TCellInterface >::PointIdsEnd ( ) const

override

PointIdsEnd() [2/2]

template<typename TCellInterface >

PointIdIterator itk::HexahedronCell< TCellInterface >::PointIdsEnd ( )

override

SetPointId()

template<typename TCellInterface >

void itk::HexahedronCell< TCellInterface >::SetPointId ( int  localId, PointIdentifier    )

override

SetPointIds() [1/2]

template<typename TCellInterface >

void itk::HexahedronCell< TCellInterface >::SetPointIds ( PointIdConstIterator  first )

override

SetPointIds() [2/2]

template<typename TCellInterface >

void itk::HexahedronCell< TCellInterface >::SetPointIds ( PointIdConstIterator  first, PointIdConstIterator  last  )

override

Member Data Documentation

CellDimension

template<typename TCellInterface >

constexpr unsigned int itk::HexahedronCell< TCellInterface >::CellDimension = 3

staticconstexpr

Definition at line 77 of file itkHexahedronCell.h.

CellDimension3D

template<typename TCellInterface >

constexpr unsigned int itk::HexahedronCell< TCellInterface >::CellDimension3D = 3

staticconstexpr

HARDCODE Implementation requirements, while allowing general interface. The General interface is needed to facilitate the general SpatialObject loader.

Definition at line 84 of file itkHexahedronCell.h.

m_PointIds

template<typename TCellInterface >

std::array<PointIdentifier, NumberOfPoints> itk::HexahedronCell< TCellInterface >::m_PointIds

protected

Initial value:

{ MakeFilled<std::array<PointIdentifier, NumberOfPoints>>(
    NumericTraits<PointIdentifier>::max()) }

Store the number of points needed for a hexahedron.

Definition at line 159 of file itkHexahedronCell.h.

NumberOfEdges

template<typename TCellInterface >

constexpr unsigned int itk::HexahedronCell< TCellInterface >::NumberOfEdges = 12

staticconstexpr

Definition at line 75 of file itkHexahedronCell.h.

NumberOfFaces

template<typename TCellInterface >

constexpr unsigned int itk::HexahedronCell< TCellInterface >::NumberOfFaces = 6

staticconstexpr

Definition at line 76 of file itkHexahedronCell.h.

NumberOfPoints

template<typename TCellInterface >

constexpr unsigned int itk::HexahedronCell< TCellInterface >::NumberOfPoints = 8

staticconstexpr

Hexahedron-specific topology numbers.

Definition at line 73 of file itkHexahedronCell.h.

NumberOfVertices

template<typename TCellInterface >

constexpr unsigned int itk::HexahedronCell< TCellInterface >::NumberOfVertices = 8

staticconstexpr

Definition at line 74 of file itkHexahedronCell.h.

PointDimension3D

template<typename TCellInterface >

constexpr unsigned int itk::HexahedronCell< TCellInterface >::PointDimension3D = 3

staticconstexpr

Definition at line 85 of file itkHexahedronCell.h.

---

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

• itkHexahedronCell.h