ObjectGenerator Class Reference

The ObjectGenerator sets up a phase space by filling volumetric objects. More...

#include <ObjectGenerator.h>

Inheritance diagram for ObjectGenerator:

Public Member Functions
virtual void	readXML (XMLfileUnits &xmlconfig)
	Read in XML configuration for ObjectGenerator and all its included objects. More...
void	setFiller (std::shared_ptr< ObjectFillerBase > filler)
void	setObject (std::shared_ptr< Object > object)
void	setVelocityAssigner (std::shared_ptr< VelocityAssignerBase > vAssigner)
void	setMoleculeIDPool (std::shared_ptr< MoleculeIdPool > moleculeIdPool)
void	readPhaseSpaceHeader (Domain *, double)
	read the phase space components and header information More...
unsigned long	readPhaseSpace (ParticleContainer *particleContainer, Domain *domain, DomainDecompBase *domainDecomp)
	read the actual phase space information More...

Detailed Description

The ObjectGenerator sets up a phase space by filling volumetric objects.

The idea of the ObjectGenerator is to create a composite 3D volumetric Object and fill this with molecules. The molecule placement into the object is performed by a Filler. The assignment of molecule velocities is performed by a VelocityAssigner. The molecule IDs are provided by a MoleculeIdPool.

Member Function Documentation

readPhaseSpace()

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

virtual

read the actual phase space information

Returns

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

Implements InputBase.

readPhaseSpaceHeader()

void ObjectGenerator::readPhaseSpaceHeader ( Domain *  domain, double  timestep  )

inlinevirtual

read the phase space components and header information

Parameters

domain	pointer to domain object
timestep	timestep length

Implements InputBase.

readXML()

void ObjectGenerator::readXML ( XMLfileUnits &  xmlconfig )

virtual

Read in XML configuration for ObjectGenerator and all its included objects.

The following XML object structure is handled by this method:

Note

This structure is not fixed yet and may see changes

<objectgenerator>
  <filler type="STRING"> <!-- see Filler documentation --> </filler>
  <object type="STRING"> <!-- see Object documentation --> </object>
  <velocityAssigner type="STRING"> <!-- see VelocityAssignerBase documentation --> </velocityAssigner>
</objectgenerator>

Reimplemented from InputBase.

---

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

• src/io/ObjectGenerator.h
• src/io/ObjectGenerator.cpp