ZeroNetChargeElectrodes< DIM > Class Template Reference

#include <ZeroNetChargeElectrodes.hpp>

Inherits ElectrodesStimulusFactory< DIM >.

Collaboration diagram for ZeroNetChargeElectrodes< DIM >:

Public Member Functions
	ZeroNetChargeElectrodes (std::vector< std::pair< AbstractChasteRegion< DIM > , AbstractChasteRegion< DIM > > > &rElectrodePairs, std::vector< double > &rStimulusMagnitudes, std::vector< double > &rDurations, std::vector< double > &rPeriods, std::vector< double > &rStarts, std::vector< double > &rEnds)
boost::shared_ptr < AbstractStimulusFunction >	CreateStimulusForNode (unsigned nodeIndex)
	~ZeroNetChargeElectrodes ()

Detailed Description

template<unsigned DIM>
class ZeroNetChargeElectrodes< DIM >

This class implements the specification of two electrodes with a RegularStimulusZeroNetCharge applied to them. Note that the compatibility conditions are the same as its parent class (ElectrodesStimulusFactory), becuase the magnitudes involved are either + or minus 'Magnitude', hence the stimulus will be compatible.

See documentation of ElectrodesStimulusFactory for full functionality.

Definition at line 53 of file ZeroNetChargeElectrodes.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

ZeroNetChargeElectrodes< DIM >::ZeroNetChargeElectrodes	(	std::vector< std::pair< AbstractChasteRegion< DIM > , AbstractChasteRegion< DIM > > > &	rElectrodePairs,
		std::vector< double > &	rStimulusMagnitudes,
		std::vector< double > &	rDurations,
		std::vector< double > &	rPeriods,
		std::vector< double > &	rStarts,
		std::vector< double > &	rEnds
	)			`[inline]`

Constructor. Electrodes and stimulation parameters need to be passed in.

Parameters:

	rElectrodePairs	the pairs of electrodes
	rStimulusMagnitudes	the magnitudes of the stimuli (microA / cm^3). First electrode will have magnitude value and second electrode will have -magnitude (before being corrected to ensure equal flux).
	rDurations	the duration of each stimulus (ms)
	rPeriods	the period of each stimulus (ms)
	rStarts	the start time of each stimulus (ms).
	rEnds	the end of each stimulation (ms)