DecompWriter Class Reference

writes out information about decomposition of the simulation domain. More...

#include <DecompWriter.h>

Inheritance diagram for DecompWriter:

Public Member Functions
void	readXML (XMLfileUnits &xmlconfig)
	Read in XML configuration for DecompWriter. More...
void	init (ParticleContainer *particleContainer, DomainDecompBase *domainDecomp, Domain *domain)
void	endStep (ParticleContainer *particleContainer, DomainDecompBase *domainDecomp, Domain *domain, unsigned long simstep)
void	finish (ParticleContainer *particleContainer, DomainDecompBase *domainDecomp, Domain *domain)
std::string	getPluginName ()
	return the name of the plugin 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

writes out information about decomposition of the simulation domain.

Writes out decomposition information. The data written to the file depend on the used domain decomposition.

Member Function Documentation

endStep()

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

virtual

Todo:

comment

Implements PluginBase.

finish()

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

virtual

Todo:

comment

Implements PluginBase.

getPluginName()

std::string DecompWriter::getPluginName ( )

inlinevirtual

return the name of the plugin

Implements PluginBase.

init()

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

virtual

Todo:

comment

Implements PluginBase.

readXML()

void DecompWriter::readXML ( XMLfileUnits &  xmlconfig )

virtual

Read in XML configuration for DecompWriter.

The following xml object structure is handled by this method:

<outputplugin name="DecompWriter">
  <writefrequency>INTEGER</writefrequency>
  <outputprefix>STRING</outputprefix>
  <incremental>INTEGER</incremental>
  <appendTimestamp>INTEGER</appendTimestamp>
</outputplugin>

Implements PluginBase.

---

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

• src/io/DecompWriter.h
• src/io/DecompWriter.cpp