ls1-MarDyn
ls1-MarDyn molecular dynamics code
Public Member Functions | List of all members
ObjectFillerBase Class Referenceabstract

#include <ObjectFillerBase.h>

Inheritance diagram for ObjectFillerBase:
GridFiller ReplicaFiller

Public Member Functions

virtual void readXML (XMLfileUnits &xmlconfig)=0
 Read in XML configuration for Filler and all its included objects. More...
 
virtual void init ()=0
 
virtual void setObject (std::shared_ptr< Object > object)=0
 
virtual int getMolecule (Molecule *molecule)=0
 
virtual std::string getPluginName ()=0
 

Detailed Description

FillerBase interface

Member Function Documentation

◆ getMolecule()

virtual int ObjectFillerBase::getMolecule ( Molecule molecule)
pure virtual

Get a single molecule By subsequent calls all molecules will be returned, one by one.

Parameters
[out]moleculePointer to molecule data structure where to store the molecule data (coordinate and component id)
Returns
0 if no more molecules can be returned

Implemented in GridFiller, and ReplicaFiller.

◆ init()

virtual void ObjectFillerBase::init ( )
pure virtual

Initialize the generator with current internal state

Implemented in GridFiller, and ReplicaFiller.

◆ readXML()

virtual void ObjectFillerBase::readXML ( XMLfileUnits xmlconfig)
pure virtual

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

The following xml object structure is handled by this method:

<filler type="STRING">
<!-- see derived filler classes -->
</filler>

Implemented in GridFiller, and ReplicaFiller.


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