Chaste  Release::3.4
AbstractIvpOdeSolver.hpp
1 /*
2 
3 Copyright (c) 2005-2016, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef _ABSTRACTIVPODESOLVER_HPP_
37 #define _ABSTRACTIVPODESOLVER_HPP_
38 
39 #include <vector>
40 
41 #include "ChasteSerialization.hpp"
42 #include "ClassIsAbstract.hpp"
43 #include "Identifiable.hpp"
44 
45 #include "OdeSolution.hpp"
46 #include "AbstractOdeSystem.hpp"
47 
53 {
62  template<class Archive>
63  void serialize(Archive & archive, const unsigned int version)
64  {
65  archive & mStoppingEventOccurred;
66  archive & mStoppingTime;
67  }
68 
69 protected:
70 
76 
78  double mStoppingTime;
79 
80 public:
81 
101  virtual OdeSolution Solve(AbstractOdeSystem* pAbstractOdeSystem,
102  std::vector<double>& rYValues,
103  double startTime,
104  double endTime,
105  double timeStep,
106  double timeSampling)=0;
107 
123  virtual void Solve(AbstractOdeSystem* pAbstractOdeSystem,
124  std::vector<double>& rYValues,
125  double startTime,
126  double endTime,
127  double timeStep)=0;
128 
139  virtual void SolveAndUpdateStateVariable(AbstractOdeSystem* pAbstractOdeSystem,
140  double startTime,
141  double endTime,
142  double timeStep);
143 
148  bool StoppingEventOccurred();
149 
155  double GetStoppingTime();
156 
161 
165  virtual ~AbstractIvpOdeSolver();
166 
167 };
168 
170 
171 #endif //_ABSTRACTIVPODESOLVER_HPP_
#define CLASS_IS_ABSTRACT(T)
friend class boost::serialization::access
void serialize(Archive &archive, const unsigned int version)
virtual void SolveAndUpdateStateVariable(AbstractOdeSystem *pAbstractOdeSystem, double startTime, double endTime, double timeStep)
virtual OdeSolution Solve(AbstractOdeSystem *pAbstractOdeSystem, std::vector< double > &rYValues, double startTime, double endTime, double timeStep, double timeSampling)=0