Chaste Release::3.1
DifferentialAdhesionPottsUpdateRule.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 #ifndef DIFFERENTIALADHESIONUPDATERULE_HPP_
00036 #define DIFFERENTIALADHESIONUPDATERULE_HPP_
00037 
00038 #include "ChasteSerialization.hpp"
00039 #include <boost/serialization/base_object.hpp>
00040 
00041 #include "AdhesionPottsUpdateRule.hpp"
00042 #include "PottsBasedCellPopulation.hpp"
00043 
00044 // Needed here to avoid serialization errors (on Boost<1.37)
00045 #include "CellLabel.hpp"
00046 
00052 template<unsigned DIM>
00053 class DifferentialAdhesionPottsUpdateRule : public AdhesionPottsUpdateRule<DIM>
00054 {
00055 friend class TestPottsUpdateRules;
00056 
00057 private:
00058 
00064     double mLabelledCellLabelledCellAdhesionEnergyParameter;
00065 
00071     double mLabelledCellCellAdhesionEnergyParameter;
00072 
00078     double mLabelledCellBoundaryAdhesionEnergyParameter;
00079 
00080     friend class boost::serialization::access;
00081     template<class Archive>
00082     void serialize(Archive & archive, const unsigned int version)
00083     {
00084         archive & boost::serialization::base_object<AdhesionPottsUpdateRule<DIM> >(*this);
00085         archive & mLabelledCellLabelledCellAdhesionEnergyParameter;
00086         archive & mLabelledCellCellAdhesionEnergyParameter;
00087         archive & mLabelledCellBoundaryAdhesionEnergyParameter;
00088     }
00089 
00090 public:
00091 
00095     DifferentialAdhesionPottsUpdateRule();
00096 
00100     ~DifferentialAdhesionPottsUpdateRule();
00101 
00110     virtual double GetCellCellAdhesionEnergy(CellPtr pCellA, CellPtr pCellB);
00111 
00119     virtual double GetCellBoundaryAdhesionEnergy(CellPtr pCell);
00120 
00124     double GetLabelledCellLabelledCellAdhesionEnergyParameter();
00125 
00129     double GetLabelledCellCellAdhesionEnergyParameter();
00130 
00134     double GetLabelledCellBoundaryAdhesionEnergyParameter();
00135 
00141     void SetLabelledCellLabelledCellAdhesionEnergyParameter(double labelledCellLabelledCellAdhesionEnergyParameter);
00142 
00148     void SetLabelledCellCellAdhesionEnergyParameter(double labelledCellCellAdhesionEnergyParameter);
00149 
00155     void SetLabelledCellBoundaryAdhesionEnergyParameter(double labelledCellBoundaryAdhesionEnergyParameter);
00156 
00162     void OutputUpdateRuleParameters(out_stream& rParamsFile);
00163 };
00164 
00165 #include "SerializationExportWrapper.hpp"
00166 EXPORT_TEMPLATE_CLASS_SAME_DIMS(DifferentialAdhesionPottsUpdateRule)
00167 
00168 #endif /*DIFFERENTIALADHESIONUPDATERULE_HPP_*/