fluxagent.h

Go to the documentation of this file.

#ifndef FLUXAGENT_H
#define FLUXAGENT_H

#include "agent.h"
#include "cubicgrid.h"

namespace LangmuirCore
{

struct SimulationParameters;

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

    ~FluxAgent();

    void setPotential(double potential);

    double potential() const;

    void setRate(double rate);

    void setRateSmartly(double rate, double dflt);

    double rate() const;

    void setAttempts(unsigned long int value);

    unsigned long int attempts() const;

    void setSuccesses(unsigned long int value);

    unsigned long int successes() const;

    void storeLast();

    unsigned long int successesSinceLast() const;

    unsigned long int attemptsSinceLast() const;

    unsigned long int stepsSinceLast() const;

    double successProbability()const;

    double successRate()const;

    double successProbabilitySinceLast()const;

    double successRateSinceLast()const;

    void resetCounters();

    Grid::CubeFace face()const;

    Grid& grid()const;

protected:
    void initializeSite(int site);

    void initializeSite(Grid::CubeFace cubeFace);

    virtual bool shouldTransport(int site);

    virtual double energyChange(int site);

    QString faceToLetter();

    unsigned long int m_attempts;

    unsigned long int m_successes;

    unsigned long int m_lastSuccesses;

    unsigned long int m_lastAttempts;

    unsigned long int m_lastStep;

    double m_probability;

    double m_potential;

    Grid &m_grid;

    Grid::CubeFace m_face;
};

}
#endif