AbstractPottsUpdateRule.hpp

/*

Copyright (C) University of Oxford, 2005-2011

University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.

This file is part of Chaste.

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

Chaste 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 Lesser General Public
License for more details. The offer of Chaste under the terms of the
License is subject to the License being interpreted in accordance with
English Law and subject to any action against the University of Oxford
being under the jurisdiction of the English Courts.

You should have received a copy of the GNU Lesser General Public License
along with Chaste. If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef ABSTRACTPOTTSUPDATERULE_HPP_
#define ABSTRACTPOTTSUPDATERULE_HPP_

#include "ChasteSerialization.hpp"
#include "ClassIsAbstract.hpp"
#include "PottsBasedCellPopulation.hpp"
#include "Identifiable.hpp"

template<unsigned DIM>
class PottsBasedCellPopulation; // Circular definition

template<unsigned DIM>
class AbstractPottsUpdateRule : public Identifiable
{
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
    }

public:

    AbstractPottsUpdateRule();

    virtual ~AbstractPottsUpdateRule();

    virtual double EvaluateHamiltonianContribution(unsigned currentNodeIndex,
                                                   unsigned targetNodeIndex,
                                                   PottsBasedCellPopulation<DIM>& rCellPopulation)=0;

    void OutputUpdateRuleInfo(out_stream& rParamsFile);

    virtual void OutputUpdateRuleParameters(out_stream& rParamsFile)=0;
};

TEMPLATED_CLASS_IS_ABSTRACT_1_UNSIGNED(AbstractPottsUpdateRule)

#endif /*ABSTRACTPOTTSUPDATERULE_HPP_*/