LifeV
StimulusPacingProtocol Class Reference

#include <StimulusPacingProtocol.hpp>

+ Inheritance diagram for StimulusPacingProtocol:
+ Collaboration diagram for StimulusPacingProtocol:

Private Attributes

Real M_radius
 
Real M_stimulusAmplitude
 
Real M_pacingSite_X
 
Real M_pacingSite_Y
 
Real M_pacingSite_Z
 
Real M_startingTimeStimulus
 
Real M_tShortS1S1
 
Real M_stimulusInterval
 
Real M_minimumStimulusInterval
 
Real M_stIntS1S2
 
Real M_stIntS1S2Min
 
Real M_stIntS2S3
 
Real M_stIntS3S4
 
int M_nbStimMax
 
int M_repeatSt
 
int M_numberStimulus
 
std::string M_pacingProtocol
 
std::string M_pacingProtocolType
 
Real M_stimulusDuration
 
Real M_dt
 

Constructors & Destructor

 StimulusPacingProtocol ()
 Empty Constructor. More...
 
virtual ~StimulusPacingProtocol ()
 Destructor. More...
 

Set Methods

void setRadius (Real r)
 
void setStimulusAmplitude (Real I)
 
void setPacingSite (Real x, Real y, Real z)
 
void setPacingProtocol (std::string PacingProtocol)
 
const RealStInt () const
 
void setStInt (const Real &StInt)
 
const RealtimeShortS1S1 () const
 
void setTimeShortS1S1 (const Real &tShortS1S1)
 
const RealstartingTimeStimulus () const
 
void setStartingTimeStimulus (const Real &startingTimeStimulus)
 
const RealstIntMin () const
 
void setStIntMin (const Real &stIntMin)
 
const RealtimeStep () const
 
void setTimeStep (const Real &dt)
 
const RealstIntS1S2 () const
 
void setStIntS1S2 (const Real &stIntS1S2)
 
const RealstIntS1S2Min () const
 
void setStIntS1S2Min (const Real &stIntS1S2Min)
 
const RealstIntS2S3 () const
 
void setStIntS2S3 (const Real &stIntS2S3)
 
const RealstIntS3S4 () const
 
void setStIntS3S4 (const Real &stIntS3S4)
 
const int & nbStimMax () const
 
void setNbStimMax (const int &nbStimMax)
 
const int & repeatSt () const
 
void setRepeatSt (const int &repeatSt)
 
const RealstimulusDuration () const
 
void setStimulusDuration (const Real &stimDur)
 
void setPacingProtocolType (const std::string &pacProTyp)
 
void setParameters (list_Type &list)
 

Methods

Real appliedCurrent (const Real &t, const Real &x, const Real &y, const Real &z, const ID &i)
 
Real fixedCycleLength (const Real &t)
 
Real fixedCycleLengthwExtraStim (const Real &t)
 
Real standardS1S2Protocol (const Real &t)
 
Real dynamicProtocol (const Real &t)
 
Real pacingProtocolChoice (const Real &t)
 Methods. More...
 
void showMe ()
 

Additional Inherited Members

- Public Types inherited from ElectroStimulus
typedef VectorEpetra vector_Type
 
typedef std::shared_ptr< VectorEpetravectorPtr_Type
 
typedef Teuchos::ParameterList list_Type
 
- Public Member Functions inherited from ElectroStimulus
 ElectroStimulus ()
 Empty Constructor. More...
 
virtual ~ElectroStimulus ()
 Destructor. More...
 

Detailed Description

Definition at line 44 of file StimulusPacingProtocol.hpp.

Constructor & Destructor Documentation

◆ StimulusPacingProtocol()

Empty Constructor.

Constructors.

Definition at line 44 of file StimulusPacingProtocol.cpp.

◆ ~StimulusPacingProtocol()

virtual ~StimulusPacingProtocol ( )
inlinevirtual

Destructor.

Definition at line 58 of file StimulusPacingProtocol.hpp.

Member Function Documentation

◆ setRadius()

void setRadius ( Real  r)
inline

Definition at line 65 of file StimulusPacingProtocol.hpp.

◆ setStimulusAmplitude()

void setStimulusAmplitude ( Real  I)
inline

Definition at line 71 of file StimulusPacingProtocol.hpp.

◆ setPacingSite()

