molsim/docs/VTKWriter_8h_source.html

#pragma once


#include "FileWriter.h"

#include "io/vtk/vtk-unstructured.h"

#include "objects/Particle.h"

#include <string>


class VTKWriter : public FileWriter {

  private:

    VTKFile_t *m_vtkFile;

    std::string m_basename = "MD_vtk";

    std::string m_dirname = "vtk";


    void initializeOutput(int numParticles);


    void writeFile(int iteration, int total);


    void plotParticle(const Particle &p);


  public:

    VTKWriter();


    explicit VTKWriter(const std::string &basename);


    VTKWriter(const std::string &basename, const std::string &dirname);


    virtual ~VTKWriter();


    void writeParticles(const ParticleContainer &particles, int iteration, int total) override;

};


FileWriter.h
General class used to strictly write particle data to some output file. data.

Particle.h
Model of a single particle.

FileWriter
Superclass which implements functionality to output data to a file on disk.
Definition FileWriter.h:16

ParticleContainer
Class for encapsulating multiple Particle objects..
Definition ParticleContainer.h:17

Particle
Particle class modeling a particle's position, velocity, force, mass and type.
Definition Particle.h:46

VTKFile_t
Class corresponding to the VTKFile_t schema type.
Definition vtk-unstructured.h:1771

VTKWriter
Class which implements functionality to generate VTK output from particles.
Definition VTKWriter.h:19

VTKWriter::VTKWriter
VTKWriter(const std::string &basename, const std::string &dirname)
Creates a new VTKWriter with the given basename for future file outputs in the specified directory.

VTKWriter::VTKWriter
VTKWriter(const std::string &basename)
Creates a new VTKWriter with the given basename for future file outputs.

VTKWriter::writeFile
void writeFile(int iteration, int total)
Writes the contents of m_vtkFile into a given VTK file. Terminates program execution on error.

VTKWriter::m_vtkFile
VTKFile_t * m_vtkFile
The VTK file instance containing particle data.
Definition VTKWriter.h:22

VTKWriter::initializeOutput
void initializeOutput(int numParticles)
Initializes m_vtkFile with necessary metadata for writing purposes. Terminates program execution on e...

VTKWriter::writeParticles
void writeParticles(const ParticleContainer &particles, int iteration, int total) override
Writes the type, mass, position, velocity and force of a ParticleContainer to a VTK file....

VTKWriter::m_basename
std::string m_basename
The base name of the generated files.
Definition VTKWriter.h:24

VTKWriter::plotParticle
void plotParticle(const Particle &p)
Plots a single particle to m_vtkFile. Terminates program execution on error.

VTKWriter::m_dirname
std::string m_dirname
The name of the directory in which to store the generated files.
Definition VTKWriter.h:26

VTKWriter::VTKWriter
VTKWriter()
Creates a new uninitialized VTKWriter.

VTKWriter::~VTKWriter
virtual ~VTKWriter()
Destroys the current VTKWriter object.

vtk-unstructured.h
Generated from vtk-unstructured.xsd.