rw::writer::Writer Class Reference

A interface class writing data. More...

#include <writer.h>

Collaboration diagram for rw::writer::Writer:

Public Member Functions
	Writer ()
	Constructor.
	Writer (const std::string &filename, const std::string &format="vtu", const std::string &compress_type="")
	Constructor.
	~Writer ()
	Destructor.
void	open (const std::string &filename, const std::string &format="vtu", const std::string &compress_type="")
	Open a .vtu file.
void	close ()
	Closes the file and store it to the hard disk.
Mesh data
void	appendNodes (const std::vector< util::Point > *nodes, const std::vector< util::Point > *u=nullptr)
	Writes the nodes to the file.
void	appendMesh (const std::vector< util::Point > *nodes, const size_t &element_type, const std::vector< size_t > *en_con, const std::vector< util::Point > *u=nullptr)
	Writes the mesh data to file.
Point data
void	appendPointData (const std::string &name, const std::vector< uint8_t > *data)
	Writes the scalar point data to the file.
void	appendPointData (const std::string &name, const std::vector< size_t > *data)
	Writes the scalar point data to the file.
void	appendPointData (const std::string &name, const std::vector< int > *data)
	Writes the scalar point data to the file.
void	appendPointData (const std::string &name, const std::vector< float > *data)
	Writes the scalar point data to the file.
void	appendPointData (const std::string &name, const std::vector< double > *data)
	Writes the scalar point data to the file.
void	appendPointData (const std::string &name, const std::vector< util::Point > *data)
	Writes the vector point data to the file.
void	appendPointData (const std::string &name, const std::vector< util::SymMatrix3 > *data)
	Writes the symmetric matrix data associated to nodes to the file.
Cell data
void	appendCellData (const std::string &name, const std::vector< float > *data)
	Writes the float data associated to cells to the file.
void	appendCellData (const std::string &name, const std::vector< util::SymMatrix3 > *data)
	Writes the symmetric matrix data associated to cells to the file.
Field data
void	appendFieldData (const std::string &name, const double &data)
	Writes the scalar field data to the file.
void	appendFieldData (const std::string &name, const float &data)
	Writes the scalar field data to the file.
void	addTimeStep (const double &timestep)
	Writes the time step to the file.

Private Attributes
rw::writer::VtkWriter *	d_vtkWriter_p
	Pointer to the vtk writer class.
rw::writer::LegacyVtkWriter *	d_legacyVtkWriter_p
	Pointer to the vtk writer class.
rw::writer::MshWriter *	d_mshWriter_p
	Pointer to the vtk writer class.
std::string	d_format
	Format of output file.

Detailed Description

A interface class writing data.

This interface separates the caller from vtk library.

Definition at line 44 of file writer.h.

Constructor & Destructor Documentation

Writer() [1/2]

rw::writer::Writer::Writer

(

)

Constructor.

Definition at line 18 of file writer.cpp.

    : d_vtkWriter_p(nullptr), d_legacyVtkWriter_p(nullptr),
      d_mshWriter_p(nullptr), d_format("vtu") {}

Writer() [2/2]

rw::writer::Writer::Writer ( const std::string &  filename, const std::string &  format = "vtu", const std::string &  compress_type = ""  )

explicit

Constructor.

Creates and opens .vtu file of name given by filename. The file remains open till the close() function is invoked or if the instance of this class is destroyed.

Parameters

filename	Name of file which will be created
format	Format of the output file, e.g. "vtu", "msh"
compress_type	Specify the compression type (optional)

Definition at line 22 of file writer.cpp.

    : d_vtkWriter_p(nullptr), d_legacyVtkWriter_p(nullptr),
      d_mshWriter_p(nullptr), d_format("vtu") {
  open(filename, format, compress_type);
}

References open().

Here is the call graph for this function:

~Writer()

rw::writer::Writer::~Writer

(

)

Destructor.

Definition at line 48 of file writer.cpp.

                        {
  delete (d_vtkWriter_p);
}

Member Function Documentation

addTimeStep()

void rw::writer::Writer::addTimeStep

(

const double &

timestep

)

Writes the time step to the file.

Parameters

timestep

Current time step of the simulation

Definition at line 175 of file writer.cpp.

                                                       {
 
  if (d_format == "vtu")
    d_vtkWriter_p->addTimeStep(timestep);
  else if (d_format == "msh")
    d_mshWriter_p->addTimeStep(timestep);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->addTimeStep(timestep);
}

appendCellData() [1/2]

void rw::writer::Writer::appendCellData	(	const std::string &	name,
		const std::vector< float > *	data
	)

Writes the float data associated to cells to the file.

Parameters

