Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
RegularStimulus.cpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, are permitted provided that the following conditions are met:
14 * Redistributions of source code must retain the above copyright notice,
15 this list of conditions and the following disclaimer.
16 * Redistributions in binary form must reproduce the above copyright notice,
17 this list of conditions and the following disclaimer in the documentation
18 and/or other materials provided with the distribution.
19 * Neither the name of the University of Oxford nor the names of its
20 contributors may be used to endorse or promote products derived from this
21 software without specific prior written permission.
22
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36
37#include "RegularStimulus.hpp"
38#include <cmath>
39#include <cassert>
40
41#include <iostream>
42
43RegularStimulus::RegularStimulus(double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime)
44{
45 assert(period > 0);
46 assert(period >= duration);
47
48 mMagnitudeOfStimulus = magnitudeOfStimulus;
49 mDuration = duration;
50 mPeriod = period;
51 mStartTime = startTime;
52 mStopTime = stopTime;
53
54 //Swell duration to avoid rounding issues
55 mDuration += period*DBL_EPSILON;
56}
57
59{
60 /*
61 * This covers a borderline case where start time is larger than period
62 * and period divides start time, e.g. start_time=2 period=1.
63 *
64 * fmod() will return -0 in this case and will therefore switch the stimulus on.
65 */
66 if (time < mStartTime)
67 {
68 return 0.0;
69 }
70
71 double beatTime = fmod(time-mStartTime, mPeriod);
72
73 if (beatTime >=0 && beatTime <= mDuration && time <= mStopTime)
74 {
76 }
77 else
78 {
79 return 0.0;
80 }
81}
82
84{
85 return mPeriod;
86}
87
92
94{
95 return mDuration;
96}
97
99{
100 return mStartTime;
101}
102
103void RegularStimulus::SetMagnitude(double magnitude)
104{
105 mMagnitudeOfStimulus = magnitude;
106}
107
108void RegularStimulus::SetPeriod(double period)
109{
110 mPeriod = period;
111}
112
113void RegularStimulus::SetDuration(double duration)
114{
115 mDuration = duration;
116}
117
118void RegularStimulus::SetStartTime(double startTime)
119{
120 mStartTime = startTime;
121}
122
123void RegularStimulus::SetStopTime(double stopTime)
124{
125 mStopTime = stopTime;
126}
127
128// Serialization for Boost >= 1.36
#define CHASTE_CLASS_EXPORT(T)
void SetStopTime(double stopTime)
void SetMagnitude(double magnitude)
void SetPeriod(double period)
RegularStimulus(double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime=DBL_MAX)
void SetDuration(double duration)
void SetStartTime(double startTime)
double GetStimulus(double time)