Lagrangian Particle Code for The Simulation of 2D/3D Fluid Dynamics
 All Classes Files Functions Variables Typedefs Friends Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ParticleViewer Class Referenceabstract

An abstract class for classes that output simulations results. More...

#include <particle_viewer.h>

Inheritance diagram for ParticleViewer:
TXTParticleViewer1D VTKParticleViewer

Public Member Functions

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

Protected Member Functions

std::string rightFlush (std::size_t writeStep, std::size_t numDigits)
 A small helper function that organizes the format of output filename. More...
 

Protected Attributes

ParticleDatam_pParticleData
 A pointer to the object which holds particle information and data.
 
std::string m_sOutputfileName
 The name of the output file.
 
int m_iNumDigits
 The number of digits for the indexing of output file name.
 
std::string m_sParticleType
 The type of particle data to output (all, fluid, boundary, etc)
 

Detailed Description

An abstract class for classes that output simulations results.

Author
Chen, Hsin-Chiang (morri.nosp@m.sche.nosp@m.n2008.nosp@m.@gma.nosp@m.il.co.nosp@m.m)

Co-author: Yu, Kwangmin (yukwa.nosp@m.ngmi.nosp@m.n@gma.nosp@m.il.c.nosp@m.om) on initial interface and data structure design

Version
1.0
Date
2014/07/12

Created on: 2014/05/23

Member Function Documentation

string ParticleViewer::rightFlush ( std::size_t  writeStep,
std::size_t  numDigits 
)
protected

A small helper function that organizes the format of output filename.

Parameters
[in]writeStepThe number of times of output
[in]numDigitsThe number of digits for the indexing of output file name
virtual int ParticleViewer::writeResult ( double  time,
std::size_t  writeStep 
)
pure virtual

Write simulation results to the output file.

Parameters
[in]timeThe physical output time
[in]writeStepThe number of times of output
Returns
0 if output success; 1 otherwise

Implemented in TXTParticleViewer1D, and VTKParticleViewer.


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