DELPHIN Namespace Reference

---

Detailed Description

This namespace contains all classes and functions for Delphin 5 output file handling.

Classes
class	Delphin5OutputData
	This class stores all output data from a Delphin 5 output file. More...
class	ReadNotification
	Used to provide feedback from the output file read function to any user. More...
class	MaterialDef
	Contains the data entries in the material table of the geometry section. More...
class	Grid
	Contains the grid data of the geometry section. More...
class	ElementGeometry
	Contains the element data in the elements table of the geometry section. More...
class	SidesGeometry
	Contains the sides data in the sides table of the geometry sectin. More...
struct	SideIdentification
	Used to look up sides around an element by index and orientation. More...
class	rectangle
	A type that represents a rectangle. More...
struct	ElementData
	Used to obtain relationships between elements and neighboring sides. More...
struct	LineData
	Data used for geometry and boundary line files. More...
struct	QuadElementData
	Node connectivity data for FE Quadrilateral mesh. More...
Functions
std::ostream &	operator<< (std::ostream &out, Delphin5OutputData::type_t t)
	Output file stream operators (ASCII mode) for type_t data.
void	string2type (const std::string &str, Delphin5OutputData::type_t &t)
std::ostream &	operator<< (std::ostream &out, Delphin5OutputData::spaceType_t t)
	Output file stream operators (ASCII mode) for spaceType_t data.
void	string2spaceType (const std::string &str, Delphin5OutputData::spaceType_t &t)
std::ostream &	operator<< (std::ostream &out, Delphin5OutputData::timeType_t t)
	Output file stream operators (ASCII mode) for timeType_t data.
void	string2timeType (const std::string &str, Delphin5OutputData::timeType_t &t)
bool	operator== (const MaterialDef &lhs, const MaterialDef &rhs)
bool	operator== (const ElementGeometry &lhs, const std::pair< unsigned int, unsigned int > &rhs)
	Comparison operator to find an element by its coordinates.
bool	operator!= (const ElementGeometry &lhs, const std::pair< unsigned int, unsigned int > &rhs)
bool	operator== (const SidesGeometry &lhs, const SideIdentification &rhs)
	Comparison operator to look up a side entry in the sides geometry vector around by index and orientation.
bool	operator!= (const SidesGeometry &lhs, const SideIdentification &rhs)
void	read_string (std::istream &in, std::string &str)
	Reads a string in binary format from the binary input stream 'in'.
void	write_string (std::ostream &out, const std::string &str)
	Writes a string in binary format into the binary output stream 'out'.
template<typename T>
void	read_vector (std::istream &in, std::vector< T > &vec)
template<typename T>
void	write_vector (std::ostream &out, const std::vector< T > &vec)
bool	write_XY_generic_file (const std::string &fname, const std::vector< double > &timepoints, const std::vector< std::vector< double > > &values, const std::string &tp_var_name, const std::string &values_var_name, std::string &errmsg)
	Writes a XY-Plot file : X = Time, Y = Values.
bool	write_3D_triplet_format_file (const std::string &fname, const std::vector< double > &t_vec, const std::vector< double > &x_vec, const std::vector< double > &v_vec, const std::string &tp_var_name, const std::string &dir_var_name, const std::string &values_var_name, std::string &errmsg)
	Writes a 3D-plot file in triplet format.
bool	write_1D_XY_tecplot_file (const std::string &fname, const std::vector< double > &timepoints, const std::vector< std::vector< double > > &values, const std::string &tp_var_name, const std::string &values_var_name, std::string &errmsg)
	Writes a XY-Plot file : X = Time, Y = Values.
bool	write_1D_joined_XY_tecplot_file (const std::string &fname, const std::vector< double > &timepoints, const std::vector< std::vector< double > > &all_values, const std::string &tp_var_name, const std::vector< std::string > &values_var_names, std::string &errmsg)
	Writes a joined XY-Plot file : X = Time, Y1, Y2, .. YN = Values.
bool	write_1D_tecplot_field_file (const std::string &fname, const std::vector< ElementGeometry > &e_vec, const std::vector< int > &nums, const std::vector< double > &timepoints, const std::vector< std::vector< double > > &values, const std::string &tp_var_name, const std::string &values_var_name, std::string &errmsg)
	Writes a TecPlot file in general format for elements (field output).
bool	write_1D_tecplot_flux_file (const std::string &fname, const std::vector< SidesGeometry > &s_vec, const std::vector< int > &nums, const std::vector< double > &timepoints, const std::vector< std::vector< double > > &values, const std::string &tp_var_name, const std::string &values_var_name, std::string &errmsg)
	Writes a TecPlot file in general format for sides (flux output).
bool	write_1D_joined_tecplot_file (const std::string &fname, const std::vector< ElementGeometry > &e_vec, const std::vector< int > &nums, const std::vector< double > &timepoints, const std::vector< std::vector< std::vector< double > > > &all_values, const std::string &tp_var_name, const std::vector< std::string > &values_var_names, std::string &errmsg)
	Writes a TecPlot file similar to write_1D_tecplot_file() but writes multiply quantities into the same file.
