RandomCellKiller.cpp

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 #include "RandomCellKiller.hpp"
00029 
00030 template<unsigned DIM>
00031 RandomCellKiller<DIM>::RandomCellKiller(AbstractCellPopulation<DIM>* pCellPopulation, double probabilityOfDeathInAnHour)
00032         : AbstractCellKiller<DIM>(pCellPopulation),
00033           mProbabilityOfDeathInAnHour(probabilityOfDeathInAnHour)
00034 {
00035     if ((mProbabilityOfDeathInAnHour<0) || (mProbabilityOfDeathInAnHour>1))
00036     {
00037         EXCEPTION("Probability of death must be between zero and one");
00038     }
00039 }
00040 
00041 template<unsigned DIM>
00042 double RandomCellKiller<DIM>::GetDeathProbabilityInAnHour() const
00043 {
00044     return mProbabilityOfDeathInAnHour;
00045 }
00046 
00047 template<unsigned DIM>
00048 void RandomCellKiller<DIM>::TestAndLabelSingleCellForApoptosis(CellPtr pCell)
00049 {
00050     // We assume a constant time step
00051     double death_prob_this_timestep = 1.0 - pow((1.0 - mProbabilityOfDeathInAnHour), SimulationTime::Instance()->GetTimeStep());
00052 
00053     if (!pCell->HasApoptosisBegun() &&
00054         RandomNumberGenerator::Instance()->ranf() < death_prob_this_timestep)
00055     {
00056         pCell->StartApoptosis();
00057     }
00058 }
00059 
00060 template<unsigned DIM>
00061 void RandomCellKiller<DIM>::TestAndLabelCellsForApoptosisOrDeath()
00062 {
00063     for (typename AbstractCellPopulation<DIM>::Iterator cell_iter = this->mpCellPopulation->Begin();
00064          cell_iter != this->mpCellPopulation->End();
00065          ++cell_iter)
00066     {
00067         TestAndLabelSingleCellForApoptosis(*cell_iter);
00068     }
00069 }
00070 
00071 template<unsigned DIM>
00072 void RandomCellKiller<DIM>::OutputCellKillerParameters(out_stream& rParamsFile)
00073 {
00074     *rParamsFile << "\t\t\t<ProbabilityOfDeathInAnHour>" << mProbabilityOfDeathInAnHour << "</ProbabilityOfDeathInAnHour> \n";
00075 
00076     // Call method on direct parent class
00077     AbstractCellKiller<DIM>::OutputCellKillerParameters(rParamsFile);
00078 }
00079 
00081 // Explicit instantiation
00083 
00084 template class RandomCellKiller<1>;
00085 template class RandomCellKiller<2>;
00086 template class RandomCellKiller<3>;
00087 
00088 // Serialization for Boost >= 1.36
00089 #include "SerializationExportWrapperForCpp.hpp"
00090 EXPORT_TEMPLATE_CLASS_SAME_DIMS(RandomCellKiller)

Generated on Tue May 31 14:31:40 2011 for Chaste by  doxygen 1.5.5