Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractGeneralizedRushLarsenCardiacCell.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 ABSTRACTGENERALIZEDRUSHLARSENCARDIACCELL_HPP_
37#define ABSTRACTGENERALIZEDRUSHLARSENCARDIACCELL_HPP_
38
40#include <boost/serialization/base_object.hpp>
41#include "ClassIsAbstract.hpp"
42#include "AbstractCardiacCell.hpp"
43#include "PetscTools.hpp"
44
45/*
46Megan E. Marsh, Raymond J. Spiteri
47Numerical Simulation Laboratory
48University of Saskatchewan
49December 2011
50Partial support provided by research grants from the National
51Science and Engineering Research Council (NSERC) of Canada
52and the MITACS/Mprime Canadian Network of Centres of Excellence.
53*/
54
60{
61private:
70 template<class Archive>
71 void serialize(Archive & archive, const unsigned int version)
72 {
73 // This calls serialize on the base class.
74 archive & boost::serialization::base_object<AbstractCardiacCell>(*this);
75 }
76
77public:
92 unsigned numberOfStateVariables,
93 unsigned voltageIndex,
94 boost::shared_ptr<AbstractStimulusFunction> pIntracellularStimulus);
95
98
110 OdeSolution Compute(double tStart, double tEnd, double tSamp=0.0);
111
122 void ComputeExceptVoltage(double tStart, double tEnd);
123
131 void SolveAndUpdateState(double tStart, double tEnd);
132
133
137 bool HasAnalyticJacobian() const;
138
145 void ForceUseOfNumericalJacobian(bool useNumericalJacobian = true);
146
147
148private:
149// LCOV_EXCL_START
157 void EvaluateYDerivatives(double time, const std::vector<double>& rY, std::vector<double>& rDY)
158 {
160 }
161// LCOV_EXCL_STOP
162
163protected:
169 virtual void ComputeOneStepExceptVoltage(double time)=0;
170
176 virtual void UpdateTransmembranePotential(double time)=0;
177
179 std::vector<double> mPartialF;
180
182 std::vector<double> mEvalF;
183
185 std::vector<double> mYInit;
186
189};
190
192
193#endif // ABSTRACTGENERALIZEDRUSHLARSENCARDIACCELL_HPP_
#define CLASS_IS_ABSTRACT(T)
#define NEVER_REACHED
void serialize(Archive &archive, const unsigned int version)
void EvaluateYDerivatives(double time, const std::vector< double > &rY, std::vector< double > &rDY)
virtual void UpdateTransmembranePotential(double time)=0
OdeSolution Compute(double tStart, double tEnd, double tSamp=0.0)
virtual void ComputeOneStepExceptVoltage(double time)=0