Chaste Release::3.1
Public Member Functions | Protected Attributes
PlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <PlaneStimulusCellFactory.hpp>

Inheritance diagram for PlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >:
Collaboration diagram for PlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >:

List of all members.

Public Member Functions

 PlaneStimulusCellFactory (double stimulusMagnitude=-600, double stimulusDuration=0.5)
AbstractCardiacCellInterface * CreateCardiacCellForTissueNode (unsigned node)

Protected Attributes

boost::shared_ptr< SimpleStimulus > mpStimulus

Detailed Description

template<class CELL, unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
class PlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >

PlaneStimulusCellFactory provides cells within 1e-5 of x=0 with a SimpleStimulus.

Definition at line 50 of file PlaneStimulusCellFactory.hpp.

Constructor & Destructor Documentation

template<class CELL , unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
PlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >::PlaneStimulusCellFactory ( double  stimulusMagnitude = -600,
double  stimulusDuration = 0.5 
) [inline]

Constructor

Parameters:
stimulusMagnitudeThe magnitude of the simple stimulus to be applied (defaults to -600).
stimulusDurationThe duration of the simple stimulus to be applied (defaults to 0.5ms).

Definition at line 62 of file PlaneStimulusCellFactory.hpp.

References PlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >::mpStimulus.

Member Function Documentation

template<class CELL , unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
AbstractCardiacCellInterface* PlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >::CreateCardiacCellForTissueNode ( unsigned  node) [inline, virtual]
Parameters:
nodeThe global index of a node
Returns:
A cardiac cell which corresponds to this node.

Todo:
remove magic number? (#1884)

Implements AbstractCardiacCellFactory< ELEMENT_DIM, SPACE_DIM >.

Definition at line 73 of file PlaneStimulusCellFactory.hpp.

References AbstractCardiacCellFactory< ELEMENT_DIM, SPACE_DIM >::GetMesh(), AbstractCardiacCellFactory< ELEMENT_DIM, SPACE_DIM >::mpSolver, PlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >::mpStimulus, and AbstractCardiacCellFactory< ELEMENT_DIM, SPACE_DIM >::mpZeroStimulus.

Member Data Documentation

template<class CELL , unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
boost::shared_ptr<SimpleStimulus> PlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >::mpStimulus [protected]

The stimulus to apply at stimulated nodes

Definition at line 54 of file PlaneStimulusCellFactory.hpp.

Referenced by PlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >::CreateCardiacCellForTissueNode(), GeneralPlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >::GeneralPlaneStimulusCellFactory(), and PlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >::PlaneStimulusCellFactory().

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