MkesferaGenerator Class Reference

Single droplet scenario generator. More...

#include <Mkesfera.h>

Inheritance diagram for MkesferaGenerator:

Public Member Functions
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...
void	readXML (XMLfileUnits &xmlconfig)
	Read in XML configuration for MkesferaGenerator and all its included objects. More...

Detailed Description

Single droplet scenario generator.

Creates a droplet with a given center position and radius inside the simulation box. The density of the droplet and its surrounding can be chosen seperately. The droplet and its surrounding consist both out of molecules from the component with ID=1 in the xml input file.

Member Function Documentation

readPhaseSpace()

unsigned long MkesferaGenerator::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

< relative koordinates of face centers

Implements InputBase.

readPhaseSpaceHeader()

void MkesferaGenerator::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 MkesferaGenerator::readXML ( XMLfileUnits &  xmlconfig )

virtual

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

The following xml object structure is handled by this method:

<generator name="mkesfera">
  <outer-density>DOUBLE</outer-density>
  <droplet>
    <radius>DOUBLE</radius>
    <density>DOUBLE</density>
    <center>
      <x>DOUBLE</x>
      <y>DOUBLE</y>
      <z>DOUBLE</z>
    </center>
  </droplet>
</generator>

Reimplemented from InputBase.

---

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

• src/io/Mkesfera.h
• src/io/Mkesfera.cpp