AbstractIvpOdeSolver.hpp

00001 /*
00002 
00003 Copyright (c) 2005-2015, University of Oxford.
00004 All rights reserved.
00005 
00006 University of Oxford means the Chancellor, Masters and Scholars of the
00007 University of Oxford, having an administrative office at Wellington
00008 Square, Oxford OX1 2JD, UK.
00009 
00010 This file is part of Chaste.
00011 
00012 Redistribution and use in source and binary forms, with or without
00013 modification, are permitted provided that the following conditions are met:
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016  * Redistributions in binary form must reproduce the above copyright notice,
00017    this list of conditions and the following disclaimer in the documentation
00018    and/or other materials provided with the distribution.
00019  * Neither the name of the University of Oxford nor the names of its
00020    contributors may be used to endorse or promote products derived from this
00021    software without specific prior written permission.
00022 
00023 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00026 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00027 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00028 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
00029 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00030 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00031 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00032 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 
00034 */
00035 
00036 #ifndef _ABSTRACTIVPODESOLVER_HPP_
00037 #define _ABSTRACTIVPODESOLVER_HPP_
00038 
00039 #include <vector>
00040 
00041 #include "ChasteSerialization.hpp"
00042 #include "ClassIsAbstract.hpp"
00043 #include "Identifiable.hpp"
00044 
00045 #include "OdeSolution.hpp"
00046 #include "AbstractOdeSystem.hpp"
00047 
00052 class AbstractIvpOdeSolver : public Identifiable
00053 {
00055     friend class boost::serialization::access;
00062     template<class Archive>
00063     void serialize(Archive & archive, const unsigned int version)
00064     {
00065         archive & mStoppingEventOccurred;
00066         archive & mStoppingTime;
00067     }
00068 
00069 protected:
00070 
00075     bool mStoppingEventOccurred;
00076 
00078     double mStoppingTime;
00079 
00080 public:
00081 
00101     virtual OdeSolution Solve(AbstractOdeSystem* pAbstractOdeSystem,
00102                               std::vector<double>& rYValues,
00103                               double startTime,
00104                               double endTime,
00105                               double timeStep,
00106                               double timeSampling)=0;
00107 
00123     virtual void Solve(AbstractOdeSystem* pAbstractOdeSystem,
00124                        std::vector<double>& rYValues,
00125                        double startTime,
00126                        double endTime,
00127                        double timeStep)=0;
00128 
00139     virtual void SolveAndUpdateStateVariable(AbstractOdeSystem* pAbstractOdeSystem,
00140                                              double startTime,
00141                                              double endTime,
00142                                              double timeStep);
00143 
00148     bool StoppingEventOccurred();
00149 
00155     double GetStoppingTime();
00156 
00160     AbstractIvpOdeSolver();
00161 
00165     virtual ~AbstractIvpOdeSolver();
00166 
00167 };
00168 
00169 CLASS_IS_ABSTRACT(AbstractIvpOdeSolver)
00170 
00171 #endif //_ABSTRACTIVPODESOLVER_HPP_