Class to collect all data given on one grid. More...

Public Types
enum	DataType
	Enum describing different possible data types. More...

Public Member Functions
template<class V , class IV >
void	SetSimplexGrid (int dim, const V &points, const IV &cells)
	Enter data of a simplex grid. More...

template<typename V >
void	SetRectilinearGrid (const V &x, const V &y)
	Enter data of a 2D rectilinear grid. More...

template<typename V >
void	SetRectilinearGrid (const V &x, const V &y, const V &z)
	Enter data of a 3D rectilinear grid. More...

template<class V >
void	SetCellRegions (const V &cr)
	Set cell region data (for multiregion grids) More...

template<class V >
void	SetBoundaryCellRegions (const V &cr)
	Set boundary cell region data (for multiregion grids) More...

template<class IV >
void	SetSimplexGridBoundaryCells (const IV &cells)
	Set boundary cells for simplex grids. More...

template<class IV >
void	SetCellMaskByMask (const IV &mask_in, const std::string name)
	Mask cells which shall be shown. More...

template<class IV >
void	SetCellMaskByList (const IV &cells_in, const std::string name)
	Mask cells which shall be shown. More...

template<class IV >
void	SetCellMaskByRegionsOmitted (const IV &regions_omitted, const std::string name)
	Mask cells which shall be shown. More...

template<class V >
void	SetPointScalar (const V &f, const std::string name)
	Set data of a scalar function defined on the points of the grid. More...

template<class V >
void	SetPointVector (const V &u, const V &v, const std::string name)
	Set data of a vector function defined on the points on a 2D grid. More...

template<class V >
void	SetPointVector (const V &u, const V &v, const V &w, const std::string name)
	Set data of a vector function defined on the points on a 2D grid. More...

template<class V >
void	SetPointVector (const V &uvw, const int dim, const std::string name)
	Set data of a vector function defined on the points on a 2D grid. More...

template<class V >
void	SetCellScalar (const V &f, const std::string name)
	Set data of a scalar function defined on the cells of the grid. More...

template<class V >
void	SetBoundaryCellScalar (const V &f, const std::string name)
	Set data of a scalar function defined on the cells of the grid. More...

void	SetCoordinateScaleFactor (double factor)
	Set scale factor for coordinates. More...

void	SetCoordinateScaleFactorX (double factor)
	Set scale factor for x coordinates. More...

void	SetCoordinateScaleFactorY (double factor)
	Set scale factor for y coordinates. More...

void	SetCoordinateScaleFactorZ (double factor)
	Set scale factor for z coordinates. More...

void	WriteVTK (const std::string fname, const std::string filetype)
	Write dataset to disk in VTK format. More...

int	GetSpaceDimension ()
	Request the space dimension of the dataset. More...

DataType	GetDataType ()
	Request the data type of the dataset. More...

vtkSmartPointer< vtkDataSet >	GetVTKDataSet ()
	Request vtkDataset which contains all the data. More...

vtkSmartPointer< vtkDataSet >	GetVTKBoundaryDataSet ()
	Request boundary dataset. More...

vtkSmartPointer< vtkIdList >	GetCellList (std::string name)
	Request celllist. More...

Static Public Member Functions
static std::shared_ptr< DataSet >	New ()
	Static constructor of smart pointer to an empty instance. More...

Detailed Description

Class to collect all data given on one grid.

Wrapper of vtkRectilinearGrid resp. vtkUnstructuredGrid Using duck typing, this class internally builds copies of the data in the form of a vtkDataSet

Member Enumeration Documentation

◆ DataType

enum vtkfig::DataSet::DataType

strong

Enum describing different possible data types.

Member Function Documentation

◆ New()

static std::shared_ptr<DataSet> vtkfig::DataSet::New ( )

static

Static constructor of smart pointer to an empty instance.

Examples: example-gridview2d.cxx, example-gridview3d.cxx, example-multifig.cxx, example-multiframe.cxx, example-rectcontour2d.cxx, example-rectcontour3d.cxx, example-rectquiver2d.cxx, example-rectquiver3d.cxx, example-rectstream2d.cxx, example-simplexcontour2d.cxx, example-simplexcontour3d.cxx, example-simplexquiver2d.cxx, example-simplexquiver3d.cxx, and example-xyplot.cxx.

◆ SetSimplexGrid()

template<class V , class IV >

void vtkfig::DataSet::SetSimplexGrid	(	int	dim,
		const V &	points,
		const IV &	cells
	)