bool	write_1D_tecplot_surface_plot_file (const std::string &fname, const std::vector< ElementGeometry > &e_vec, const std::vector< int > &nums, const std::vector< double > &timepoints, const std::vector< std::vector< double > > &values, const std::string &tp_var_name, const std::string &values_var_name, bool binary, std::string &errmsg)
bool	write_2D_tecplot_field_file (const std::string &fname, const Delphin5OutputData &data, const std::string &tp_var_name, const std::string &values_var_name, bool binary, std::string &errmsg)
	Writes a 2D TecPlot field output file using a quadrilateral FE grid.
bool	write_2D_vector_tecplot_file (const std::string &fname, const Delphin5OutputData &data, const std::string &tp_var_name, const std::string &values_var_name, bool binary, std::string &errmsg)
	Writes a 2D TecPlot flux output file (for transient 2D vector plot).
bool	create_geometry_lines (const std::vector< MaterialDef > &mat_vec, const Grid &grid, const std::vector< ElementGeometry > &e_vec, std::vector< LineData > &linevec, std::vector< LineData > &boundaryvec, std::vector< std::vector< int > > mat, std::string &errmsg)
	Fills two vectors with geometry information about the structure and the boundaries of the structure.
bool	write_geometry_file (const std::string &fname, const std::vector< LineData > &linevec)
	Writes a TecPlot geometry file containing the geometry of the structure including all internal boundaries.
bool	write_boundary_zone_file (const std::string &fname, const std::vector< LineData > &boundaryvec)
	Writes a TecPlot geometry file containing the structure boundary geometry.

---

Function Documentation

std::ostream& DELPHIN::operator<<	(	std::ostream &	out,
		Delphin5OutputData::type_t	t
	)

Output file stream operators (ASCII mode) for type_t data.

void DELPHIN::string2type	(	const std::string &	str,
		Delphin5OutputData::type_t &	t
	)

std::ostream& DELPHIN::operator<<	(	std::ostream &	out,
		Delphin5OutputData::spaceType_t	t
	)

Output file stream operators (ASCII mode) for spaceType_t data.

void DELPHIN::string2spaceType	(	const std::string &	str,
		Delphin5OutputData::spaceType_t &	t
	)

std::ostream& DELPHIN::operator<<	(	std::ostream &	out,
		Delphin5OutputData::timeType_t	t
	)

Output file stream operators (ASCII mode) for timeType_t data.

void DELPHIN::string2timeType	(	const std::string &	str,
		Delphin5OutputData::timeType_t &	t
	)

bool DELPHIN::operator==	(	const MaterialDef &	lhs,
		const MaterialDef &	rhs
	)

Definition at line 62 of file delphin_output_lib_types.h.

bool DELPHIN::operator==	(	const ElementGeometry &	lhs,
		const std::pair< unsigned int, unsigned int > &	rhs
	)

Comparison operator to find an element by its coordinates.

Definition at line 99 of file delphin_output_lib_types.h.

bool DELPHIN::operator!=	(	const ElementGeometry &	lhs,
		const std::pair< unsigned int, unsigned int > &	rhs
	)

Definition at line 102 of file delphin_output_lib_types.h.

bool DELPHIN::operator==	(	const SidesGeometry &	lhs,
		const SideIdentification &	rhs
	)

Comparison operator to look up a side entry in the sides geometry vector around by index and orientation.

Definition at line 130 of file delphin_output_lib_types.h.

bool DELPHIN::operator!=	(	const SidesGeometry &	lhs,
		const SideIdentification &	rhs
	)

Definition at line 135 of file delphin_output_lib_types.h.

void DELPHIN::read_string	(	std::istream &	in,
		std::string &	str
	)

Reads a string in binary format from the binary input stream 'in'.

void DELPHIN::write_string	(	std::ostream &	out,
		const std::string &	str
	)

Writes a string in binary format into the binary output stream 'out'.

template<typename T>

void DELPHIN::read_vector	(	std::istream &	in,
		std::vector< T > &	vec
	)

Definition at line 38 of file delphin_output_lib_utils.h.

template<typename T>

void DELPHIN::write_vector	(	std::ostream &	out,
		const std::vector< T > &	vec
	)

Definition at line 48 of file delphin_output_lib_utils.h.

bool DELPHIN::write_XY_generic_file	(	const std::string &	fname,
		const std::vector< double > &	timepoints,
		const std::vector< std::vector< double > > &	values,
		const std::string &	tp_var_name,
		const std::string &	values_var_name,
		std::string &	errmsg
	)

Writes a XY-Plot file : X = Time, Y = Values.

Parameters:

	fname	Full path to target file.
	timepoints	Vector with num_t time points.
	values	Vector with num_t vectors with 1 value each
	tp_var_name	String with time variable name.
	values_var_name	String with value variable name.
	errmsg	Used to store error messages.

Returns:

Returns 'true' if writing of output file was successful, or 'false' if not. If writing failed, an error message is written into the 'errmsg' string.

bool DELPHIN::write_3D_triplet_format_file	(	const std::string &	fname,
		const std::vector< double > &	t_vec,
		const std::vector< double > &	x_vec,
		const std::vector< double > &	v_vec,
		const std::string &	tp_var_name,
		const std::string &	dir_var_name,
		const std::string &	values_var_name,
		std::string &	errmsg
	)

