defines cell interface More...

#include <vtkGenericAdaptorCell.h>

Inheritance diagram for vtkGenericAdaptorCell:

Collaboration diagram for vtkGenericAdaptorCell:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkGenericAdaptorCell *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual vtkIdType	GetId ()=0
	Unique identification number of the cell over the whole data set.
virtual int	GetType ()=0
	Does `this' a cell of a dataset?
virtual int	GetDimension ()=0
	Return the topological dimension of the current cell.
virtual int	GetGeometryOrder ()=0
	Return the interpolation order of the geometry.
int	IsGeometryLinear ()
	Does the cell have a non-linear interpolation for the geometry?
virtual int	IsPrimary ()=0
	Return the interpolation order of attribute `a' on the cell (may differ by cell).
virtual int	GetNumberOfPoints ()=0
	Return the number of corner points that compose the cell.
virtual int	GetNumberOfDOFNodes ()=0
	Return the number of boundaries of dimension `dim' (or all dimensions greater than 0 and less than GetDimension() if -1) of the cell.
virtual vtkGenericCellIterator *	NewCellIterator ()=0
	Return the points of cell into `it'.
virtual void	GetBoundaryIterator (vtkGenericCellIterator *boundaries, int dim=-1)=0
	Return the boundaries' cells of dimension dim' (or all dimensions less than GetDimension() if -1) that are part of the boundary of the cell.
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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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 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.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkGenericAdaptorCell *	SafeDownCast (vtkObjectBase *o)
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
virtual vtkObjectBase *	NewInstanceInternal () const
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 ()
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
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

Detailed Description

defines cell interface

In VTK, spatial-temporal data is defined in terms of a dataset which is composed of cells. The cells are topological entities over which an interpolation field is applied. Cells are defined in terms of a topology (e.g., vertices, lines, triangles, polygons, tetrahedra, etc.), points that instantiate the geometry of the cells, and interpolation fields (in the general case one interpolation field is for geometry, the other is for attribute data associated with the cell).

Currently most algorithms in VTK use vtkCell and vtkDataSet, which make assumptions about the nature of datasets, cells, and attributes. In particular, this abstraction assumes that cell interpolation functions are linear, or products of linear functions. Further, VTK implements most of the interpolation functions. This implementation starts breaking down as the complexity of the interpolation (or basis) functions increases.

vtkGenericAdaptorCell addresses these issues by providing more general abstraction for cells. It also adopts modern C++ practices including using iterators. The vtkGenericAdaptorCell is designed to fit within the adaptor framework; meaning that it is meant to adapt VTK to external simulation systems (see the GenericFiltering/README.html).

Please note that most cells are defined in terms of other cells (the boundary cells). They are also defined in terms of points, which are not the same as vertices (vertices are a 0-D cell; points represent a position in space).

Another important concept is the notion of DOFNodes. These concept supports cell types with complex interpolation functions. For example, higher-order p-method finite elements may have different functions on each of their topological features (edges, faces, region). The coefficients of these polynomial functions are associated with DOFNodes. (There is a single DOFNode for each topological feature.) Note that from this perspective, points are used to establish the topological form of the cell; mid-side nodes and such are considered DOFNodes.

See also: vtkGenericDataSet

Tests:: vtkGenericAdaptorCell (Tests)

Definition at line 83 of file vtkGenericAdaptorCell.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkGenericAdaptorCell::Superclass

Definition at line 86 of file vtkGenericAdaptorCell.h.

Member Function Documentation

◆ IsTypeOf()

vtkTypeBool vtkGenericAdaptorCell::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkGenericAdaptorCell::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

vtkGenericAdaptorCell * vtkGenericAdaptorCell::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkGenericAdaptorCell::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkGenericAdaptorCell * vtkGenericAdaptorCell::NewInstance ( ) const

◆ PrintSelf()

void vtkGenericAdaptorCell::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 vtkObjectBase.

◆ GetId()

virtual vtkIdType vtkGenericAdaptorCell::GetId ( )

pure virtual

Unique identification number of the cell over the whole data set.

This unique key may not be contiguous.

◆ GetType()

virtual int vtkGenericAdaptorCell::GetType ( )

pure virtual

