Chaste Release::3.1
AdhesionPottsUpdateRule.hpp
00001 /*
00002 
00003 Copyright (c) 2005-2012, University of Oxford.
00004 All rights reserved.
00005 
00006 University of Oxford means the Chancellor, Masters and Scholars of the
00007 University of Oxford, having an administrative office at Wellington
00008 Square, Oxford OX1 2JD, UK.
00009 
00010 This file is part of Chaste.
00011 
00012 Redistribution and use in source and binary forms, with or without
00013 modification, are permitted provided that the following conditions are met:
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016  * Redistributions in binary form must reproduce the above copyright notice,
00017    this list of conditions and the following disclaimer in the documentation
00018    and/or other materials provided with the distribution.
00019  * Neither the name of the University of Oxford nor the names of its
00020    contributors may be used to endorse or promote products derived from this
00021    software without specific prior written permission.
00022 
00023 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00026 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00027 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00028 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
00029 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00030 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00031 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00032 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 
00034 */
00035 
00036 #ifndef ADHESIONUPDATERULE_HPP_
00037 #define ADHESIONUPDATERULE_HPP_
00038 
00039 #include "ChasteSerialization.hpp"
00040 #include <boost/serialization/base_object.hpp>
00041 
00042 #include "AbstractPottsUpdateRule.hpp"
00043 #include "PottsBasedCellPopulation.hpp"
00044 
00045 // Needed here to avoid serialization errors (on Boost<1.37)
00046 #include "CellLabel.hpp"
00047 
00052 template<unsigned DIM>
00053 class AdhesionPottsUpdateRule : public AbstractPottsUpdateRule<DIM>
00054 {
00055 friend class TestPottsUpdateRules;
00056 
00057 private:
00058 
00064     double mCellCellAdhesionEnergyParameter;
00065 
00071     double mCellBoundaryAdhesionEnergyParameter;
00072 
00073     friend class boost::serialization::access;
00074     template<class Archive>
00075     void serialize(Archive & archive, const unsigned int version)
00076     {
00077         archive & boost::serialization::base_object<AbstractPottsUpdateRule<DIM> >(*this);
00078         archive & mCellCellAdhesionEnergyParameter;
00079         archive & mCellBoundaryAdhesionEnergyParameter;
00080     }
00081 
00082 public:
00083 
00087     AdhesionPottsUpdateRule();
00088 
00092     ~AdhesionPottsUpdateRule();
00093 
00106     double EvaluateHamiltonianContribution(unsigned currentNodeIndex,
00107                                            unsigned targetNodeIndex,
00108                                            PottsBasedCellPopulation<DIM>& rCellPopulation);
00109 
00119     virtual double GetCellCellAdhesionEnergy(CellPtr pCellA, CellPtr pCellB);
00120 
00129     virtual double GetCellBoundaryAdhesionEnergy(CellPtr pCell);
00130 
00134     double GetCellCellAdhesionEnergyParameter();
00135 
00139     double GetCellBoundaryAdhesionEnergyParameter();
00140 
00146     void SetCellCellAdhesionEnergyParameter(double cellCellAdhesionEnergyEnergyParameter);
00147 
00153     void SetCellBoundaryAdhesionEnergyParameter(double cellBoundaryAdhesionEnergyParameter);
00154 
00160     void OutputUpdateRuleParameters(out_stream& rParamsFile);
00161 };
00162 
00163 #include "SerializationExportWrapper.hpp"
00164 EXPORT_TEMPLATE_CLASS_SAME_DIMS(AdhesionPottsUpdateRule)
00165 
00166 #endif /*ADHESIONUPDATERULE_HPP_*/