Base class for data collectors in a CRTP style. More...

#include <dune/vtk/datacollectorinterface.hh>

Inheritance diagram for Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >:

Public Types
enum	{ dim = GridView::dimension }
	The dimension of the grid. More...

enum	{ dow = GridView::dimensionworld }
	The dimension of the world. More...

using	GridView = GridViewType

Public Member Functions
	DataCollectorInterface (GridView const &gridView)
	Store a copy of the GridView.

void	update ()
	Update the DataCollector on the current GridView.

int	ghostLevel () const
	Return the number of ghost elements.

std::uint64_t	numCells () const
	Return the number of cells in (this partition of the) grid.

std::uint64_t	numPoints () const
	Return the number of points in (this partition of the) grid.

template<class T >
std::vector< T >	points () const
	Return a flat vector of point coordinates.

template<class T , class VtkFunction >
std::vector< T >	pointData (VtkFunction const &fct) const
	Return a flat vector of function values evaluated at the points.

template<class T , class VtkFunction >
std::vector< T >	cellData (VtkFunction const &fct) const
	Return a flat vector of function values evaluated at the cells in the order of traversal.

void	updateImpl ()

int	ghostLevelImpl () const

template<class T , class VtkFunction >
std::vector< T >	cellDataImpl (VtkFunction const &fct) const

Static Public Attributes
static constexpr auto	partition = Partition{}
	The partitionset to collect data from.

Protected Member Functions
Derived &	asDerived ()

const Derived &	asDerived () const

Protected Attributes
GridView	gridView_

Detailed Description

template<class GridViewType, class Derived, class Partition = Partitions::InteriorBorder>
class Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >

Base class for data collectors in a CRTP style.

Template Parameters

GridViewType	Model of Dune::GridView
Derived	Implementation of a concrete DataCollector.
Partition	Dune::PartitionType [Partitions::InteriorBorder]

Member Typedef Documentation

◆ GridView

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

using Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::GridView = GridViewType

Member Enumeration Documentation

◆ anonymous enum

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

anonymous enum

The dimension of the grid.

Enumerator
dim

◆ anonymous enum

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

anonymous enum

The dimension of the world.

Enumerator
dow

Constructor & Destructor Documentation

◆ DataCollectorInterface()

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::DataCollectorInterface ( GridView const & gridView )

inline

Store a copy of the GridView.

Member Function Documentation

◆ asDerived() [1/2]

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

Derived & Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::asDerived ( )

inlineprotected

◆ asDerived() [2/2]

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

const Derived & Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::asDerived ( ) const

inlineprotected

◆ cellData()

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

template<class T , class VtkFunction >

std::vector< T > Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::cellData ( VtkFunction const & fct ) const

inline

Return a flat vector of function values evaluated at the cells in the order of traversal.

See also: pointData. Note: Cells might be described explicitly by connectivity, offsets, and types, e.g. in an UnstructuredGrid, or might be described implicitly by the grid type, e.g. in StructuredGrid.

◆ cellDataImpl()

template<class GV , class D , class P >

template<class T , class VtkFunction >

std::vector< T > Dune::Vtk::DataCollectorInterface< GV, D, P >::cellDataImpl ( VtkFunction const & fct ) const

◆ ghostLevel()

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

int Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::ghostLevel ( ) const

inline

Return the number of ghost elements.

◆ ghostLevelImpl()

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

int Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::ghostLevelImpl ( ) const

inline

◆ numCells()

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

std::uint64_t Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::numCells ( ) const

inline

Return the number of cells in (this partition of the) grid.

◆ numPoints()

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

std::uint64_t Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::numPoints ( ) const

inline

Return the number of points in (this partition of the) grid.

◆ pointData()

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

template<class T , class VtkFunction >

std::vector< T > Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::pointData ( VtkFunction const & fct ) const

inline

Return a flat vector of function values evaluated at the points.

In case of a vector valued function, flat the vector entries: [fct(p0)_0, fct(p0)_1, fct(p0)_2, fct(p1)_0, ...] where the vector dimension must be 3 (possible extended by 0s) In case of tensor valued function, flat the tensor row-wise: [fct(p0)_00, fct(p0)_01, fct(p0)_02, fct(p0)_10, fct(p0)_11, fct(p0)_12, fct(p0)_20...] where the tensor dimension must be 3x3 (possible extended by 0s)

◆ points()

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

template<class T >

std::vector< T > Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::points ( ) const

inline

Return a flat vector of point coordinates.

All coordinates are extended to 3 components and concatenated. [p0_x, p0_y, p0_z, p1_x, p1_y, p1_z, ...] If the GridView::dimensionworld < 3, the remaining components are set to 0

◆ update()

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

void Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::update ( )

inline

Update the DataCollector on the current GridView.

◆ updateImpl()

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

void Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::updateImpl ( )

inline

Member Data Documentation

◆ gridView_

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

GridView Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::gridView_

protected

◆ partition

template<class GridViewType , class Derived , class Partition = Partitions::InteriorBorder>

constexpr auto Dune::Vtk::DataCollectorInterface< GridViewType, Derived, Partition >::partition = Partition{}

staticconstexpr

The partitionset to collect data from.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ GridView

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ DataCollectorInterface()

Member Function Documentation

◆ asDerived() [1/2]

◆ asDerived() [2/2]

◆ cellData()

◆ cellDataImpl()

◆ ghostLevel()

◆ ghostLevelImpl()

◆ numCells()

◆ numPoints()

◆ pointData()

◆ points()

◆ update()

◆ updateImpl()

Member Data Documentation

◆ gridView_

◆ partition