Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
GRL2IvpOdeSolver.cpp
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/*
37Megan E. Marsh, Raymond J. Spiteri
38Numerical Simulation Laboratory
39University of Saskatchewan
40December 2011
41Partial support provided by research grants from the National
42Science and Engineering Research Council (NSERC) of Canada
43and the MITACS/Mprime Canadian Network of Centres of Excellence.
44*/
45
46#include <cstdio>
47#include <cmath>
48
49#include "GRL2IvpOdeSolver.hpp"
51 double timeStep,
52 double time,
53 std::vector<double>& rCurrentYValues,
54 std::vector<double>& rNextYValues)
55{
56 /*
57 * Apply GRL2 second-order method for each time step in AbstractOneStepIvpSolver.
58 * Calculates a vector containing the next Y value from the current one for each
59 * equation in the system.
60 */
61 const double delta = 1.0e-8; // The step for numerical jacobian calculation
62
63 const unsigned num_equations = pAbstractOdeSystem->GetNumberOfStateVariables();
64
65 if (mEvalF.size() != num_equations)
66 {
67 mEvalF.resize(num_equations);
68 mPartialF.resize(num_equations);
69 mTemp.resize(num_equations);
70 mYinit.resize(num_equations);
71 }
72
73 rNextYValues = rCurrentYValues;
74 double ysave;
75
76 mYinit = rNextYValues;
77 pAbstractOdeSystem->EvaluateYDerivatives(time, rNextYValues, mEvalF);
78
79 for (unsigned i=0; i<num_equations; i++)
80 {
81 rNextYValues[i]=rNextYValues[i]+delta;
82 pAbstractOdeSystem->EvaluateYDerivatives(time, rNextYValues, mTemp);
83 mPartialF[i]=(mTemp[i]-mEvalF[i])/delta;
84 rNextYValues[i]=rNextYValues[i]-delta;
85 }
86 // Midpoint
87 for (unsigned i=0; i<num_equations; i++)
88 {
89 if (fabs(mPartialF[i])<delta)
90 {
91 rNextYValues[i]=rNextYValues[i]+0.5*mEvalF[i]*timeStep;
92 }
93 else
94 {
95 rNextYValues[i]=rNextYValues[i]+(mEvalF[i]/mPartialF[i])*(exp(mPartialF[i]*0.5*timeStep)-1);
96 }
97 }
98 //Second half of the method
99 for (unsigned i=0; i<num_equations; i++)
100 {
101 ysave = rNextYValues[i];
102 rNextYValues[i]=mYinit[i];
103 pAbstractOdeSystem->EvaluateYDerivatives(time, rNextYValues, mTemp);
104 mEvalF[i]=mTemp[i];
105
106 rNextYValues[i]=rNextYValues[i]+delta;
107 pAbstractOdeSystem->EvaluateYDerivatives(time, rNextYValues, mTemp);
108 mPartialF[i]=(mTemp[i]-mEvalF[i])/delta;
109 rNextYValues[i]=ysave;
110 }
111
112 //Final step update
113 for (unsigned i=0; i<num_equations; i++)
114 {
115 if (fabs(mPartialF[i])<delta)
116 {
117 rNextYValues[i]=mYinit[i]+mEvalF[i]*timeStep;
118 }
119 else
120 {
121 rNextYValues[i]=mYinit[i]+(mEvalF[i]/mPartialF[i])*(exp(mPartialF[i]*timeStep)-1);
122 }
123 }
124}
125
126// Serialization for Boost >= 1.36
#define CHASTE_CLASS_EXPORT(T)
virtual void EvaluateYDerivatives(double time, const std::vector< double > &rY, std::vector< double > &rDY)=0
std::vector< double > mTemp
std::vector< double > mYinit
std::vector< double > mPartialF
std::vector< double > mEvalF
void CalculateNextYValue(AbstractOdeSystem *pAbstractOdeSystem, double timeStep, double time, std::vector< double > &rCurrentYValues, std::vector< double > &rNextYValues)