RegularStimulus.cpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2009
00004 
00005 University of Oxford means the Chancellor, Masters and Scholars of the
00006 University of Oxford, having an administrative office at Wellington
00007 Square, Oxford OX1 2JD, UK.
00008 
00009 This file is part of Chaste.
00010 
00011 Chaste is free software: you can redistribute it and/or modify it
00012 under the terms of the GNU Lesser General Public License as published
00013 by the Free Software Foundation, either version 2.1 of the License, or
00014 (at your option) any later version.
00015 
00016 Chaste is distributed in the hope that it will be useful, but WITHOUT
00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00019 License for more details. The offer of Chaste under the terms of the
00020 License is subject to the License being interpreted in accordance with
00021 English Law and subject to any action against the University of Oxford
00022 being under the jurisdiction of the English Courts.
00023 
00024 You should have received a copy of the GNU Lesser General Public License
00025 along with Chaste. If not, see <http://www.gnu.org/licenses/>.
00026 
00027 */
00028 
00029 
00030 #include "RegularStimulus.hpp"
00031 #include <cmath>
00032 #include <cassert>
00033 
00043 RegularStimulus::RegularStimulus(double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime)
00044 {
00045     assert(period > 0);
00046     assert(period >= duration);
00047 
00048     mMagnitudeOfStimulus = magnitudeOfStimulus;
00049     mDuration = duration;
00050     mPeriod = period;
00051     mStartTime = startTime;
00052     mStopTime = stopTime;
00053 
00054     //Swell duration to avoid rounding issues
00055     mDuration += period*DBL_EPSILON;
00056 }
00057 
00061 RegularStimulus::~RegularStimulus()
00062 {
00063     // Do nothing
00064 }
00065 
00072 double RegularStimulus::GetStimulus(double time)
00073 {
00074     double beatTime = fmod(time-mStartTime,mPeriod);
00075 
00076     if (beatTime >=0 && beatTime <= mDuration && time <= mStopTime)
00077     {
00078         return mMagnitudeOfStimulus;
00079     }
00080     else
00081     {
00082         return 0.0;
00083     }
00084 }

Generated on Wed Mar 18 12:51:52 2009 for Chaste by  doxygen 1.5.5