void setPacingSite ( Real  x,
Real  y,
Real  z 
)
inline

Definition at line 77 of file StimulusPacingProtocol.hpp.

◆ setPacingProtocol()

void setPacingProtocol ( std::string  PacingProtocol)
inline

Definition at line 84 of file StimulusPacingProtocol.hpp.

◆ StInt()

const Real& StInt ( ) const
inline

Definition at line 90 of file StimulusPacingProtocol.hpp.

◆ setStInt()

void setStInt ( const Real StInt)
inline

Definition at line 94 of file StimulusPacingProtocol.hpp.

◆ timeShortS1S1()

const Real& timeShortS1S1 ( ) const
inline

Definition at line 99 of file StimulusPacingProtocol.hpp.

◆ setTimeShortS1S1()

void setTimeShortS1S1 ( const Real tShortS1S1)
inline

Definition at line 103 of file StimulusPacingProtocol.hpp.

◆ startingTimeStimulus()

const Real& startingTimeStimulus ( ) const
inline

Definition at line 108 of file StimulusPacingProtocol.hpp.

◆ setStartingTimeStimulus()

void setStartingTimeStimulus ( const Real startingTimeStimulus)
inline

Definition at line 112 of file StimulusPacingProtocol.hpp.

◆ stIntMin()

const Real& stIntMin ( ) const
inline

Definition at line 117 of file StimulusPacingProtocol.hpp.

◆ setStIntMin()

void setStIntMin ( const Real stIntMin)
inline

Definition at line 121 of file StimulusPacingProtocol.hpp.

◆ timeStep()

const Real& timeStep ( ) const
inline

Definition at line 126 of file StimulusPacingProtocol.hpp.

◆ setTimeStep()

void setTimeStep ( const Real dt)
inline

Definition at line 130 of file StimulusPacingProtocol.hpp.

◆ stIntS1S2()

const Real& stIntS1S2 ( ) const
inline

Definition at line 136 of file StimulusPacingProtocol.hpp.

◆ setStIntS1S2()

void setStIntS1S2 ( const Real stIntS1S2)
inline

Definition at line 140 of file StimulusPacingProtocol.hpp.

◆ stIntS1S2Min()

const Real& stIntS1S2Min ( ) const
inline

Definition at line 145 of file StimulusPacingProtocol.hpp.

◆ setStIntS1S2Min()

void setStIntS1S2Min ( const Real stIntS1S2Min)
inline

Definition at line 149 of file StimulusPacingProtocol.hpp.

◆ stIntS2S3()

const Real& stIntS2S3 ( ) const
inline

Definition at line 154 of file StimulusPacingProtocol.hpp.

◆ setStIntS2S3()

void setStIntS2S3 ( const Real stIntS2S3)
inline

Definition at line 158 of file StimulusPacingProtocol.hpp.

◆ stIntS3S4()

const Real& stIntS3S4 ( ) const
inline

Definition at line 163 of file StimulusPacingProtocol.hpp.

◆ setStIntS3S4()

void setStIntS3S4 ( const Real stIntS3S4)
inline

Definition at line 167 of file StimulusPacingProtocol.hpp.

◆ nbStimMax()

const int& nbStimMax ( ) const
inline

Definition at line 172 of file StimulusPacingProtocol.hpp.

◆ setNbStimMax()

void setNbStimMax ( const int &  nbStimMax)
inline

Definition at line 176 of file StimulusPacingProtocol.hpp.

◆ repeatSt()

const int& repeatSt ( ) const
inline

Definition at line 181 of file StimulusPacingProtocol.hpp.

◆ setRepeatSt()

void setRepeatSt ( const int &  repeatSt)
inline

Definition at line 185 of file StimulusPacingProtocol.hpp.

◆ stimulusDuration()

const Real& stimulusDuration ( ) const
inline

Definition at line 190 of file StimulusPacingProtocol.hpp.

◆ setStimulusDuration()

void setStimulusDuration ( const Real stimDur)
inline

Definition at line 194 of file StimulusPacingProtocol.hpp.

◆ setPacingProtocolType()

void setPacingProtocolType ( const std::string &  pacProTyp)
inline

Definition at line 199 of file StimulusPacingProtocol.hpp.

◆ setParameters()

void setParameters ( list_Type list)
inlinevirtual

