AbstractStimulusFactory< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <AbstractStimulusFactory.hpp>

Collaboration diagram for AbstractStimulusFactory< ELEMENT_DIM, SPACE_DIM >:

Public Member Functions
virtual boost::shared_ptr < AbstractStimulusFunction >	CreateStimulusForNode (unsigned nodeIndex)
virtual unsigned	GetNumberOfCells ()
virtual void	SetCompatibleExtracellularStimulus ()
	AbstractStimulusFactory ()
virtual	~AbstractStimulusFactory ()
void	SetMesh (AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM > *pMesh)
AbstractTetrahedralMesh < ELEMENT_DIM, SPACE_DIM > *	GetMesh ()
std::vector < AbstractChasteRegion < SPACE_DIM > * >	GetRegionsToBeGrounded ()
Protected Attributes
AbstractTetrahedralMesh < ELEMENT_DIM, SPACE_DIM > *	mpMesh
std::vector < AbstractChasteRegion < SPACE_DIM > * >	mGroundedRegions

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
class AbstractStimulusFactory< ELEMENT_DIM, SPACE_DIM >

Abstract class that specifies a stimulus factory. The core method is CreateStimulusForNode which creates a stimulus object at each node in the mesh. The default implementation (here) specifies a ZeroStimulus. child classes may override this method.

The other crucial method is SetCompatibleExtracellularStimulus which ensures that the stimulus specified obeys compatibility conditions. The implementation here is empty (compatible with ZeroStimulus which implicitly obeys compatibility conditions). child classes may over-ride the method.

Definition at line 53 of file AbstractStimulusFactory.hpp.

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractStimulusFactory< ELEMENT_DIM, SPACE_DIM >::AbstractStimulusFactory ( ) [inline]

Default constructor.

Definition at line 49 of file AbstractStimulusFactory.cpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractStimulusFactory< ELEMENT_DIM, SPACE_DIM >::~AbstractStimulusFactory ( ) [inline, virtual]

Destructor

Definition at line 56 of file AbstractStimulusFactory.cpp.

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

boost::shared_ptr< AbstractStimulusFunction > AbstractStimulusFactory< ELEMENT_DIM, SPACE_DIM >::CreateStimulusForNode ( unsigned nodeIndex ) [inline, virtual]

Create a stimulus object for the given node. Default implementation here returns a zero stimulus.

May be overridden by child classes.

Parameters:

nodeIndex

Global node index.

Reimplemented in ElectrodesStimulusFactory< DIM >, and ZeroNetChargeElectrodes< DIM >.

Definition at line 34 of file AbstractStimulusFactory.cpp.

Referenced by ExtendedBidomainTissue< SPACE_DIM >::ExtendedBidomainTissue().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM > * AbstractStimulusFactory< ELEMENT_DIM, SPACE_DIM >::GetMesh ( ) [inline]

Returns:: the mesh used to create the stimuli.

Definition at line 73 of file AbstractStimulusFactory.cpp.

References EXCEPTION, and AbstractStimulusFactory< ELEMENT_DIM, SPACE_DIM >::mpMesh.

Referenced by ExtendedBidomainTissue< SPACE_DIM >::ExtendedBidomainTissue().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

unsigned AbstractStimulusFactory< ELEMENT_DIM, SPACE_DIM >::GetNumberOfCells ( ) [inline, virtual]

Returns:: The number of cells

Definition at line 42 of file AbstractStimulusFactory.cpp.

References AbstractStimulusFactory< ELEMENT_DIM, SPACE_DIM >::mpMesh.

Referenced by ExtendedBidomainTissue< SPACE_DIM >::ExtendedBidomainTissue().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::vector< AbstractChasteRegion< SPACE_DIM > * > AbstractStimulusFactory< ELEMENT_DIM, SPACE_DIM >::GetRegionsToBeGrounded ( ) [inline]

Access to the variable mGroundedRegions which stores the regions to be grounded

Definition at line 89 of file AbstractStimulusFactory.cpp.

References AbstractStimulusFactory< ELEMENT_DIM, SPACE_DIM >::mGroundedRegions.

Referenced by ExtendedBidomainProblem< DIM >::ProcessExtracellularStimulus().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractStimulusFactory< ELEMENT_DIM, SPACE_DIM >::SetCompatibleExtracellularStimulus ( ) [inline, virtual]

Empty default implementation that is compatible with the default implementation of CreateStimulusForNode (i.e., empty implementation for zero stimulus).

If needed, over-ride this

Reimplemented in ElectrodesStimulusFactory< DIM >.

Definition at line 67 of file AbstractStimulusFactory.cpp.

Referenced by ExtendedBidomainProblem< DIM >::ProcessExtracellularStimulus().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractStimulusFactory< ELEMENT_DIM, SPACE_DIM >::SetMesh ( AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM > * pMesh ) [inline]