Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
RungeKuttaFehlbergIvpOdeSolver.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, 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
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36#ifndef _RUNGEKUTTAFEHLBERGIVPODESOLVER_HPP_
37#define _RUNGEKUTTAFEHLBERGIVPODESOLVER_HPP_
38
40#include <boost/serialization/base_object.hpp>
41
42#include "AbstractOneStepIvpOdeSolver.hpp"
43
57{
58friend class TestRungeKuttaFehlbergIvpOdeSolver;
59
60private:
69 template<class Archive>
70 void serialize(Archive & archive, const unsigned int version)
71 {
72 // This calls serialize on the base class - all member variables instantiated on construction or temporary.
73 archive & boost::serialization::base_object<AbstractIvpOdeSolver>(*this);
74 }
75
76 /*
77 * All these are here for more efficient memory allocation, rather than
78 * because they need to be member variables.
79 */
80
81 double m1932o2197;
82 double m7200o2197;
83 double m7296o2197;
84 double m12o13;
85 double m439o216;
86 double m3680o513;
87 double m845o4104;
88 double m8o27;
89 double m3544o2565;
90 double m1859o4104;
91 double m1o360;
92 double m128o4275;
93 double m2197o75240;
94 double m2o55;
95 double m25o216;
96 double m1408o2565;
97 double m2197o4104;
99 std::vector<double> mError;
101 std::vector<double> mk1;
102 std::vector<double> mk2;
103 std::vector<double> mk3;
104 std::vector<double> mk4;
105 std::vector<double> mk5;
106 std::vector<double> mk6;
107 std::vector<double> myk2;
108 std::vector<double> myk3;
109 std::vector<double> myk4;
110 std::vector<double> myk5;
111 std::vector<double> myk6;
113protected:
114
129 void InternalSolve(OdeSolution& rSolution,
130 AbstractOdeSystem* pAbstractOdeSystem,
131 std::vector<double>& rCurrentYValues,
132 std::vector<double>& rWorkingMemory,
133 double startTime,
134 double endTime,
135 double maxTimeStep,
136 double minTimeStep,
137 double tolerance,
138 bool outputSolution);
139
150 void CalculateNextYValue(AbstractOdeSystem* pAbstractOdeSystem,
151 double timeStep,
152 double time,
153 std::vector<double>& rCurrentYValues,
154 std::vector<double>& rNextYValues);
155
166 void AdjustStepSize(double& rCurrentStepSize,
167 const double& rError,
168 const double& rTolerance,
169 const double& rMaxTimeStep,
170 const double& rMinTimeStep);
171
172public:
173
178
199 OdeSolution Solve(AbstractOdeSystem* pAbstractOdeSystem,
200 std::vector<double>& rYValues,
201 double startTime,
202 double endTime,
203 double timeStep,
204 double ignoredSamplingTime);
205
221 void Solve(AbstractOdeSystem* pAbstractOdeSystem,
222 std::vector<double>& rYValues,
223 double startTime,
224 double endTime,
225 double timeStep);
226};
227
230
231#endif //_RUNGEKUTTAFEHLBERGIVPODESOLVER_HPP_
gcov doesn't like this file...
#define CHASTE_CLASS_EXPORT(T)
void AdjustStepSize(double &rCurrentStepSize, const double &rError, const double &rTolerance, const double &rMaxTimeStep, const double &rMinTimeStep)
void InternalSolve(OdeSolution &rSolution, AbstractOdeSystem *pAbstractOdeSystem, std::vector< double > &rCurrentYValues, std::vector< double > &rWorkingMemory, double startTime, double endTime, double maxTimeStep, double minTimeStep, double tolerance, bool outputSolution)
OdeSolution Solve(AbstractOdeSystem *pAbstractOdeSystem, std::vector< double > &rYValues, double startTime, double endTime, double timeStep, double ignoredSamplingTime)
void serialize(Archive &archive, const unsigned int version)
friend class boost::serialization::access
void CalculateNextYValue(AbstractOdeSystem *pAbstractOdeSystem, double timeStep, double time, std::vector< double > &rCurrentYValues, std::vector< double > &rNextYValues)