MaMiCo 1.2
Loading...
Searching...
No Matches
coupling::cellmappings::VTKMoleculePlotter< LinkedCell, dim > Class Template Reference

This class writes molecule data to streams for .vtk file. More...

#include <VTKMoleculePlotter.h>

Public Member Functions

 VTKMoleculePlotter (std::stringstream &moleculeVelocities, std::stringstream &moleculePositions, std::stringstream &moleculePotentials, const std::string &appendFloatZeros, coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface)
 
 ~VTKMoleculePlotter ()
 
void beginCellIteration ()
 
void endCellIteration ()
 
void handleCell (LinkedCell &cell)
 
const unsigned int & getParticleCounter () const
 

Private Attributes

coupling::interface::MDSolverInterface< LinkedCell, dim > *const _mdSolverInterface
 
std::stringstream & _moleculeVelocities
 
std::stringstream & _moleculePositions
 
std::stringstream & _moleculePotentials
 
const std::string & _appendFloatZeros
 
unsigned int _particleCounter
 

Detailed Description

template<class LinkedCell, unsigned int dim>
class coupling::cellmappings::VTKMoleculePlotter< LinkedCell, dim >

This class writes molecule data to streams for .vtk file.

Template Parameters
LinkedCellcell type
dimNumber of dimensions; it can be 1, 2 or 3
Author
Philipp Neumann

Constructor & Destructor Documentation

◆ VTKMoleculePlotter()

template<class LinkedCell, unsigned int dim>
coupling::cellmappings::VTKMoleculePlotter< LinkedCell, dim >::VTKMoleculePlotter ( std::stringstream & moleculeVelocities,
std::stringstream & moleculePositions,
std::stringstream & moleculePotentials,
const std::string & appendFloatZeros,
coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface )
inline

Constructor

Parameters
moleculeVelocities
moleculePositions
moleculePotentials
appendFloatZeros
mdSolverInterface

◆ ~VTKMoleculePlotter()

template<class LinkedCell, unsigned int dim>
coupling::cellmappings::VTKMoleculePlotter< LinkedCell, dim >::~VTKMoleculePlotter ( )
inline

Destructor

Member Function Documentation

◆ beginCellIteration()

template<class LinkedCell, unsigned int dim>
void coupling::cellmappings::VTKMoleculePlotter< LinkedCell, dim >::beginCellIteration ( )
inline

sets the particle counter to zero, before the iteration process begins.

◆ endCellIteration()

template<class LinkedCell, unsigned int dim>
void coupling::cellmappings::VTKMoleculePlotter< LinkedCell, dim >::endCellIteration ( )
inline

empty function

◆ getParticleCounter()

template<class LinkedCell, unsigned int dim>
const unsigned int & coupling::cellmappings::VTKMoleculePlotter< LinkedCell, dim >::getParticleCounter ( ) const
inline

returns number if the particles

Returns
_particleCounter

◆ handleCell()

template<class LinkedCell, unsigned int dim>
void coupling::cellmappings::VTKMoleculePlotter< LinkedCell, dim >::handleCell ( LinkedCell & cell)
inline

writes molecule data to the corresponding stringstreams.

Parameters
cell

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