VTKMoleculeWriter Class Reference

#include <VTKMoleculeWriter.h>

Inheritance diagram for VTKMoleculeWriter:

Public Member Functions
	VTKMoleculeWriter (unsigned int frequency, std::string name)
virtual void	init (ParticleContainer *particleContainer, DomainDecompBase *domainDecomp, Domain *domain)
	NOP. More...
virtual void	endStep (ParticleContainer *particleContainer, DomainDecompBase *domainDecomp, Domain *domain, unsigned long simstep)
virtual void	finish (ParticleContainer *particleContainer, DomainDecompBase *domainDecomp, Domain *domain)
	NOP. More...
std::string	getPluginName ()
	return the name of the plugin More...
void	readXML (XMLfileUnits &xmlconfig)
	Method readXML will be called once for each plugin section in the input file. More...
Public Member Functions inherited from PluginBase
	PluginBase ()
	Subclasses should use their constructur to pass parameters (e.g. filenames)
virtual void	beforeEventNewTimestep (ParticleContainer *particleContainer, DomainDecompBase *domainDecomp, unsigned long simstep)
	Method will be called first thing in a new timestep. More...
virtual void	beforeForces (ParticleContainer *particleContainer, DomainDecompBase *domainDecomp, unsigned long simstep)
	Method beforeForces will be called before forcefields have been applied no alterations w.r.t. Forces shall be made here. More...
virtual void	siteWiseForces (ParticleContainer *particleContainer, DomainDecompBase *domainDecomp, unsigned long simstep)
	Method siteWiseForces will be called before forcefields have been applied alterations to sitewise forces and fullMolecule forces can be made here. More...
virtual void	afterForces (ParticleContainer *particleContainer, DomainDecompBase *domainDecomp, unsigned long simstep)
	Method afterForces will be called after forcefields have been applied no sitewise Forces can be applied here. More...
virtual void	registerCallbacks (std::map< std::string, FunctionWrapper > &callbackMap)
virtual void	accessAllCallbacks (const std::map< std::string, FunctionWrapper > &callbackMap)

Static Public Member Functions
static PluginBase *	createInstance ()

Detailed Description

This class is an implementation of the OutputBase for the VTK file format.

@TODO Think about a way how to handle the setup of particleConainers, Domain, etc... Maybe some kind of factory?

Member Function Documentation

endStep()

void VTKMoleculeWriter::endStep ( ParticleContainer *  particleContainer, DomainDecompBase *  domainDecomp, Domain *  domain, unsigned long  simstep  )

virtual

Todo:

document me!

Implements PluginBase.

finish()

void VTKMoleculeWriter::finish ( ParticleContainer *  particleContainer, DomainDecompBase *  domainDecomp, Domain *  domain  )

virtual

NOP.

Todo:

document me!

Implements PluginBase.

getPluginName()

std::string VTKMoleculeWriter::getPluginName ( )

inlinevirtual

return the name of the plugin

Implements PluginBase.

init()

void VTKMoleculeWriter::init ( ParticleContainer *  particleContainer, DomainDecompBase *  domainDecomp, Domain *  domain  )

virtual

NOP.

Todo:

document me!

Implements PluginBase.

readXML()

void VTKMoleculeWriter::readXML ( XMLfileUnits &  xmlconfig )

virtual

Method readXML will be called once for each plugin section in the input file.

This method can be used to read in parameters from the corresponding plugin section in the xml config file. The method will be called once after an instance of the plugin is created.

Note

The same plugins may be specified multiple times in the xml config file. It is the responsibility of the plugin to handle this case in a propper way.

The following xml object structure will be provided to the plugin:

<plugin name="plugin name">
  <!-- options for the specific plugin -->
</plugin>

Parameters

xmlconfig

section of the xml file

Implements PluginBase.

---

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

• src/io/vtk/VTKMoleculeWriter.h
• src/io/vtk/VTKMoleculeWriter.cpp