AbstractOneStepIvpOdeSolver.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 
00029 #ifndef _ABSTRACTONESTEPIVPODESOLVER_HPP_
00030 #define _ABSTRACTONESTEPIVPODESOLVER_HPP_
00031 
00032 #include "ChasteSerialization.hpp"
00033 #include "ClassIsAbstract.hpp"
00034 #include <boost/serialization/base_object.hpp>
00035 
00036 #include "AbstractIvpOdeSolver.hpp"
00037 
00042 class AbstractOneStepIvpOdeSolver : public AbstractIvpOdeSolver
00043 {
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         // This calls serialize on the base class.
00059         archive & boost::serialization::base_object<AbstractIvpOdeSolver>(*this);
00060     }
00061 
00065     std::vector<double> mWorkingMemory;
00066 
00067 protected:
00068 
00080     virtual void InternalSolve(AbstractOdeSystem* pAbstractOdeSystem,
00081                                std::vector<double>& rCurrentYValues,
00082                                std::vector<double>& rWorkingMemory,
00083                                double startTime,
00084                                double endTime,
00085                                double timeStep);
00086 
00097     virtual void CalculateNextYValue(AbstractOdeSystem* pAbstractOdeSystem,
00098                                      double timeStep,
00099                                      double time,
00100                                      std::vector<double>& rCurrentYValues,
00101                                      std::vector<double>& rNextYValues)=0;
00102 
00103 public:
00104 
00131     virtual OdeSolution Solve(AbstractOdeSystem* pAbstractOdeSystem,
00132                               std::vector<double>& rYValues,
00133                               double startTime,
00134                               double endTime,
00135                               double timeStep,
00136                               double timeSampling);
00137 
00160     virtual void Solve(AbstractOdeSystem* pAbstractOdeSystem,
00161                        std::vector<double>& rYValues,
00162                        double startTime,
00163                        double endTime,
00164                        double timeStep);
00165 
00169     virtual ~AbstractOneStepIvpOdeSolver()
00170     {}
00171 };
00172 
00173 CLASS_IS_ABSTRACT(AbstractOneStepIvpOdeSolver)
00174 
00175 #endif //_ABSTRACTONESTEPIVPODESOLVER_HPP_