RegularStimulusZeroNetCharge.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 "RegularStimulusZeroNetCharge.hpp"
00031 #include <cmath>
00032 
00033 RegularStimulusZeroNetCharge::RegularStimulusZeroNetCharge(double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime)
00034     : RegularStimulus(magnitudeOfStimulus, duration, period, startTime,stopTime)
00035 {
00036 
00037 }
00038 
00039 double RegularStimulusZeroNetCharge::GetStimulus(double time)
00040 {
00041     /*
00042      * This covers a borderline case where start time is larger than period
00043      * and period divides start time, e.g. start_time=2 period=1.
00044      *
00045      * fmod() will return -0 in this case and will therefore switch the stimulus on.
00046      */
00047     if (time < mStartTime)
00048     {
00049         return 0.0;
00050     }
00051 
00052     double beatTime = fmod(time-mStartTime,mPeriod);
00053 
00054     if (beatTime >=0 && beatTime <= mDuration/2 && time <= mStopTime)
00055     {
00056         return mMagnitudeOfStimulus;
00057     }
00058     else if (beatTime >=0 && beatTime > mDuration/2 && beatTime <= mDuration && time <= mStopTime)
00059     {
00060         return -mMagnitudeOfStimulus;
00061     }
00062     else
00063     {
00064         return 0.0;
00065     }
00066 }
00067 
00068 // Serialization for Boost >= 1.36
00069 #include "SerializationExportWrapperForCpp.hpp"
00070 CHASTE_CLASS_EXPORT(RegularStimulusZeroNetCharge)

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