Chaste
Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractSteadyStateRunner.cpp
1
/*
2
3
Copyright (c) 2005-2024, University of Oxford.
4
All rights reserved.
5
6
University of Oxford means the Chancellor, Masters and Scholars of the
7
University of Oxford, having an administrative office at Wellington
8
Square, Oxford OX1 2JD, UK.
9
10
This file is part of Chaste.
11
12
Redistribution and use in source and binary forms, with or without
13
modification, 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
23
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34
*/
35
36
#include "AbstractSteadyStateRunner.hpp"
37
38
#ifdef CHASTE_CVODE
39
40
AbstractSteadyStateRunner::AbstractSteadyStateRunner
(boost::shared_ptr<AbstractCvodeCell> pModel)
41
: mpModel(pModel),
42
mNumEvaluations(0u),
43
mMaxNumPaces(10000u),
44
mSuppressOutput(false)
45
{
46
}
47
48
bool
AbstractSteadyStateRunner::RunToSteadyState
()
49
{
50
// Get timing information from the cell stimulus (only works for regular stimuli)
51
if
(!boost::dynamic_pointer_cast<RegularStimulus>(
mpModel
->GetStimulusFunction()))
52
{
53
EXCEPTION
(
"Steady State approximations only work for models with RegularStimulus objects."
);
54
}
55
56
RunToSteadyStateImplementation
();
57
58
if
(
mNumEvaluations
<
mMaxNumPaces
)
59
{
60
if
(!
mSuppressOutput
)
61
{
62
std::cout <<
"Steady state detected after "
<<
GetNumEvaluations
() <<
" paces."
<< std::endl;
63
}
64
return
true
;
65
}
66
else
67
{
68
if
(!
mSuppressOutput
)
69
{
70
std::cout <<
"Steady state not reached after "
<<
GetNumEvaluations
() <<
" paces."
<< std::endl;
71
}
72
WARNING(
"Model "
<<
mpModel
->GetSystemName() <<
" did not reach steady state within "
<<
mMaxNumPaces
<<
" paces."
);
73
return
false
;
74
}
75
}
76
77
void
AbstractSteadyStateRunner::SuppressOutput
(
bool
suppress)
78
{
79
mSuppressOutput
= suppress;
80
}
81
82
unsigned
AbstractSteadyStateRunner::GetNumEvaluations
()
83
{
84
return
mNumEvaluations
;
85
}
86
87
void
AbstractSteadyStateRunner::SetMaxNumPaces
(
unsigned
numPaces)
88
{
89
if
(numPaces == 0u)
90
{
91
EXCEPTION
(
"Please set a maximum number of paces that is positive"
);
92
}
93
mMaxNumPaces
= numPaces;
94
}
95
96
#endif
// CHASTE_CVODE
EXCEPTION
#define EXCEPTION(message)
Definition
Exception.hpp:156
AbstractSteadyStateRunner::mMaxNumPaces
unsigned mMaxNumPaces
Definition
AbstractSteadyStateRunner.hpp:68
AbstractSteadyStateRunner::GetNumEvaluations
unsigned GetNumEvaluations()
Definition
AbstractSteadyStateRunner.cpp:82
AbstractSteadyStateRunner::RunToSteadyStateImplementation
virtual void RunToSteadyStateImplementation()=0
AbstractSteadyStateRunner::mpModel
boost::shared_ptr< AbstractCvodeCell > mpModel
Definition
AbstractSteadyStateRunner.hpp:62
AbstractSteadyStateRunner::mSuppressOutput
bool mSuppressOutput
Definition
AbstractSteadyStateRunner.hpp:71
AbstractSteadyStateRunner::AbstractSteadyStateRunner
AbstractSteadyStateRunner()
Definition
AbstractSteadyStateRunner.hpp:58
AbstractSteadyStateRunner::mNumEvaluations
unsigned mNumEvaluations
Definition
AbstractSteadyStateRunner.hpp:65
AbstractSteadyStateRunner::SetMaxNumPaces
void SetMaxNumPaces(unsigned numPaces)
Definition
AbstractSteadyStateRunner.cpp:87
AbstractSteadyStateRunner::SuppressOutput
void SuppressOutput(bool suppress=true)
Definition
AbstractSteadyStateRunner.cpp:77
AbstractSteadyStateRunner::RunToSteadyState
bool RunToSteadyState()
Definition
AbstractSteadyStateRunner.cpp:48
heart
src
odes
single_cell
AbstractSteadyStateRunner.cpp
Generated by
1.9.8