OpenFPM_io  0.2.0
Project that contain the implementation and interfaces for basic structure like vectors, grids, graph ... .
 All Data Structures Functions Variables Typedefs
VTKWriter< pair, VECTOR_ST_GRIDS > Class Template Reference

#include <VTKWriter_grids_st.hpp>

Public Member Functions

 VTKWriter ()
 
void add (size_t i, 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, const comb< pair::first::dims > &cmb)
 Add grid dataset. More...
 
template<int prp = -1>
bool write (std::string file, std::string g_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_prop_components (size_t k)
 
std::string get_properties_output (size_t k, std::string prop_name)
 Create the VTK properties output. More...
 
std::string lastProp ()
 Return the output of the domain property. More...
 
size_t getMaxFused ()
 Get the maximum number of fused grid. More...
 
std::string get_vertex_list ()
 Create the VTK vertex definition. More...
 
std::string get_point_data_header ()
 Get the point data header. More...
 
void append_grid (size_t id, const typename pair::first &g, const comb< pair::first::dims > &cmb)
 Append the grid to the sub-domain, if for a sub-domain we have a grid that is overlapping fuse them, otherwise create a new combination and grid. More...
 

Private Attributes

openfpm::vector< ele_g_st
< typename pair::first,
typename pair::second > > 
vg
 Vector of grids.
 

Detailed Description

template<typename pair>
class VTKWriter< pair, VECTOR_ST_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 157 of file VTKWriter_grids_st.hpp.

Constructor & Destructor Documentation

template<typename pair >
VTKWriter< pair, VECTOR_ST_GRIDS >::VTKWriter ( )
inline

VTKWriter constructor

Definition at line 548 of file VTKWriter_grids_st.hpp.

Member Function Documentation

template<typename pair >
void VTKWriter< pair, VECTOR_ST_GRIDS >::add ( size_t  i,
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,
const comb< pair::first::dims > &  cmb 
)
inline

Add grid dataset.

Parameters
isub-domain id
gGrid to add
offsetgrid offset
spacingspacing of the grid
dompart of the spacethat is the domain

Increase the size

Definition at line 560 of file VTKWriter_grids_st.hpp.

template<typename pair >
void VTKWriter< pair, VECTOR_ST_GRIDS >::append_grid ( size_t  id,
const typename pair::first &  g,
const comb< pair::first::dims > &  cmb 
)
inlineprivate

Append the grid to the sub-domain, if for a sub-domain we have a grid that is overlapping fuse them, otherwise create a new combination and grid.

Parameters
idsub-domain id
locationin the cell of the grid
Returns
a valid slot, if does not exist it append the grid at the end with the new combination

Definition at line 523 of file VTKWriter_grids_st.hpp.

template<typename pair >
std::string VTKWriter< pair, VECTOR_ST_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 505 of file VTKWriter_grids_st.hpp.

template<typename pair >
std::string VTKWriter< pair, VECTOR_ST_GRIDS >::get_point_list ( )
inlineprivate

Create the VTK point definition.

vertex node output string

For each sub-domain

Get the iterator

Where the grid is defined

Definition at line 226 of file VTKWriter_grids_st.hpp.

template<typename pair >
std::string VTKWriter< pair, VECTOR_ST_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 211 of file VTKWriter_grids_st.hpp.

template<typename pair >
std::string VTKWriter< pair, VECTOR_ST_GRIDS >::get_prop_components ( size_t  k)
inlineprivate

For each sub-domain

Definition at line 281 of file VTKWriter_grids_st.hpp.

template<typename pair >
std::string VTKWriter< pair, VECTOR_ST_GRIDS >::get_properties_output ( size_t  k,
std::string  prop_name 
)
inlineprivate

Create the VTK properties output.

Parameters
kcomponent
propproperty name

vertex node output string

For each sub-domain

Get the iterator

Where the grid is defined

Get the iterator

Where the grid is defined

Definition at line 308 of file VTKWriter_grids_st.hpp.

template<typename pair >
size_t VTKWriter< pair, VECTOR_ST_GRIDS >::get_total ( )
inlineprivate

Get the total number of points.

Returns
the total number

Calculate the full number of vertices

Definition at line 167 of file VTKWriter_grids_st.hpp.

template<typename pair >
std::string VTKWriter< pair, VECTOR_ST_GRIDS >::get_vertex_list ( )
inlineprivate

Create the VTK vertex definition.

vertex node output string

For each sub-domain

For each grid point create a vertex

Definition at line 467 of file VTKWriter_grids_st.hpp.

template<typename pair >
std::string VTKWriter< pair, VECTOR_ST_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 191 of file VTKWriter_grids_st.hpp.

template<typename pair >
size_t VTKWriter< pair, VECTOR_ST_GRIDS >::getMaxFused ( )
inlineprivate

Get the maximum number of fused grid.

Returns
the maximum number of fused grids

For each sub-domain

Definition at line 445 of file VTKWriter_grids_st.hpp.

template<typename pair >
std::string VTKWriter< pair, VECTOR_ST_GRIDS >::lastProp ( )
inlineprivate

Return the output of the domain property.

Returns
vtk output

vertex node output string

For each sub-domain

Get the iterator

Definition at line 399 of file VTKWriter_grids_st.hpp.

template<typename pair >
template<int prp = -1>
bool VTKWriter< pair, VECTOR_ST_GRIDS >::write ( std::string  file,
std::string  g_name = "grids",
file_type  ft = file_type::ASCII 
)
inline

It write a VTK file from a graph.

Template Parameters
prp_outwhich properties to output [default = -1 (all)]
Parameters
filepath where to write
g_nameof the set of grids
file_typespecify if it is a VTK BINARY or ASCII file [default = ASCII]

Definition at line 584 of file VTKWriter_grids_st.hpp.


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