Chaste Release::3.1
AbstractSteadyStateRunner.cpp
00001 /*
00002 
00003 Copyright (c) 2005-2012, University of Oxford.
00004 All rights reserved.
00005 
00006 University of Oxford means the Chancellor, Masters and Scholars of the
00007 University of Oxford, having an administrative office at Wellington
00008 Square, Oxford OX1 2JD, UK.
00009 
00010 This file is part of Chaste.
00011 
00012 Redistribution and use in source and binary forms, with or without
00013 modification, are permitted provided that the following conditions are met:
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016  * Redistributions in binary form must reproduce the above copyright notice,
00017    this list of conditions and the following disclaimer in the documentation
00018    and/or other materials provided with the distribution.
00019  * Neither the name of the University of Oxford nor the names of its
00020    contributors may be used to endorse or promote products derived from this
00021    software without specific prior written permission.
00022 
00023 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00026 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00027 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00028 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
00029 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00030 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00031 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00032 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 
00034 */
00035 
00036 #include "AbstractSteadyStateRunner.hpp"
00037 
00038 #ifdef CHASTE_CVODE
00039 
00040 AbstractSteadyStateRunner::AbstractSteadyStateRunner(boost::shared_ptr<AbstractCvodeCell> pModel)
00041  : mpModel(pModel),
00042    mNumEvaluations(0u),
00043    mMaxNumPaces(10000u)
00044 {}
00045 
00046 
00047 bool AbstractSteadyStateRunner::RunToSteadyState()
00048 {
00049     // Get timing information from the cell stimulus (only works for regular stimuli)
00050     if (!boost::dynamic_pointer_cast<RegularStimulus>(mpModel->GetStimulusFunction()) )
00051     {
00052         EXCEPTION("Steady State approximations only work for models with RegularStimulus objects.");
00053     }
00054 
00055     RunToSteadyStateImplementation();
00056 
00057     if (mNumEvaluations<mMaxNumPaces)
00058     {
00059         std::cout << "Steady state detected after " << GetNumEvaluations() << " paces." << std::endl;
00060         return true;
00061     }
00062     else
00063     {
00064         std::cout << "Steady state not reached after "<< GetNumEvaluations() << " paces." << std::endl;
00065         WARNING("Model " << mpModel->GetSystemName() << " did not reach steady state within " << mMaxNumPaces << " paces.");
00066         return false;
00067     }
00068 }
00069 
00070 
00071 unsigned AbstractSteadyStateRunner::GetNumEvaluations()
00072 {
00073     return mNumEvaluations;
00074 }
00075 
00076 
00077 void AbstractSteadyStateRunner::SetMaxNumPaces(unsigned numPaces)
00078 {
00079     if (numPaces==0u)
00080     {
00081         EXCEPTION("Please set a maximum number of paces that is positive");
00082     }
00083     mMaxNumPaces = numPaces;
00084 }
00085 
00086 #endif // CHASTE_CVODE
00087