rw::writer::MshWriter Class Reference

A .msh writer for simple point data and complex fem mesh data. More...

#include <mshWriter.h>

Collaboration diagram for rw::writer::MshWriter:

Public Member Functions
	MshWriter (const std::string &filename, const std::string &compress_type="")
	Constructor.
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 Member Functions
void	writeMshDataHeader (const std::string &name, int field_type, size_t num_data, bool is_node_data=true)
	utility function

Private Attributes
std::string	d_filename
	filename
std::string	d_compressType
	compression_type Specify the compressor (if any)
FILE *	d_file
	msh file

Detailed Description

A .msh writer for simple point data and complex fem mesh data.

We are using Gmsh 2.0 format.

Definition at line 29 of file mshWriter.h.

Constructor & Destructor Documentation

MshWriter()

rw::writer::MshWriter::MshWriter ( const std::string &  filename, const std::string &  compress_type = ""  )

explicit

Constructor.

Writes mesh data in .msh format

Parameters

filename	Name of file which will be created
compress_type	Compression method (optional)

Definition at line 22 of file mshWriter.cpp.

    : d_compressType(compress_type), d_file(nullptr) {
  d_filename = util::io::checkAndCreateNewFilename(filename, "msh");
}

References util::io::checkAndCreateNewFilename(), and d_filename.

Here is the call graph for this function:

Member Function Documentation

addTimeStep()

void rw::writer::MshWriter::addTimeStep

(

const double &

timestep

)

Writes the time step to the file.

Parameters

timestep

Current time step of the simulation

Definition at line 228 of file mshWriter.cpp.

                                                          {
  // we add field data as node data
 
  // Write metadata
  writeMshDataHeader("time", 1, 1, true);
  fprintf(d_file, "1 %lf\n", timestep);
  fprintf(d_file, "$EndNodeData\n");
}

appendCellData() [1/2]

void rw::writer::MshWriter::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 205 of file mshWriter.cpp.

                                                                         {
  // Write metadata
  writeMshDataHeader(name, 1, data->size(), false);
  for (size_t i=0; i < data->size(); i++) {
    double d = (*data)[i];
    fprintf(d_file, "%zu %lf\n", i + 1, d);
  }
  fprintf(d_file, "$EndElementData\n");
}

appendCellData() [2/2]

void rw::writer::MshWriter::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 216 of file mshWriter.cpp.

                                                                  {
  // Write metadata
  writeMshDataHeader(name, 6, data->size(), false);
  for (size_t i=0; i < data->size(); i++) {
    auto d = (*data)[i];
    fprintf(d_file, "%zu %lf %lf %lf %lf %lf %lf\n", i + 1, d(0,0), d(1,1),
            d(2,2), d(1,2), d(0,2), d(0,1));
  }
  fprintf(d_file, "$EndElementData\n");
}

appendFieldData() [1/2]

void rw::writer::MshWriter::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 244 of file mshWriter.cpp.

                                                                {
  // we add field data as node data
 
  // Write metadata
  writeMshDataHeader(name, 1, 1, true);
  fprintf(d_file, "1 %lf\n", data);
  fprintf(d_file, "$EndNodeData\n");
}

appendFieldData() [2/2]

void rw::writer::MshWriter::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 254 of file mshWriter.cpp.

                                                               {
  // we add field data as node data
 
  // Write metadata
  writeMshDataHeader(name, 1, 1, true);
  fprintf(d_file, "1 %lf\n", data);
  fprintf(d_file, "$EndNodeData\n");
}

appendMesh()

void rw::writer::MshWriter::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 94 of file mshWriter.cpp.

                                   {
 
  appendNodes(nodes, u);
 
  // get mesh information
  size_t num_vertex = util::vtk_map_element_to_num_nodes[element_type];
  size_t num_elems = en_con->size() / num_vertex;
  size_t msh_element_type = util::vtk_to_msh_element_type_map[element_type];
 
  // write the connectivity
  fprintf(d_file, "$Elements\n");
  fprintf(d_file, "%zu\n", num_elems);
 
  // loop over the elements
  for (size_t e=0; e < num_elems; e++) {
 
    // elements ids are 1 based in Gmsh
    fprintf(d_file, "%zu %zu 2 0 6 ", e+1, msh_element_type);
 
    // write ids of node (numbering starts with 1)
    for (size_t v=0; v<num_vertex; v++)
      fprintf(d_file, "%zu ", (*en_con)[e * num_vertex + v] + 1);
 
    fprintf(d_file, "\n");
  } // element loop
  fprintf(d_file, "$EndElements\n");
}

References util::vtk_map_element_to_num_nodes, and util::vtk_to_msh_element_type_map.

appendNodes()

void rw::writer::MshWriter::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 60 of file mshWriter.cpp.

                                                                       {
 
  // open file stream
  if (!d_file)
    d_file = fopen(d_filename.c_str(), "w");
 
  if (!d_file) {
    throw std::runtime_error(
        util::io::Msg()
        << "Error: Can not open file = " << d_filename  <<".\n");
  }
 
  // Write the file header.
  fprintf(d_file, "$MeshFormat\n");
  fprintf(d_file, "2.0 0 %zu\n", sizeof(double));
  fprintf(d_file, "$EndMeshFormat\n");
 
  // get mesh information
  size_t num_nodes = nodes->size();
 
  // write the nodes in (n x y z) format
  fprintf(d_file, "$Nodes\n");
  fprintf(d_file, "%zu\n", num_nodes);
 
  for (size_t i=0; i < num_nodes; i++) {
    auto p = (*nodes)[i];
    if (u)
      p = p + (*u)[i];
    fprintf(d_file, "%zu %lf %lf %lf\n", i + 1, p.d_x, p.d_y, p.d_z);
  }
  fprintf(d_file, "$EndNodes\n");
}

