Chaste Commit::1fd4e48e3990e67db148bc1bc4cf6991a0049d0c
|
#include <AbstractSteadyStateRunner.hpp>
Public Member Functions | |
AbstractSteadyStateRunner (boost::shared_ptr< AbstractCvodeCell > pModel) | |
virtual | ~AbstractSteadyStateRunner () |
bool | RunToSteadyState () |
void | SuppressOutput (bool suppress=true) |
unsigned | GetNumEvaluations () |
void | SetMaxNumPaces (unsigned numPaces) |
Protected Member Functions | |
virtual void | RunToSteadyStateImplementation ()=0 |
Protected Attributes | |
boost::shared_ptr< AbstractCvodeCell > | mpModel |
unsigned | mNumEvaluations |
unsigned | mMaxNumPaces |
bool | mSuppressOutput |
Private Member Functions | |
AbstractSteadyStateRunner () | |
This class is abstract to investigate different ways of getting a cell model to steady state.
A simple concrete example is SteadyStateRunner.
Definition at line 52 of file AbstractSteadyStateRunner.hpp.
|
inlineprivate |
Default constructor is private to ensure it is never used.
Definition at line 58 of file AbstractSteadyStateRunner.hpp.
AbstractSteadyStateRunner::AbstractSteadyStateRunner | ( | boost::shared_ptr< AbstractCvodeCell > | pModel | ) |
Constructor
pModel | The cell model to run to steady state. |
Definition at line 40 of file AbstractSteadyStateRunner.cpp.
|
inlinevirtual |
Destructor (empty)
Definition at line 96 of file AbstractSteadyStateRunner.hpp.
unsigned AbstractSteadyStateRunner::GetNumEvaluations | ( | ) |
Definition at line 82 of file AbstractSteadyStateRunner.cpp.
References mNumEvaluations.
Referenced by RunToSteadyState().
bool AbstractSteadyStateRunner::RunToSteadyState | ( | ) |
Run the cell model to steady state (defined by a small change in state variables between beats)
Requires a method called RunToSteadyStateImplementation which must be overridden in subclasses for different approximations.
Definition at line 48 of file AbstractSteadyStateRunner.cpp.
References EXCEPTION, GetNumEvaluations(), mMaxNumPaces, mNumEvaluations, mpModel, mSuppressOutput, and RunToSteadyStateImplementation().
|
protectedpure virtual |
Run the cell model to steady state (defined by a small change in state variables between beats)
Must be overridden in subclasses for different approximations.
Subclasses must check they don't do more than mMaxNumPaces and should increment mNumEvaluations to reflect how many paces were simulated
Implemented in SteadyStateRunner.
Referenced by RunToSteadyState().
void AbstractSteadyStateRunner::SetMaxNumPaces | ( | unsigned | numPaces | ) |
numPaces | The maximum number of paces to do on the way to steady state |
Definition at line 87 of file AbstractSteadyStateRunner.cpp.
References EXCEPTION, and mMaxNumPaces.
void AbstractSteadyStateRunner::SuppressOutput | ( | bool | suppress = true | ) |
Stop class, and subclasses printing output to std::cout
suppress | whether to suppress output. |
Definition at line 77 of file AbstractSteadyStateRunner.cpp.
References mSuppressOutput.
|
protected |
The maximum number of paces that are allowed
Definition at line 68 of file AbstractSteadyStateRunner.hpp.
Referenced by RunToSteadyState(), SteadyStateRunner::RunToSteadyStateImplementation(), and SetMaxNumPaces().
|
protected |
The number of evaluations that it took
Definition at line 65 of file AbstractSteadyStateRunner.hpp.
Referenced by GetNumEvaluations(), RunToSteadyState(), and SteadyStateRunner::RunToSteadyStateImplementation().
|
protected |
The cell model to run to steady state
Definition at line 62 of file AbstractSteadyStateRunner.hpp.
Referenced by RunToSteadyState(), and SteadyStateRunner::RunToSteadyStateImplementation().
|
protected |
Whether to suppress output from this class (defaults to false)
Definition at line 71 of file AbstractSteadyStateRunner.hpp.
Referenced by RunToSteadyState(), and SuppressOutput().