LPFluidCode/particle__viewer_8h_source.html

 #ifndef __PARTICLE_VIEWER_H__

 #define __PARTICLE_VIEWER_H__


 #include <cstddef>

 #include <string>


 class ParticleData;


 class ParticleViewer {


 public:

     virtual int writeResult(double time, std::size_t writeStep) = 0;


 protected:

     ParticleData* m_pParticleData;

     std::string m_sOutputfileName;

     int m_iNumDigits;

     std::string m_sParticleType;


     std::string rightFlush(std::size_t writeStep, std::size_t numDigits);


 };


 class VTKParticleViewer : public ParticleViewer {


 public:

     VTKParticleViewer(ParticleData* data, const std::string& particleType, const std::string& outputfileName="", int numDigits=7);


     virtual int writeResult(double time, std::size_t writeStep);


 };


 class TXTParticleViewer1D : public ParticleViewer {


 public:

     TXTParticleViewer1D(ParticleData* data, const std::string& particleType, const std::string& outputfileName="", int numDigits=7);


     virtual int writeResult(double time, std::size_t writeStep);


 };


 #endif // __PARTICLE_VIEWER_H__

ParticleViewer::m_sParticleType
std::string m_sParticleType
The type of particle data to output (all, fluid, boundary, etc)
Definition: particle_viewer.h:62

ParticleViewer::m_pParticleData
ParticleData * m_pParticleData
A pointer to the object which holds particle information and data.
Definition: particle_viewer.h:59

VTKParticleViewer
A class that output simulation results in the .vtk format.
Definition: particle_viewer.h:93

ParticleViewer::rightFlush
std::string rightFlush(std::size_t writeStep, std::size_t numDigits)
A small helper function that organizes the format of output filename.
Definition: particle_viewer.cpp:16

ParticleViewer
An abstract class for classes that output simulations results.
Definition: particle_viewer.h:47

TXTParticleViewer1D::writeResult
virtual int writeResult(double time, std::size_t writeStep)
Write 1D simulation results to the output file in the .txt format.
Definition: particle_viewer.cpp:291

VTKParticleViewer::VTKParticleViewer
VTKParticleViewer(ParticleData *data, const std::string &particleType, const std::string &outputfileName="", int numDigits=7)
Constructor.
Definition: particle_viewer.cpp:48

VTKParticleViewer::writeResult
virtual int writeResult(double time, std::size_t writeStep)
Write simulation results to the output file in the .vtk format.
Definition: particle_viewer.cpp:57

TXTParticleViewer1D
A class that output 1D simulation results in the .txt format.
Definition: particle_viewer.h:139

ParticleViewer::m_iNumDigits
int m_iNumDigits
The number of digits for the indexing of output file name.
Definition: particle_viewer.h:61

ParticleViewer::writeResult
virtual int writeResult(double time, std::size_t writeStep)=0
Write simulation results to the output file.

ParticleData
A class that stores all information and data of particles, such as x, y, and z coordinates, neighbour lists, and bounding boxes.
Definition: particle_data.h:51

TXTParticleViewer1D::TXTParticleViewer1D
TXTParticleViewer1D(ParticleData *data, const std::string &particleType, const std::string &outputfileName="", int numDigits=7)
Constructor.
Definition: particle_viewer.cpp:282

ParticleViewer::m_sOutputfileName
std::string m_sOutputfileName
The name of the output file.
Definition: particle_viewer.h:60