name	Name of the data
data	Vector containing the data

Definition at line 153 of file writer.cpp.

                                                         {
 
  if (d_format == "vtu")
    d_vtkWriter_p->appendCellData(name, data);
  else if (d_format == "msh")
    d_mshWriter_p->appendCellData(name, data);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->appendCellData(name, data);
}

appendCellData() [2/2]

void rw::writer::Writer::appendCellData	(	const std::string &	name,
		const std::vector< util::SymMatrix3 > *	data
	)

Writes the symmetric matrix data associated to cells to the file.

Parameters

name	Name of the data
data	Vector containing the data

Definition at line 164 of file writer.cpp.

                                                                  {
 
  if (d_format == "vtu")
    d_vtkWriter_p->appendCellData(name, data);
  else if (d_format == "msh")
    d_mshWriter_p->appendCellData(name, data);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->appendCellData(name, data);
}

appendFieldData() [1/2]

void rw::writer::Writer::appendFieldData	(	const std::string &	name,
		const double &	data
	)

Writes the scalar field data to the file.

Parameters

name	Name of the data
data	Value

Definition at line 185 of file writer.cpp.

                                                             {
 
  if (d_format == "vtu")
    d_vtkWriter_p->appendFieldData(name, data);
  else if (d_format == "msh")
    d_mshWriter_p->appendFieldData(name, data);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->appendFieldData(name, data);
}

appendFieldData() [2/2]

void rw::writer::Writer::appendFieldData	(	const std::string &	name,
		const float &	data
	)

Writes the scalar field data to the file.

Parameters

name	Name of the data
data	Value

Definition at line 196 of file writer.cpp.

                                                            {
 
  if (d_format == "vtu")
    d_vtkWriter_p->appendFieldData(name, data);
  else if (d_format == "msh")
    d_mshWriter_p->appendFieldData(name, data);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->appendFieldData(name, data);
}

appendMesh()

void rw::writer::Writer::appendMesh	(	const std::vector< util::Point > *	nodes,
		const size_t &	element_type,
		const std::vector< size_t > *	en_con,
		const std::vector< util::Point > *	u = nullptr
	)

Writes the mesh data to file.

Parameters

nodes	Vector of nodal coordinates
element_type	Type of element
en_con	Vector of element-node connectivity
u	Vector of nodal displacement

Definition at line 64 of file writer.cpp.

                                                                    {
 
  if (d_format == "vtu")
    d_vtkWriter_p->appendMesh(nodes, element_type, en_con, u);
  else if (d_format == "msh")
    d_mshWriter_p->appendMesh(nodes, element_type, en_con, u);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->appendMesh(nodes, element_type, en_con, u);
}

Referenced by anonymous_namespace{particleMesh.cpp}::maybeWriteMeshFile().

Here is the caller graph for this function:

appendNodes()

void rw::writer::Writer::appendNodes	(	const std::vector< util::Point > *	nodes,
		const std::vector< util::Point > *	u = nullptr
	)

Writes the nodes to the file.

Parameters

nodes	Reference positions of the nodes
u	Nodal displacements

Definition at line 52 of file writer.cpp.

                                   {
 
  if (d_format == "vtu")
    d_vtkWriter_p->appendNodes(nodes, u);
  else if (d_format == "msh")
    d_mshWriter_p->appendNodes(nodes, u);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->appendNodes(nodes, u);
}

appendPointData() [1/7]

void rw::writer::Writer::appendPointData	(	const std::string &	name,
		const std::vector< double > *	data
	)

Writes the scalar point data to the file.

Parameters

name	Name of the data
data	Vector containing the data

Definition at line 120 of file writer.cpp.

                                                          {
 
  if (d_format == "vtu")
    d_vtkWriter_p->appendPointData(name, data);
  else if (d_format == "msh")
    d_mshWriter_p->appendPointData(name, data);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->appendPointData(name, data);
}

appendPointData() [2/7]

void rw::writer::Writer::appendPointData	(	const std::string &	name,
		const std::vector< float > *	data
	)

Writes the scalar point data to the file.

Parameters

name	Name of the data
data	Vector containing the data

Definition at line 109 of file writer.cpp.

                                                         {
 
  if (d_format == "vtu")
    d_vtkWriter_p->appendPointData(name, data);
  else if (d_format == "msh")
    d_mshWriter_p->appendPointData(name, data);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->appendPointData(name, data);
}

appendPointData() [3/7]

void rw::writer::Writer::appendPointData	(	const std::string &	name,
		const std::vector< int > *	data
	)

Writes the scalar point data to the file.

Parameters

name	Name of the data
data	Vector containing the data

