CellCycleModelOdeHandler.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 #ifndef CELLCYCLEMODELODEHANDLER_HPP_
00029 #define CELLCYCLEMODELODEHANDLER_HPP_
00030 
00031 #include <boost/shared_ptr.hpp>
00032 
00033 #include "ChasteSerialization.hpp"
00034 #include "AbstractOdeSystem.hpp"
00035 #include "AbstractCellCycleModelOdeSolver.hpp"
00036 #include "SimulationTime.hpp"
00037 
00043 class CellCycleModelOdeHandler
00044 {
00045 private:
00046 
00048     friend class boost::serialization::access;
00055     template<class Archive>
00056     void serialize(Archive & archive, const unsigned int version)
00057     {
00058         archive & mpOdeSystem;
00059         archive & mpOdeSolver;
00060         archive & mLastTime;
00061         archive & mDt;
00062     }
00063 
00064 protected:
00065     
00070     double mDt;
00071 
00073     AbstractOdeSystem* mpOdeSystem;
00074 
00076     boost::shared_ptr<AbstractCellCycleModelOdeSolver> mpOdeSolver;
00077 
00079     double mLastTime;
00080 
00088     bool SolveOdeToTime(double currentTime);
00089 
00096     virtual void AdjustOdeParameters(double currentTime);
00097 
00098 public:
00099 
00106     CellCycleModelOdeHandler(double lastTime = SimulationTime::Instance()->GetTime(),
00107                              boost::shared_ptr<AbstractCellCycleModelOdeSolver> pOdeSolver = boost::shared_ptr<AbstractCellCycleModelOdeSolver>());
00108 
00112     virtual ~CellCycleModelOdeHandler();
00113 
00117     AbstractOdeSystem* GetOdeSystem() const;
00118 
00124     void SetOdeSystem(AbstractOdeSystem* pOdeSystem);
00125 
00129     const boost::shared_ptr<AbstractCellCycleModelOdeSolver> GetOdeSolver() const;
00130 
00136     void SetLastTime(double lastTime);
00137 
00142     double GetDt();
00143 
00150     void SetDt(double timeStep);
00151 
00157     void SetStateVariables(const std::vector<double>& rStateVariables);
00158 };
00159 
00160 #endif /*CELLCYCLEMODELODEHANDLER_HPP_*/

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