AbstractPottsUpdateRule.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2011
00004 
00005 University of Oxford means the Chancellor, Masters and Scholars of the
00006 University of Oxford, having an administrative office at Wellington
00007 Square, Oxford OX1 2JD, UK.
00008 
00009 This file is part of Chaste.
00010 
00011 Chaste is free software: you can redistribute it and/or modify it
00012 under the terms of the GNU Lesser General Public License as published
00013 by the Free Software Foundation, either version 2.1 of the License, or
00014 (at your option) any later version.
00015 
00016 Chaste is distributed in the hope that it will be useful, but WITHOUT
00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00019 License for more details. The offer of Chaste under the terms of the
00020 License is subject to the License being interpreted in accordance with
00021 English Law and subject to any action against the University of Oxford
00022 being under the jurisdiction of the English Courts.
00023 
00024 You should have received a copy of the GNU Lesser General Public License
00025 along with Chaste. If not, see <http://www.gnu.org/licenses/>.
00026 
00027 */
00028 
00029 #ifndef ABSTRACTPOTTSUPDATERULE_HPP_
00030 #define ABSTRACTPOTTSUPDATERULE_HPP_
00031 
00032 #include "ChasteSerialization.hpp"
00033 #include "ClassIsAbstract.hpp"
00034 #include "PottsBasedCellPopulation.hpp"
00035 #include "Identifiable.hpp"
00036 
00037 template<unsigned DIM>
00038 class PottsBasedCellPopulation; // Circular definition
00039 
00044 template<unsigned DIM>
00045 class AbstractPottsUpdateRule : public Identifiable
00046 {
00048     friend class boost::serialization::access;
00055     template<class Archive>
00056     void serialize(Archive & archive, const unsigned int version)
00057     {
00058     }
00059 
00060 public:
00061 
00065     AbstractPottsUpdateRule();
00066 
00070     virtual ~AbstractPottsUpdateRule();
00071 
00082     virtual double EvaluateHamiltonianContribution(unsigned currentNodeIndex,
00083                                                    unsigned targetNodeIndex,
00084                                                    PottsBasedCellPopulation<DIM>& rCellPopulation)=0;
00085 
00092     void OutputUpdateRuleInfo(out_stream& rParamsFile);
00093 
00102     virtual void OutputUpdateRuleParameters(out_stream& rParamsFile)=0;
00103 };
00104 
00105 TEMPLATED_CLASS_IS_ABSTRACT_1_UNSIGNED(AbstractPottsUpdateRule)
00106 
00107 #endif /*ABSTRACTPOTTSUPDATERULE_HPP_*/
Generated on Thu Dec 22 13:00:05 2011 for Chaste by  doxygen 1.6.3