Reimplemented from ElectroStimulus.

Definition at line 205 of file StimulusPacingProtocol.hpp.

◆ appliedCurrent()

Real appliedCurrent ( const Real t,
const Real x,
const Real y,
const Real z,
const ID i 
)
virtual

Reimplemented from ElectroStimulus.

Definition at line 314 of file StimulusPacingProtocol.cpp.

◆ fixedCycleLength()

Real fixedCycleLength ( const Real t)

Definition at line 92 of file StimulusPacingProtocol.cpp.

+ Here is the caller graph for this function:

◆ fixedCycleLengthwExtraStim()

Real fixedCycleLengthwExtraStim ( const Real t)

Definition at line 119 of file StimulusPacingProtocol.cpp.

+ Here is the caller graph for this function:

◆ standardS1S2Protocol()

Real standardS1S2Protocol ( const Real t)

Definition at line 185 of file StimulusPacingProtocol.cpp.

+ Here is the caller graph for this function:

◆ dynamicProtocol()

Real dynamicProtocol ( const Real t)

Definition at line 263 of file StimulusPacingProtocol.cpp.

+ Here is the caller graph for this function:

◆ pacingProtocolChoice()

Real pacingProtocolChoice ( const Real t)

Methods.

Definition at line 60 of file StimulusPacingProtocol.cpp.

+ Here is the caller graph for this function:

◆ showMe()

void showMe ( )
virtual

Reimplemented from ElectroStimulus.

Definition at line 328 of file StimulusPacingProtocol.cpp.

Field Documentation

◆ M_radius

Real M_radius
private

Definition at line 262 of file StimulusPacingProtocol.hpp.

◆ M_stimulusAmplitude

Real M_stimulusAmplitude
private

Definition at line 263 of file StimulusPacingProtocol.hpp.

◆ M_pacingSite_X

Real M_pacingSite_X
private

Definition at line 264 of file StimulusPacingProtocol.hpp.

◆ M_pacingSite_Y

Real M_pacingSite_Y
private

Definition at line 265 of file StimulusPacingProtocol.hpp.

◆ M_pacingSite_Z

Real M_pacingSite_Z
private

Definition at line 266 of file StimulusPacingProtocol.hpp.

◆ M_startingTimeStimulus

Real M_startingTimeStimulus
private

Definition at line 269 of file StimulusPacingProtocol.hpp.

◆ M_tShortS1S1

Real M_tShortS1S1
private

Definition at line 270 of file StimulusPacingProtocol.hpp.

◆ M_stimulusInterval

Real M_stimulusInterval
private

Definition at line 271 of file StimulusPacingProtocol.hpp.

◆ M_minimumStimulusInterval

Real M_minimumStimulusInterval
private

Definition at line 272 of file StimulusPacingProtocol.hpp.

◆ M_stIntS1S2

Real M_stIntS1S2
private

Definition at line 273 of file StimulusPacingProtocol.hpp.

◆ M_stIntS1S2Min

Real M_stIntS1S2Min
private

Definition at line 274 of file StimulusPacingProtocol.hpp.

◆ M_stIntS2S3

Real M_stIntS2S3
private

Definition at line 275 of file StimulusPacingProtocol.hpp.

◆ M_stIntS3S4

Real M_stIntS3S4
private

Definition at line 276 of file StimulusPacingProtocol.hpp.

◆ M_nbStimMax

int M_nbStimMax
private

Definition at line 279 of file StimulusPacingProtocol.hpp.

◆ M_repeatSt

int M_repeatSt
private

Definition at line 280 of file StimulusPacingProtocol.hpp.

◆ M_numberStimulus

int M_numberStimulus
private

Definition at line 281 of file StimulusPacingProtocol.hpp.

◆ M_pacingProtocol

std::string M_pacingProtocol
private

Definition at line 284 of file StimulusPacingProtocol.hpp.

◆ M_pacingProtocolType

std::string M_pacingProtocolType
private

Definition at line 285 of file StimulusPacingProtocol.hpp.

◆ M_stimulusDuration

Real M_stimulusDuration
private

Definition at line 288 of file StimulusPacingProtocol.hpp.

◆ M_dt

Real M_dt
private

Definition at line 292 of file StimulusPacingProtocol.hpp.


The documentation for this class was generated from the following files: