RandomCellKiller.cpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2010
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 #include "RandomCellKiller.hpp"
00029 
00030 
00031 template<unsigned DIM>
00032 RandomCellKiller<DIM>::RandomCellKiller(AbstractTissue<DIM>* pTissue, double probabilityOfDeathInAnHour)
00033         : AbstractCellKiller<DIM>(pTissue),
00034           mProbabilityOfDeathInAnHour(probabilityOfDeathInAnHour)
00035 {
00036     if ((mProbabilityOfDeathInAnHour<0) || (mProbabilityOfDeathInAnHour>1))
00037     {
00038         EXCEPTION("Probability of death must be between zero and one");
00039     }
00040 }
00041 
00042 template<unsigned DIM>
00043 double RandomCellKiller<DIM>::GetDeathProbabilityInAnHour() const
00044 {
00045     return mProbabilityOfDeathInAnHour;
00046 }
00047 
00048 template<unsigned DIM>
00049 void RandomCellKiller<DIM>::TestAndLabelSingleCellForApoptosis(TissueCell& rCell)
00050 {
00051     // We assume a constant time step
00052     double death_prob_this_timestep = 1.0 - pow((1.0 - mProbabilityOfDeathInAnHour), SimulationTime::Instance()->GetTimeStep());
00053 
00054     if (!rCell.HasApoptosisBegun() &&
00055         RandomNumberGenerator::Instance()->ranf() < death_prob_this_timestep)
00056     {
00057         rCell.StartApoptosis();
00058     }
00059 }
00060 
00061 template<unsigned DIM>
00062 void RandomCellKiller<DIM>::TestAndLabelCellsForApoptosisOrDeath()
00063 {
00064     for (typename AbstractTissue<DIM>::Iterator cell_iter = this->mpTissue->Begin();
00065          cell_iter != this->mpTissue->End();
00066          ++cell_iter)
00067     {
00068         TestAndLabelSingleCellForApoptosis(*cell_iter);
00069     }
00070 }
00071 
00072 
00074 // Explicit instantiation
00076 
00077 template class RandomCellKiller<1>;
00078 template class RandomCellKiller<2>;
00079 template class RandomCellKiller<3>;
00080 
00081 
00082 // Serialization for Boost >= 1.36
00083 #include "SerializationExportWrapperForCpp.hpp"
00084 EXPORT_TEMPLATE_CLASS_SAME_DIMS(RandomCellKiller)

Generated by  doxygen 1.6.2