Chaste  Release::3.4
GeneralPlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <GeneralPlaneStimulusCellFactory.hpp>

+ Inheritance diagram for GeneralPlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >:
+ Collaboration diagram for GeneralPlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >:

Public Member Functions

 GeneralPlaneStimulusCellFactory (unsigned numEleAcross, double meshWidth, bool useMeshWidthAsMag=false, double stimulusMagnitude=-1e7, double stimulusDuration=0.5)
 
- Public Member Functions inherited from PlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >
 PlaneStimulusCellFactory (double stimulusMagnitude=-600, double stimulusDuration=0.5)
 
AbstractCardiacCellInterfaceCreateCardiacCellForTissueNode (Node< SPACE_DIM > *pNode)
 
- Public Member Functions inherited from AbstractCardiacCellFactory< ELEMENT_DIM, SPACE_DIM >
virtual
AbstractCardiacCellInterface
CreateCardiacCellForNode (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 ()
 

Additional Inherited Members

- Protected Attributes inherited from PlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >
boost::shared_ptr< SimpleStimulusmpStimulus
 
- Protected Attributes inherited from AbstractCardiacCellFactory< ELEMENT_DIM, SPACE_DIM >
boost::shared_ptr< ZeroStimulusmpZeroStimulus
 
boost::shared_ptr
< AbstractIvpOdeSolver
mpSolver
 

Detailed Description

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

GeneralPlaneStimulusCellFactory

Supplies cells with a stimuli that depend upon the number of cells and width of the mesh.

Applied to cells within 1e-5 of x=0.

Definition at line 49 of file GeneralPlaneStimulusCellFactory.hpp.

Constructor & Destructor Documentation

template<class CELL, unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
GeneralPlaneStimulusCellFactory< CELL, ELEMENT_DIM, SPACE_DIM >::GeneralPlaneStimulusCellFactory ( unsigned  numEleAcross,
double  meshWidth,
bool  useMeshWidthAsMag = false,
double  stimulusMagnitude = -1e7,
double  stimulusDuration = 0.5 
)
inline

Constructor

Todo:
The useMeshWidth is temporary, while we are sorting out 3D stimulus. It is to be removed later (along with StimulusConvergenceTester) scale stimulus depending on space_step of elements
Todo:
It looks like the value of the stimulus is specific to 3D
Parameters
numEleAcrossNumber of elements across which to apply the stimulus
meshWidthWidth of the mesh (used to calculate magnitude of stimulus)
useMeshWidthAsMagsee todo comments above (defaults to false).
stimulusMagnitudeMagnitude of the applied stimulus (defaults to -1e7, modified in the constructor dependent on mesh size).
stimulusDurationDuration of the applied stimulus (defaults to 0.5ms).

Definition at line 68 of file GeneralPlaneStimulusCellFactory.hpp.

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


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