ls1-MarDyn
ls1-MarDyn molecular dynamics code
Public Member Functions | List of all members
MkTcTSGenerator Class Reference

Generates a scenario of two layers of the same component but with different densities. More...

#include <TcTS.h>

Inheritance diagram for MkTcTSGenerator:
InputBase

Public Member Functions

void readPhaseSpaceHeader (Domain *domain, double timestep)
 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 MkTcTSGenerator and all its included objects. More...
 

Detailed Description

Generates a scenario of two layers of the same component but with different densities.

Creates two layers of the same height in the simulation box. The density of the two layers can be chosen separately. The layers consist both out of molecules from the component with ID=1 in the xml input file.

Member Function Documentation

◆ readPhaseSpace()

unsigned long MkTcTSGenerator::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 MkTcTSGenerator::readPhaseSpaceHeader ( Domain domain,
double  timestep 
)
virtual

read the phase space components and header information

Parameters
domainpointer to domain object
timesteptimestep length

Implements InputBase.

◆ readXML()

void MkTcTSGenerator::readXML ( XMLfileUnits xmlconfig)
virtual

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

The following xml object structure is handled by this method:

<generator name="mkTcTS">
<layer1>
<density>DOUBLE</density>
</layer1>
<layer2>
<density>DOUBLE</density>
</layer2>
</generator>

Reimplemented from InputBase.


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