Writes a 3D-plot file in triplet format.

Parameters:

	fname	Full path to target file.
	t_vec	Vector with time points.
	x_vec	Vector with coordinates
	v_vec	Vector with values
	tp_var_name	String with time variable name.
	dir_var_name	String with coordinate variable name.
	values_var_name	String with value variable name.
	errmsg	Used to store error messages.

Returns:

Returns 'true' if writing of output file was successful, or 'false' if not. If writing failed, an error message is written into the 'errmsg' string.

bool DELPHIN::write_1D_XY_tecplot_file	(	const std::string &	fname,
		const std::vector< double > &	timepoints,
		const std::vector< std::vector< double > > &	values,
		const std::string &	tp_var_name,
		const std::string &	values_var_name,
		std::string &	errmsg
	)

Writes a XY-Plot file : X = Time, Y = Values.

Parameters:

	fname	Full path to Tecplot output file.
	timepoints	Vector with num_t time points.
	values	Vector with num_t vectors with 1 value each
	tp_var_name	String with time variable name.
	values_var_name	String with value variable name.
	errmsg	Used to store error messages.

Returns:

Returns 'true' if writing of output file was successful, or 'false' if not. If writing failed, an error message is written into the 'errmsg' string.

bool DELPHIN::write_1D_joined_XY_tecplot_file	(	const std::string &	fname,
		const std::vector< double > &	timepoints,
		const std::vector< std::vector< double > > &	all_values,
		const std::string &	tp_var_name,
		const std::vector< std::string > &	values_var_names,
		std::string &	errmsg
	)

Writes a joined XY-Plot file : X = Time, Y1, Y2, .. YN = Values.

bool DELPHIN::write_1D_tecplot_field_file	(	const std::string &	fname,
		const std::vector< ElementGeometry > &	e_vec,
		const std::vector< int > &	nums,
		const std::vector< double > &	timepoints,
		const std::vector< std::vector< double > > &	values,
		const std::string &	tp_var_name,
		const std::string &	values_var_name,
		std::string &	errmsg
	)

Writes a TecPlot file in general format for elements (field output).

bool DELPHIN::write_1D_tecplot_flux_file	(	const std::string &	fname,
		const std::vector< SidesGeometry > &	s_vec,
		const std::vector< int > &	nums,
		const std::vector< double > &	timepoints,
		const std::vector< std::vector< double > > &	values,
		const std::string &	tp_var_name,
		const std::string &	values_var_name,
		std::string &	errmsg
	)

Writes a TecPlot file in general format for sides (flux output).

bool DELPHIN::write_1D_joined_tecplot_file	(	const std::string &	fname,
		const std::vector< ElementGeometry > &	e_vec,
		const std::vector< int > &	nums,
		const std::vector< double > &	timepoints,
		const std::vector< std::vector< std::vector< double > > > &	all_values,
		const std::string &	tp_var_name,
		const std::vector< std::string > &	values_var_names,
		std::string &	errmsg
	)

Writes a TecPlot file similar to write_1D_tecplot_file() but writes multiply quantities into the same file.

bool DELPHIN::write_1D_tecplot_surface_plot_file	(	const std::string &	fname,
		const std::vector< ElementGeometry > &	e_vec,
		const std::vector< int > &	nums,
		const std::vector< double > &	timepoints,
		const std::vector< std::vector< double > > &	values,
		const std::string &	tp_var_name,
		const std::string &	values_var_name,
		bool	binary,
		std::string &	errmsg
	)

bool DELPHIN::write_2D_tecplot_field_file	(	const std::string &	fname,
		const Delphin5OutputData &	data,
		const std::string &	tp_var_name,
		const std::string &	values_var_name,
		bool	binary,
		std::string &	errmsg
	)

Writes a 2D TecPlot field output file using a quadrilateral FE grid.

bool DELPHIN::write_2D_vector_tecplot_file	(	const std::string &	fname,
		const Delphin5OutputData &	data,
		const std::string &	tp_var_name,
		const std::string &	values_var_name,
		bool	binary,
		std::string &	errmsg
	)

Writes a 2D TecPlot flux output file (for transient 2D vector plot).

bool DELPHIN::create_geometry_lines	(	const std::vector< MaterialDef > &	mat_vec,
		const Grid &	grid,
		const std::vector< ElementGeometry > &	e_vec,
		std::vector< LineData > &	linevec,
		std::vector< LineData > &	boundaryvec,
		std::vector< std::vector< int > >	mat,
		std::string &	errmsg
	)

Fills two vectors with geometry information about the structure and the boundaries of the structure.

bool DELPHIN::write_geometry_file	(	const std::string &	fname,
		const std::vector< LineData > &	linevec
	)

Writes a TecPlot geometry file containing the geometry of the structure including all internal boundaries.

bool DELPHIN::write_boundary_zone_file	(	const std::string &	fname,
		const std::vector< LineData > &	boundaryvec
	)

Writes a TecPlot geometry file containing the structure boundary geometry.