IngeWntSwatCellCycleModel.hpp

/*

Copyright (C) University of Oxford, 2005-2009

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.

Chaste is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 2.1 of the License, or
(at your option) any later version.

Chaste is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
License for more details. The offer of Chaste under the terms of the
License is subject to the License being interpreted in accordance with
English Law and subject to any action against the University of Oxford
being under the jurisdiction of the English Courts.

You should have received a copy of the GNU Lesser General Public License
along with Chaste. If not, see <http://www.gnu.org/licenses/>.

*/
#ifndef INGEWNTSWATCELLCYCLEMODEL_HPP_
#define INGEWNTSWATCELLCYCLEMODEL_HPP_

#include <boost/serialization/access.hpp>
#include <boost/serialization/base_object.hpp>

#include <cfloat>

#include "AbstractOdeSystem.hpp"
#include "AbstractWntOdeBasedCellCycleModel.hpp"
#include "IngeWntSwatCellCycleOdeSystem.hpp"
#include "CellMutationStates.hpp"
#include "Exception.hpp"


// Needs to be included last
#include <boost/serialization/export.hpp>

class IngeWntSwatCellCycleModel : public AbstractWntOdeBasedCellCycleModel
{
private:

    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        assert(mpOdeSystem!=NULL);
        archive & boost::serialization::base_object<AbstractWntOdeBasedCellCycleModel>(*this);
        // Reference can be read or written into once mpOdeSystem has been set up
        // mpOdeSystem isn't set up by the first constructor, but is by the second
        // which is now utilised by the load_construct at the bottom of this file.
        archive & static_cast<IngeWntSwatCellCycleOdeSystem*>(mpOdeSystem)->rGetMutationState();
    }

    void ChangeCellTypeDueToCurrentBetaCateninLevel();

    unsigned mHypothesis;

public:

    IngeWntSwatCellCycleModel(unsigned hypothesis)
       : mHypothesis(hypothesis)
    {
        if ( !(mHypothesis==1u || mHypothesis==2u) )
        {
            EXCEPTION("Model must be set up with argument(hypothesis) = 1u or 2u");
        }
    };

    IngeWntSwatCellCycleModel(const unsigned& rHypothesis,
                              AbstractOdeSystem* pParentOdeSystem,
                              const CellMutationState& rMutationState,
                              double birthTime,
                              double lastTime,
                              bool inSG2MPhase,
                              bool readyToDivide,
                              double divideTime);

    IngeWntSwatCellCycleModel(const unsigned& rHypothesis,
                              const std::vector<double>& rParentProteinConcentrations,
                              const CellMutationState& rMutationState);

    AbstractCellCycleModel* CreateDaughterCellCycleModel();

    void Initialise();

    bool SolveOdeToTime(double currentTime);

    double GetMembraneBoundBetaCateninLevel();

    double GetCytoplasmicBetaCateninLevel();

    double GetNuclearBetaCateninLevel();

    unsigned GetHypothesis() const; // this function promises not to change the object

};

// Declare identifier for the serializer
BOOST_CLASS_EXPORT(IngeWntSwatCellCycleModel)


namespace boost
{
namespace serialization
{
template<class Archive>
inline void save_construct_data(
    Archive & ar, const IngeWntSwatCellCycleModel * t, const unsigned int file_version)
{
    const unsigned hypothesis = t->GetHypothesis();
    ar & hypothesis;
}

template<class Archive>
inline void load_construct_data(
    Archive & ar, IngeWntSwatCellCycleModel * t, const unsigned int file_version)
{
    std::vector<double> state_vars;
    for (unsigned i=0; i<22; i++)
    {
        state_vars.push_back(0.0);
    }

    CellMutationState mutation_state = HEALTHY;

    unsigned hypothesis;
    ar & hypothesis;

    ::new(t)IngeWntSwatCellCycleModel(hypothesis, state_vars, mutation_state);
}
}
} // namespace ...

#endif /*INGEWNTSWATCELLCYCLEMODEL_HPP_*/

---