VTKWriter< pair, VECTOR_POINTS > Class Template Reference

#include <VTKWriter_point_set.hpp>

Public Member Functions
	VTKWriter ()
void	add (const typename pair::first &vps, const typename pair::second &vpp, size_t mark)
	Add a vector dataset. More...
template<int prp = -1>
bool	write (std::string file, std::string f_name="grids", file_type ft=file_type::ASCII)
	It write a VTK file from a vector of points. More...

Private Member Functions
size_t	get_total ()
	Get the total number of points. More...
std::string	get_vertex_properties_list ()
	It get the vertex properties list. More...
std::string	get_point_properties_list ()
	It get the vertex properties list. More...
std::string	get_point_list ()
	Create the VTK point definition. More...
std::string	get_vertex_list ()
	Create the VTK vertex definition. More...
std::string	get_point_data_header ()
	Get the point data header. More...

Private Attributes
openfpm::vector< ele_vps < typename pair::first > >	vps
	Vector of couple, position and properties.
openfpm::vector< ele_vpp < typename pair::second > >	vpp

Detailed Description

template<typename pair>
class VTKWriter< pair, VECTOR_POINTS >

It write a VTK format file for a list of grids defined on a space

Template Parameters

boost::mpl::pair<G,S>

where G is the type of the vector containing the properties, S is the type of vector containing the particle positions

Definition at line 137 of file VTKWriter_point_set.hpp.

Constructor & Destructor Documentation

template<typename pair >

VTKWriter< pair, VECTOR_POINTS >::VTKWriter ( )

inline

VTKWriter constructor

Definition at line 284 of file VTKWriter_point_set.hpp.

Member Function Documentation

template<typename pair >

void VTKWriter< pair, VECTOR_POINTS >::add ( const typename pair::first &  vps, const typename pair::second &  vpp, size_t  mark  )

inline

Add a vector dataset.

Parameters

vps	vector of positions
vpp	vector of properties
mark,additional	information that divide the dataset into 2 (in general is used to mark real from ghost information)

Definition at line 295 of file VTKWriter_point_set.hpp.

template<typename pair >

std::string VTKWriter< pair, VECTOR_POINTS >::get_point_data_header ( )

inlineprivate

Get the point data header.

Returns

a string with the point data header for VTK format

Definition at line 268 of file VTKWriter_point_set.hpp.

template<typename pair >

std::string VTKWriter< pair, VECTOR_POINTS >::get_point_list ( )

inlineprivate

Create the VTK point definition.

vertex node output string

For each defined grid

write the particle position

Definition at line 203 of file VTKWriter_point_set.hpp.

template<typename pair >

std::string VTKWriter< pair, VECTOR_POINTS >::get_point_properties_list ( )

inlineprivate

It get the vertex properties list.

It get the vertex properties list of the vertex defined as a VTK header

Returns

a string that define the vertex properties in graphML format

vertex property output string

Definition at line 188 of file VTKWriter_point_set.hpp.

template<typename pair >

size_t VTKWriter< pair, VECTOR_POINTS >::get_total ( )

inlineprivate

Get the total number of points.

Returns

the total number

Calculate the full number of vertices

Definition at line 148 of file VTKWriter_point_set.hpp.

template<typename pair >

std::string VTKWriter< pair, VECTOR_POINTS >::get_vertex_list ( )

inlineprivate

Create the VTK vertex definition.

vertex node output string

For each grid point create a vertex

Definition at line 238 of file VTKWriter_point_set.hpp.

template<typename pair >

std::string VTKWriter< pair, VECTOR_POINTS >::get_vertex_properties_list ( )

inlineprivate

It get the vertex properties list.

It get the vertex properties list of the vertex defined as VTK header

Returns

a string that define the vertex properties in graphML format

vertex property output string

Definition at line 168 of file VTKWriter_point_set.hpp.

template<typename pair >

template<int prp = -1>

bool VTKWriter< pair, VECTOR_POINTS >::write ( std::string  file, std::string  f_name = "grids", file_type  ft = file_type::ASCII  )

inline

It write a VTK file from a vector of points.

Template Parameters

prp_out

which properties to output [default = -1 (all)]

Parameters

file	path where to write
name	name of the dataset
file_type	specify if it is a VTK BINARY or ASCII file [default = ASCII]

Definition at line 314 of file VTKWriter_point_set.hpp.

---

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

• src/VTKWriter/VTKWriter_point_set.hpp