inline

Enter data of a simplex grid.

Template Parameters

V	Vector class counting from zero with member functions size() and operator[]. std::vector will work.
IV	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

dim	Space dimension (2 or 3)
points	Point coordinates, stored consecutively. In 2D, coordinates of point i are `(points[2i],points[2i+1])` In 3D, coordinates of point i are `(points[3i],points[3i+1],,points[3*i+2])`
cells	Simplex point indices (counting from 0!) In 2D, point indices of triangle i are `(cells[3i],cells[3i+1],cells[3i+2])` In 3D, point indices of tetrahedron i are `(cells[3i],cells[3i+1],cells[3i+2],cells[3*i+3])`

Examples: example-gridview2d.cxx, and example-gridview3d.cxx.

◆ SetRectilinearGrid() [1/2]

template<typename V >

void vtkfig::DataSet::SetRectilinearGrid	(	const V &	x,
		const V &	y
	)

inline

Enter data of a 2D rectilinear grid.

Template Parameters

V	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

x	x-coordinates
y	y-coordinates

Examples: example-gridview2d.cxx, example-gridview3d.cxx, example-multifig.cxx, and example-multiframe.cxx.

◆ SetRectilinearGrid() [2/2]

template<typename V >

void vtkfig::DataSet::SetRectilinearGrid	(	const V &	x,
		const V &	y,
		const V &	z
	)

inline

Enter data of a 3D rectilinear grid.

Template Parameters

V	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

x	x-coordinates
y	y-coordinates
z	z-coordinates

◆ SetCellRegions()

template<class V >

void vtkfig::DataSet::SetCellRegions ( const V & cr )

inline

Set cell region data (for multiregion grids)

Template Parameters

V	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

cr	Cell region numbers
name	Name of function

Here is the call graph for this function:

◆ SetBoundaryCellRegions()

template<class V >

void vtkfig::DataSet::SetBoundaryCellRegions ( const V & cr )

inline

Set boundary cell region data (for multiregion grids)

Template Parameters

V	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

cr	Cell region numbers
name	Name of function

Here is the call graph for this function:

◆ SetSimplexGridBoundaryCells()

template<class IV >

void vtkfig::DataSet::SetSimplexGridBoundaryCells ( const IV & cells )

inline

Set boundary cells for simplex grids.

Template Parameters

IV	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

cr	Cell region numbers
name	Name of function

◆ SetCellMaskByMask()

template<class IV >

void vtkfig::DataSet::SetCellMaskByMask	(	const IV &	mask_in,
		const std::string	name
	)

inline

Mask cells which shall be shown.

Template Parameters

IV	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

mask_in	Flag array indicating if cell is in
name	Name of the mask for later reference

◆ SetCellMaskByList()

template<class IV >

void vtkfig::DataSet::SetCellMaskByList	(	const IV &	cells_in,
		const std::string	name
	)

inline

Mask cells which shall be shown.

Template Parameters

IV	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

cells_in	List of cells which shall be shown
name	Name of the mask for later reference

◆ SetCellMaskByRegionsOmitted()

template<class IV >

void vtkfig::DataSet::SetCellMaskByRegionsOmitted	(	const IV &	regions_omitted,
		const std::string	name
	)

inline

Mask cells which shall be shown.

Assumes that DataSet::SetCellRegions() was called.

Template Parameters

IV	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

regions_omitted	List of regions which shall be omitted
name	Name of the mask for later reference

◆ SetPointScalar()

template<class V >

void vtkfig::DataSet::SetPointScalar	(	const V &	f,
		const std::string	name
	)

inline

Set data of a scalar function defined on the points of the grid.

Template Parameters

V	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

f	Vector of function values
name	Name of function

Examples: example-multifig.cxx, and example-multiframe.cxx.

◆ SetPointVector() [1/3]

template<class V >

void vtkfig::DataSet::SetPointVector	(	const V &	u,
		const V &	v,
		const std::string	name
	)

inline

Set data of a vector function defined on the points on a 2D grid.

Template Parameters

V	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

u	Vector of x component values
v	Vector of y component values
name	Name of function

◆ SetPointVector() [2/3]

template<class V >

void vtkfig::DataSet::SetPointVector	(	const V &	u,
		const V &	v,
		const V &	w,
		const std::string	name
	)

inline

Set data of a vector function defined on the points on a 2D grid.

Template Parameters

