InputBase Class Reference

interface for any kind of input class More...

#include <InputBase.h>

Inheritance diagram for InputBase:

Public Member Functions
virtual void	readPhaseSpaceHeader (Domain *domain, double timestep)=0
	read the phase space components and header information More...
virtual void	readXML (XMLfileUnits &)
virtual unsigned long	readPhaseSpace (ParticleContainer *particleContainer, Domain *domain, DomainDecompBase *domainDecomp)=0
	read the actual phase space information More...

Detailed Description

interface for any kind of input class

Todo:

more comment

Member Function Documentation

readPhaseSpace()

virtual unsigned long InputBase::readPhaseSpace ( ParticleContainer *  particleContainer, Domain *  domain, DomainDecompBase *  domainDecomp  )

pure virtual

read the actual phase space information

Returns

number of read in molecules added to the particle containers of all processes

Implemented in ASCIIReader, BinaryReader, CubicGridGeneratorInternal, MkesferaGenerator, MPI_IOReader, MultiObjectGenerator, ObjectGenerator, ReplicaGenerator, MkTcTSGenerator, and PerCellGenerator.

readPhaseSpaceHeader()

virtual void InputBase::readPhaseSpaceHeader ( Domain *  domain, double  timestep  )

pure virtual

read the phase space components and header information

Parameters

domain	pointer to domain object
timestep	timestep length

Implemented in CubicGridGeneratorInternal, MkesferaGenerator, MultiObjectGenerator, ObjectGenerator, ReplicaGenerator, ASCIIReader, BinaryReader, MPI_IOReader, MkTcTSGenerator, and PerCellGenerator.

readXML()

virtual void InputBase::readXML ( XMLfileUnits &  )

inlinevirtual

Reimplemented in CubicGridGeneratorInternal, MkesferaGenerator, MultiObjectGenerator, ObjectGenerator, ReplicaGenerator, MkTcTSGenerator, and PerCellGenerator.

---

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

• src/io/InputBase.h