Chaste  Release::3.4
AbstractOneStepIvpOdeSolver.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 _ABSTRACTONESTEPIVPODESOLVER_HPP_
37 #define _ABSTRACTONESTEPIVPODESOLVER_HPP_
38 
39 #include "ChasteSerialization.hpp"
40 #include "ClassIsAbstract.hpp"
41 #include <boost/serialization/base_object.hpp>
42 
43 #include "AbstractIvpOdeSolver.hpp"
44 
50 {
51 
52 private:
53 
62  template<class Archive>
63  void serialize(Archive & archive, const unsigned int version)
64  {
65  // This calls serialize on the base class.
66  archive & boost::serialization::base_object<AbstractIvpOdeSolver>(*this);
67  }
68 
72  std::vector<double> mWorkingMemory;
73 
74 protected:
75 
87  virtual void InternalSolve(AbstractOdeSystem* pAbstractOdeSystem,
88  std::vector<double>& rCurrentYValues,
89  std::vector<double>& rWorkingMemory,
90  double startTime,
91  double endTime,
92  double timeStep);
93 
104  virtual void CalculateNextYValue(AbstractOdeSystem* pAbstractOdeSystem,
105  double timeStep,
106  double time,
107  std::vector<double>& rCurrentYValues,
108  std::vector<double>& rNextYValues)=0;
109 
110 public:
111 
138  virtual OdeSolution Solve(AbstractOdeSystem* pAbstractOdeSystem,
139  std::vector<double>& rYValues,
140  double startTime,
141  double endTime,
142  double timeStep,
143  double timeSampling);
144 
167  virtual void Solve(AbstractOdeSystem* pAbstractOdeSystem,
168  std::vector<double>& rYValues,
169  double startTime,
170  double endTime,
171  double timeStep);
172 
177  {}
178 };
179 
181 
182 #endif //_ABSTRACTONESTEPIVPODESOLVER_HPP_
#define CLASS_IS_ABSTRACT(T)
virtual OdeSolution Solve(AbstractOdeSystem *pAbstractOdeSystem, std::vector< double > &rYValues, double startTime, double endTime, double timeStep, double timeSampling)
friend class boost::serialization::access
void serialize(Archive &archive, const unsigned int version)
virtual void InternalSolve(AbstractOdeSystem *pAbstractOdeSystem, std::vector< double > &rCurrentYValues, std::vector< double > &rWorkingMemory, double startTime, double endTime, double timeStep)
virtual void CalculateNextYValue(AbstractOdeSystem *pAbstractOdeSystem, double timeStep, double time, std::vector< double > &rCurrentYValues, std::vector< double > &rNextYValues)=0