V	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

u	Vector of x component values
v	Vector of y component values
w	Vector of z component values
name	Name of function

◆ SetPointVector() [3/3]

template<class V >

void vtkfig::DataSet::SetPointVector	(	const V &	uvw,
		const int	dim,
		const std::string	name
	)

inline

Set data of a vector function defined on the points on a 2D grid.

Template Parameters

V	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

uvw	Vector of row-wise stored component values ( u1 v1, w1, u2,v2,w2 ...)
name	Name of function

◆ SetCellScalar()

template<class V >

void vtkfig::DataSet::SetCellScalar	(	const V &	f,
		const std::string	name
	)

inline

Set data of a scalar function defined on the cells of the grid.

Template Parameters

V	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

f	Vector of function values
name	Name of function

◆ SetBoundaryCellScalar()

template<class V >

void vtkfig::DataSet::SetBoundaryCellScalar	(	const V &	f,
		const std::string	name
	)

inline

Set data of a scalar function defined on the cells of the grid.

Template Parameters

V	Vector class counting from zero with member functions size() and operator[]. std::vector will work.

Parameters

f	Vector of function values
name	Name of function

◆ SetCoordinateScaleFactor()

void vtkfig::DataSet::SetCoordinateScaleFactor ( double factor )

inline

Set scale factor for coordinates.

This has to be set before the grid is added to the dataset. Some vtk algorithms (notably vtkProbeFilter) struggle with small scale grids, and so one can try to increase the magnitude of coordinates.

◆ SetCoordinateScaleFactorX()

void vtkfig::DataSet::SetCoordinateScaleFactorX ( double factor )

inline

Set scale factor for x coordinates.

This has to be set before the grid is added to the dataset.

◆ SetCoordinateScaleFactorY()

void vtkfig::DataSet::SetCoordinateScaleFactorY ( double factor )

inline

Set scale factor for y coordinates.

This has to be set before the grid is added to the dataset.

◆ SetCoordinateScaleFactorZ()

void vtkfig::DataSet::SetCoordinateScaleFactorZ ( double factor )

inline

Set scale factor for z coordinates.

This has to be set before the grid is added to the dataset.

◆ WriteVTK()

void vtkfig::DataSet::WriteVTK	(	const std::string	fname,
		const std::string	filetype
	)

Write dataset to disk in VTK format.

Parameters

fname	File name
filetype	File type: "A" for ASCII, "B" for binary

◆ GetSpaceDimension()

int vtkfig::DataSet::GetSpaceDimension ( )

inline

Request the space dimension of the dataset.

Returns: Space dimension

◆ GetDataType()

DataType vtkfig::DataSet::GetDataType ( )

Request the data type of the dataset.

Returns: Data type

◆ GetVTKDataSet()

vtkSmartPointer<vtkDataSet> vtkfig::DataSet::GetVTKDataSet ( )

inline

Request vtkDataset which contains all the data.

Returns: vtkDataset

◆ GetVTKBoundaryDataSet()

vtkSmartPointer<vtkDataSet> vtkfig::DataSet::GetVTKBoundaryDataSet ( )

inline

Request boundary dataset.

Returns: vtkDataset

◆ GetCellList()

vtkSmartPointer<vtkIdList> vtkfig::DataSet::GetCellList ( std::string name )

inline

Request celllist.

Returns: Cell List

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

vtkfigDataSet.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ DataType

Member Function Documentation

◆ New()

◆ SetSimplexGrid()

◆ SetRectilinearGrid() [1/2]

◆ SetRectilinearGrid() [2/2]

◆ SetCellRegions()

◆ SetBoundaryCellRegions()

◆ SetSimplexGridBoundaryCells()

◆ SetCellMaskByMask()

◆ SetCellMaskByList()

◆ SetCellMaskByRegionsOmitted()

◆ SetPointScalar()

◆ SetPointVector() [1/3]

◆ SetPointVector() [2/3]

◆ SetPointVector() [3/3]

◆ SetCellScalar()

◆ SetBoundaryCellScalar()

◆ SetCoordinateScaleFactor()

◆ SetCoordinateScaleFactorX()

◆ SetCoordinateScaleFactorY()

◆ SetCoordinateScaleFactorZ()

◆ WriteVTK()

◆ GetSpaceDimension()

◆ GetDataType()

◆ GetVTKDataSet()

◆ GetVTKBoundaryDataSet()

◆ GetCellList()