AbstractIvpOdeSolver.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 _ABSTRACTIVPODESOLVER_HPP_
00030 #define _ABSTRACTIVPODESOLVER_HPP_
00031 
00032 #include <vector>
00033 
00034 #include "ChasteSerialization.hpp"
00035 #include "ClassIsAbstract.hpp"
00036 #include "Identifiable.hpp"
00037 
00038 #include "OdeSolution.hpp"
00039 #include "AbstractOdeSystem.hpp"
00040 
00045 class AbstractIvpOdeSolver : public Identifiable
00046 {
00048     friend class boost::serialization::access;
00055     template<class Archive>
00056     void serialize(Archive & archive, const unsigned int version)
00057     {
00058         archive & mStoppingEventOccurred;
00059         archive & mStoppingTime;
00060     }
00061 
00062 protected :
00063 
00068     bool mStoppingEventOccurred;
00069 
00071     double mStoppingTime;
00072 
00073 public :
00074 
00094     virtual OdeSolution Solve(AbstractOdeSystem* pAbstractOdeSystem,
00095                               std::vector<double>& rYValues,
00096                               double startTime,
00097                               double endTime,
00098                               double timeStep,
00099                               double timeSampling)=0;
00100 
00116     virtual void Solve(AbstractOdeSystem* pAbstractOdeSystem,
00117                        std::vector<double>& rYValues,
00118                        double startTime,
00119                        double endTime,
00120                        double timeStep)=0;
00121 
00132     virtual void SolveAndUpdateStateVariable(AbstractOdeSystem* pAbstractOdeSystem,
00133                                              double startTime,
00134                                              double endTime,
00135                                              double timeStep);
00136 
00141     bool StoppingEventOccurred();
00142 
00148     double GetStoppingTime();
00149 
00153     AbstractIvpOdeSolver();
00154 
00158     virtual ~AbstractIvpOdeSolver();
00159 
00160 };
00161 
00162 CLASS_IS_ABSTRACT(AbstractIvpOdeSolver)
00163 
00164 #endif //_ABSTRACTIVPODESOLVER_HPP_

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