Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
NhsContractionModel.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#ifndef NHSCONTRACTIONMODEL_HPP_
36#define NHSCONTRACTIONMODEL_HPP_
37
38#include "AbstractOdeBasedContractionModel.hpp"
39#include "Exception.hpp"
40
41
57{
58friend class TestContractionModels;
59
60protected :
62 double mLambda;
64 double mDLambdaDt;
66 double mCalciumI;
67
68
71
73 double mK1;
75 double mK2;
76
77 // Parameters
78
80 static const double mKon;
81
83 static const double mKrefoff;
84
86 static const double mGamma;
87
89 static const double mCalciumTroponinMax;
90
92 static const double mAlphaR1;
93
95 static const double mAlphaR2;
96
98 static const double mKZ;
99
101 static const unsigned mNr;
102
104 static const double mBeta1;
105
107 static const double mAlpha0;
108
110 static const unsigned mN;
111
113 static const double mZp;
114
116 static const double mCalcium50ref;
117
119 static const double mTref;
120
122 static const double mBeta0;
123
125 static const double mA;
126
128 static const double mA1;
129
131 static const double mA2;
132
134 static const double mA3;
135
137 static const double mAlpha1;
138
140 static const double mAlpha2;
141
143 static const double mAlpha3;
144
150
156 double CalculateT0(double z);
157
158public :
164
171 void SetStretchAndStretchRate(double lambda, double dlambdaDt);
172
179
184 void SetIntracellularCalciumConcentration(double calciumConcentration);
185
191
199 void EvaluateYDerivatives(double time, const std::vector<double> &rY, std::vector<double> &rDY);
200
204 double GetActiveTension();
205
212 {
213 EXCEPTION("If using this in an 'explicit manner' call UpdateStateVariables() and then GetActiveTension(), otherwise use NhsModelWithBackwardSolver");
214 }
215
220 {
221 return true;
222 }
223
228 {
229 return true;
230 }
231};
232#endif /*NHSCONTRACTIONMODEL_HPP_*/
#define EXCEPTION(message)
static const double mAlpha3
static const double mTref
void SetIntracellularCalciumConcentration(double calciumConcentration)
static const double mAlpha2
static const double mBeta1
static const double mAlphaR2
static const double mA3
static const double mAlpha1
void EvaluateYDerivatives(double time, const std::vector< double > &rY, std::vector< double > &rDY)
static const double mAlphaR1
static const double mAlpha0
static const double mKrefoff
void SetInputParameters(ContractionModelInputParameters &rInputParameters)
static const double mBeta0
static const double mGamma
static const unsigned mNr
static const double mZp
static const unsigned mN
static const double mCalcium50ref
double CalculateT0(double z)
static const double mKon
static const double mA1
static const double mCalciumTroponinMax
static const double mKZ
static const double mA2
void SetStretchAndStretchRate(double lambda, double dlambdaDt)