DiffusionCaUpdateRule.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 DIFFUSIONCAUPDATERULE_HPP_
00030 #define DIFFUSIONCAUPDATERULE_HPP_
00031 
00032 #include "ChasteSerialization.hpp"
00033 #include <boost/serialization/base_object.hpp>
00034 
00035 #include "AbstractCaUpdateRule.hpp"
00036 #include "CaBasedCellPopulation.hpp"
00037 
00047 template<unsigned DIM>
00048 class DiffusionCaUpdateRule : public AbstractCaUpdateRule<DIM>
00049 {
00050 private:
00051 
00053     double mDiffusionConstant;
00054 
00056     friend class boost::serialization::access;
00063     template<class Archive>
00064     void serialize(Archive & archive, const unsigned int version)
00065     {
00066         archive & boost::serialization::base_object<AbstractCaUpdateRule<DIM> >(*this);
00067         archive & mDiffusionConstant;
00068     }
00069 
00070 public:
00071 
00077     DiffusionCaUpdateRule(double diffusionConstant=1.0);
00078 
00082     ~DiffusionCaUpdateRule();
00083 
00096     unsigned GetNewLocationOfCell(unsigned currentLocationIndex,
00097                                   CaBasedCellPopulation<DIM>& rCellPopulation,
00098                                   double dt);
00099 
00101     double GetDiffusionConstant();
00102 
00108     void OutputUpdateRuleParameters(out_stream& rParamsFile);
00109 };
00110 
00111 #include "SerializationExportWrapper.hpp"
00112 EXPORT_TEMPLATE_CLASS_SAME_DIMS(DiffusionCaUpdateRule)
00113 
00114 #endif /*DIFFUSIONCAUPDATERULE_HPP_*/
Generated on Thu Dec 22 13:00:05 2011 for Chaste by  doxygen 1.6.3