![]() |
Chaste Commit::333233612e3dcc941d260418acd7b5ccdc30390e
|
#include <RegularStimulusZeroNetCharge.hpp>
Public Member Functions | |
RegularStimulusZeroNetCharge (double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime=DBL_MAX) | |
double | GetStimulus (double time) |
![]() | |
RegularStimulus (double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime=DBL_MAX) | |
double | GetPeriod () |
double | GetMagnitude () |
double | GetDuration () |
double | GetStartTime () |
void | SetMagnitude (double magnitude) |
void | SetPeriod (double period) |
void | SetDuration (double duration) |
void | SetStartTime (double startTime) |
void | SetStopTime (double stopTime) |
![]() | |
virtual | ~AbstractStimulusFunction () |
virtual void | Clear () |
Private Member Functions | |
template<class Archive > | |
void | serialize (Archive &archive, const unsigned int version) |
Friends | |
class | boost::serialization::access |
Additional Inherited Members | |
![]() | |
double | mMagnitudeOfStimulus |
double | mDuration |
double | mPeriod |
double | mStartTime |
double | mStopTime |
Provides a periodic square-wave stimulus, where the total net charge is zero for every stimulus.
i.e., -------- | | | | -------- | ------------- | | | | --------
<————> Duration
Definition at line 60 of file RegularStimulusZeroNetCharge.hpp.
RegularStimulusZeroNetCharge::RegularStimulusZeroNetCharge | ( | double | magnitudeOfStimulus, |
double | duration, | ||
double | period, | ||
double | startTime, | ||
double | stopTime = DBL_MAX |
||
) |
Create a new stimulus.
magnitudeOfStimulus | The size of the stimulus, both positive and negative |
duration | How long the stimulus is applied for (time positive + time negative) |
period | The time between square waves being applied |
startTime | The time at which the first wave is applied |
stopTime | The time the stimulus is removed (defaults to DBL_MAX if omitted) |
Definition at line 40 of file RegularStimulusZeroNetCharge.cpp.
Get the magnitude of stimulus at time 'time'. Re-implemented from parent class RegulsrStimulus.
time | The current time |
Reimplemented from RegularStimulus.
Definition at line 46 of file RegularStimulusZeroNetCharge.cpp.
References RegularStimulus::mDuration, RegularStimulus::mMagnitudeOfStimulus, RegularStimulus::mPeriod, RegularStimulus::mStartTime, and RegularStimulus::mStopTime.
|
inlineprivate |
Archive the simple stimulus, never used directly - boost uses this.
archive | |
version |
Definition at line 72 of file RegularStimulusZeroNetCharge.hpp.
|
friend |
Needed for serialization.
Definition at line 64 of file RegularStimulusZeroNetCharge.hpp.