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 >:

List of all members.

Public Member Functions
	GeneralPlaneStimulusCellFactory (unsigned numEleAcross, double meshWidth, bool useMeshWidthAsMag=false, double stimulusMagnitude=-1e7, double stimulusDuration=0.5)

---

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:

numEleAcross	Number of elements across which to apply the stimulus
meshWidth	Width of the mesh (used to calculate magnitude of stimulus)
useMeshWidthAsMag	see todo comments above (defaults to false).
stimulusMagnitude	Magnitude of the applied stimulus (defaults to -1e7, modified in the constructor dependent on mesh size).
stimulusDuration	Duration 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:

• heart/src/problem/cell_factories/GeneralPlaneStimulusCellFactory.hpp