Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
TysonNovak2001OdeSystem.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 TYSONNOVAK2001ODESYSTEM_HPP_
37#define TYSONNOVAK2001ODESYSTEM_HPP_
38
40#include <boost/serialization/base_object.hpp>
41
42#include <cmath>
43#include <iostream>
44
45#include "AbstractOdeSystemWithAnalyticJacobian.hpp"
46
52{
53private:
54
60 double mK1;
62 double mK2d;
64 double mK2dd;
66 double mK2ddd;
70 double mK3d;
72 double mK3dd;
74 double mK4d;
76 double mK4;
78 double mJ3;
80 double mJ4;
82 double mK5d;
84 double mK5dd;
86 double mK6;
88 double mJ5;
90 unsigned mN;
92 double mK7;
94 double mK8;
96 double mJ7;
98 double mJ8;
100 double mMad;
102 double mK9;
104 double mK10;
106 double mK11;
108 double mK12d;
110 double mK12dd;
112 double mK12ddd;
114 double mKeq;
116 double mK13;
118 double mK14;
120 double mK15d;
122 double mK15dd;
124 double mK16d;
126 double mK16dd;
128 double mJ15;
130 double mJ16;
132 double mMu;
134 double mMstar;
135
136 friend class boost::serialization::access;
143 template<class Archive>
144 void serialize(Archive & archive, const unsigned int version)
145 {
146 archive & boost::serialization::base_object<AbstractOdeSystem>(*this);
147 }
148
149public:
150
156 TysonNovak2001OdeSystem(std::vector<double> stateVariables=std::vector<double>());
157
162
166 void Init();
167
178 void EvaluateYDerivatives(double time, const std::vector<double>& rY, std::vector<double>& rDY);
179
189 bool CalculateStoppingEvent(double time, const std::vector<double>& rY);
190
200 double CalculateRootFunction(double time, const std::vector<double>& rY);
201
210 virtual void AnalyticJacobian(const std::vector<double>& rSolutionGuess, double** jacobian, double time, double timeStep);
211};
212
213// Declare identifier for the serializer
216
217namespace boost
218{
219namespace serialization
220{
224template<class Archive>
225inline void save_construct_data(
226 Archive & ar, const TysonNovak2001OdeSystem * t, const unsigned int file_version)
227{
228 // Save data required to construct instance
229 const std::vector<double>& state_variables = t->rGetConstStateVariables();
230 ar & state_variables;
231}
232
236template<class Archive>
237inline void load_construct_data(
238 Archive & ar, TysonNovak2001OdeSystem * t, const unsigned int file_version)
239{
240 // Retrieve data from archive required to construct new instance
241 std::vector<double> state_variables;
242 ar & state_variables;
243
244 // Invoke inplace constructor to initialise instance
245 ::new(t)TysonNovak2001OdeSystem(state_variables);
246}
247}
248} // namespace ...
249
250#endif /*TYSONNOVAK2001ODESYSTEM_HPP_*/
gcov doesn't like this file...
#define CHASTE_CLASS_EXPORT(T)
void EvaluateYDerivatives(double time, const std::vector< double > &rY, std::vector< double > &rDY)
bool CalculateStoppingEvent(double time, const std::vector< double > &rY)
virtual void AnalyticJacobian(const std::vector< double > &rSolutionGuess, double **jacobian, double time, double timeStep)
void serialize(Archive &archive, const unsigned int version)
double CalculateRootFunction(double time, const std::vector< double > &rY)