LQRadiotherapyCellKiller.hpp

/*

Copyright (c) 2005-2016, University of Oxford.
 All rights reserved.

 University of Oxford means the Chancellor, Masters and Scholars of the
 University of Oxford, having an administrative office at Wellington
 Square, Oxford OX1 2JD, UK.

 This file is part of Chaste.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice,
 this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution.
 * Neither the name of the University of Oxford nor the names of its
 contributors may be used to endorse or promote products derived from this
 software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */

#ifndef LQRADIOTHERAPYCELLKILLER_HPP_
#define LQRADIOTHERAPYCELLKILLER_HPP_

#include "AbstractCellKiller.hpp"
#include "RandomNumberGenerator.hpp"

#include "ChasteSerialization.hpp"
#include <boost/serialization/base_object.hpp>
#include "UnitCollection.hpp"

template<unsigned DIM>
class LQRadiotherapyCellKiller : public AbstractCellKiller<DIM>
{
    units::quantity<unit::per_absorbed_dose> cancerousLinearRadiosensitivity;

    units::quantity<unit::per_absorbed_dose_squared> cancerousQuadraticRadiosensitivity;

    units::quantity<unit::per_absorbed_dose> normalLinearRadiosensitivity;

    units::quantity<unit::per_absorbed_dose_squared> normalQuadraticRadiosensitivity;

    units::quantity<unit::absorbed_dose> mDose;

    std::vector<units::quantity<unit::time> > mRadiationTimes;

    double mOerAlphaMax;

    double mOerAlphaMin;

    double mOerBetaMax;

    double mOerBetaMin;

    double mKOer;

    units::quantity<unit::per_absorbed_dose> mAlphaMax;

    units::quantity<unit::per_absorbed_dose_squared> mBetaMax;

    bool mUseOer;

private:

    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        archive & boost::serialization::base_object<AbstractCellKiller<DIM> >(*this);

        // Make sure the random number generator is also archived
        SerializableSingleton<RandomNumberGenerator>* p_rng_wrapper = RandomNumberGenerator::Instance()->GetSerializationWrapper();
        archive & p_rng_wrapper;
    }

public:

    LQRadiotherapyCellKiller(AbstractCellPopulation<DIM>* pCellPopulation);

    void CheckAndLabelSingleCellForApoptosis(CellPtr pCell);

    void CheckAndLabelCellsForApoptosisOrDeath();

    void OutputCellKillerParameters(out_stream& rParamsFile);

    void SetDoseInjected(units::quantity<unit::absorbed_dose> d);

    void SetTimeOfRadiation(std::vector<units::quantity<unit::time> > t);

    void SetCancerousRadiosensitivity(units::quantity<unit::per_absorbed_dose> alpha, units::quantity<unit::per_absorbed_dose_squared> beta);

    void SetNormalRadiosensitivity(units::quantity<unit::per_absorbed_dose> alpha, units::quantity<unit::per_absorbed_dose_squared> beta);

    void SetOerAlphaMax(double value);

    void SetOerAlphaMin(double value);

    void SetOerBetaMax(double value);

    void SetOerBetaMin(double value);

    void SetOerConstant(double value);

    void SetAlphaMax(units::quantity<unit::per_absorbed_dose> value);

    void SetBetaMax(units::quantity<unit::per_absorbed_dose_squared> value);

    void UseOer(bool useOer);

};

#include "SerializationExportWrapper.hpp"
EXPORT_TEMPLATE_CLASS_SAME_DIMS(LQRadiotherapyCellKiller)

namespace boost
{
namespace serialization
{
template<class Archive, unsigned DIM>
inline void save_construct_data(Archive & ar, const LQRadiotherapyCellKiller<DIM> * t, const unsigned int file_version)
{
    // Save data required to construct instance
    const AbstractCellPopulation<DIM>* const p_cell_population = t->GetCellPopulation();
    ar << p_cell_population;
}

template<class Archive, unsigned DIM>
inline void load_construct_data(Archive & ar, LQRadiotherapyCellKiller<DIM> * t, const unsigned int file_version)
{
    // Retrieve data from archive required to construct new instance
    AbstractCellPopulation<DIM>* p_cell_population;
    ar >> p_cell_population;

    // Invoke inplace constructor to initialise instance
    ::new (t) LQRadiotherapyCellKiller<DIM>(p_cell_population);
}
}
} // namespace ...

#endif /*LQRADIOTHERAPYCELLKILLER_HPP_*/