sourceagent.h

Go to the documentation of this file.

#ifndef SOURCEAGENT_H
#define SOURCEAGENT_H

#include "fluxagent.h"

namespace LangmuirCore
{

class SourceAgent : public FluxAgent
{
public:
    SourceAgent(World &world, Grid &grid, QObject *parent = 0);

    bool tryToSeed();

    bool tryToSeed(int site);

    bool tryToInject();

protected:
    virtual int chooseSite();

    virtual bool validToInject(int site)= 0;

    virtual void inject(int site)= 0;

    virtual bool shouldTransport(int site);

    int randomSiteID();

    int randomNeighborSiteID();
};

class ElectronSourceAgent : public SourceAgent
{
public:
    ElectronSourceAgent(World &world, int site, QObject *parent = 0);

    ElectronSourceAgent(World &world, Grid::CubeFace cubeFace, QObject *parent = 0);
protected:
    virtual bool validToInject(int site);

    virtual double energyChange(int site);

    virtual void inject(int site);
};

class HoleSourceAgent : public SourceAgent
{
public:
    HoleSourceAgent(World &world, int site, QObject *parent = 0);

    HoleSourceAgent(World &world, Grid::CubeFace cubeFace, QObject *parent = 0);
protected:
    virtual bool validToInject(int site);

    virtual double energyChange(int site);

    virtual void inject(int site);
};

class ExcitonSourceAgent : public SourceAgent
{
public:
    ExcitonSourceAgent(World &world, QObject *parent = 0);
protected:
    virtual bool validToInject(int site);

    virtual double energyChange(int site);

    virtual bool shouldTransport(int site);

    virtual int chooseSite();

    virtual void inject(int site);
};

}
#endif