RegularStimulus.cpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2011
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 
00034 #include <iostream>
00035 
00036 RegularStimulus::RegularStimulus(double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime)
00037 {
00038     assert(period > 0);
00039     assert(period >= duration);
00040 
00041     mMagnitudeOfStimulus = magnitudeOfStimulus;
00042     mDuration = duration;
00043     mPeriod = period;
00044     mStartTime = startTime;
00045     mStopTime = stopTime;
00046 
00047     //Swell duration to avoid rounding issues
00048     mDuration += period*DBL_EPSILON;
00049 }
00050 
00051 double RegularStimulus::GetStimulus(double time)
00052 {
00053     /*
00054      *  This covers a borderline case where start time is larger than period 
00055      * and period divides start time, e.g. start_time=2 period=1.
00056      * 
00057      * fmod() will return -0 in this case and will therefore switch the stimulus on.
00058      */
00059     if (time < mStartTime)
00060     {
00061         return 0.0;
00062     }        
00063     
00064     double beatTime = fmod(time-mStartTime,mPeriod);
00065     
00066     if (beatTime >=0 && beatTime <= mDuration && time <= mStopTime)
00067     {
00068         return mMagnitudeOfStimulus;
00069     }
00070     else
00071     {
00072         return 0.0;
00073     }
00074 }
00075 
00076 double RegularStimulus::GetPeriod()
00077 {
00078     return mPeriod;
00079 }
00080 
00081 double RegularStimulus::GetMagnitude()
00082 {
00083     return mMagnitudeOfStimulus;
00084 }
00085 
00086 double RegularStimulus::GetDuration()
00087 {
00088     return mDuration;
00089 }
00090 
00091 double RegularStimulus::GetStartTime()
00092 {
00093     return mStartTime;
00094 }
00095 
00096 void RegularStimulus::SetPeriod(double period)
00097 {
00098     mPeriod = period;
00099 }
00100 
00101 void RegularStimulus::SetStartTime(double startTime)
00102 {
00103     mStartTime = startTime;
00104 }
00105 
00106 void RegularStimulus::SetStopTime(double stopTime)
00107 {
00108     mStopTime = stopTime;
00109 }
00110 
00111 // Serialization for Boost >= 1.36
00112 #include "SerializationExportWrapperForCpp.hpp"
00113 CHASTE_CLASS_EXPORT(RegularStimulus)

Generated on Tue May 31 14:31:42 2011 for Chaste by  doxygen 1.5.5