Reaction.hpp

/*
    dmcut2, a library for Monte-Carlo simulations at surfaces
    Copyright (C) 2008 Mathias Laurin <mathias_laurin@users.sourceforge.net>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef REACTION_HPP
#define REACTION_HPP

#include <string>
#include <vector>
#include <ostream>
#include <tr1/memory>

#include "Species.hpp"
#include "EventPtr.hpp"

namespace Surface { class Site; }

namespace Reactions {

class Reaction
        // If the parameters are known at compile-time, there can be a run speed
        // improvement by using templates, see
        // http://www.parashift.com/c++-faq-lite/pointers-to-members.html#faq-33.11
        //
        // Could also use the curiously recurring template pattern
        {
                
        public:
                typedef std::string Name;
                
                typedef std::vector<EventPtr> EventContainer;
                
                typedef std::vector<Surface::Site*> SitePtrContainer;
                
                virtual ~Reaction() { };
                

                
                virtual Name name() const = 0;
                
                
                virtual void UpdateTime() = 0;
                
                virtual double Time() const = 0;
                
                virtual bool Enabled() const = 0;
                
                virtual void operator()() = 0;
                
                virtual EventContainer GetEvents(const Surface::Site*) const = 0;
                
                virtual SitePtrContainer site_container() const = 0;            
        };

} // namespace Reactions
        
#endif

---

Project's page