Does `this' a cell of a dataset?

(otherwise, it is a boundary cell) */ virtual int IsInDataSet() = 0;

/** Return the type of the current cell.

Postcondition: (result==VTK_HIGHER_ORDER_EDGE)|| (result==VTK_HIGHER_ORDER_TRIANGLE)|| (result==VTK_HIGHER_ORDER_TETRAHEDRON)

◆ GetDimension()

virtual int vtkGenericAdaptorCell::GetDimension ( )

pure virtual

Return the topological dimension of the current cell.

Postcondition: valid_result: result>=0 && result<=3

◆ GetGeometryOrder()

virtual int vtkGenericAdaptorCell::GetGeometryOrder ( )

pure virtual

Return the interpolation order of the geometry.

Postcondition: positive_result: result>=0

◆ IsGeometryLinear()

int vtkGenericAdaptorCell::IsGeometryLinear ( )

Does the cell have a non-linear interpolation for the geometry?

Postcondition: definition: result==(GetGeometryOrder()==1)

◆ IsPrimary()

virtual int vtkGenericAdaptorCell::IsPrimary ( )

pure virtual

Return the interpolation order of attribute `a' on the cell (may differ by cell).

Precondition: a_exists: a!=0

Postcondition: positive_result: result>=0 */ virtual int GetAttributeOrder(vtkGenericAttribute* a) = 0;

/** Return the index of the first point centered attribute with the highest order in `ac'.

Precondition: ac_exists: ac!=0

Postcondition: valid_result: result>=-1 && result<ac->GetNumberOfAttributes() */ virtual int GetHighestOrderAttribute(vtkGenericAttributeCollection* ac);

/** Does the attribute `a' have a non-linear interpolation?

Precondition: a_exists: a!=0

Postcondition: definition: result==(GetAttributeOrder()==1) */ vtkTypeBool IsAttributeLinear(vtkGenericAttribute* a);

/** Is the cell primary (i.e. not composite) ?

◆ GetNumberOfPoints()

virtual int vtkGenericAdaptorCell::GetNumberOfPoints ( )

pure virtual

Return the number of corner points that compose the cell.

Postcondition: positive_result: result>=0

◆ GetNumberOfDOFNodes()

virtual int vtkGenericAdaptorCell::GetNumberOfDOFNodes ( )

pure virtual

Return the number of boundaries of dimension `dim' (or all dimensions greater than 0 and less than GetDimension() if -1) of the cell.

When dim is -1, the number of vertices is not included in the count because vertices are a special case: a vertex will have at most a single field value associated with it; DOF nodes may have an arbitrary number of field values associated with them.

Precondition: valid_dim_range: (dim==-1) || ((dim>=0)&&(dim<GetDimension()))

Postcondition: positive_result: result>=0 */ virtual int GetNumberOfBoundaries(int dim = -1) = 0;

/** Accumulated number of DOF nodes of the current cell. A DOF node is a component of cell with a given topological dimension. e.g.: a triangle has 4 DOF: 1 face and 3 edges. An hexahedron has 19 DOF: 1 region, 6 faces, and 12 edges.

The number of vertices is not included in the count because vertices are a special case: a vertex will have at most a single field value associated with it; DOF nodes may have an arbitrary number of field values associated with them.

Postcondition: valid_result: result==GetNumberOfBoundaries(-1)+1

◆ NewCellIterator()

virtual vtkGenericCellIterator * vtkGenericAdaptorCell::NewCellIterator ( )

pure virtual

Return the points of cell into `it'.

Precondition: it_exists: it!=0 */ virtual void GetPointIterator(vtkGenericPointIterator* it) = 0;

/** Create an empty cell iterator. The user is responsible for deleting it.

Postcondition: result_exists: result!=0

◆ GetBoundaryIterator()

virtual void vtkGenericAdaptorCell::GetBoundaryIterator	(	vtkGenericCellIterator *	boundaries,
		int	dim = -1 )

pure virtual

Return the boundaries' cells of dimension dim' (or all dimensions less than GetDimension() if -1) that are part of the boundary of the cell.

Precondition: valid_dim_range: (dim==-1) || ((dim>=0)&&(dim<GetDimension())); boundaries_exist: boundaries!=0

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

Common/DataModel/vtkGenericAdaptorCell.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetId()

◆ GetType()

◆ GetDimension()

◆ GetGeometryOrder()

◆ IsGeometryLinear()

◆ IsPrimary()

◆ GetNumberOfPoints()

◆ GetNumberOfDOFNodes()

◆ NewCellIterator()

◆ GetBoundaryIterator()