VTKWriter< pair, VECTOR_GRIDS > Class Template Reference

#include <VTKWriter_grids.hpp>

Public Member Functions
	VTKWriter ()
void	add (const typename pair::first &g, const Point< pair::first::dims, typename pair::second > &offset, const Point< pair::first::dims, typename pair::second > &spacing, const Box< pair::first::dims, typename pair::second > &dom)
	Add grid 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 graph. 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_g < typename pair::first, typename pair::second > >	vg
	Vector of grids.

Detailed Description

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

It write a VTK format file in case of grids defined on a space

Template Parameters

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

where G is the type of grid S is the type of space, float, double ...

Definition at line 122 of file VTKWriter_grids.hpp.

Constructor & Destructor Documentation

template<typename pair >

VTKWriter< pair, VECTOR_GRIDS >::VTKWriter ( )

inline

VTKWriter constructor

Definition at line 272 of file VTKWriter_grids.hpp.

Member Function Documentation

template<typename pair >

void VTKWriter< pair, VECTOR_GRIDS >::add ( const typename pair::first &  g, const Point< pair::first::dims, typename pair::second > &  offset, const Point< pair::first::dims, typename pair::second > &  spacing, const Box< pair::first::dims, typename pair::second > &  dom  )

inline

Add grid dataset.

Parameters

g	Grid to add
offset	grid offset
spacing	spacing of the grid
dom	part of the spacethat is the domain

Definition at line 283 of file VTKWriter_grids.hpp.

template<typename pair >

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

inlineprivate

Get the point data header.

Returns

a string with the point data header for VTK format

Definition at line 256 of file VTKWriter_grids.hpp.

template<typename pair >

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

inlineprivate

Create the VTK point definition.

vertex node output string

For each defined grid

Get the iterator

Where the grid is defined

Definition at line 187 of file VTKWriter_grids.hpp.

template<typename pair >

std::string VTKWriter< pair, VECTOR_GRIDS >::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 172 of file VTKWriter_grids.hpp.

template<typename pair >

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

inlineprivate

Get the total number of points.

Returns

the total number

Calculate the full number of vertices

Definition at line 132 of file VTKWriter_grids.hpp.

template<typename pair >

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

inlineprivate

Create the VTK vertex definition.

vertex node output string

For each grid point create a vertex

Definition at line 226 of file VTKWriter_grids.hpp.

template<typename pair >

std::string VTKWriter< pair, VECTOR_GRIDS >::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 152 of file VTKWriter_grids.hpp.

template<typename pair >

template<int prp = -1>

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

inline

It write a VTK file from a graph.

Template Parameters

prp_out

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

Parameters

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

Definition at line 300 of file VTKWriter_grids.hpp.

---

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

• src/VTKWriter/VTKWriter_grids.hpp