Definition at line 98 of file writer.cpp.

                                                       {
 
  if (d_format == "vtu")
    d_vtkWriter_p->appendPointData(name, data);
  else if (d_format == "msh")
    d_mshWriter_p->appendPointData(name, data);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->appendPointData(name, data);
}

appendPointData() [4/7]

void rw::writer::Writer::appendPointData	(	const std::string &	name,
		const std::vector< size_t > *	data
	)

Writes the scalar point data to the file.

Parameters

name	Name of the data
data	Vector containing the data

Definition at line 87 of file writer.cpp.

                                                          {
 
  if (d_format == "vtu")
    d_vtkWriter_p->appendPointData(name, data);
  else if (d_format == "msh")
    d_mshWriter_p->appendPointData(name, data);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->appendPointData(name, data);
}

appendPointData() [5/7]

void rw::writer::Writer::appendPointData	(	const std::string &	name,
		const std::vector< uint8_t > *	data
	)

Writes the scalar point data to the file.

Parameters

name	Name of the data
data	Vector containing the data

Definition at line 76 of file writer.cpp.

                                                           {
 
  if (d_format == "vtu")
    d_vtkWriter_p->appendPointData(name, data);
  else if (d_format == "msh")
    d_mshWriter_p->appendPointData(name, data);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->appendPointData(name, data);
}

appendPointData() [6/7]

void rw::writer::Writer::appendPointData	(	const std::string &	name,
		const std::vector< util::Point > *	data
	)

Writes the vector point data to the file.

Parameters

name	Name of the data
data	Vector containing the data

Definition at line 131 of file writer.cpp.

                                                             {
 
  if (d_format == "vtu")
    d_vtkWriter_p->appendPointData(name, data);
  else if (d_format == "msh")
    d_mshWriter_p->appendPointData(name, data);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->appendPointData(name, data);
}

appendPointData() [7/7]

void rw::writer::Writer::appendPointData	(	const std::string &	name,
		const std::vector< util::SymMatrix3 > *	data
	)

Writes the symmetric matrix data associated to nodes to the file.

Parameters

name	Name of the data
data	Vector containing the data

Definition at line 142 of file writer.cpp.

                                                                  {
 
  if (d_format == "vtu")
    d_vtkWriter_p->appendPointData(name, data);
  else if (d_format == "msh")
    d_mshWriter_p->appendPointData(name, data);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->appendPointData(name, data);
}

close()

void rw::writer::Writer::close

(

)

Closes the file and store it to the hard disk.

Definition at line 207 of file writer.cpp.

                           {
 
  if (d_format == "vtu")
    d_vtkWriter_p->close();
  else if (d_format == "msh")
    d_mshWriter_p->close();
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p->close();
}

Referenced by anonymous_namespace{particleMesh.cpp}::maybeWriteMeshFile().

Here is the caller graph for this function:

open()

void rw::writer::Writer::open	(	const std::string &	filename,
		const std::string &	format = "vtu",
		const std::string &	compress_type = ""
	)

Open a .vtu file.

Parameters

filename	Name of file which will be created
format	Format of the output file, e.g. "vtu", "msh"
compress_type	Compression type (optional)

Definition at line 30 of file writer.cpp.

                                                              {
  d_format = format;
  if (d_format == "vtu")
    d_vtkWriter_p = new rw::writer::VtkWriter(filename, compress_type);
  else if (d_format == "msh")
    d_mshWriter_p = new rw::writer::MshWriter(filename, compress_type);
  else if (d_format == "legacy_vtk")
    d_legacyVtkWriter_p =
        new rw::writer::LegacyVtkWriter(filename, compress_type);
  else {
    throw std::runtime_error(
        util::io::Msg()
        << "File format " << d_format << " is not supported.\n");
  }
}

Referenced by Writer().

Here is the caller graph for this function:

Field Documentation

d_format

std::string rw::writer::Writer::d_format

private

Format of output file.

Definition at line 234 of file writer.h.

d_legacyVtkWriter_p

rw::writer::LegacyVtkWriter* rw::writer::Writer::d_legacyVtkWriter_p

private

Pointer to the vtk writer class.

Definition at line 228 of file writer.h.

d_mshWriter_p

rw::writer::MshWriter* rw::writer::Writer::d_mshWriter_p

private

Pointer to the vtk writer class.

Definition at line 231 of file writer.h.

d_vtkWriter_p

rw::writer::VtkWriter* rw::writer::Writer::d_vtkWriter_p

private

Pointer to the vtk writer class.

Definition at line 225 of file writer.h.

---

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

• /home/user/project/src/rw/writer.h
• /home/user/project/src/rw/writer.cpp