Chaste  Release::2017.1
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 >:

Public Member Functions

 PlaneStimulusCellFactory (double stimulusMagnitude=-600, double stimulusDuration=0.5)
 
AbstractCardiacCellInterfaceCreateCardiacCellForTissueNode (Node< SPACE_DIM > *pNode)
 
- Public Member Functions inherited from AbstractCardiacCellFactory< ELEMENT_DIM, SPACE_DIM >
virtual AbstractCardiacCellInterfaceCreateCardiacCellForNode (Node< SPACE_DIM > *pNode)
 
virtual void FinaliseCellCreation (std::vector< AbstractCardiacCellInterface * > *pCellsDistributed, unsigned lo, unsigned hi)
 
virtual void FillInCellularTransmuralAreas ()
 
virtual unsigned GetNumberOfCells ()
 
 AbstractCardiacCellFactory (boost::shared_ptr< AbstractIvpOdeSolver > pSolver=boost::shared_ptr< AbstractIvpOdeSolver >(new EulerIvpOdeSolver))
 
virtual ~AbstractCardiacCellFactory ()
 
virtual void SetMesh (AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM > *pMesh)
 
AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM > * GetMesh ()
 
void SetHeartGeometryInformation (HeartGeometryInformation< SPACE_DIM > *pHeartGeometryInformation)
 
HeartGeometryInformation< SPACE_DIM > * GetHeartGeometryInformation ()
 

Protected Attributes

boost::shared_ptr< SimpleStimulusmpStimulus
 
- Protected Attributes inherited from AbstractCardiacCellFactory< ELEMENT_DIM, SPACE_DIM >
boost::shared_ptr< ZeroStimulusmpZeroStimulus
 
boost::shared_ptr< AbstractIvpOdeSolvermpSolver
 

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.

Member Function Documentation

template<class CELL , unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
AbstractCardiacCellInterface* PlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >::CreateCardiacCellForTissueNode ( Node< SPACE_DIM > *  pNode)
inlinevirtual
Parameters
pNodePointer to the 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 Node< SPACE_DIM >::GetPoint(), AbstractCardiacCellFactory< ELEMENT_DIM, SPACE_DIM >::mpSolver, 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 GeneralPlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >::GeneralPlaneStimulusCellFactory().


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