appendPointData() [1/7]

void rw::writer::MshWriter::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 171 of file mshWriter.cpp.

                                                                           {
  // Write metadata
  writeMshDataHeader(name, 1, data->size(), true);
  for (size_t i=0; i < data->size(); i++) {
    double d = (*data)[i];
    fprintf(d_file, "%zu %lf\n", i + 1, d);
  }
  fprintf(d_file, "$EndNodeData\n");
}

appendPointData() [2/7]

void rw::writer::MshWriter::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 160 of file mshWriter.cpp.

                                                                          {
  // Write metadata
  writeMshDataHeader(name, 1, data->size(), true);
  for (size_t i=0; i < data->size(); i++) {
    double d = (*data)[i];
    fprintf(d_file, "%zu %lf\n", i + 1, d);
  }
  fprintf(d_file, "$EndNodeData\n");
}

appendPointData() [3/7]

void rw::writer::MshWriter::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 149 of file mshWriter.cpp.

                                                                        {
  // Write metadata
  writeMshDataHeader(name, 1, data->size(), true);
  for (size_t i=0; i < data->size(); i++) {
    double d = (*data)[i];
    fprintf(d_file, "%zu %lf\n", i + 1, d);
  }
  fprintf(d_file, "$EndNodeData\n");
}

appendPointData() [4/7]

void rw::writer::MshWriter::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 137 of file mshWriter.cpp.

                                                                           {
 
  // Write metadata
  writeMshDataHeader(name, 1, data->size(), true);
  for (size_t i=0; i < data->size(); i++) {
    double d = (*data)[i];
    fprintf(d_file, "%zu %lf\n", i + 1, d);
  }
  fprintf(d_file, "$EndNodeData\n");
}

appendPointData() [5/7]

void rw::writer::MshWriter::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 125 of file mshWriter.cpp.

                                                                            {
 
  // Write metadata
  writeMshDataHeader(name, 1, data->size(), true);
  for (size_t i=0; i < data->size(); i++) {
    double d = (*data)[i];
    fprintf(d_file, "%zu %lf\n", i + 1, d);
  }
  fprintf(d_file, "$EndNodeData\n");
}

appendPointData() [6/7]

void rw::writer::MshWriter::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 182 of file mshWriter.cpp.

                                                             {
  // Write metadata
  writeMshDataHeader(name, 3, data->size(), true);
  for (size_t i=0; i < data->size(); i++) {
    auto d = (*data)[i];
    fprintf(d_file, "%zu %lf %lf %lf\n", i + 1, d.d_x, d.d_y, d.d_z);
  }
  fprintf(d_file, "$EndNodeData\n");
}

appendPointData() [7/7]

void rw::writer::MshWriter::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 193 of file mshWriter.cpp.

                                                                  {
  // Write metadata
  writeMshDataHeader(name, 6, data->size(), true);
  for (size_t i=0; i < data->size(); i++) {
    auto d = (*data)[i];
    fprintf(d_file, "%zu %lf %lf %lf %lf %lf %lf\n", i + 1, d(0,0), d(1,1),
            d(2,2), d(1,2), d(0,2), d(0,1));
  }
  fprintf(d_file, "$EndNodeData\n");
}

close()

void rw::writer::MshWriter::close

(

)

Closes the file and store it to the hard disk.

Definition at line 237 of file mshWriter.cpp.

                              {
  ntag = 0;
  etag = 0;
  d_filename.clear();
  fclose(d_file);
}

References etag, and ntag.

writeMshDataHeader()

void rw::writer::MshWriter::writeMshDataHeader ( const std::string &  name, int  field_type, size_t  num_data, bool  is_node_data = true  )

private

utility function

field_type:

• 1 - scalar with 1 component
• 2 - vector with 2 component
• 3 - vector with 3 component
• 6 - symmetric tensor with 6 component

Parameters

name	Name of data
field_type	Field type (see above)
num_data	Number of data
is_node_data	Indicate if this is Node or Element data

Definition at line 28 of file mshWriter.cpp.

                             {
 
  // Write metadata
  if (is_node_data)
    fprintf(d_file, "$NodeData\n");
  else
    fprintf(d_file, "$ElementData\n");
 
  // number of string the data name has (int)
  fprintf(d_file, "1\n");
 
  // name of data (string)
  fprintf(d_file, "\"%s\"\n", name.c_str());
 
  // default (number of real number tags) (int and double)
  fprintf(d_file, "1 \n");
  fprintf(d_file, "1.0 \n");
 
  // three tags in integer (ints)
  fprintf(d_file, "3 \n");
  if (is_node_data) {
    fprintf(d_file, "%d\n", ntag);
    ntag++;
  } else {
    fprintf(d_file, "%d\n", etag);
    etag++;
  }
  fprintf(d_file, "%d\n", field_type);
  fprintf(d_file, "%d\n", int(num_data));
}

References etag, and ntag.

Field Documentation

d_compressType

std::string rw::writer::MshWriter::d_compressType

private

compression_type Specify the compressor (if any)

Definition at line 207 of file mshWriter.h.

d_file

FILE* rw::writer::MshWriter::d_file

private

msh file

Definition at line 210 of file mshWriter.h.

d_filename

std::string rw::writer::MshWriter::d_filename

private

filename

Definition at line 204 of file mshWriter.h.

Referenced by MshWriter().

---

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

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