algorithm.h

Go to the documentation of this file.

#ifndef ALGORITHM_H
 
#define ALGORITHM_H
 
#include "booltype.h"
#include <stdint.h>
#include <vector>
 
//#define ALGORITHM_SHOW_EVENTS
 
//#define ALGORITHM_DEBUG_TIMER
 
class GslRandomNumberGenerator;
class EventBase;
class Algorithm;
class Mutex;
 
class State
{
public:
        State();
        virtual ~State();
 
        double getTime() const                                                                                                                          { return m_time; }
 
        void setTime(double t)                                                                                                                          { m_time = t; }
 
        // Protected by a mutex
        void setAbortAlgorithm(const std::string &reason) const;
 
        // Will only be called from the main simulation thread
        void clearAbort();
        bool shouldAbortAlgorithm() const                                                                                                       { return m_abort; }
        std::string getAbortReason() const;
private:
        double m_time;
 
        mutable bool m_abort;
        mutable Mutex *m_pAbortMutex;
        mutable std::string m_abortReason;
};
 
class Algorithm
{
public:
        Algorithm(State &state, GslRandomNumberGenerator &rng);
        virtual ~Algorithm();
 
        bool_t evolve(double &tMax, int64_t &maxEvents, double startTime = 0, bool initEvents = true);
 
        double getTime() const                                                                          { return m_time; }
 
        GslRandomNumberGenerator *getRandomNumberGenerator() const                                      { return m_pRndGen; }
protected:
        State *getState() const                                                                                                         { return m_pState; }
 
        virtual bool_t initEventTimes() const;
 
        virtual bool_t getNextScheduledEvent(double &dt, EventBase **ppEvt);
 
        virtual void advanceEventTimes(EventBase *pScheduledEvent, double dt);
 
        virtual void onAboutToFire(EventBase *pEvt)                                                     { }
 
        virtual void onFiredEvent(EventBase *pEvt)                                                      { }
 
        virtual void onAlgorithmLoop(bool finished)                                                     { }
private:
        mutable GslRandomNumberGenerator *m_pRndGen;
        State *m_pState;
        double m_time;
};
 
#endif // ALGORITHM_H